Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-HeartRate | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: ZibHeartRate | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
The heart rate is the number of heartbeats per minute.
This Observation resource represents the Dutch zib (‘Zorginformatiebouwsteen’, i.e. Health and Care Information Model) HeartRate v3.4 (2020).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PatternVitalSigns
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | PatternVitalSigns | This is an abstract profile. Child profiles: NlcoreHeartRate HeartRate | |
  code | 1..1 | CodeableConcept | Type of observation (code / type) Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
  system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8867-4 | |
 Slices for effective[x] | 1..1 | dateTime, Period | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
  effective[x]:effectiveDateTime | 1..1 | dateTime | HeartRateDateTime | |
 value[x] | 0..1 | Quantity | HeartRateValue Required Pattern: At least the following | |
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
| code | 1..1 | code | Coded form of the unit Fixed Value: /min | |
| note | 0..1 | Annotation | Comments about the observation | |
| text | 1..1 | markdown | Comment | |
| method | 0..1 | CodeableConcept | HeartRateMeasurementMethod Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 (extensible) | |
| Slices for component | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code | |
 component:heartbeatRegularity | 0..1 | BackboneElement | Component results | |
  code | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301112006 | |
 value[x] | 0..1 | CodeableConcept | HeartbeatRegularity Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 (required) | |
 component:interpretationHeartRate | 0..1 | BackboneElement | Component results | |
| code | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301113001 | |
| value[x] | 0..1 | CodeableConcept | InterpretationHeartRate Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 (extensible) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.method | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 |
| Observation.component:heartbeatRegularity.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 |
| Observation.component:interpretationHeartRate.value[x] | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | PatternVitalSigns | This is an abstract profile. Child profiles: NlcoreHeartRate HeartRate |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| Slices for category | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| category:VSCat | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs | |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8867-4 | |
| coding | Σ | 1..* | Coding | Code defined by a terminology system |
 subject | Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about |
| Slices for effective[x] | ΣC | 1..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
 effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| effective[x]:effectiveDateTime | ΣC | 1..1 | dateTime | HeartRateDateTime |
| value[x] | ΣC | 0..1 | Quantity | HeartRateValue Required Pattern: At least the following |
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
| code | 1..1 | code | Coded form of the unit Fixed Value: /min | |
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| note | 0..1 | Annotation | Comments about the observation | |
| text | Σ | 1..1 | markdown | Comment |
| method | 0..1 | CodeableConcept | HeartRateMeasurementMethod Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 (extensible) | |
| Slices for component | ΣC | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code |
| component:All Slices | Content/Rules for all slices | |||
| 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. |
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:heartbeatRegularity | ΣC | 0..1 | BackboneElement | Component results |
 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. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301112006 | |
| value[x] | ΣC | 0..1 | CodeableConcept | HeartbeatRegularity Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 (required) |
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:interpretationHeartRate | ΣC | 0..1 | BackboneElement | Component results |
| 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. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301113001 | |
| value[x] | ΣC | 0..1 | CodeableConcept | InterpretationHeartRate Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 (extensible) |
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.status | required | ObservationStatus |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.category:VSCat | preferred | Pattern: vital-signs |
| Observation.code | example | Pattern: LOINC code 8867-4 |
| Observation.dataAbsentReason | extensible | DataAbsentReason |
| Observation.method | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component:heartbeatRegularity.code | example | Pattern: SNOMED CT code 301112006 |
| Observation.component:heartbeatRegularity.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 |
| Observation.component:heartbeatRegularity.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component:interpretationHeartRate.code | example | Pattern: SNOMED CT code 301113001 |
| Observation.component:interpretationHeartRate.value[x] | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 |
| Observation.component:interpretationHeartRate.dataAbsentReason | extensible | DataAbsentReason |
| 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() | |
| vs-1 | error | Observation.effective[x], Observation.effective[x]:effectiveDateTime | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day : ($this as dateTime).toString().length() >= 8 | |
| vs-2 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present. : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| vs-3 | error | Observation.component, Observation.component:heartbeatRegularity, Observation.component:interpretationHeartRate | If there is no a value a data absent reason must be present : value.exists() or dataAbsentReason.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | PatternVitalSigns | This is an abstract profile. Child profiles: NlcoreHeartRate HeartRate | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| Slices for category | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| category:VSCat | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8867-4 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject | Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about | ||||
| focus | ΣTU | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| Slices for effective[x] | ΣC | 1..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| effective[x]:effectiveDateTime | ΣC | 1..1 | dateTime | HeartRateDateTime | ||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| value[x] | ΣC | 0..1 | Quantity | HeartRateValue Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator | 0..1 | code | < | <= | >= | > - how to understand the value | |||||
| unit | 0..1 | string | Unit representation | |||||
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |||||
| code | 1..1 | code | Coded form of the unit Fixed Value: /min | |||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the 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. | |||||
| note | 0..1 | Annotation | Comments about the 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 | |||||
 author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | Comment | ||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | HeartRateMeasurementMethod Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 (extensible) | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation | ||||
