XealthIG - Local Development build (vv1.52.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: Xealth Observation Vital Signs
| Official URL: https://fhir.xealth.io/StructureDefinition/xealth-observation-vitalsigns | Version: v1.52.0 | |||
| Active as of 2026-10-26 | Computable Name: XealthObservationVitalSigns | |||
Defines Xealth constraints on Observation Vital Signs
Usages:
- This Profile is not used by any profiles in this Specification
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Observation |
C | 0..* | observation-vitalsigns | FHIR Vital Signs Profile Constraints: obs-6, obs-7, vs-2, orderingProvider-with-ehrOrderId |
  meta |
1..1 | Meta | Metadata about the resource | |
 implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:ehrOrderId |
0..1 | string | The EHR's identifier for the order. URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id | |
 extension:orderingProvider |
0..1 | (Complex) | The name and identifier of the ordering provider. If identifier is present, then name must be as well, and vice versa. URL: https://fhir.xealth.io/StructureDefinition/extension-ordering-provider | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 basedOn |
1..* | Reference(ServiceRequest) | The Xealth order this Observation is based on. | |
| status |
1..1 | code | registered | preliminary | final | amended + Binding: Xealth Observation Valid Status Value Set (required) | |
 Slices for category |
1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 category:VSCat |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
  coding |
1..* | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category (no extensions allowed) | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs (no extensions allowed) | |
| code |
1..1 | CodeableConcept | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible): This identifies the vital sign result type. | |
 Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
 system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| subject |
1..1 | Reference(Patient) | The patient this Observation is made about. | |
| effective[x] |
C | 1..1 | dateTime | Often just a dateTime for Vital Signs Constraints: vs-1 |
| performer |
1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |
| value[x] |
C | 1..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component |
C | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. Constraints: vs-3 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: VitalSigns (extensible): This identifies the vital sign result type. | |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| Slices for value[x] |
C | 0..1 | CodeableConcept | Vital Sign Value recorded with UCUM Slice: Unordered, Closed by type:$this Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| value[x]:valueCodeableConcept |
C | 0..1 | CodeableConcept | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. |
 Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | |
| Slices for coding |
Content/Rules for all slices | |||
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| 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 | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | Xealth Observation Valid Status Value Set | 📦v1.52.0 | This IG |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:VSCat | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x] | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x]:valueCodeableConcept | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| orderingProvider-with-ehrOrderId | error | Observation | If Observation.orderingProvider is present, then Observation.ehrOrderId must be present. |
extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ordering-provider') implies extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id')
|
| vs-1 | error | Observation.effective[x] | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
$this is dateTime implies $this.toString().length() >= 10
|
| 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 | If there is no a value a data absent reason must be present |
value.exists() or dataAbsentReason.exists()
|
This structure is derived from observation-vitalsigns
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | observation-vitalsigns | FHIR Vital Signs Profile Constraints: orderingProvider-with-ehrOrderId |
 meta |
1..1 | Meta | Metadata about the resource | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:ehrOrderId |
0..1 | string | The EHR's identifier for the order. URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id | |
| extension:orderingProvider |
0..1 | (Complex) | The name and identifier of the ordering provider. If identifier is present, then name must be as well, and vice versa. URL: https://fhir.xealth.io/StructureDefinition/extension-ordering-provider | |
| basedOn |
1..* | Reference(ServiceRequest) | The Xealth order this Observation is based on. | |
| status |
1..1 | code | registered | preliminary | final | amended + Binding: Xealth Observation Valid Status Value Set (required) | |
| code |
||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| subject |
1..1 | Reference(Patient) | The patient this Observation is made about. | |
| effective[x] |
1..1 | dateTime | Often just a dateTime for Vital Signs | |
| performer |
1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |
| value[x] |
1..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. | |
| component |
||||
| code |
||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| value[x] |
0..1 | CodeableConcept | Vital Sign Value recorded with UCUM Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| valueCodeableConcept |
0..1 | CodeableConcept | Vital Sign Value recorded with UCUM | |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | Xealth Observation Valid Status Value Set | 📦v1.52.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| orderingProvider-with-ehrOrderId | error | Observation | If Observation.orderingProvider is present, then Observation.ehrOrderId must be present. |
extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ordering-provider') implies extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | observation-vitalsigns | FHIR Vital Signs Profile Constraints: obs-6, obs-7, vs-2, orderingProvider-with-ehrOrderId | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
1..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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:ehrOrderId |
0..1 | string | The EHR's identifier for the order. URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id | |||||
| extension:orderingProvider |
0..1 | (Complex) | The name and identifier of the ordering provider. If identifier is present, then name must be as well, and vice versa. URL: https://fhir.xealth.io/StructureDefinition/extension-ordering-provider | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifier for observation | |||||
| basedOn |
1..* | Reference(ServiceRequest) | The Xealth order this Observation is based on. | |||||
| partOf |
0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||
| status |
1..1 | code | registered | preliminary | final | amended + Binding: Xealth Observation Valid Status Value Set (required) | |||||
| Slices for category |
1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:VSCat |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| 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 | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category (no extensions allowed) | |||||
| 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 (no extensions allowed) | |||||
| 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 | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible): This identifies the vital sign result type. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| 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 | |||||
| subject |
1..1 | Reference(Patient) | The patient this Observation is made about. | |||||
| focus |
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 | |||||
| effective[x] |
C | 1..1 | dateTime | Often just a dateTime for Vital Signs Constraints: vs-1 | ||||
| issued |
0..1 | instant | Date/Time this version was made available | |||||
| performer |
1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |||||
| value[x] |
C | 1..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. | ||||
| 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..* | Annotation | Comments about the observation | |||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| 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 Constraints: obs-3 | ||||
| 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(4.0.1) | Low Range, if relevant Constraints: sqty-1 | ||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1 | ||||
| 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(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components | |||||
| derivedFrom |
0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Related measurements the observation is made from | |||||
| component |
C | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. Constraints: vs-3 | ||||
| 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: VitalSigns (extensible): This identifies the vital sign result type. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| 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 | |||||
| Slices for value[x] |
C | 0..1 | CodeableConcept | Vital Sign Value recorded with UCUM Slice: Unordered, Closed by type:$this Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| value[x]:valueCodeableConcept |
C | 0..1 | CodeableConcept | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | |||||
| Slices for coding |
Content/Rules for all slices | |||||||
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| 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 | |||||
| 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 | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | Xealth Observation Valid Status Value Set | 📦v1.52.0 | This IG |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:VSCat | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x] | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x]:valueCodeableConcept | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| orderingProvider-with-ehrOrderId | error | Observation | If Observation.orderingProvider is present, then Observation.ehrOrderId must be present. |
extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ordering-provider') implies extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id')
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
| vs-1 | error | Observation.effective[x] | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
$this is dateTime implies $this.toString().length() >= 10
|
| 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 | If there is no a value a data absent reason must be present |
value.exists() or dataAbsentReason.exists()
|
This structure is derived from observation-vitalsigns
Summary
Mandatory: 7 elements(6 nested mandatory elements)
Must-Support: 9 elements
Extensions
This structure refers to these extensions:
- https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
- https://fhir.xealth.io/StructureDefinition/extension-ordering-provider
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Observation.code.coding
- The element 1 is sliced based on the value of Observation.component.code.coding
- The element 1 is sliced based on the value of Observation.component.value[x]
- The element 1 is sliced based on the value of Observation.component.valueCodeableConcept.coding
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | observation-vitalsigns | FHIR Vital Signs Profile Constraints: obs-6, obs-7, vs-2, orderingProvider-with-ehrOrderId |
| meta |
1..1 | Meta | Metadata about the resource | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:ehrOrderId |
0..1 | string | The EHR's identifier for the order. URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id | |
| extension:orderingProvider |
0..1 | (Complex) | The name and identifier of the ordering provider. If identifier is present, then name must be as well, and vice versa. URL: https://fhir.xealth.io/StructureDefinition/extension-ordering-provider | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| basedOn |
1..* | Reference(ServiceRequest) | The Xealth order this Observation is based on. | |
| status |
1..1 | code | registered | preliminary | final | amended + Binding: Xealth Observation Valid Status Value Set (required) | |
| Slices for category |
1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| category:VSCat |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| coding |
1..* | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category (no extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs (no extensions allowed) | |
| code |
1..1 | CodeableConcept | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible): This identifies the vital sign result type. | |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| subject |
1..1 | Reference(Patient) | The patient this Observation is made about. | |
| effective[x] |
C | 1..1 | dateTime | Often just a dateTime for Vital Signs Constraints: vs-1 |
| performer |
1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |
| value[x] |
C | 1..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. |
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| component |
C | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. Constraints: vs-3 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| code |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: VitalSigns (extensible): This identifies the vital sign result type. | |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| Slices for value[x] |
C | 0..1 | CodeableConcept | Vital Sign Value recorded with UCUM Slice: Unordered, Closed by type:$this Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| value[x]:valueCodeableConcept |
C | 0..1 | CodeableConcept | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | |
| Slices for coding |
Content/Rules for all slices | |||
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| 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 | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | Xealth Observation Valid Status Value Set | 📦v1.52.0 | This IG |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:VSCat | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x] | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x]:valueCodeableConcept | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| orderingProvider-with-ehrOrderId | error | Observation | If Observation.orderingProvider is present, then Observation.ehrOrderId must be present. |
extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ordering-provider') implies extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id')
|
| vs-1 | error | Observation.effective[x] | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
$this is dateTime implies $this.toString().length() >= 10
|
| 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 | If there is no a value a data absent reason must be present |
value.exists() or dataAbsentReason.exists()
|
Differential View
This structure is derived from observation-vitalsigns
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Observation |
C | 0..* | observation-vitalsigns | FHIR Vital Signs Profile Constraints: orderingProvider-with-ehrOrderId |
| meta |
1..1 | Meta | Metadata about the resource | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:ehrOrderId |
0..1 | string | The EHR's identifier for the order. URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id | |
| extension:orderingProvider |
0..1 | (Complex) | The name and identifier of the ordering provider. If identifier is present, then name must be as well, and vice versa. URL: https://fhir.xealth.io/StructureDefinition/extension-ordering-provider | |
| basedOn |
1..* | Reference(ServiceRequest) | The Xealth order this Observation is based on. | |
| status |
1..1 | code | registered | preliminary | final | amended + Binding: Xealth Observation Valid Status Value Set (required) | |
| code |
||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| subject |
1..1 | Reference(Patient) | The patient this Observation is made about. | |
| effective[x] |
1..1 | dateTime | Often just a dateTime for Vital Signs | |
| performer |
1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |
| value[x] |
1..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. | |
| component |
||||
| code |
||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| value[x] |
0..1 | CodeableConcept | Vital Sign Value recorded with UCUM Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| valueCodeableConcept |
0..1 | CodeableConcept | Vital Sign Value recorded with UCUM | |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | Xealth Observation Valid Status Value Set | 📦v1.52.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| orderingProvider-with-ehrOrderId | error | Observation | If Observation.orderingProvider is present, then Observation.ehrOrderId must be present. |
extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ordering-provider') implies extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | observation-vitalsigns | FHIR Vital Signs Profile Constraints: obs-6, obs-7, vs-2, orderingProvider-with-ehrOrderId | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
1..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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:ehrOrderId |
0..1 | string | The EHR's identifier for the order. URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id | |||||
| extension:orderingProvider |
0..1 | (Complex) | The name and identifier of the ordering provider. If identifier is present, then name must be as well, and vice versa. URL: https://fhir.xealth.io/StructureDefinition/extension-ordering-provider | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifier for observation | |||||
| basedOn |
1..* | Reference(ServiceRequest) | The Xealth order this Observation is based on. | |||||
| partOf |
0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||
| status |
1..1 | code | registered | preliminary | final | amended + Binding: Xealth Observation Valid Status Value Set (required) | |||||
| Slices for category |
1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:VSCat |
1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category (no extensions allowed) | |||||
| 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 (no extensions allowed) | |||||
| 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 | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible): This identifies the vital sign result type. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| 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 | |||||
| subject |
1..1 | Reference(Patient) | The patient this Observation is made about. | |||||
| focus |
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 | |||||
| effective[x] |
C | 1..1 | dateTime | Often just a dateTime for Vital Signs Constraints: vs-1 | ||||
| issued |
0..1 | instant | Date/Time this version was made available | |||||
| performer |
1..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |||||
| value[x] |
C | 1..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. | ||||
| 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..* | Annotation | Comments about the observation | |||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| 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 Constraints: obs-3 | ||||
| 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(4.0.1) | Low Range, if relevant Constraints: sqty-1 | ||||
| high |
C | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant Constraints: sqty-1 | ||||
| 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(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components | |||||
| derivedFrom |
0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Related measurements the observation is made from | |||||
| component |
C | 0..* | BackboneElement | Used when reporting systolic and diastolic blood pressure. Constraints: vs-3 | ||||
| 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: VitalSigns (extensible): This identifies the vital sign result type. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| 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 | |||||
| Slices for value[x] |
C | 0..1 | CodeableConcept | Vital Sign Value recorded with UCUM Slice: Unordered, Closed by type:$this Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| value[x]:valueCodeableConcept |
C | 0..1 | CodeableConcept | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | |||||
| Slices for coding |
Content/Rules for all slices | |||||||
| coding:loincCode |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| 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 | |||||
| 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 | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | Xealth Observation Valid Status Value Set | 📦v1.52.0 | This IG |
| Observation.category | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.category:VSCat | Base | preferred | Observation Category Codes | 📍4.0.1 | FHIR Std. |
| Observation.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
| Observation.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Observation.method | Base | example | Observation Methods | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | Vital Signs | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x] | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.value[x]:valueCodeableConcept | Base | extensible | Vital Signs Units | 📍4.0.1 | FHIR Std. |
| Observation.component.dataAbsentReason | Base | extensible | DataAbsentReason | 📍4.0.1 | FHIR Std. |
| Observation.component.interpretation | Base | extensible | Observation Interpretation Codes | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| orderingProvider-with-ehrOrderId | error | Observation | If Observation.orderingProvider is present, then Observation.ehrOrderId must be present. |
extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ordering-provider') implies extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id')
|
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
| vs-1 | error | Observation.effective[x] | if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
$this is dateTime implies $this.toString().length() >= 10
|
| 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 | If there is no a value a data absent reason must be present |
value.exists() or dataAbsentReason.exists()
|
This structure is derived from observation-vitalsigns
Summary
Mandatory: 7 elements(6 nested mandatory elements)
Must-Support: 9 elements
Extensions
This structure refers to these extensions:
- https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
- https://fhir.xealth.io/StructureDefinition/extension-ordering-provider
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Observation.code.coding
- The element 1 is sliced based on the value of Observation.component.code.coding
- The element 1 is sliced based on the value of Observation.component.value[x]
- The element 1 is sliced based on the value of Observation.component.valueCodeableConcept.coding
Other representations of profile: CSV, Excel, Schematron