This page is part of the Personal Health Device FHIR IG (v0.1.0: STU 1 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Phd Numeric Observation Profile

The Numeric Observation Profile is used when the PHD metric measurement contains one of the following attributes:

Attribute Value Additional Information
Basic-Nu-Observed-Value 16-bit Mder SFLOAT 12-bit mantissa
Simple-Nu-Observed-Value 32-bit Mder FLOAT 24-bit mantissa
Nu-Observed-Value 32-bit Mder FLOAT Complex attribute. Also contains
metric-id
measurement status
unit-code

These attributes contain a measurement value that is a single number. The Mder SFLOAT and FLOAT encodings indicate both precision and the number of significant figures. The Observation.valueQuantity.value element is required to honor the reported precision. See the section Mder FLOATs and SFLOATs for instructions on handling Mder S/FLOATs and their encoding to the valueQuantity .

The structure definition for this profile is as follows:

NameFlagsCard.Type
profile1..
phdProfile1..1Fixed Value
identifier
value1..
11073Type
value1..
unit
system1..Fixed Value
code1..
system1..
code1..
coding1..
system1..Fixed Value
code1..Fixed Value
display
value1..
unit
system1..Fixed Value
code1..
dataAbsentReason..0
system1..Fixed Value
code1..
system1..Fixed Value
code1..
dataAbsentReason..0
coding1..
system1..Fixed Value
code1..Fixed Value
display
value1..
unit
system1..Fixed Value
code1..
value1..
unit
system1..Fixed Value
code1..
dataAbsentReason..0
coding1..
system1..Fixed Value
code1..Fixed Value
display
value1..
dataAbsentReason..0
coding1..
system1..Fixed Value
code1..Fixed Value
display
value1..
unit
system1..Fixed Value
code1..
value1..
unit
system1..Fixed Value
code1..
dataAbsentReason..0
coding1..
system1..Fixed Value
code1..Fixed Value
display
value1..
dataAbsentReason..0

Mapping Numerics to FHIR

The following table shows how the numeric attributes are mapped to FHIR. Since the FHIR Quantity also contains the units the Unit-Code attribute value is required to complete the picture.

Attribute FHIR coding
Basic-Nu-Observed-Value.value
Unit-Code.code
Observation.valueQuantity.value
Observation.valueQuantity.code
Simple-Nu-Observed-Value.value
Unit-Code.code
Observation.valueQuantity.value
Observation.valueQuantity.code
Nu-Observed-Value.value
Nu-Observed-Value.unit
Nu-Observed-Value.metric-id
Nu-Observed-Value.status
Observation.valueQuantity.value
Observation.valueQuantity.code
effects Observation.code see Obtaining the Observation.code
handle measurement status see Phd Base Observation Profile

Conditional Create Identifier Generation

For a general description of the PHD Profile Identifier see the "PHD Profile Identifier" section in Phd Base Profile. The table below lists the items that make up the identifier.

Entry value Additional information
device "PhdParentDeviceComponent.identifier.value" This value is the PHD IEEE EUI-64 system identifier
patient "Patient.identifier.value-Patient.identifier.system" or
provided logical id
The dashes are part of the identifier.
When the service provider gives the PHG a pre-determined patient logical id the PHG creates no Patient resource and has no patient information. In that special case the provided logical id is used
type "Observation.code.coding.code" See Obtaining the Observation.code
value "Observation.valueQuantity.value" or
"Observation.dataAbsentReason.coding.code
The numerical value of the measurement or
the data absent reason if the value is not present
units "Observation.valueQuantity.code" The 32-bit MDC code for the units
reported PHD timestamp "timestamp" See Generating the PHD Reported Time Stamp
supplemental types "Supplemental-Types.N-" A sequence of 32-bit MDC codes separated by a dash

The final identifier is made by concatenating the entries above as follows:

  • "device-patient-type-value-units-reported PHD timestamp-supplemental types"

Additional Numerical Measurement Information

11073 20601 numeric metric measurements have some additional optional attributes that are used only for numerics. When they occur, these additional attributes provide further information about the measurement. An example of such a numeric-only additional attribute is one that describes the accuracy of the measurement. The accuracy is a measure of the deviation of the actual measurement from the reported measurement. Consequently, 'accuracy' is not a concept that makes any sense in the context of a measurement which is one or more of a finite set of enumerated codes such as a glucose-monitor meal assoication (breakfast, snack, fasting, etc.), and thus the attribute is not used in Enumration metrics.

As in the PhdBaseObservation profile, an Observation.component element is used to contain the additional information. There are five metric attributes that give extra information about numeric-only measurements.

Accuracy

The Accuracy attribute gives the maximum deviation as an absolute value of the reported measurement from the actual measurement over the entire range of the measurement. The reported accuracy is, thus, static and does not vary over the range of the measurement. It shall be reported if the PHD provides it and it is not corrupted. It is in the units of the measurement itself. The entries are as populated as follows:

Observation.component element entry Additional Information
.code.coding.code 67914 This is the MDC code for the Accuracy attribute
.code.coding.system urn:iso:std:iso:11073:10101 Indicates the MDC coding system
.code.coding.display optional but Should contain the reference id MDC_ATTR_NU_ACCUR_MSMT along with any other additional text
.valueQuantity.value the value This is accuracy value
.valueQuantity.unit optional but Should contain the UCUM string and shall match the UCUM string of the primary measurement
.valueQuantity.system urn:iso:std:iso:11073:10101 Indicates the MDC coding system
.valueQuantity.code shall be the code of the primary measurement The code shall be the MDC unit code

Alert Operational State

The Alert Operational State is currently only used in the Pluse Oximeter specialization. This attribute uses an ASN1-BITs field to indicate whether the alerts on a given limit (upper or lower) are on or off. When SET, the alerts are off. This is a state-type measurement and when this attribute is present, both the set and cleared states are reported. Three bits are defined thus there will be three component entries for each of the bits.

Observation.component element entry Additional Information
.code.coding.code 68746.n 68746 is the MDC code for the Alert Operational State. 'n' is 0, 1, or 2 depending upon which bit is being reported.
.code.coding.system http://hl7.org/fhir/IEEE.ASN1 Indicates the ASN-1 coding system
.code.coding.display optional but Should contain the ASN1 name 'lim-alert-off', 'lim-low-off', or 'lim-high-off' for bits 0-2, respectively, along with any other additional text
.valueCodeableConcept.coding.code 'Y' or 'N' 'Y' for bit set, 'N' for bit cleared
.valueCodeableConcept.coding.system http://hl7.org/fhir/v2/0136 Indicates the V2 binary coding system

Alert Operational Text String

This attributes provides a human readable string describing the lower and upper threshold limits. It is currently used only in the Pulse Oximeter specialization.

Observation.component element entry Additional Information
.code.coding.code 68104 This is the MDC code for the Alert-Operational-Text_string attribute
.code.coding.system urn:iso:std:iso:11073:10101 Indicates the MDC coding system
.code.coding.display optional but Should contain the reference id MDC_ATTR_AL_OP_TEXT_STRING along with any other additional text
.valueString the strings These are the lower and upper limit strings

Current Limits

The Current-Limits attribute is currently only used in the Pluse Oximeter specialization. It gives the lower and upper threshold limits of whatever measurement is being monitored.

Observation.component element entry Additional Information
.code.coding.code 67892 This is the MDC code for the Current-Limits attribute
.code.coding.system urn:iso:std:iso:11073:10101 Indicates the MDC coding system
.code.coding.display optional but Should contain the reference id MDC_ATTR_LIMIT_CURR along with any other additional text
.valueRange.low.value the value This is the lower limit
.valueRange.low.unit optional but Should contain the UCUM string and shall match the UCUM string of the primary measurement
.valueRange.low.system urn:iso:std:iso:11073:10101 Indicates the MDC coding system
.valueRange.low.code shall be the code of the primary measurement The code shall be the MDC unit code
.valueRange.high.value the value This is the upper limit
.valueRange.high.unit optional but Should contain the UCUM string and shall match the UCUM string of the primary measurement
.valueRange.high.system urn:iso:std:iso:11073:10101 Indicates the MDC coding system
.valueRange.high.code shall be the code of the primary measurement The code shall be the MDC unit code

Measurement Confidence 95

The Measurement-Confidence-95 attribute is currently used only in the Continuous Glucose specialization. The attribute gives a lower and upper bound with which the manufacturer is 95%confident that the actual reported measurement is within that bounds.

Observation.component element entry Additional Information
.code.coding.code 526998 This is the MDC code for the Measurement-Confidence-95 attribute
.code.coding.system urn:iso:std:iso:11073:10101 Indicates the MDC coding system
.code.coding.display optional but Should contain the reference id MDC_ATTR_MSMT_CONFIDENCE_95 along with any other additional text
.valueRange.low.value the value This is the lower limit
.valueRange.low.unit optional but Should contain the UCUM string and shall match the UCUM string of the primary measurement
.valueRange.low.system urn:iso:std:iso:11073:10101 Indicates the MDC coding system
.valueRange.low.code shall be the code of the primary measurement The code shall be the MDC unit code
.valueRange.high.value the value This is the upper limit
.valueRange.high.unit optional but Should contain the UCUM string and shall match the UCUM string of the primary measurement
.valueRange.high.system urn:iso:std:iso:11073:10101 Indicates the MDC coding system
.valueRange.high.code shall be the code of the primary measurement The code shall be the MDC unit code

Threshold Notification Text String

The Threshold-Notification-Text-String attribute is currently used only in the Continuous Glucose specialization. It provides a human readable string describing the thresholds. There are separate measurement objects that actually give the thresholds.

Observation.component element entry Additional Information
.code.coding.code 68232 This is the MDC code for the Alert-Operational-Text_string attribute
.code.coding.system urn:iso:std:iso:11073:10101 Indicates the MDC coding system
.code.coding.display optional but Should contain the reference id MDC_ATTR_THRES_NOTIF_TEXT_STRING along with any other additional text
.valueString the string This is a texual description of the thresholds for the given measurement

Consumer of the Phd Numeric Observation Profile

The consumer of this profile does not need to concern itself with the mapping complexities or the phd-related entry for the Observation.identifier which is used by the uploader to prevent data duplication. There are no extensions introduced by this profile so the resource is consumable by any reader that understands the Observation resource. The following table summarizes the elements used describing the measurement:

Measurement item element Additional Information
measurement type Observation.code.coding.code The first coding element is always MDC
The second coding element is LOINC if a vital sign
measurement value Observation.valueQuantity.value Value has precision of original measurement
measurement units Observation.valueQuantity.code Uses MDC coding system. Observation.valueQuantity.unit contains UCUM string if known
error Observation.dataAbsentReason Contains error code. If present no Observation.valueQuantity is present
time stamp Observation.dateTimeEffective

Observation.period
If the measurement is a point in time.

If the measurement has a duration.
coincident time stamp Observation.related.target.reference Points to Observation following the Coincident Time Stamp Observation profile. For time quality auditing purposes. Not present if the sensor provides NO time stamp
related measurement Observation.related.target.reference Points to a PHD Observation that is related to this Observation such as a cardio session. Will NOT be a coincident time stamp observation
additional descriptions Observation.component If a component element exists it contains additional information about the measurement
patient Observation.subject Points to the Patient resource
sensor device Observation.device Points to the DeviceComponent resource

Phd Numeric Observation JSON Example

The following JSON example is a pulse rate measurment from a Blood Pressure Cuff.

{
    "resourceType":"Observation",
    "meta":{
        "profile": [
            "http://pchalliance.org/phdfhir/StructureDefinition/PhdNumericObservation"
        ]
    },
    "identifier": [
        {
            "value":"sisansarahId-urn:oid:1.2.3.4.5.6.7.8.10-01040302f0000000-149546-20171212091343-48-264864"
        }
    ],
    "status":"final",
    "category": [
        {
            "coding": [
                {
                    "system":"http://hl7.org/fhir/observation-category",
                    "code":"vital-signs",
                    "display":"Vital Signs"
                }
            ]
        }
    ],
    "code":{
        "coding": [
            {
                "system":"urn:iso:std:iso:11073:10101",
                "code":"149546",
                "display":"MDC_PULS_RATE_NON_INV"
            },
            {
                "system":"http://loinc.org",
                "code":"8867-4",
                "display":"Blood Pressure cuff heart rate"
            }
        ]
    },
    "subject":{
        "reference":"Patient/PatientId-sisansarahId"
    },
    "effectiveDateTime":"2017-12-12T09:13:43-05:00",
    "performer": [
        {
            "reference":"Patient/PatientId-sisansarahId"
        }
    ],
    "valueQuantity":{
        "value":"48",
        "unit":"{beat}/min",
        "system":"urn:iso:std:iso:11073:10101",
        "code":"264864"
    },
    "device":{
        "reference":"DeviceComponent/SysId-01040302f0000000"
    },
    "related": [
        {
            "id":"coincidentTimeStampRelated",
            // The presence of this Coincident Time Stamp Observation
            // reference indicates that the PHD provided the time
            // stamp and the time is not the time of reception by the PHG.

            "type":"qualified-by",
            "target":{
                "reference":"urn:oid:3.14159.20171212091339"
                // The reason for this funny logical id is that this
                // resource is extracted from a Bundle upload where the Coincident Time Stamp
                // Observation is present. A temporary id is used and when the server receives
                // the Bundle, the server creates a logical id for the Coincident Time Stamp
                // Observation and changes all the temporary ids accordingly. When this resource
                // is saved on the server, the above temporary id will be the server-assigned
                // logical id of the Coincident Time Stamp Observation 
            }
        }
    ]
}