MyHealtheVet use of PGHD
0.2.10-beta - ci-build
MyHealtheVet use of PGHD - Local Development build (v0.2.10-beta) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://johnmoehrke.github.io/MHV-PGHD/StructureDefinition/VA.MHV.bloodOxygenSat | Version: 0.2.10-beta | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: MHVbloodOxygenSat |
A profile on the Observation that declares how MHV will Read/Create in PGHD for blood Oxygen Saturation measurements (aka Pulse Ox).
This profile is consistent with FHIR core Vital-Signs for Oxygen Saturation
The MyHealtheVet Oxygen Saturation - aka Pulse OX
Epic MyHealtheVet will support Oxygen Saturation measurements in the PGHD (FHIR) repository
Given that Oxygen Saturation measurements may be automatically recorded by Internet connected Oxygen Saturation measurement devices that are Veteran authorized
When the Veteran needs to confirm that the measurements taken are available in PGHD
Then the MyHealtheVet will provide a user interface that displays the current measurements,
And these current measurements shall be sorted by date/time
And these current measurements shall be paged in pages of N size
will have a User Interface similar to
Where:
GET [base]/Observation?subject=[patient]&code=59408-5[&_count=1000][&date=...]
_count
to limit the count to the size of the output desireddate
to limit the boundary of time of the output desiredGiven that there are measurement shown in table form
When the user requests to see a graphic view
Then MyHealtheVet will show the data time-plotted
And normal range of 90%-99% indicated for visual relationship
Given that the Oxygen Saturation measurements will often be automatically entered upon use of a Oxygen Saturation device
When the device is used by someone other than the Veteran a spurious measurement will be recorded into PGHD
And the Veteran desires to not have that incorrect/inaccurate value associated with their medical measurements in PGHD
Then MyHealtheVet will provide a way for the user to select an entry from the list of measurements displayed
And MyHealtheVet will use the PGHD DELETE verb to indicate to PGHD that the entry should be marked as deleted
Note, that PGHD does not fully delete entries that are marked as deleted, but does make them unavailable for normal queries so the result will be that the measurement will no longer be in the list in MyHealtheVet or Virtual Care Manager
Given that some Veterans will not have measurement devices that are capable of automatically recording, or unwilling to authorize the measurement device, or do not have technology sufficient to support automatical recording from an Oxygen Saturation measurement device
When the Veteran takes a measurement
And the Veteran desires to enter the measurement
Then the MyHealtheVet will provide a user interface that enables the manual entry of the Oxygen Saturation measurement
Note that the Veteran may have a pulse that is associated with the Oxygen Saturation entry. This may be optionally recorded as a related Heart Rate Observation. Similar to the Blood-Pressure use of a related Heart-Rate measurement.
Note, when a Heart Rate associated with a Oxygen Saturation Measurement is deleted or updated; the relationship between the Oxygen Saturation Measurement and that Heart Rate must be confirmed or eliminated.
Note that the Veteran may have a respiration rate that is associated with the Oxygen Saturation entry. This may be optionally recorded as a related Respiration Rate Observation. Similar to the Blood-Pressure use of a related Heart-Rate measurement.
Note, when a Respiration Rate associated with a Oxygen Saturation Measurement is deleted or updated; the relationship between the Oxygen Saturation Measurement and that Respiration Rate must be confirmed or eliminated.
Edit is not proposed as a User-Story as it presents too many concerns for revisions. The use-case need to change a measurement can be satisfied by deleting the current and adding a replacement with the proper values.
Because Blood Oxygen Saturation are recorded by various applications with either of two LOINC codes, MHV will query PGHD asking for Observations with either of the two codes. Because this is a logical “OR”, then results will also include Observations with both codes. MHV further requests inclusion of other Observations linked by a hasMember relationship, which would be related heart rate at the time the blood pressure was taken.
The following is a example, hitting the test PGHD service, about a test patient.
https://veteran.apps-staging.va.gov/smart-pgd-fhir/v2/Observation?patient.identifier=urn:uuid:2.16.840.1.113883.4.349|1012853550V207686&code=http://loinc.org|59408-5,http://loinc.org|2708-6&_include=Observation:has-member&_sort=-date&_count=100&_pretty=true&_format=json
Breakdown of query parameters
Results will be limited to 100 Blood Oxygen Saturation Observations, which might be larger than 100 as there would be associated heart rate observations.
The next page is retrieved using the FHIR paging mechanism.
The User Experience should NOT be aware of pages at the FHIR API level.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from observation-vitalsigns
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | observation-vitalsigns | FHIR Vital Signs Profile | |
meta | ||||
security | 0..0 | |||
tag | 1..1 | Coding | Tags applied to this resource Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://wiki.mobilehealth.va.gov/x/Onc1C | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2ce6d9aa-c068-4809-8dda-662bcb16d09a | |
implicitRules | 0..0 | |||
language | 0..0 | |||
contained | 0..0 | |||
extension | 0..0 | |||
modifierExtension | 0..0 | |||
basedOn | 0..0 | |||
partOf | 0..0 | |||
code | ||||
Slices for coding | 2..2 | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:$this | |
coding:ox1 | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
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: 59408-5 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood by Pulse oximetry | |
coding:ox2 | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
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: 2708-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood | |
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 | 0..0 | |||
value[x] | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. | |
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation Required Pattern: % | |
dataAbsentReason | 0..0 | |||
interpretation | 0..0 | |||
note | 0..1 | Annotation | Comments about the observation | |
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..0 | |||
device | 0..0 | |||
referenceRange | 0..0 | |||
hasMember | S | 0..2 | Reference(VA MHV HeartRate Observation | VA MHV Respiration Rate Observation) | Used when reporting vital signs panel components |
derivedFrom | 0..0 | |||
component | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | observation-vitalsigns | FHIR Vital Signs Profile |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:VSCat | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs |
code | SΣ | 1..1 | CodeableConcept | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible): This identifies the vital sign result type. |
Slices for coding | Σ | 2..2 | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:$this |
coding:ox1 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
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: 59408-5 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood by Pulse oximetry | |
coding:ox2 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
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: 2708-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood | |
subject | SΣ | 1..1 | Reference(Patient) | 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 |
effective[x]:effectiveDateTime | SΣC | 1..1 | dateTime | Often just a dateTime for Vital Signs |
value[x] | SΣC | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. |
value | Σ | 0..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 | Σ | 0..1 | string | Unit representation Required Pattern: % |
note | 0..1 | Annotation | Comments about the observation | |
hasMember | SΣ | 0..2 | Reference(VA MHV HeartRate Observation | VA MHV Respiration Rate Observation) | Used when reporting vital signs panel components |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.category:VSCat | preferred | ObservationCategoryCodes |
Observation.code | extensible | VitalSigns |
Observation.value[x].comparator | required | QuantityComparator |
Observation.component.code | extensible | VitalSigns |
Observation.component.value[x] | required | VitalSignsUnits |
Observation.component.dataAbsentReason | extensible | DataAbsentReason |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | observation-vitalsigns | FHIR Vital Signs Profile |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
tag | Σ | 1..1 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". Required Pattern: At least the following |
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: https://wiki.mobilehealth.va.gov/x/Onc1C | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2ce6d9aa-c068-4809-8dda-662bcb16d09a | |
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 | Narrative | Text summary of the resource, for human interpretation | |
identifier | Σ | 0..* | Identifier | Business Identifier for observation |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:VSCat | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
code | SΣ | 1..1 | CodeableConcept | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible): This identifies the vital sign result type. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for coding | Σ | 2..2 | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:$this |
coding:ox1 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
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: 59408-5 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood by Pulse oximetry | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
coding:ox2 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
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: 2708-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | Σ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(Patient) | 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 |
effective[x]:effectiveDateTime | SΣC | 1..1 | dateTime | Often just a dateTime for Vital Signs |
value[x] | SΣC | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. |
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 | Σ | 0..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 | Σ | 0..1 | string | Unit representation Required Pattern: % |
system | ΣC | 0..1 | uri | System that defines coded unit form |
code | Σ | 0..1 | code | Coded form of the unit |
note | 0..1 | Annotation | Comments about the observation | |
hasMember | SΣ | 0..2 | Reference(VA MHV HeartRate Observation | VA MHV Respiration Rate Observation) | Used when reporting vital signs panel components |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.meta.tag | example | Pattern: 2ce6d9aa-c068-4809-8dda-662bcb16d09a |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.category:VSCat | preferred | ObservationCategoryCodes |
Observation.code | extensible | VitalSigns |
Observation.value[x].comparator | required | QuantityComparator |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
Observation.component.code | extensible | VitalSigns |
Observation.component.value[x] | required | VitalSignsUnits |
Observation.component.dataAbsentReason | extensible | DataAbsentReason |
Observation.component.interpretation | extensible | ObservationInterpretationCodes |
This structure is derived from observation-vitalsigns
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 1 element
Prohibited: 21 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Differential View
This structure is derived from observation-vitalsigns
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | observation-vitalsigns | FHIR Vital Signs Profile | |
meta | ||||
security | 0..0 | |||
tag | 1..1 | Coding | Tags applied to this resource Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://wiki.mobilehealth.va.gov/x/Onc1C | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2ce6d9aa-c068-4809-8dda-662bcb16d09a | |
implicitRules | 0..0 | |||
language | 0..0 | |||
contained | 0..0 | |||
extension | 0..0 | |||
modifierExtension | 0..0 | |||
basedOn | 0..0 | |||
partOf | 0..0 | |||
code | ||||
Slices for coding | 2..2 | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:$this | |
coding:ox1 | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
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: 59408-5 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood by Pulse oximetry | |
coding:ox2 | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
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: 2708-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood | |
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 | 0..0 | |||
value[x] | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. | |
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation Required Pattern: % | |
dataAbsentReason | 0..0 | |||
interpretation | 0..0 | |||
note | 0..1 | Annotation | Comments about the observation | |
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..0 | |||
device | 0..0 | |||
referenceRange | 0..0 | |||
hasMember | S | 0..2 | Reference(VA MHV HeartRate Observation | VA MHV Respiration Rate Observation) | Used when reporting vital signs panel components |
derivedFrom | 0..0 | |||
component | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | observation-vitalsigns | FHIR Vital Signs Profile |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:VSCat | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs |
code | SΣ | 1..1 | CodeableConcept | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible): This identifies the vital sign result type. |
Slices for coding | Σ | 2..2 | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:$this |
coding:ox1 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
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: 59408-5 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood by Pulse oximetry | |
coding:ox2 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
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: 2708-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood | |
subject | SΣ | 1..1 | Reference(Patient) | 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 |
effective[x]:effectiveDateTime | SΣC | 1..1 | dateTime | Often just a dateTime for Vital Signs |
value[x] | SΣC | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. |
value | Σ | 0..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 | Σ | 0..1 | string | Unit representation Required Pattern: % |
note | 0..1 | Annotation | Comments about the observation | |
hasMember | SΣ | 0..2 | Reference(VA MHV HeartRate Observation | VA MHV Respiration Rate Observation) | Used when reporting vital signs panel components |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.category:VSCat | preferred | ObservationCategoryCodes |
Observation.code | extensible | VitalSigns |
Observation.value[x].comparator | required | QuantityComparator |
Observation.component.code | extensible | VitalSigns |
Observation.component.value[x] | required | VitalSignsUnits |
Observation.component.dataAbsentReason | extensible | DataAbsentReason |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | observation-vitalsigns | FHIR Vital Signs Profile |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
tag | Σ | 1..1 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". Required Pattern: At least the following |
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: https://wiki.mobilehealth.va.gov/x/Onc1C | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 2ce6d9aa-c068-4809-8dda-662bcb16d09a | |
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 | Narrative | Text summary of the resource, for human interpretation | |
identifier | Σ | 0..* | Identifier | Business Identifier for observation |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by value:coding.code, value:coding.system Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
category:VSCat | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: vital-signs |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
code | SΣ | 1..1 | CodeableConcept | Coded Responses from C-CDA Vital Sign Results Binding: VitalSigns (extensible): This identifies the vital sign result type. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for coding | Σ | 2..2 | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:$this |
coding:ox1 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
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: 59408-5 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood by Pulse oximetry | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
coding:ox2 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
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: 2708-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Oxygen saturation in Arterial blood | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | Σ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(Patient) | 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 |
effective[x]:effectiveDateTime | SΣC | 1..1 | dateTime | Often just a dateTime for Vital Signs |
value[x] | SΣC | 0..1 | Quantity | Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept. |
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 | Σ | 0..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 | Σ | 0..1 | string | Unit representation Required Pattern: % |
system | ΣC | 0..1 | uri | System that defines coded unit form |
code | Σ | 0..1 | code | Coded form of the unit |
note | 0..1 | Annotation | Comments about the observation | |
hasMember | SΣ | 0..2 | Reference(VA MHV HeartRate Observation | VA MHV Respiration Rate Observation) | Used when reporting vital signs panel components |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.meta.tag | example | Pattern: 2ce6d9aa-c068-4809-8dda-662bcb16d09a |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.category:VSCat | preferred | ObservationCategoryCodes |
Observation.code | extensible | VitalSigns |
Observation.value[x].comparator | required | QuantityComparator |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
Observation.component.code | extensible | VitalSigns |
Observation.component.value[x] | required | VitalSignsUnits |
Observation.component.dataAbsentReason | extensible | DataAbsentReason |
Observation.component.interpretation | extensible | ObservationInterpretationCodes |
This structure is derived from observation-vitalsigns
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 1 element
Prohibited: 21 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron