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/ManaakiNgaTahiObservation | Version: 0.1.3 | |||
Active as of 2025-06-05 | Computable Name: ManaakiNgaTahiObservation |
Observation FHIR resource for Manaaki Nga Tahi
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business Identifier for observation |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order |
![]() ![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient) | Who and/or what the observation is about |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() |
Σ | 1..1 | dateTime | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
Σ | 1..1 | instant | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
Σ | 0..* | Reference(Patient | Practitioner) | Who is responsible for the observation |
![]() |
Path | Conformance | ValueSet | URI |
Observation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard | |
Observation.category | required | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard | |
Observation.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
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() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Observation | Measurements and simple assertions | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..* | Identifier | Business Identifier for observation | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) | |
![]() ![]() ![]() |
0..1 | Reference(Patient) | Who and/or what the observation is about | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
1..1 | dateTime | Must be in UTC timezone on the FHIR server | |
![]() ![]() ![]() |
1..1 | instant | Must be in UTC timezone on the FHIR server | |
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner) | Who is responsible for the observation | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Actual component result | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Quantity | Actual component result | |
![]() |
Path | Conformance | ValueSet | URI |
Observation.category | required | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard | |
Observation.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business Identifier for observation |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order |
![]() ![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient) | Who and/or what the observation is about |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() |
Σ | 1..1 | dateTime | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
Σ | 1..1 | instant | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
Σ | 0..* | Reference(Patient | Practitioner) | Who is responsible for the observation |
![]() ![]() ![]() |
0..* | Annotation | Comments about the observation | |
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Component results |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Actual component result Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Actual component result |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Quantity | Actual component result |
![]() ![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() ![]() ![]() |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
![]() |
Path | Conformance | ValueSet | URI |
Observation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
Observation.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard | |
Observation.category | required | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard | |
Observation.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard | |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning From the FHIR Standard | |
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto From the FHIR Standard | |
Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard | |
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard | |
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
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() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
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: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business Identifier for observation |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order |
![]() ![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient) | Who and/or what the observation is about |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() |
Σ | 1..1 | dateTime | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
Σ | 1..1 | instant | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
Σ | 0..* | Reference(Patient | Practitioner) | Who is responsible for the observation |
![]() |
Path | Conformance | ValueSet | URI |
Observation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard | |
Observation.category | required | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard | |
Observation.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
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() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Observation | Measurements and simple assertions | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..* | Identifier | Business Identifier for observation | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) | |
![]() ![]() ![]() |
0..1 | Reference(Patient) | Who and/or what the observation is about | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
1..1 | dateTime | Must be in UTC timezone on the FHIR server | |
![]() ![]() ![]() |
1..1 | instant | Must be in UTC timezone on the FHIR server | |
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner) | Who is responsible for the observation | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Actual component result | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Quantity | Actual component result | |
![]() |
Path | Conformance | ValueSet | URI |
Observation.category | required | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard | |
Observation.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Observation | Measurements and simple assertions Constraints: obs-6, obs-7 |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business Identifier for observation |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
Σ | 0..* | Reference(ServiceRequest) | Fulfills plan, proposal or order |
![]() ![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
![]() ![]() ![]() |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (required) | |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient) | Who and/or what the observation is about |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() |
Σ | 1..1 | dateTime | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
Σ | 1..1 | instant | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
Σ | 0..* | Reference(Patient | Practitioner) | Who is responsible for the observation |
![]() ![]() ![]() |
0..* | Annotation | Comments about the observation | |
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Component results |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Actual component result Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Actual component result |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Quantity | Actual component result |
![]() ![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() ![]() ![]() |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
![]() |
Path | Conformance | ValueSet | URI |
Observation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
Observation.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 From the FHIR Standard | |
Observation.category | required | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category From the FHIR Standard | |
Observation.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard | |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning From the FHIR Standard | |
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto From the FHIR Standard | |
Observation.component.code | example | LOINCCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes From the FHIR Standard | |
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard | |
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
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() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty() |
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