CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG
1.0.0 - Release 1
CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG
1.0.0 - Release 1
This page is part of the CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/ach-monthly-observation-vitals | Version: 1.0.0 | |||
| 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 is based on the HL7 FHIR® R4 Observation Vital Signs Profile v4.0.1.
Usages:
You can also check for usages in the FHIR IG Statistics
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 |
  id
|
Σ | 1..1 | id | Logical id of this artifact |
|
implicitRules
|
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension
|
?! | 0..* | Extension | Extensions that cannot be ignored |
  partOf
|
SΣ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
  reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
status
|
?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
 Slices for category
|
S | 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. |
  category:VSCat
|
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
   coding
|
SΣ | 1..* | Coding | Code defined by a terminology system |
|
system
|
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
|
code
|
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs |
|
code
|
SΣ | 1..1 | CodeableConcept | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible) |
|
subject
|
SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about |
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
encounter
|
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
 effective[x]
|
SΣC | 1..1 | Often just a dateTime for Vital Signs Constraints: vs-1 |
|
|
effectiveDateTime
|
dateTime | |||
|
effectivePeriod
|
Period | |||
|
issued
|
SΣ | 0..1 | instant | Date/Time this version was made available |
|
value[x]
|
SΣC | 0..1 | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. | |
|
valueQuantity
|
Quantity | |||
|
valueCodeableConcept
|
CodeableConcept | |||
|
valueString
|
string | |||
|
valueBoolean
|
boolean | |||
|
valueInteger
|
integer | |||
|
valueRange
|
Range | |||
|
valueRatio
|
Ratio | |||
|
valueSampledData
|
SampledData | |||
|
valueTime
|
time | |||
|
valueDateTime
|
dateTime | |||
|
valuePeriod
|
Period | |||
|
dataAbsentReason
|
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
|
bodySite
|
S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (extensible) |
|
method
|
S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (extensible) |
|
referenceRange
|
SC | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 |
|
modifierExtension
|
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
|
low
|
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
|
high
|
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
|
age
|
S | 0..1 | Range | Applicable age range, if relevant |
|
hasMember
|
SΣ | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
 component
|
SΣ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
|
SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VitalSigns (extensible): This identifies the vital sign result type. |
|
value[x]
|
SΣC | 0..1 | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. |
|
|
valueQuantity
|
Quantity | |||
|
valueCodeableConcept
|
CodeableConcept | |||
|
valueString
|
string | |||
|
valueBoolean
|
boolean | |||
|
valueInteger
|
integer | |||
|
valueRange
|
Range | |||
|
valueRatio
|
Ratio | |||
|
valueSampledData
|
SampledData | |||
|
valueTime
|
time | |||
|
valueDateTime
|
dateTime | |||
|
valuePeriod
|
Period | |||
|
dataAbsentReason
|
SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
|
referenceRange
|
S | 0..* | BackboneElement | Provides guide for interpretation of component result |
|
modifierExtension
|
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
|
low
|
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
|
high
|
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
|
age
|
S | 0..1 | Range | Applicable age range, if relevant |
|
Documentation for this format
| ||||
| Path | Conformance | ValueSet | URI |
| Observation.status | required |
ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
|
|
| Observation.category | preferred |
ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category|4.0.1
From the FHIR Standard
|
|
| Observation.category:VSCat | preferred |
ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category|4.0.1
From the FHIR Standard
|
|
| Observation.code | extensible |
VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresult
From the FHIR Standard
|
|
| Observation.dataAbsentReason | extensible |
DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
From the FHIR Standard
|
|
| Observation.interpretation | extensible |
ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation|4.0.1
From the FHIR Standard
|
|
| Observation.bodySite | extensible |
SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
|
|
| Observation.method | extensible |
ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods
From the FHIR Standard
|
|
| Observation.component.code | extensible |
VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresult|4.0.1
From the FHIR Standard
|
|
| Observation.component.value[x] | extensible |
VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
From the FHIR Standard
|
|
| Observation.component.dataAbsentReason | extensible |
DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
From the FHIR Standard
|
|
| Observation.component.interpretation | extensible |
ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation|4.0.1
From the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() |
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
|
| obs-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 observation-vitalsigns
| Name | Flags | Card. | Type |
Description & Constraints Filter:
|
|---|---|---|---|---|
|
Observation
|
0..* | observation-vitalsigns | FHIR Vital Signs Profile | |
 id
|
1..1 | id | Logical id of this artifact | |
|
meta
|
||||
|
Slices for extension
|
Content/Rules for all slices | |||
 extension:link-received-date-extension
|
0..1 | dateTime |
Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension |
|
|
partOf
|
S | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
|
reference
|
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
code
|
1..1 | CodeableConcept |
Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible) |
|
|
subject
|
||||
|
reference
|
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
encounter
|
||||
|
reference
|
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
issued
|
S | 0..1 | instant | Date/Time this version was made available |
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. |
|
bodySite
|
S | 0..1 | CodeableConcept |
Observed body part Binding: SNOMEDCTBodyStructures (extensible) |
|
method
|
S | 0..1 | CodeableConcept |
How it was done Binding: ObservationMethods (extensible) |
|
referenceRange
|
S | 0..* | BackboneElement | Provides guide for interpretation |
|
low
|
S | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
|
high
|
S | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
|
age
|
S | 0..1 | Range | Applicable age range, if relevant |
|
hasMember
|
S | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
|
reference
|
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
component
|
||||
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. |
|
referenceRange
|
S | 0..* | BackboneElement | Provides guide for interpretation of component result |
|
low
|
S | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
|
high
|
S | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
|
age
|
S | 0..1 | Range | Applicable age range, if relevant |
|
Documentation for this format
| ||||
| Path | Conformance | ValueSet | URI |
| Observation.code | extensible |
VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresult
From the FHIR Standard
|
|
| Observation.bodySite | extensible |
SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
|
|
| Observation.method | extensible |
ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods
From the FHIR Standard
|
| Name | Flags | Card. | Type |
Description & Constraints Filter:
|
||||
|---|---|---|---|---|---|---|---|---|
|
Observation
|
C | 0..* | observation-vitalsigns | FHIR Vital Signs Profile Constraints: obs-6, obs-7, vs-2 |
||||
|
id
|
Σ | 1..1 | id | Logical id of this artifact | ||||
|
meta
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
id
|
0..1 | string | Unique id for inter-element referencing | |||||
 Slices for extension
|
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
|||||
|
extension:link-received-date-extension
|
0..1 | dateTime | Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension |
|||||
|
versionId
|
Σ | 0..1 | id | Version specific identifier | ||||
|
lastUpdated
|
Σ | 0..1 | instant | When the resource version last changed | ||||
|
source
|
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
|
profile
|
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
||||
|
security
|
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
||||
|
tag
|
Σ | 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". |
||||
|
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 |
|||||
|
extension
|
0..* | Extension | Additional content defined by implementations |
|||||
|
modifierExtension
|
?! | 0..* | Extension | Extensions that cannot be ignored |
||||
|
identifier
|
Σ | 0..* | Identifier | Business Identifier for observation |
||||
|
basedOn
|
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
||||
|
partOf
|
SΣ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
||||
|
id
|
0..1 | string | Unique id for inter-element referencing | |||||
|
extension
|
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
|||||
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
|
type
|
Σ | 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). |
||||
|
identifier
|
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
|
display
|
Σ | 0..1 | string | Text alternative for the resource | ||||
|
status
|
?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
||||
|
Slices for category
|
S | 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. |
||||
|
category:VSCat
|
S | 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
|
SΣ | 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
|
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
||||
|
version
|
Σ | 0..1 | string | Version of the system - if relevant | ||||
|
code
|
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs |
||||
|
display
|
Σ | 0..1 | string | Representation defined by the system | ||||
|
userSelected
|
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
 text
|
Σ | 0..1 | string | Plain text representation of the concept | ||||
|
code
|
SΣ | 1..1 | CodeableConcept | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible) |
||||
|
subject
|
SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about | ||||
|
id
|
0..1 | string | Unique id for inter-element referencing | |||||
|
extension
|
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
|||||
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
|
type
|
Σ | 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). |
||||
|
identifier
|
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
|
display
|
Σ | 0..1 | string | Text alternative for the resource | ||||
|
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 | ||||
|
id
|
0..1 | string | Unique id for inter-element referencing | |||||
|
extension
|
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
|||||
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
|
type
|
Σ | 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). |
||||
|
identifier
|
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
|
display
|
Σ | 0..1 | string | Text alternative for the resource | ||||
|
effective[x]
|
SΣC | 1..1 | Often just a dateTime for Vital Signs Constraints: vs-1 |
|||||
|
effectiveDateTime
|
dateTime | |||||||
|
effectivePeriod
|
Period | |||||||
|
issued
|
SΣ | 0..1 | instant | Date/Time this version was made available | ||||
|
performer
|
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
||||
|
value[x]
|
SΣC | 0..1 | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. | |||||
|
valueQuantity
|
Quantity | |||||||
|
valueCodeableConcept
|
CodeableConcept | |||||||
|
valueString
|
string | |||||||
|
valueBoolean
|
boolean | |||||||
|
valueInteger
|
integer | |||||||
|
valueRange
|
Range | |||||||
|
valueRatio
|
Ratio | |||||||
|
valueSampledData
|
SampledData | |||||||
|
valueTime
|
time | |||||||
|
valueDateTime
|
dateTime | |||||||
|
valuePeriod
|
Period | |||||||
|
dataAbsentReason
|
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
||||
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
||||
|
note
|
0..* | Annotation | Comments about the observation |
|||||
|
bodySite
|
S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (extensible) |
||||
|
method
|
S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (extensible) |
||||
|
specimen
|
0..1 | Reference(Specimen) | Specimen used for this observation | |||||
|
device
|
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
|
referenceRange
|
SC | 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
|
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant | ||||
|
high
|
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant | ||||
|
type
|
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. |
|||||
|
appliesTo
|
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. |
|||||
|
age
|
S | 0..1 | Range | Applicable age range, if relevant | ||||
|
text
|
0..1 | string | Text based reference range in an observation | |||||
|
hasMember
|
SΣ | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
||||
|
id
|
0..1 | string | Unique id for inter-element referencing | |||||
|
extension
|
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
|||||
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
|
type
|
Σ | 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). |
||||
|
identifier
|
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
|
display
|
Σ | 0..1 | string | Text alternative for the resource | ||||
|
derivedFrom
|
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Related measurements the observation is made from |
||||
|
component
|
SΣ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
|
SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VitalSigns (extensible): This identifies the vital sign result type. |
||||
|
value[x]
|
SΣC | 0..1 | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. |
|||||
|
valueQuantity
|
Quantity | |||||||
|
valueCodeableConcept
|
CodeableConcept | |||||||
|
valueString
|
string | |||||||
|
valueBoolean
|
boolean | |||||||
|
valueInteger
|
integer | |||||||
|
valueRange
|
Range | |||||||
|
valueRatio
|
Ratio | |||||||
|
valueSampledData
|
SampledData | |||||||
|
valueTime
|
time | |||||||
|
valueDateTime
|
dateTime | |||||||
|
valuePeriod
|
Period | |||||||
|
dataAbsentReason
|
SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
||||
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
||||
|
referenceRange
|
S | 0..* | BackboneElement | Provides guide for interpretation of component result |
||||
|
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
|
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant | ||||
|
high
|
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant | ||||
|
type
|
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. |
|||||
|
appliesTo
|
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. |
|||||
|
age
|
S | 0..1 | Range | Applicable age range, if relevant | ||||
|
text
|
0..1 | string | Text based reference range in an observation | |||||
|
Documentation for this format
| ||||||||
| Path | Conformance | ValueSet | URI | |||
| Observation.meta.security | extensible |
All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels|4.0.1
From the FHIR Standard
|
||||
| Observation.meta.tag | example |
CommonTagshttp://hl7.org/fhir/ValueSet/common-tags|4.0.1
From the FHIR Standard
|
||||
| Observation.language | preferred |
CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
|
||||
| Observation.partOf.type | extensible |
ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
|
||||
| Observation.status | required |
ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
|
||||
| Observation.category | preferred |
ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category|4.0.1
From the FHIR Standard
|
||||
| Observation.category:VSCat | preferred |
ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category|4.0.1
From the FHIR Standard
|
||||
| Observation.code | extensible |
VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresult
From the FHIR Standard
|
||||
| Observation.subject.type | extensible |
ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
|
||||
| Observation.encounter.type | extensible |
ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
|
||||
| Observation.dataAbsentReason | extensible |
DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
From the FHIR Standard
|
||||
| Observation.interpretation | extensible |
ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation|4.0.1
From the FHIR Standard
|
||||
| Observation.bodySite | extensible |
SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
|
||||
| Observation.method | extensible |
ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods
From the FHIR Standard
|
||||
| Observation.referenceRange.type | preferred |
ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning|4.0.1
From the FHIR Standard
|
||||
| Observation.referenceRange.appliesTo | example |
ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto|4.0.1
From the FHIR Standard
|
||||
| Observation.hasMember.type | extensible |
ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
|
||||
| Observation.component.code | extensible |
VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresult|4.0.1
From the FHIR Standard
|
||||
| Observation.component.value[x] | extensible |
VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
From the FHIR Standard
|
||||
| Observation.component.dataAbsentReason | extensible |
DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
From the FHIR Standard
|
||||
| Observation.component.interpretation | extensible |
ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation|4.0.1
From the FHIR Standard
|
||||
| Observation.component.referenceRange.type | preferred |
ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning|4.0.1
From the FHIR Standard
|
||||
| Observation.component.referenceRange.appliesTo | example |
ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto|4.0.1
From the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() |
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
|
| obs-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 observation-vitalsigns
Summary
Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 19 elements
Extensions
This structure refers to these extensions:
Maturity: 1
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 |
|
id
|
Σ | 1..1 | id | Logical id of this artifact |
|
implicitRules
|
?!Σ | 0..1 | uri | A set of rules under which this content was created |
|
modifierExtension
|
?! | 0..* | Extension | Extensions that cannot be ignored |
|
partOf
|
SΣ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
status
|
?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
|
Slices for category
|
S | 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. |
|
category:VSCat
|
S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
|
coding
|
SΣ | 1..* | Coding | Code defined by a terminology system |
|
system
|
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
|
code
|
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs |
|
code
|
SΣ | 1..1 | CodeableConcept | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible) |
|
subject
|
SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about |
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
encounter
|
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
effective[x]
|
SΣC | 1..1 | Often just a dateTime for Vital Signs Constraints: vs-1 |
|
|
effectiveDateTime
|
dateTime | |||
|
effectivePeriod
|
Period | |||
|
issued
|
SΣ | 0..1 | instant | Date/Time this version was made available |
|
value[x]
|
SΣC | 0..1 | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. | |
|
valueQuantity
|
Quantity | |||
|
valueCodeableConcept
|
CodeableConcept | |||
|
valueString
|
string | |||
|
valueBoolean
|
boolean | |||
|
valueInteger
|
integer | |||
|
valueRange
|
Range | |||
|
valueRatio
|
Ratio | |||
|
valueSampledData
|
SampledData | |||
|
valueTime
|
time | |||
|
valueDateTime
|
dateTime | |||
|
valuePeriod
|
Period | |||
|
dataAbsentReason
|
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
|
bodySite
|
S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (extensible) |
|
method
|
S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (extensible) |
|
referenceRange
|
SC | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 |
|
modifierExtension
|
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
|
low
|
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
|
high
|
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
|
age
|
S | 0..1 | Range | Applicable age range, if relevant |
|
hasMember
|
SΣ | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
component
|
SΣ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
|
SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VitalSigns (extensible): This identifies the vital sign result type. |
|
value[x]
|
SΣC | 0..1 | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. |
|
|
valueQuantity
|
Quantity | |||
|
valueCodeableConcept
|
CodeableConcept | |||
|
valueString
|
string | |||
|
valueBoolean
|
boolean | |||
|
valueInteger
|
integer | |||
|
valueRange
|
Range | |||
|
valueRatio
|
Ratio | |||
|
valueSampledData
|
SampledData | |||
|
valueTime
|
time | |||
|
valueDateTime
|
dateTime | |||
|
valuePeriod
|
Period | |||
|
dataAbsentReason
|
SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
|
referenceRange
|
S | 0..* | BackboneElement | Provides guide for interpretation of component result |
|
modifierExtension
|
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
|
low
|
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
|
high
|
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
|
age
|
S | 0..1 | Range | Applicable age range, if relevant |
|
Documentation for this format
| ||||
| Path | Conformance | ValueSet | URI |
| Observation.status | required |
ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
|
|
| Observation.category | preferred |
ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category|4.0.1
From the FHIR Standard
|
|
| Observation.category:VSCat | preferred |
ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category|4.0.1
From the FHIR Standard
|
|
| Observation.code | extensible |
VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresult
From the FHIR Standard
|
|
| Observation.dataAbsentReason | extensible |
DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
From the FHIR Standard
|
|
| Observation.interpretation | extensible |
ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation|4.0.1
From the FHIR Standard
|
|
| Observation.bodySite | extensible |
SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
|
|
| Observation.method | extensible |
ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods
From the FHIR Standard
|
|
| Observation.component.code | extensible |
VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresult|4.0.1
From the FHIR Standard
|
|
| Observation.component.value[x] | extensible |
VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
From the FHIR Standard
|
|
| Observation.component.dataAbsentReason | extensible |
DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
From the FHIR Standard
|
|
| Observation.component.interpretation | extensible |
ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation|4.0.1
From the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() |
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
|
| obs-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 observation-vitalsigns
| Name | Flags | Card. | Type |
Description & Constraints Filter:
|
|---|---|---|---|---|
|
Observation
|
0..* | observation-vitalsigns | FHIR Vital Signs Profile | |
|
id
|
1..1 | id | Logical id of this artifact | |
|
meta
|
||||
|
Slices for extension
|
Content/Rules for all slices | |||
|
extension:link-received-date-extension
|
0..1 | dateTime |
Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension |
|
|
partOf
|
S | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
|
reference
|
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
code
|
1..1 | CodeableConcept |
Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible) |
|
|
subject
|
||||
|
reference
|
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
encounter
|
||||
|
reference
|
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
issued
|
S | 0..1 | instant | Date/Time this version was made available |
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. |
|
bodySite
|
S | 0..1 | CodeableConcept |
Observed body part Binding: SNOMEDCTBodyStructures (extensible) |
|
method
|
S | 0..1 | CodeableConcept |
How it was done Binding: ObservationMethods (extensible) |
|
referenceRange
|
S | 0..* | BackboneElement | Provides guide for interpretation |
|
low
|
S | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
|
high
|
S | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
|
age
|
S | 0..1 | Range | Applicable age range, if relevant |
|
hasMember
|
S | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
|
reference
|
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
|
component
|
||||
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. |
|
referenceRange
|
S | 0..* | BackboneElement | Provides guide for interpretation of component result |
|
low
|
S | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant |
|
high
|
S | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant |
|
age
|
S | 0..1 | Range | Applicable age range, if relevant |
|
Documentation for this format
| ||||
| Path | Conformance | ValueSet | URI |
| Observation.code | extensible |
VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresult
From the FHIR Standard
|
|
| Observation.bodySite | extensible |
SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
|
|
| Observation.method | extensible |
ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods
From the FHIR Standard
|
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 |
||||
|
id
|
Σ | 1..1 | id | Logical id of this artifact | ||||
|
meta
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
id
|
0..1 | string | Unique id for inter-element referencing | |||||
|
Slices for extension
|
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
|||||
|
extension:link-received-date-extension
|
0..1 | dateTime | Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension |
|||||
|
versionId
|
Σ | 0..1 | id | Version specific identifier | ||||
|
lastUpdated
|
Σ | 0..1 | instant | When the resource version last changed | ||||
|
source
|
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
|
profile
|
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
||||
|
security
|
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
||||
|
tag
|
Σ | 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". |
||||
|
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 |
|||||
|
extension
|
0..* | Extension | Additional content defined by implementations |
|||||
|
modifierExtension
|
?! | 0..* | Extension | Extensions that cannot be ignored |
||||
|
identifier
|
Σ | 0..* | Identifier | Business Identifier for observation |
||||
|
basedOn
|
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
||||
|
partOf
|
SΣ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
||||
|
id
|
0..1 | string | Unique id for inter-element referencing | |||||
|
extension
|
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
|||||
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
|
type
|
Σ | 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). |
||||
|
identifier
|
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
|
display
|
Σ | 0..1 | string | Text alternative for the resource | ||||
|
status
|
?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
||||
|
Slices for category
|
S | 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. |
||||
|
category:VSCat
|
S | 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
|
SΣ | 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
|
SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
||||
|
version
|
Σ | 0..1 | string | Version of the system - if relevant | ||||
|
code
|
SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs |
||||
|
display
|
Σ | 0..1 | string | Representation defined by the system | ||||
|
userSelected
|
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
|
text
|
Σ | 0..1 | string | Plain text representation of the concept | ||||
|
code
|
SΣ | 1..1 | CodeableConcept | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible) |
||||
|
subject
|
SΣ | 1..1 | Reference(Patient) | Who and/or what the observation is about | ||||
|
id
|
0..1 | string | Unique id for inter-element referencing | |||||
|
extension
|
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
|||||
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
|
type
|
Σ | 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). |
||||
|
identifier
|
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
|
display
|
Σ | 0..1 | string | Text alternative for the resource | ||||
|
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 | ||||
|
id
|
0..1 | string | Unique id for inter-element referencing | |||||
|
extension
|
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
|||||
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
|
type
|
Σ | 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). |
||||
|
identifier
|
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
|
display
|
Σ | 0..1 | string | Text alternative for the resource | ||||
|
effective[x]
|
SΣC | 1..1 | Often just a dateTime for Vital Signs Constraints: vs-1 |
|||||
|
effectiveDateTime
|
dateTime | |||||||
|
effectivePeriod
|
Period | |||||||
|
issued
|
SΣ | 0..1 | instant | Date/Time this version was made available | ||||
|
performer
|
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
||||
|
value[x]
|
SΣC | 0..1 | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. | |||||
|
valueQuantity
|
Quantity | |||||||
|
valueCodeableConcept
|
CodeableConcept | |||||||
|
valueString
|
string | |||||||
|
valueBoolean
|
boolean | |||||||
|
valueInteger
|
integer | |||||||
|
valueRange
|
Range | |||||||
|
valueRatio
|
Ratio | |||||||
|
valueSampledData
|
SampledData | |||||||
|
valueTime
|
time | |||||||
|
valueDateTime
|
dateTime | |||||||
|
valuePeriod
|
Period | |||||||
|
dataAbsentReason
|
SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
||||
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
||||
|
note
|
0..* | Annotation | Comments about the observation |
|||||
|
bodySite
|
S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (extensible) |
||||
|
method
|
S | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (extensible) |
||||
|
specimen
|
0..1 | Reference(Specimen) | Specimen used for this observation | |||||
|
device
|
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
|
referenceRange
|
SC | 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
|
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant | ||||
|
high
|
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant | ||||
|
type
|
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. |
|||||
|
appliesTo
|
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. |
|||||
|
age
|
S | 0..1 | Range | Applicable age range, if relevant | ||||
|
text
|
0..1 | string | Text based reference range in an observation | |||||
|
hasMember
|
SΣ | 0..* | Reference(QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Used when reporting vital signs panel components |
||||
|
id
|
0..1 | string | Unique id for inter-element referencing | |||||
|
extension
|
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
|||||
|
reference
|
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
|
type
|
Σ | 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). |
||||
|
identifier
|
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
|
display
|
Σ | 0..1 | string | Text alternative for the resource | ||||
|
derivedFrom
|
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | MolecularSequence | Vital Signs Profile) | Related measurements the observation is made from |
||||
|
component
|
SΣ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
|
SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: VitalSigns (extensible): This identifies the vital sign result type. |
||||
|
value[x]
|
SΣC | 0..1 | Vital Sign Value recorded with UCUM Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. |
|||||
|
valueQuantity
|
Quantity | |||||||
|
valueCodeableConcept
|
CodeableConcept | |||||||
|
valueString
|
string | |||||||
|
valueBoolean
|
boolean | |||||||
|
valueInteger
|
integer | |||||||
|
valueRange
|
Range | |||||||
|
valueRatio
|
Ratio | |||||||
|
valueSampledData
|
SampledData | |||||||
|
valueTime
|
time | |||||||
|
valueDateTime
|
dateTime | |||||||
|
valuePeriod
|
Period | |||||||
|
dataAbsentReason
|
SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
||||
|
interpretation
|
S | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
||||
|
referenceRange
|
S | 0..* | BackboneElement | Provides guide for interpretation of component result |
||||
|
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
|
SC | 0..1 | SimpleQuantity(4.0.1) | Low Range, if relevant | ||||
|
high
|
SC | 0..1 | SimpleQuantity(4.0.1) | High Range, if relevant | ||||
|
type
|
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. |
|||||
|
appliesTo
|
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. |
|||||
|
age
|
S | 0..1 | Range | Applicable age range, if relevant | ||||
|
text
|
0..1 | string | Text based reference range in an observation | |||||
|
Documentation for this format
| ||||||||
| Path | Conformance | ValueSet | URI | |||
| Observation.meta.security | extensible |
All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels|4.0.1
From the FHIR Standard
|
||||
| Observation.meta.tag | example |
CommonTagshttp://hl7.org/fhir/ValueSet/common-tags|4.0.1
From the FHIR Standard
|
||||
| Observation.language | preferred |
CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
|
||||
| Observation.partOf.type | extensible |
ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
|
||||
| Observation.status | required |
ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
|
||||
| Observation.category | preferred |
ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category|4.0.1
From the FHIR Standard
|
||||
| Observation.category:VSCat | preferred |
ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category|4.0.1
From the FHIR Standard
|
||||
| Observation.code | extensible |
VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresult
From the FHIR Standard
|
||||
| Observation.subject.type | extensible |
ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
|
||||
| Observation.encounter.type | extensible |
ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
|
||||
| Observation.dataAbsentReason | extensible |
DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
From the FHIR Standard
|
||||
| Observation.interpretation | extensible |
ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation|4.0.1
From the FHIR Standard
|
||||
| Observation.bodySite | extensible |
SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
|
||||
| Observation.method | extensible |
ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods
From the FHIR Standard
|
||||
| Observation.referenceRange.type | preferred |
ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning|4.0.1
From the FHIR Standard
|
||||
| Observation.referenceRange.appliesTo | example |
ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto|4.0.1
From the FHIR Standard
|
||||
| Observation.hasMember.type | extensible |
ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
|
||||
| Observation.component.code | extensible |
VitalSignshttp://hl7.org/fhir/ValueSet/observation-vitalsignresult|4.0.1
From the FHIR Standard
|
||||
| Observation.component.value[x] | extensible |
VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1
From the FHIR Standard
|
||||
| Observation.component.dataAbsentReason | extensible |
DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1
From the FHIR Standard
|
||||
| Observation.component.interpretation | extensible |
ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation|4.0.1
From the FHIR Standard
|
||||
| Observation.component.referenceRange.type | preferred |
ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning|4.0.1
From the FHIR Standard
|
||||
| Observation.component.referenceRange.appliesTo | example |
ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto|4.0.1
From the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
|
| dom-3 | error | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
|
| dom-4 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
|
| dom-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
|
| dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() |
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
|
| obs-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 observation-vitalsigns
Summary
Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 19 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
