Te Whatu Ora Shared Care FHIR API
0.3.9 - release New Zealand flag

Te Whatu Ora Shared Care FHIR API, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.9 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/cinc-fhir-ig/ and changes regularly. See the Directory of published versions

Resource Profile: ManaakiNgaTahiObservation

Official URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservation Version: 0.1.3
Active as of 2024-03-22 Computable Name: ManaakiNgaTahiObservation

Observation FHIR resource for Manaaki Nga Tahi

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationMeasurements and simple assertions
... implicitRules 0..0
... language 0..0
... modifierExtension 0..0
.... use 1..1codeusual | official | temp | secondary | old (If known)
.... value 1..1stringThe value that is unique
... basedOn 0..*Reference(ServiceRequest)Fulfills plan, proposal or order
... partOf 0..0
... category 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (required)
... code 1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
... subject 0..1Reference(Patient)Who and/or what the observation is about
... focus 0..0
... Slices for effective[x] 1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime C1..1dateTimeClinically relevant time/time-period for observation
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... issued C1..1instantDate/Time this version was made available
fhir-hnz-instant-utc-1: Value of instant must be UTC Coordinated Universal Time (not New Zealand time)
... performer 0..*Reference(Patient | Practitioner)Who is responsible for the observation
... value[x] 0..0
... dataAbsentReason 0..0
... interpretation 0..0
... bodySite 0..0
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... hasMember 0..0
... derivedFrom 0..0
... component
.... Slices for value[x] 0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result
Slice: Unordered, Open by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptActual component result
..... value[x]:valueQuantity 0..1QuantityActual component result

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningObservation.effective[x]:effectiveDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-instant-utc-1warningObservation.issuedValue of instant must be UTC Coordinated Universal Time (not New Zealand time)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... identifier Σ1..*IdentifierBusiness Identifier for observation
.... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... value Σ1..1stringThe value that is unique
Example General: 123456
... basedOn Σ0..*Reference(ServiceRequest)Fulfills plan, proposal or order
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
... subject Σ0..1Reference(Patient)Who and/or what the observation is about
... Slices for effective[x] Σ1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime ΣC1..1dateTimeClinically relevant time/time-period for observation
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... issued ΣC1..1instantDate/Time this version was made available
fhir-hnz-instant-utc-1: Value of instant must be UTC Coordinated Universal Time (not New Zealand time)
... performer Σ0..*Reference(Patient | Practitioner)Who is responsible for the observation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningObservation.effective[x]:effectiveDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-instant-utc-1warningObservation.issuedValue of instant must be UTC Coordinated Universal Time (not New Zealand time)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... extension 0..*ExtensionAdditional content defined by implementations
... identifier Σ1..*IdentifierBusiness Identifier for observation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... basedOn Σ0..*Reference(ServiceRequest)Fulfills plan, proposal or order
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (required)
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
... subject Σ0..1Reference(Patient)Who and/or what the observation is about
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... Slices for effective[x] Σ1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime ΣC1..1dateTimeClinically relevant time/time-period for observation
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... issued ΣC1..1instantDate/Time this version was made available
fhir-hnz-instant-utc-1: Value of instant must be UTC Coordinated Universal Time (not New Zealand time)
... performer Σ0..*Reference(Patient | Practitioner)Who is responsible for the observation
... note 0..*AnnotationComments about the observation
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... Slices for value[x] Σ0..1Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... value[x]:valueCodeableConcept Σ0..1CodeableConceptActual component result
..... value[x]:valueQuantity Σ0..1QuantityActual component result
.... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Observation.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningObservation.effective[x]:effectiveDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-instant-utc-1warningObservation.issuedValue of instant must be UTC Coordinated Universal Time (not New Zealand time)
: true

This structure is derived from Observation

Summary

Mandatory: 7 elements
Prohibited: 15 elements

Slices

This structure defines the following Slices:

  • The element Observation.effective[x] is sliced based on the value of type:$this
  • The element Observation.component.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationMeasurements and simple assertions
... implicitRules 0..0
... language 0..0
... modifierExtension 0..0
.... use 1..1codeusual | official | temp | secondary | old (If known)
.... value 1..1stringThe value that is unique
... basedOn 0..*Reference(ServiceRequest)Fulfills plan, proposal or order
... partOf 0..0
... category 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (required)
... code 1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
... subject 0..1Reference(Patient)Who and/or what the observation is about
... focus 0..0
... Slices for effective[x] 1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime C1..1dateTimeClinically relevant time/time-period for observation
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... issued C1..1instantDate/Time this version was made available
fhir-hnz-instant-utc-1: Value of instant must be UTC Coordinated Universal Time (not New Zealand time)
... performer 0..*Reference(Patient | Practitioner)Who is responsible for the observation
... value[x] 0..0
... dataAbsentReason 0..0
... interpretation 0..0
... bodySite 0..0
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... hasMember 0..0
... derivedFrom 0..0
... component
.... Slices for value[x] 0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result
Slice: Unordered, Open by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptActual component result
..... value[x]:valueQuantity 0..1QuantityActual component result

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningObservation.effective[x]:effectiveDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-instant-utc-1warningObservation.issuedValue of instant must be UTC Coordinated Universal Time (not New Zealand time)
: true

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... identifier Σ1..*IdentifierBusiness Identifier for observation
.... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... value Σ1..1stringThe value that is unique
Example General: 123456
... basedOn Σ0..*Reference(ServiceRequest)Fulfills plan, proposal or order
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
... subject Σ0..1Reference(Patient)Who and/or what the observation is about
... Slices for effective[x] Σ1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime ΣC1..1dateTimeClinically relevant time/time-period for observation
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... issued ΣC1..1instantDate/Time this version was made available
fhir-hnz-instant-utc-1: Value of instant must be UTC Coordinated Universal Time (not New Zealand time)
... performer Σ0..*Reference(Patient | Practitioner)Who is responsible for the observation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningObservation.effective[x]:effectiveDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-instant-utc-1warningObservation.issuedValue of instant must be UTC Coordinated Universal Time (not New Zealand time)
: true

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... extension 0..*ExtensionAdditional content defined by implementations
... identifier Σ1..*IdentifierBusiness Identifier for observation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... basedOn Σ0..*Reference(ServiceRequest)Fulfills plan, proposal or order
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... category 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (required)
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
... subject Σ0..1Reference(Patient)Who and/or what the observation is about
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... Slices for effective[x] Σ1..1dateTimeClinically relevant time/time-period for observation
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime ΣC1..1dateTimeClinically relevant time/time-period for observation
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... issued ΣC1..1instantDate/Time this version was made available
fhir-hnz-instant-utc-1: Value of instant must be UTC Coordinated Universal Time (not New Zealand time)
... performer Σ0..*Reference(Patient | Practitioner)Who is responsible for the observation
... note 0..*AnnotationComments about the observation
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... Slices for value[x] Σ0..1Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... value[x]:valueCodeableConcept Σ0..1CodeableConceptActual component result
..... value[x]:valueQuantity Σ0..1QuantityActual component result
.... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Observation.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categoryrequiredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningObservation.effective[x]:effectiveDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-instant-utc-1warningObservation.issuedValue of instant must be UTC Coordinated Universal Time (not New Zealand time)
: true

This structure is derived from Observation

Summary

Mandatory: 7 elements
Prohibited: 15 elements

Slices

This structure defines the following Slices:

  • The element Observation.effective[x] is sliced based on the value of type:$this
  • The element Observation.component.value[x] is sliced based on the value of type:$this

 

Other representations of profile: CSV, Excel, Schematron