Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/patient-cohort | Version: 0.4.1 | |||
| Active as of 2025-08-31 | Computable Name: PatientCohort | |||
Indicates the cohort for which the patient belongs, such as CRC, ARRC, LTC, CDOS, PRISON, etc.
Context of Use
This extension may be used on the following element(s)
Claim
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Patient Cohort | |
  extension |
0..0 | |||
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/patient-cohort" | |
  value[x] |
1..1 | CodeableConcept | Value of extension Binding: Patient Cohort ValueSet (required) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Patient Cohort | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/patient-cohort" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Patient Cohort ValueSet (required) | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Patient Cohort | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/patient-cohort" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Patient Cohort ValueSet (required) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Patient Cohort | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/patient-cohort" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Patient Cohort ValueSet (required) | |
| Documentation for this format | ||||
This structure is derived from Extension
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | URI |
| Extension.value[x] | required | PatientCohort(a valid code from Patient Cohort CodeSystem)https://fhir-ig.digital.health.nz/shared-care/ValueSet/pharmacy-claim-patient-cohort-valuesetFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |