Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) 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/ManaakiNgaTahiObservation | Version: 0.1.3 | |||
| Active as of 2026-10-13 | Computable Name: ManaakiNgaTahiObservation | |||
Observation FHIR resource for Manaaki Nga Tahi
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Observation |
C | 0..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 |
  identifier |
1..* | Identifier | Business Identifier for observation | |
   use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
 value |
1..1 | string | The value that is unique Example General: 123456 | |
 basedOn |
0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | |
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |
| category |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) | |
| subject |
0..1 | Reference(Patient) | Who and/or what the observation is about | |
 Slices for effective[x] |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  effective[x]:effectiveDateTime |
1..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| issued |
1..1 | instant | Must be in UTC timezone on the FHIR server | |
| performer |
0..* | Reference(Patient | Practitioner) | Who is responsible for the observation | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | required | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | Observation | Measurements and simple assertions | |
 implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
 modifierExtension |
0..0 | Extension | ||
| identifier |
1..* | Identifier | Business Identifier for observation | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) | |
| value |
1..1 | string | The value that is unique | |
| basedOn |
0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | |
| partOf |
0..0 | Part of referenced event | ||
| category |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) | |
| subject |
0..1 | Reference(Patient) | Who and/or what the observation is about | |
| focus |
0..0 | What the observation is about, when it is not about the subject of record | ||
| Slices for effective[x] |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| effective[x]:effectiveDateTime |
1..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| issued |
1..1 | instant | Must be in UTC timezone on the FHIR server | |
| performer |
0..* | Reference(Patient | Practitioner) | Who is responsible for the observation | |
| value[x] |
0..0 | Actual result | ||
| dataAbsentReason |
0..0 | Why the result is missing | ||
| interpretation |
0..0 | High, low, normal, etc. | ||
| bodySite |
0..0 | Observed body part | ||
| method |
0..0 | How it was done | ||
| specimen |
0..0 | Specimen used for this observation | ||
| device |
0..0 | (Measurement) Device | ||
| referenceRange |
0..0 | Provides guide for interpretation | ||
| hasMember |
0..0 | Related resource that belongs to the Observation group | ||
| derivedFrom |
0..0 | Related measurements the observation is made from | ||
 component |
||||
 Slices for value[x] |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |
 value[x]:valueCodeableConcept |
0..1 | CodeableConcept | Actual component result | |
| value[x]:valueQuantity |
0..1 | Quantity | Actual component result | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.category | Base | required | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 |
| id |
0..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| contained |
0..* | Resource | Contained, inline Resources | |
 extension |
0..* | Extension | Additional content defined by implementations | |
| identifier |
1..* | Identifier | Business Identifier for observation | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| basedOn |
0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | |
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |
| category |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) | |
| subject |
0..1 | Reference(Patient) | Who and/or what the observation is about | |
| encounter |
0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
| Slices for effective[x] |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| effective[x]:effectiveDateTime |
1..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| issued |
1..1 | instant | Must be in UTC timezone on the FHIR server | |
| performer |
0..* | Reference(Patient | Practitioner) | Who is responsible for the observation | |
| note |
0..* | Annotation | Comments about the observation | |
| component |
0..* | BackboneElement | Component results | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |
| Slices for value[x] |
0..1 | Actual component result Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
| valueQuantity |
Quantity | |||
| valueCodeableConcept |
CodeableConcept | |||
| valueString |
string | |||
| valueBoolean |
boolean | |||
| valueInteger |
integer | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueSampledData |
SampledData | |||
| valueTime |
time | |||
| valueDateTime |
dateTime | |||
| valuePeriod |
Period | |||
| value[x]:valueCodeableConcept |
0..1 | CodeableConcept | Actual component result | |
| value[x]:valueQuantity |
0..1 | Quantity | Actual component result | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | required | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📦4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Observation
Summary
Mandatory: 7 elements
Prohibited: 15 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 |
| identifier |
1..* | Identifier | Business Identifier for observation | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| basedOn |
0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | |
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |
| category |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) | |
| subject |
0..1 | Reference(Patient) | Who and/or what the observation is about | |
| Slices for effective[x] |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| effective[x]:effectiveDateTime |
1..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| issued |
1..1 | instant | Must be in UTC timezone on the FHIR server | |
| performer |
0..* | Reference(Patient | Practitioner) | Who is responsible for the observation | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | required | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
0..* | Observation | Measurements and simple assertions | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| modifierExtension |
0..0 | Extension | ||
| identifier |
1..* | Identifier | Business Identifier for observation | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) | |
| value |
1..1 | string | The value that is unique | |
| basedOn |
0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | |
| partOf |
0..0 | Part of referenced event | ||
| category |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) | |
| subject |
0..1 | Reference(Patient) | Who and/or what the observation is about | |
| focus |
0..0 | What the observation is about, when it is not about the subject of record | ||
| Slices for effective[x] |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| effective[x]:effectiveDateTime |
1..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| issued |
1..1 | instant | Must be in UTC timezone on the FHIR server | |
| performer |
0..* | Reference(Patient | Practitioner) | Who is responsible for the observation | |
| value[x] |
0..0 | Actual result | ||
| dataAbsentReason |
0..0 | Why the result is missing | ||
| interpretation |
0..0 | High, low, normal, etc. | ||
| bodySite |
0..0 | Observed body part | ||
| method |
0..0 | How it was done | ||
| specimen |
0..0 | Specimen used for this observation | ||
| device |
0..0 | (Measurement) Device | ||
| referenceRange |
0..0 | Provides guide for interpretation | ||
| hasMember |
0..0 | Related resource that belongs to the Observation group | ||
| derivedFrom |
0..0 | Related measurements the observation is made from | ||
| component |
||||
| Slices for value[x] |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |
| value[x]:valueCodeableConcept |
0..1 | CodeableConcept | Actual component result | |
| value[x]:valueQuantity |
0..1 | Quantity | Actual component result | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.category | Base | required | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 |
| id |
0..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| contained |
0..* | Resource | Contained, inline Resources | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| identifier |
1..* | Identifier | Business Identifier for observation | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |
| system |
0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| basedOn |
0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | |
| status |
1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | |
| category |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
| code |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) | |
| subject |
0..1 | Reference(Patient) | Who and/or what the observation is about | |
| encounter |
0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
| Slices for effective[x] |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| effective[x]:effectiveDateTime |
1..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| issued |
1..1 | instant | Must be in UTC timezone on the FHIR server | |
| performer |
0..* | Reference(Patient | Practitioner) | Who is responsible for the observation | |
| note |
0..* | Annotation | Comments about the observation | |
| component |
0..* | BackboneElement | Component results | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |
| Slices for value[x] |
0..1 | Actual component result Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
| valueQuantity |
Quantity | |||
| valueCodeableConcept |
CodeableConcept | |||
| valueString |
string | |||
| valueBoolean |
boolean | |||
| valueInteger |
integer | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueSampledData |
SampledData | |||
| valueTime |
time | |||
| valueDateTime |
dateTime | |||
| valuePeriod |
Period | |||
| value[x]:valueCodeableConcept |
0..1 | CodeableConcept | Actual component result | |
| value[x]:valueQuantity |
0..1 | Quantity | Actual component result | |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Observation.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| Observation.category | Base | required | Observation Category Codes | 📦4.0.1 | FHIR Std. |
| Observation.code | Base | example | LOINC Codes | 📦4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Observation
Summary
Mandatory: 7 elements
Prohibited: 15 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron