MyHealtheVet PHR FHIR API
0.3.9-current - ci-build
MyHealtheVet PHR FHIR API, published by VA Digital Services. This guide is not an authorized publication; it is the continuous build for version 0.3.9-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/department-of-veterans-affairs/mhv-fhir-phr-mapping/ and changes regularly. See the Directory of published versions
Official URL: https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.vitalsBP | Version: 0.3.9-current | |||
Standards status: Trial-use | Maturity Level: 4 | Computable Name: MHVvitalsBP |
A profile on the Observation resource for Blood Pressure
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreBloodPressureProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | USCoreBloodPressureProfile | US Core Blood Pressure Profile | |
Slices for identifier | 1..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:use | |
identifier:TOid | 1..* | Identifier | Business Identifier for observation | |
use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
system | C | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} |
value | 0..1 | string | `VitalSignTO` | `.` | {VitalSignTO.type.id} | |
basedOn | 0..0 | |||
partOf | 0..0 | |||
status | 1..1 | code | May indicate entered-in-error | |
category | 1..* | CodeableConcept | Classification of type of observation | |
code | ||||
coding | S | 0..* | Coding | Code defined by a terminology system |
text | S | 0..1 | string | Plain text representation of the concept |
subject | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about | |
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 | |||
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 | |
value[x] | 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 | |||
Slices for component | Content/Rules for all slices | |||
component:systolic | 1..1 | BackboneElement | Systolic Blood Pressure | |
component:diastolic | 1..1 | BackboneElement | Diastolic Blood Pressure | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
TOid-startswithoid | error | Observation.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | USCoreBloodPressureProfile | US Core Blood Pressure Profile obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:use |
identifier:TOid | Σ | 1..* | Identifier | Business Identifier for observation |
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
system | ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | `VitalSignTO` | `.` | {VitalSignTO.type.id} Example General: 123456 |
status | ?!SΣ | 1..1 | code | May indicate entered-in-error 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 | Blood Pressure Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 85354-9 | |
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 | Often just a dateTime for Vital Signs Slice: Unordered, Closed by type:$this vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
effective[x]:effectiveDateTime | SΣC | 1..1 | dateTime | Often just a dateTime for Vital Signs vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
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 | |||
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 | |
dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
Slices for component | SΣC | 2..* | BackboneElement | Component observations Slice: Unordered, Open by pattern:code vs-3: If there is no a value a data absent reason must be present |
component:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. |
value[x] | SΣC | 0..1 | Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | |
valueQuantity | Quantity | |||
dataAbsentReason | SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
component:systolic | SΣC | 1..1 | BackboneElement | Systolic Blood Pressure vs-3: If there is no a value a data absent reason must be present |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | Systolic Blood Pressure Code Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8480-6 | |
value[x] | SΣC | 0..1 | Quantity | Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 1..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
dataAbsentReason | SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
component:diastolic | SΣC | 1..1 | BackboneElement | Diastolic Blood Pressure vs-3: If there is no a value a data absent reason must be present |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | Diastolic Blood Pressure Code Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8462-4 | |
value[x] | SΣC | 0..1 | Quantity | Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 1..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
dataAbsentReason | SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|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 from the FHIR Standard | |
Observation.category:VSCat | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.code | extensible | Pattern: LOINC Code 85354-9http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | |
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Observation.component.code | extensible | UsCoreVitalSignshttp://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | |
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 from the FHIR Standard | |
Observation.component:systolic.code | extensible | Pattern: LOINC Code 8480-6http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | |
Observation.component:systolic.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1 from the FHIR Standard | |
Observation.component:systolic.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.component:systolic.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Observation.component:diastolic.code | extensible | Pattern: LOINC Code 8462-4http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | |
Observation.component:diastolic.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1 from the FHIR Standard | |
Observation.component:diastolic.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.component:diastolic.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
TOid-startswithoid | error | Observation.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | USCoreBloodPressureProfile | US Core Blood Pressure Profile obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present. | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 1..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:use | ||||
identifier:TOid | Σ | 1..* | Identifier | Business Identifier for observation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | `VitalSignTO` | `.` | {VitalSignTO.type.id} Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | May indicate entered-in-error 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 | Blood Pressure Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 85354-9 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | 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 vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day | ||||
effective[x]:effectiveDateTime | SΣC | 1..1 | dateTime S | Often just a dateTime for Vital Signs vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day | ||||
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 | |||||
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 | ||||
dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
Slices for component | SΣC | 2..* | BackboneElement | Component observations Slice: Unordered, Open by pattern:code vs-3: If there is no a value a data absent reason must be present | ||||
component:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. | ||||
value[x] | SΣC | 0..1 | Vital Sign Component 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 | |||||||
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 | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
component:systolic | SΣC | 1..1 | BackboneElement | Systolic Blood Pressure vs-3: If there is no a value a data absent reason must be present | ||||
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 | Systolic Blood Pressure Code Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8480-6 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | SΣC | 0..1 | Quantity | Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | SΣ | 1..1 | string | Unit representation | ||||
system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] | ||||
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 | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
component:diastolic | SΣC | 1..1 | BackboneElement | Diastolic Blood Pressure vs-3: If there is no a value a data absent reason must be present | ||||
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 | Diastolic Blood Pressure Code Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8462-4 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | SΣC | 0..1 | Quantity | Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | SΣ | 1..1 | string | Unit representation | ||||
system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] | ||||
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 | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.identifier:TOid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type 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 from the FHIR Standard | ||||
Observation.category:VSCat | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | extensible | Pattern: LOINC Code 85354-9http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | ||||
Observation.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | extensible | UsCoreVitalSignshttp://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | ||||
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 from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.component:systolic.code | extensible | Pattern: LOINC Code 8480-6http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | ||||
Observation.component:systolic.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1 from the FHIR Standard | ||||
Observation.component:systolic.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Observation.component:systolic.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component:systolic.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.component:diastolic.code | extensible | Pattern: LOINC Code 8462-4http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | ||||
Observation.component:diastolic.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1 from the FHIR Standard | ||||
Observation.component:diastolic.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Observation.component:diastolic.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component:diastolic.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
TOid-startswithoid | error | Observation.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
This structure is derived from USCoreBloodPressureProfile
Summary
Mandatory: 4 elements
Must-Support: 3 elements
Prohibited: 15 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 4
Differential View
This structure is derived from USCoreBloodPressureProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | USCoreBloodPressureProfile | US Core Blood Pressure Profile | |
Slices for identifier | 1..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:use | |
identifier:TOid | 1..* | Identifier | Business Identifier for observation | |
use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
system | C | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} |
value | 0..1 | string | `VitalSignTO` | `.` | {VitalSignTO.type.id} | |
basedOn | 0..0 | |||
partOf | 0..0 | |||
status | 1..1 | code | May indicate entered-in-error | |
category | 1..* | CodeableConcept | Classification of type of observation | |
code | ||||
coding | S | 0..* | Coding | Code defined by a terminology system |
text | S | 0..1 | string | Plain text representation of the concept |
subject | 1..1 | Reference(US Core Patient Profile) | Who and/or what the observation is about | |
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 | |||
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 | |
value[x] | 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 | |||
Slices for component | Content/Rules for all slices | |||
component:systolic | 1..1 | BackboneElement | Systolic Blood Pressure | |
component:diastolic | 1..1 | BackboneElement | Diastolic Blood Pressure | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
TOid-startswithoid | error | Observation.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | USCoreBloodPressureProfile | US Core Blood Pressure Profile obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:use |
identifier:TOid | Σ | 1..* | Identifier | Business Identifier for observation |
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
system | ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | `VitalSignTO` | `.` | {VitalSignTO.type.id} Example General: 123456 |
status | ?!SΣ | 1..1 | code | May indicate entered-in-error 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 | Blood Pressure Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 85354-9 | |
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 | Often just a dateTime for Vital Signs Slice: Unordered, Closed by type:$this vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
effective[x]:effectiveDateTime | SΣC | 1..1 | dateTime | Often just a dateTime for Vital Signs vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day |
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 | |||
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 | |
dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
Slices for component | SΣC | 2..* | BackboneElement | Component observations Slice: Unordered, Open by pattern:code vs-3: If there is no a value a data absent reason must be present |
component:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. |
value[x] | SΣC | 0..1 | Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | |
valueQuantity | Quantity | |||
dataAbsentReason | SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
component:systolic | SΣC | 1..1 | BackboneElement | Systolic Blood Pressure vs-3: If there is no a value a data absent reason must be present |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | Systolic Blood Pressure Code Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8480-6 | |
value[x] | SΣC | 0..1 | Quantity | Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 1..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
dataAbsentReason | SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
component:diastolic | SΣC | 1..1 | BackboneElement | Diastolic Blood Pressure vs-3: If there is no a value a data absent reason must be present |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | Diastolic Blood Pressure Code Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8462-4 | |
value[x] | SΣC | 0..1 | Quantity | Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 1..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] |
dataAbsentReason | SC | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|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 from the FHIR Standard | |
Observation.category:VSCat | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.code | extensible | Pattern: LOINC Code 85354-9http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | |
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Observation.component.code | extensible | UsCoreVitalSignshttp://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | |
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 from the FHIR Standard | |
Observation.component:systolic.code | extensible | Pattern: LOINC Code 8480-6http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | |
Observation.component:systolic.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1 from the FHIR Standard | |
Observation.component:systolic.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.component:systolic.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Observation.component:diastolic.code | extensible | Pattern: LOINC Code 8462-4http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | |
Observation.component:diastolic.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1 from the FHIR Standard | |
Observation.component:diastolic.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.component:diastolic.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
TOid-startswithoid | error | Observation.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | USCoreBloodPressureProfile | US Core Blood Pressure Profile obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present. | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 1..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:use | ||||
identifier:TOid | Σ | 1..* | Identifier | Business Identifier for observation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | ΣC | 0..1 | uri | urn:oid:2.16.840.1.113883.4.349.4.{stationNbr} TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | `VitalSignTO` | `.` | {VitalSignTO.type.id} Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | May indicate entered-in-error 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 | Blood Pressure Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 85354-9 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | 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 vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day | ||||
effective[x]:effectiveDateTime | SΣC | 1..1 | dateTime S | Often just a dateTime for Vital Signs vs-1: if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day | ||||
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 | |||||
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 | ||||
dataAbsentReason | SC | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
Slices for component | SΣC | 2..* | BackboneElement | Component observations Slice: Unordered, Open by pattern:code vs-3: If there is no a value a data absent reason must be present | ||||
component:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. | ||||
value[x] | SΣC | 0..1 | Vital Sign Component 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 | |||||||
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 | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
component:systolic | SΣC | 1..1 | BackboneElement | Systolic Blood Pressure vs-3: If there is no a value a data absent reason must be present | ||||
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 | Systolic Blood Pressure Code Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8480-6 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | SΣC | 0..1 | Quantity | Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | SΣ | 1..1 | string | Unit representation | ||||
system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] | ||||
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 | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
component:diastolic | SΣC | 1..1 | BackboneElement | Diastolic Blood Pressure vs-3: If there is no a value a data absent reason must be present | ||||
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 | Diastolic Blood Pressure Code Binding: US Core Vital Signs ValueSet (extensible): The vital sign codes from the base FHIR and US Core Vital Signs. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 8462-4 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | SΣC | 0..1 | Quantity | Vital Sign Component Value Binding: VitalSignsUnits (extensible): Common UCUM units for recording Vital Signs. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | SΣ | 1..1 | string | Unit representation | ||||
system | SΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: mm[Hg] | ||||
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 | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.identifier:TOid.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.identifier:TOid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type 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 from the FHIR Standard | ||||
Observation.category:VSCat | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | extensible | Pattern: LOINC Code 85354-9http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | ||||
Observation.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | extensible | UsCoreVitalSignshttp://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | ||||
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 from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.component:systolic.code | extensible | Pattern: LOINC Code 8480-6http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | ||||
Observation.component:systolic.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1 from the FHIR Standard | ||||
Observation.component:systolic.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Observation.component:systolic.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component:systolic.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.component:diastolic.code | extensible | Pattern: LOINC Code 8462-4http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs | ||||
Observation.component:diastolic.value[x] | extensible | VitalSignsUnitshttp://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1 from the FHIR Standard | ||||
Observation.component:diastolic.value[x].comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Observation.component:diastolic.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component:diastolic.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
TOid-startswithoid | error | Observation.identifier:TOid.system | ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr} : value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.') |
This structure is derived from USCoreBloodPressureProfile
Summary
Mandatory: 4 elements
Must-Support: 3 elements
Prohibited: 15 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron