Personal Health Device Implementation Guide
2.0.0-ballot2 - STU 2 - Ballot International flag

Personal Health Device Implementation Guide, published by HL7 International / Health Care Devices. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/phd/ and changes regularly. See the Directory of published versions

Artifact List

Page standards status: Informative

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

PhdFHIRServer

Capability statement. This statement indicates what the server must support and accept to work with this Guide. Though the CapabilityStatement indicates, for example, that the server must support the Device resource, it does not mean the server must save the Device resource. The use case may only be interested in the Observation and Patient resources. What it does mean is that the server cannot generate an error when the PHG uploads a Device resource or references a Device resource that it has uploaded.

Structures: Abstract Profiles

These are profiles on resources or data types that describe patterns used by other profiles, but cannot be instantiated directly. I.e. instances can conform to profiles based on these abstract profiles but do not declare conformance to the abstract profiles themselves.

PhdBaseObservation

Common base profile with the elements that are common to the PHD IG Observation profiles.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

PhdBitsEnumerationObservation

Observations from a PHD where the measurement is an ASN1 BITS value.

PhdCodedEnumerationObservation

Observations coming from a PHD where the measurement value is a code.

PhdCoincidentTimeStampObservation

Observations containing a coincident timestamp.

PhdCompoundNumericObservation

Observations coming from a PHD where the measurement is a set of numbers such as the x, y, and z components of an acceleration.

PhdCompoundObservation

Observations from a PHD where the measurement is a set of numbers such as the x, y, and z components of an acceleration.

PhdDevice

Profile for the Device Resource for a PHD

PhdDeviceMetric

Profile for the DeviceMetric for a PHD

PhdNumericObservation

Observations from a PHD where the measurement is number

PhdPatient

The patient information reported from personal health gateways (PHG)

PhdRtsaObservation

Observations from a PHD where the measurement is a sample array.

PhdStringObservation

Observations from a PHD where the measurement is a human readable string.

PhgDevice

Profile for the Device Resource for a PHG

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Coincident Timestamp Reference

Reference to a coincident timestamp observation that relates the gateway timeline to the PHD timeline.

Confidence 95 range

The Confidence 95 range of a measurable quantity.

Numeric Accuracy

The accuracy of a measurable quantity.

Simple Alerting

A simple alerting extension for PHDs.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

ANS1ToHL7 codes defined for Boolean Clock attributes

ValueSet for the ANS1ToHL7 codes that are not derived from enumeration measurements.

ANS1ToHL7 codes defined for non-measurement attributes

ValueSet for the ANS1ToHL7 codes that are not derived from enumeration measurements.

ANS1ToHL7 codes for measurement attributes

Value set for those Asn1ToHL7 codes whose source is a measurement attribute.

Continua PHD-PHG Device Interfaces ValueSet

ValueSet containing all codes from the ContinuaPHDInterfaceIDs CodeSystem, representing Continua Personal Area Network (PHD) interfaces supported by a Personal Health Gateway.

Continua PHG-HFS Interfaces ValueSet

ValueSet containing all codes from the ContinuaHFS CodeSystem, representing Continua Health and Fitness Server (HFS) interfaces supported by a PHG.

Device Type Specialization IEEE 11073-10101 Nomenclature Codes

ValueSet for the ISO/IEEE 11073-10101 Nomenclature Codes for Device Specialization types

IEEE 11073 MDC Object infrastructure and Device nomenclature

ValueSet for the ISO/IEEE 11073-10101 Nomenclature filtered by & Device nomenclature partition.

MDC Clock Resolution Types

ValueSet for the ISO/IEEE 11073-10101 Nomenclature Codes for Clock Resolution types

MDC Clock Types

ValueSet for the ISO/IEEE 11073-10101 Nomenclature Codes for Clock Types

MDC Device Identifier Types

ValueSet for the MDC Device Identifier Types

MDC Device Version Type codes

ValueSet for the MDC Device Version Type codes. ToDo: We still need to define a code for the ACOM version.

MDC Non-Object codes

ValueSet for the ISO/IEEE 11073-10101 Nomenclature excluding Object partition.

MDC Time Synchronization Methods

ValueSet for the MDC codes representing time synchronization methods such as NTP, GPS, and others.

MDC Value Set

ValueSet for the MDC CodeSystem.

Simple Alert Operational States Value Set

A ValueSet containing operational states for simple alerts.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

ASN1 bits to HL7 enumerated values

Codes for the IEEE 11073-10206 BITs measurement bit values. For example, 150604.0 is the code for Mder bit 0 in measurement type 150604 which is a pulse oximeter device and sensor status. The description of that code is 'Indicates the device is not connected with the sensor'. This code system will grow as more BITs measurements are defined in specializations

Continua Device Identifiers

Codes that identify the device 'identifier', such as whether an EUI is a system id, Bluetooth address, or Ethernet MAC address

Continua Device Interface Identifiers

Codes used to describe the PHD types and interfaces supported by a Personal Health Gateway. More codes maybe added to this list in the future.

Continua Health and Fitness Service Interfaces

Codes used to describe the Continua Health and Fitness interfaces supported by a Personal Health Gateway. More codes maybe added to this list in the future.

Missing MDC Codes

Codes that are missing from the MDC (Medical Device Communication) standard.

PHD Observation Categories Code System

Codes used for tagging observations coming from PHD devices. More codes maybe added to this list in the future.

SimpleAlertOperationalStates CodeSystem

The operational states for the simple alerting system.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

ACME Inc Private MDC Codes

An example CodeSystem that defines two private codes for an imaginary company in the MDC CodeSystem.

Example 1 of an RTSA

This example is an RTSA observation of a pleth signal from a pulse oximeter. This very short waveform maps to a valueSampledData element.

Example 2 of an RTSA

ECG waveform with scaling

Example Bundled upload

This example is an upload from a Bluetooth Low Energy Pulse oximeter device streaming data. In this case the gateway has previously uploaded measurements and saved the logical ids of the Patient and Device resources so they are not re-uploaded.

Example Phd Device Metric

This example is a PhdDeviceMetric for a Blood Pressure measurement.

Example of PHD Device

This example PHD Device resource is referenced by other examples and is present for the validator.

Example of String measurement 1

This example observation reports some arbitrary text from a cardiavascular fitness device.

Example of String measurement 2

This example observation reports some arbitrary text from a Glucose meter explaining the failure of the measurement.

Example of a ASN1 BITs measurement from a Pulse Oximeter

This example is a device and sensor status measurement from a pulse oximeter.

Example of a BPM status report

This example reports the status of a BPM measurement.

Example of a Blood Pressure PHD

This example maps the System Information data from a Blood Pressure PHD. This device did not report Reg-Cert-Data-List information.

Example of a Coincident Timestamp

This Coincident Timestamp observation is referenced by other Observation examples.

Example of a Coincident Timestamp PHG better synchronized

This example is a Coincident Timestamp where the PHG is better synchronized to NTP time than the PHD.

Example of a Coincident Timestamp referenced from BP observation

This Coincident Timestamp observation is referenced by the Blood Pressure Observation

Example of a Coincident Timestamp with a Time Fault

This example is a Coincident Timestamp where the PHD has a time fault; it's current timeline is unknown and it reported timestamps in its measurements.

Example of a Gateway

This example maps an Android Gateway

Example of a Gateway 2

This example maps an Android Gateway

Example of a Glucose Monitor PHD

This example maps an Glucose monitor PHD. It is referenced by a coded Glucose meal context observation

Example of a NaN case

This example contains a NaN (not a number) measurement.

Example of a compound numeric observation

This example is from a Blood Pressure cuff.

Example of a compound numeric observation with one component value absent

This example is from a Blood Pressure cuff.

Example of a compound observation

This artificial example combines a glucose measurement and context information.

Example of a first time Bundle upload

This example shows a full first time transaction Bundle containing Patient, Device, and Observation resources.

Example of a known Patient

This example maps a known patient where an optional patient name is included.

Example of a numeric body temperature observation.

This example is a simple numeric observation of a health thermometer.

Example of a numeric glucose observation.

This example is a simple numeric observation of a (continuous) glucose monitor.

Example of a numeric with an alert.

This example is a simple numeric observation from a pulse oximeter with an alert.

Example of a numeric.

This example is a simple numeric observation of a pulse rate from a pulse oximeter. This particular example also has a component as the original measurement has a Supplemental Information attribute indicating that this is a SPOT measurement (a stable average).

Example of an unknown Patient

This example maps an unknown patient.

Example of coded enumeration

This example contains measurement that is itself a code. The measurement comes from a Glucose meter and indicates that the glucose measurement was taken after lunch or dinner. It is also known as the meal context.