| 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 | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| Slices for component | ΣC | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code | ||||
| component:All Slices | Content/Rules for all slices | |||||||
| 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. | ||||
| value[x] | ΣC | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| 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 | |||||
| component:heartbeatRegularity | ΣC | 0..1 | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301112006 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | ΣC | 0..1 | CodeableConcept | HeartbeatRegularity Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 (required) | ||||
| 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 | |||||
| component:interpretationHeartRate | ΣC | 0..1 | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301113001 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | ΣC | 0..1 | CodeableConcept | InterpretationHeartRate Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 (extensible) | ||||
| 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 | Conformance | ValueSet / Code | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | ObservationStatus | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.category:VSCat | preferred | Pattern: vital-signs | ||||
| Observation.code | example | Pattern: LOINC code 8867-4 | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:heartbeatRegularity.code | example | Pattern: SNOMED CT code 301112006 | ||||
| Observation.component:heartbeatRegularity.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 | ||||
| Observation.component:heartbeatRegularity.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:heartbeatRegularity.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:interpretationHeartRate.code | example | Pattern: SNOMED CT code 301113001 | ||||
| Observation.component:interpretationHeartRate.value[x] | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 | ||||
| Observation.component:interpretationHeartRate.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:interpretationHeartRate.interpretation | extensible | ObservationInterpretationCodes |
| 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-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.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() | |
| vs-1 | error | Observation.effective[x], Observation.effective[x]:effectiveDateTime | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day : ($this as dateTime).toString().length() >= 8 | |
| vs-2 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present. : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| vs-3 | error | Observation.component, Observation.component:heartbeatRegularity, Observation.component:interpretationHeartRate | If there is no a value a data absent reason must be present : value.exists() or dataAbsentReason.exists() |
This structure is derived from PatternVitalSigns
Summary
Slices
This structure defines the following Slices:
Differential View
This structure is derived from PatternVitalSigns
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | PatternVitalSigns | This is an abstract profile. Child profiles: NlcoreHeartRate HeartRate | |
| code | 1..1 | CodeableConcept | Type of observation (code / type) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8867-4 | |
| Slices for effective[x] | 1..1 | dateTime, Period | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
| effective[x]:effectiveDateTime | 1..1 | dateTime | HeartRateDateTime | |
| value[x] | 0..1 | Quantity | HeartRateValue Required Pattern: At least the following | |
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
| code | 1..1 | code | Coded form of the unit Fixed Value: /min | |
| note | 0..1 | Annotation | Comments about the observation | |
| text | 1..1 | markdown | Comment | |
| method | 0..1 | CodeableConcept | HeartRateMeasurementMethod Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 (extensible) | |
| Slices for component | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code | |
| component:heartbeatRegularity | 0..1 | BackboneElement | Component results | |
| code | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301112006 | |
| value[x] | 0..1 | CodeableConcept | HeartbeatRegularity Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 (required) | |
| component:interpretationHeartRate | 0..1 | BackboneElement | Component results | |
| code | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301113001 | |
| value[x] | 0..1 | CodeableConcept | InterpretationHeartRate Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 (extensible) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.method | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 |
| Observation.component:heartbeatRegularity.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 |
| Observation.component:interpretationHeartRate.value[x] | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | PatternVitalSigns | This is an abstract profile. Child profiles: NlcoreHeartRate HeartRate |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| Slices for category | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| category:VSCat | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs | |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8867-4 | |
| coding | Σ | 1..* | Coding | Code defined by a terminology system |
| subject | Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about |
| Slices for effective[x] | ΣC | 1..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| effective[x]:effectiveDateTime | ΣC | 1..1 | dateTime | HeartRateDateTime |
| value[x] | ΣC | 0..1 | Quantity | HeartRateValue Required Pattern: At least the following |
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
| code | 1..1 | code | Coded form of the unit Fixed Value: /min | |
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| note | 0..1 | Annotation | Comments about the observation | |
| text | Σ | 1..1 | markdown | Comment |
| method | 0..1 | CodeableConcept | HeartRateMeasurementMethod Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 (extensible) | |
| Slices for component | ΣC | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code |
| component:All Slices | Content/Rules for all slices | |||
| 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. |
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:heartbeatRegularity | ΣC | 0..1 | BackboneElement | Component results |
| 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. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301112006 | |
| value[x] | ΣC | 0..1 | CodeableConcept | HeartbeatRegularity Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 (required) |
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component:interpretationHeartRate | ΣC | 0..1 | BackboneElement | Component results |
| 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. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301113001 | |
| value[x] | ΣC | 0..1 | CodeableConcept | InterpretationHeartRate Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 (extensible) |
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.status | required | ObservationStatus |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.category:VSCat | preferred | Pattern: vital-signs |
| Observation.code | example | Pattern: LOINC code 8867-4 |
| Observation.dataAbsentReason | extensible | DataAbsentReason |
| Observation.method | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component:heartbeatRegularity.code | example | Pattern: SNOMED CT code 301112006 |
| Observation.component:heartbeatRegularity.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 |
| Observation.component:heartbeatRegularity.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component:interpretationHeartRate.code | example | Pattern: SNOMED CT code 301113001 |
| Observation.component:interpretationHeartRate.value[x] | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 |
| Observation.component:interpretationHeartRate.dataAbsentReason | extensible | DataAbsentReason |
| 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() | |
| vs-1 | error | Observation.effective[x], Observation.effective[x]:effectiveDateTime | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day : ($this as dateTime).toString().length() >= 8 | |
| vs-2 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present. : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| vs-3 | error | Observation.component, Observation.component:heartbeatRegularity, Observation.component:interpretationHeartRate | If there is no a value a data absent reason must be present : value.exists() or dataAbsentReason.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | PatternVitalSigns | This is an abstract profile. Child profiles: NlcoreHeartRate HeartRate | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| Slices for category | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| category:VSCat | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8867-4 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject | Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about | ||||
| focus | ΣTU | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| Slices for effective[x] | ΣC | 1..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| effective[x]:effectiveDateTime | ΣC | 1..1 | dateTime | HeartRateDateTime | ||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| value[x] | ΣC | 0..1 | Quantity | HeartRateValue Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator | 0..1 | code | < | <= | >= | > - how to understand the value | |||||
| unit | 0..1 | string | Unit representation | |||||
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |||||
| code | 1..1 | code | Coded form of the unit Fixed Value: /min | |||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the 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. | |||||
| note | 0..1 | Annotation | Comments about the 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 | |||||
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | Comment | ||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | HeartRateMeasurementMethod Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 (extensible) | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation | ||||
| 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 | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| Slices for component | ΣC | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code | ||||
| component:All Slices | Content/Rules for all slices | |||||||
| 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. | ||||
| value[x] | ΣC | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| 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 | |||||
| component:heartbeatRegularity | ΣC | 0..1 | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301112006 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | ΣC | 0..1 | CodeableConcept | HeartbeatRegularity Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 (required) | ||||
| 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 | |||||
| component:interpretationHeartRate | ΣC | 0..1 | 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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 301113001 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | ΣC | 0..1 | CodeableConcept | InterpretationHeartRate Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 (extensible) | ||||
| 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 | Conformance | ValueSet / Code | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | ObservationStatus | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.category:VSCat | preferred | Pattern: vital-signs | ||||
| Observation.code | example | Pattern: LOINC code 8867-4 | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.2--20200901000000 | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:heartbeatRegularity.code | example | Pattern: SNOMED CT code 301112006 | ||||
| Observation.component:heartbeatRegularity.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.1--20200901000000 | ||||
| Observation.component:heartbeatRegularity.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:heartbeatRegularity.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:interpretationHeartRate.code | example | Pattern: SNOMED CT code 301113001 | ||||
| Observation.component:interpretationHeartRate.value[x] | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.12.3.3--20200901000000 | ||||
| Observation.component:interpretationHeartRate.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:interpretationHeartRate.interpretation | extensible | ObservationInterpretationCodes |
| 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-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.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() | |
| vs-1 | error | Observation.effective[x], Observation.effective[x]:effectiveDateTime | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day : ($this as dateTime).toString().length() >= 8 | |
| vs-2 | error | Observation | If there is no component or hasMember element then either a value[x] or a data absent reason must be present. : (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists()) | |
| vs-3 | error | Observation.component, Observation.component:heartbeatRegularity, Observation.component:interpretationHeartRate | If there is no a value a data absent reason must be present : value.exists() or dataAbsentReason.exists() |
This structure is derived from PatternVitalSigns
Summary
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron