CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG
2.0.0-cibuild - Release 2 ci-build
CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG - Local Development build (v2.0.0-cibuild) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/ach-monthly-observation-vitals | Version: 2.0.0-cibuild | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: AcuteCareHospitalMonthlyReportingVitalsObservation | ||
This profile contains Required and Must Support data elements for reporting observation-vital signs information to the NHSN Acute Care Hospital (ACH) Monthly Digital Quality Measure. This profile inherits from the US Core 6.1.0 Vital Signs
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 1.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USCoreVitalSignsProfile(6.1.0) | US Core Vital Signs Profile Constraints: obs-6, obs-7, vs-2 |
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required) |
![]() ![]() |
S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI) Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | (USCDI) Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | (USCDI) Symbol in syntax defined by the system Fixed Value: vital-signs |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Coded Responses from C-CDA Vital Sign Results Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. |
![]() ![]() |
SΣ | 1..1 | Reference(Cross-Measure Patient Profile) | (USCDI) Who and/or what the observation is about |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
SΣC | 1..1 | (USCDI) Often just a dateTime for Vital Signs Constraints: vs-1 | |
![]() ![]() ![]() |
dateTime S | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
SΣ | 0..1 | instant | Date/Time this version was made available |
![]() ![]() |
SΣC | 0..1 | (USCDI) Vital Signs Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | |
![]() ![]() ![]() |
Quantity S | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() |
time | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
SC | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
![]() ![]() |
S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (extensible) |
![]() ![]() |
S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (extensible) |
![]() ![]() |
SC | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant |
![]() ![]() |
SΣ | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
SΣC | 0..* | BackboneElement | (USCDI) Component observations Constraints: vs-3 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of component observation (code / type) Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. |
![]() ![]() ![]() |
SΣC | 0..1 | (USCDI) Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | |
![]() ![]() ![]() ![]() |
Quantity S | |||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
SC | 0..1 | CodeableConcept | (USCDI) Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Provides guide for interpretation of component result |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
![]() ![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
![]() ![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| 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 | US Core Vital Signs ValueSet | 📦6.1.0 | US Core v6.1 |
| Observation.value[x] | Base | extensible | Vital Signs Units | 📍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 | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Observation.method | Base | extensible | Observation Methods | 📦4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | US Core Vital Signs ValueSet | 📦6.1.0 | US Core v6.1 |
| Observation.component.value[x] | 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. |
| 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()
|
| 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 USCoreVitalSignsProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreVitalSignsProfile(6.1.0) | US Core Vital Signs Profile | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
||||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension | |
![]() ![]() |
S | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
1..1 | Reference(Cross-Measure Patient Profile) | (USCDI) Who and/or what the observation is about | |
![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
S | 0..1 | instant | Date/Time this version was made available |
![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. |
![]() ![]() |
S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (extensible) |
![]() ![]() |
S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (extensible) |
![]() ![]() |
S | 0..* | BackboneElement | Provides guide for interpretation |
![]() ![]() ![]() |
S | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() |
S | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant |
![]() ![]() |
S | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Provides guide for interpretation of component result |
![]() ![]() ![]() ![]() |
S | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
![]() ![]() ![]() ![]() |
S | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
![]() ![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.bodySite | Base | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Observation.method | Base | extensible | Observation Methods | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USCoreVitalSignsProfile(6.1.0) | US Core Vital Signs Profile Constraints: obs-6, obs-7, vs-2 | ||||
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for observation | ||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
![]() ![]() |
SΣ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required) | ||||
![]() ![]() |
S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI) Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | (USCDI) Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | (USCDI) Symbol in syntax defined by the system Fixed Value: vital-signs | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Coded Responses from C-CDA Vital Sign Results Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Cross-Measure Patient Profile) | (USCDI) Who and/or what the observation is about | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
SΣC | 1..1 | (USCDI) Often just a dateTime for Vital Signs Constraints: vs-1 | |||||
![]() ![]() ![]() |
dateTime S | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
SΣ | 0..1 | instant | Date/Time this version was made available | ||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
![]() ![]() |
SΣC | 0..1 | (USCDI) Vital Signs Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | |||||
![]() ![]() ![]() |
Quantity S | |||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
SC | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||
![]() ![]() |
0..* | Annotation | Comments about the observation | |||||
![]() ![]() |
S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (extensible) | ||||
![]() ![]() |
S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (extensible) | ||||
![]() ![]() |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||
![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
![]() ![]() |
SC | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | High Range, if relevant | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant | ||||
![]() ![]() ![]() |
0..1 | string | Text based reference range in an observation | |||||
![]() ![]() |
SΣ | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Related measurements the observation is made from | ||||
![]() ![]() |
SΣC | 0..* | BackboneElement | (USCDI) Component observations Constraints: vs-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of component observation (code / type) Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. | ||||
![]() ![]() ![]() |
SΣC | 0..1 | (USCDI) Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | |||||
![]() ![]() ![]() ![]() |
Quantity S | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
SC | 0..1 | CodeableConcept | (USCDI) Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Provides guide for interpretation of component result | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant | ||||
![]() ![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Text based reference range in an observation | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Observation.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Observation.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Observation.partOf.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| 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 | US Core Vital Signs ValueSet | 📦6.1.0 | US Core v6.1 |
| Observation.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.encounter.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.value[x] | Base | extensible | Vital Signs Units | 📍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 | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Observation.method | Base | extensible | 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.hasMember.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | US Core Vital Signs ValueSet | 📦6.1.0 | US Core v6.1 |
| Observation.component.value[x] | 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. |
| Observation.component.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| 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()
|
| 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 USCoreVitalSignsProfile
Summary
Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 19 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USCoreVitalSignsProfile(6.1.0) | US Core Vital Signs Profile Constraints: obs-6, obs-7, vs-2 |
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required) |
![]() ![]() |
S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI) Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | (USCDI) Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | (USCDI) Symbol in syntax defined by the system Fixed Value: vital-signs |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Coded Responses from C-CDA Vital Sign Results Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. |
![]() ![]() |
SΣ | 1..1 | Reference(Cross-Measure Patient Profile) | (USCDI) Who and/or what the observation is about |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
SΣC | 1..1 | (USCDI) Often just a dateTime for Vital Signs Constraints: vs-1 | |
![]() ![]() ![]() |
dateTime S | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
SΣ | 0..1 | instant | Date/Time this version was made available |
![]() ![]() |
SΣC | 0..1 | (USCDI) Vital Signs Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | |
![]() ![]() ![]() |
Quantity S | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() |
time | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
SC | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
![]() ![]() |
S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (extensible) |
![]() ![]() |
S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (extensible) |
![]() ![]() |
SC | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant |
![]() ![]() |
SΣ | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
SΣC | 0..* | BackboneElement | (USCDI) Component observations Constraints: vs-3 |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of component observation (code / type) Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. |
![]() ![]() ![]() |
SΣC | 0..1 | (USCDI) Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | |
![]() ![]() ![]() ![]() |
Quantity S | |||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() ![]() |
time | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
SC | 0..1 | CodeableConcept | (USCDI) Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Provides guide for interpretation of component result |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
![]() ![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
![]() ![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| 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 | US Core Vital Signs ValueSet | 📦6.1.0 | US Core v6.1 |
| Observation.value[x] | Base | extensible | Vital Signs Units | 📍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 | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Observation.method | Base | extensible | Observation Methods | 📦4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | US Core Vital Signs ValueSet | 📦6.1.0 | US Core v6.1 |
| Observation.component.value[x] | 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. |
| 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()
|
| 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 USCoreVitalSignsProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreVitalSignsProfile(6.1.0) | US Core Vital Signs Profile | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
||||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension | |
![]() ![]() |
S | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
1..1 | Reference(Cross-Measure Patient Profile) | (USCDI) Who and/or what the observation is about | |
![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
S | 0..1 | instant | Date/Time this version was made available |
![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. |
![]() ![]() |
S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (extensible) |
![]() ![]() |
S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (extensible) |
![]() ![]() |
S | 0..* | BackboneElement | Provides guide for interpretation |
![]() ![]() ![]() |
S | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() |
S | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant |
![]() ![]() |
S | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
![]() ![]() ![]() |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Provides guide for interpretation of component result |
![]() ![]() ![]() ![]() |
S | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
![]() ![]() ![]() ![]() |
S | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
![]() ![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.bodySite | Base | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Observation.method | Base | extensible | Observation Methods | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USCoreVitalSignsProfile(6.1.0) | US Core Vital Signs Profile Constraints: obs-6, obs-7, vs-2 | ||||
![]() ![]() |
Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business Identifier for observation | ||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
![]() ![]() |
SΣ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
?!SΣ | 1..1 | code | (USCDI) registered | preliminary | final | amended + Binding: ObservationStatus (required) | ||||
![]() ![]() |
S | 1..* | CodeableConcept | (USCDI) Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI) Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | (USCDI) Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | (USCDI) Symbol in syntax defined by the system Fixed Value: vital-signs | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Coded Responses from C-CDA Vital Sign Results Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Cross-Measure Patient Profile) | (USCDI) Who and/or what the observation is about | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
SΣC | 1..1 | (USCDI) Often just a dateTime for Vital Signs Constraints: vs-1 | |||||
![]() ![]() ![]() |
dateTime S | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
SΣ | 0..1 | instant | Date/Time this version was made available | ||||
![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
![]() ![]() |
SΣC | 0..1 | (USCDI) Vital Signs Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | |||||
![]() ![]() ![]() |
Quantity S | |||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
SC | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||
![]() ![]() |
0..* | Annotation | Comments about the observation | |||||
![]() ![]() |
S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (extensible) | ||||
![]() ![]() |
S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (extensible) | ||||
![]() ![]() |
0..1 | Reference(Specimen) | Specimen used for this observation | |||||
![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
![]() ![]() |
SC | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity | High Range, if relevant | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant | ||||
![]() ![]() ![]() |
0..1 | string | Text based reference range in an observation | |||||
![]() ![]() |
SΣ | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Related measurements the observation is made from | ||||
![]() ![]() |
SΣC | 0..* | BackboneElement | (USCDI) Component observations Constraints: vs-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | (USCDI) Type of component observation (code / type) Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. | ||||
![]() ![]() ![]() |
SΣC | 0..1 | (USCDI) Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | |||||
![]() ![]() ![]() ![]() |
Quantity S | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
SC | 0..1 | CodeableConcept | (USCDI) Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Provides guide for interpretation of component result | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant | ||||
![]() ![]() ![]() ![]() |
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | Range | Applicable age range, if relevant | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Text based reference range in an observation | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Observation.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Observation.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Observation.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Observation.partOf.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.status | Base | required | ObservationStatus | 📍4.0.1 | FHIR Std. |
| 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 | US Core Vital Signs ValueSet | 📦6.1.0 | US Core v6.1 |
| Observation.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.encounter.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.value[x] | Base | extensible | Vital Signs Units | 📍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 | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std. |
| Observation.method | Base | extensible | 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.hasMember.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Observation.component.code | Base | extensible | US Core Vital Signs ValueSet | 📦6.1.0 | US Core v6.1 |
| Observation.component.value[x] | 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. |
| Observation.component.referenceRange.type | Base | preferred | Observation Reference Range Meaning Codes | 📍4.0.1 | FHIR Std. |
| Observation.component.referenceRange.appliesTo | Base | example | Observation Reference Range Applies To Codes | 📍4.0.1 | FHIR Std. |
| 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()
|
| 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 USCoreVitalSignsProfile
Summary
Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 19 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron