0.1.0 - ci-build International flag

JohnMoehrkeTestVital, published by John Moehrke (himself). This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/JohnMoehrke/testVital/ and changes regularly. See the Directory of published versions

Resource Profile: VA PHR Vital-Signs

Official URL: http://johnmoehrke.github.io/testvital/StructureDefinition/Myvitals Version: 0.1.0
Draft as of 2025-10-23 Computable Name: Myvitals

A profile on the Observation resource for PHR exposing Vital-Signs using FHIR API.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreVitalSignsProfile US Core Vital Signs Profile
Constraints: obs-6, obs-7, vs-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Required Pattern: final
... 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: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
.... coding SΣ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
... Slices for effective[x] SΣC 1..1 dateTime S Often just a dateTime for Vital Signs
Slice: Unordered, Closed by type:$this
Constraints: vs-1
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime S Often just a dateTime for Vital Signs
Constraints: vs-1
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) {c} Who is responsible for the observation
.... Slices for extension Content/Rules for all slices
..... extension:site 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Location) {c} Value of extension
... value[x] SΣC 0..1 Vital Signs Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period

doco Documentation for this format

Terminology Bindings

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 📦5.0.1 US Core v5.0
Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component.​code Base extensible US Core Vital Signs ValueSet 📦5.0.1 US Core v5.0
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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
vs-1 error Observation.effective[x], Observation.effective[x]:effectiveDateTime if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day $this 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())

This structure is derived from USCoreVitalSignsProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* USCoreVitalSignsProfile US Core Vital Signs Profile
... basedOn 0..0
... partOf 0..0
... status 1..1 code registered | preliminary | final | amended +
Required Pattern: final
... code
.... coding S 0..* Coding Code defined by a terminology system
.... text S 0..1 string Plain text representation of the concept
... focus 0..0
... encounter 0..0
... Slices for effective[x] 1..1 dateTime Often just a dateTime for Vital Signs
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime 1..1 dateTime Often just a dateTime for Vital Signs
... issued 0..0
... performer S 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) {c} Who is responsible for the observation
.... Slices for extension Content/Rules for all slices
..... extension:site 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... value[x] 1..1 Reference(Location) {c} Value of extension
... dataAbsentReason 0..0
... interpretation 0..0
... note 0..0
... bodySite 0..0
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... hasMember 0..0
... derivedFrom 0..0
... component 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreVitalSignsProfile US Core Vital Signs Profile
Constraints: obs-6, obs-7, vs-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Required Pattern: final
... 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: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
... Slices for effective[x] SΣC 1..1 dateTime S Often just a dateTime for Vital Signs
Slice: Unordered, Closed by type:$this
Constraints: vs-1
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime S Often just a dateTime for Vital Signs
Constraints: vs-1
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) {c} Who is responsible for the observation
.... 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:site 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Location) {c} Value of extension
.... reference ΣC 0..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
... value[x] SΣC 0..1 Vital Signs Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Observation.status Base required 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 📦5.0.1 US Core v5.0
Observation.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📦4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base extensible US Core Vital Signs ValueSet 📦5.0.1 US Core v5.0
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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
vs-1 error Observation.effective[x], Observation.effective[x]:effectiveDateTime if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day $this 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())

This structure is derived from USCoreVitalSignsProfile

Summary

Mandatory: 1 element
Must-Support: 3 elements
Prohibited: 16 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.effective[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreVitalSignsProfile US Core Vital Signs Profile
Constraints: obs-6, obs-7, vs-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Required Pattern: final
... 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: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
.... coding SΣ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
... Slices for effective[x] SΣC 1..1 dateTime S Often just a dateTime for Vital Signs
Slice: Unordered, Closed by type:$this
Constraints: vs-1
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime S Often just a dateTime for Vital Signs
Constraints: vs-1
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) {c} Who is responsible for the observation
.... Slices for extension Content/Rules for all slices
..... extension:site 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Location) {c} Value of extension
... value[x] SΣC 0..1 Vital Signs Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period

doco Documentation for this format

Terminology Bindings

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 📦5.0.1 US Core v5.0
Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.component.​code Base extensible US Core Vital Signs ValueSet 📦5.0.1 US Core v5.0
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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
vs-1 error Observation.effective[x], Observation.effective[x]:effectiveDateTime if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day $this 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())

Differential View

This structure is derived from USCoreVitalSignsProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* USCoreVitalSignsProfile US Core Vital Signs Profile
... basedOn 0..0
... partOf 0..0
... status 1..1 code registered | preliminary | final | amended +
Required Pattern: final
... code
.... coding S 0..* Coding Code defined by a terminology system
.... text S 0..1 string Plain text representation of the concept
... focus 0..0
... encounter 0..0
... Slices for effective[x] 1..1 dateTime Often just a dateTime for Vital Signs
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime 1..1 dateTime Often just a dateTime for Vital Signs
... issued 0..0
... performer S 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) {c} Who is responsible for the observation
.... Slices for extension Content/Rules for all slices
..... extension:site 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... value[x] 1..1 Reference(Location) {c} Value of extension
... dataAbsentReason 0..0
... interpretation 0..0
... note 0..0
... bodySite 0..0
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... hasMember 0..0
... derivedFrom 0..0
... component 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* USCoreVitalSignsProfile US Core Vital Signs Profile
Constraints: obs-6, obs-7, vs-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
Required Pattern: final
... 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: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
... Slices for effective[x] SΣC 1..1 dateTime S Often just a dateTime for Vital Signs
Slice: Unordered, Closed by type:$this
Constraints: vs-1
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime S Often just a dateTime for Vital Signs
Constraints: vs-1
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) {c} Who is responsible for the observation
.... 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:site 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Location) {c} Value of extension
.... reference ΣC 0..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
... value[x] SΣC 0..1 Vital Signs Value
Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs.
.... valueQuantity Quantity S
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Observation.status Base required 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 📦5.0.1 US Core v5.0
Observation.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.value[x] Base extensible Vital Signs Units 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📦4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base extensible US Core Vital Signs ValueSet 📦5.0.1 US Core v5.0
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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
vs-1 error Observation.effective[x], Observation.effective[x]:effectiveDateTime if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day $this 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())

This structure is derived from USCoreVitalSignsProfile

Summary

Mandatory: 1 element
Must-Support: 3 elements
Prohibited: 16 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.effective[x]

 

Other representations of profile: CSV, Excel, Schematron