Personal Health Device Implementation Guide
2.1.0 - STU 2.0 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.1.0 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.

PhdServerCapabilityStatement

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

Observation elements that are common to all the PHD Observation profiles

Structures: Resource Profiles

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

PhdBitsEnumerationObservation

StructureDefinition for Observation Resources representing measurement data coming from a medical device where the measurement is an ASN1 BITS value.

PhdCodedEnumerationObservation

StructureDefinition for Observation Resources representing measurement data coming from a medical device where the measurement itself is an enumerated code.

PhdCoincidentTimeStampObservation

StructureDefinition for Observation Resources representing the coincident time stamp. This report is a measurement of the current time of the sensor at the current time of the PHG. The purpose of this observation is to record the difference in the time lines between the PHG and PHD and to be able to recover the original measurement time stamps reported by the PHD should the PHG correct them because the sensor clock is in error.

PhdCompoundNumericObservation

StructureDefinition for Observation Resources representing measurement data coming from a medical device where the measurement is described by a set of numbers such as the x, y, and x components of an acceleration.

PhdCompoundObservation

StructureDefinition for Observation Resources representing measurement data coming from a medical device where the measurement is described by a set of numbers such as the x, y, and x components of an acceleration.

PhdDevice

StructureDefinition for the Device Resource representing a PHD

PhdDeviceMetric

StructureDefinition for the Device Metric Resource representing an observation type that can be generated by a PHD

PhdNumericObservation

StructureDefinition for Observation Resources representing measurement data coming from a medical device where the measurement is number.

PhdPatient

Structure definition for the patient information reported from personal health gateways (PHG)

PhdRtsaObservation

StructureDefinition for Observation Resources representing measurement data coming from a medical device where the measurement is a waveform.

PhdStringEnumerationObservation

StructureDefinition for Observation Resources representing measurement data coming from a medical device where the measurement itself is an enumerated human readable string.

PhgDevice

StructureDefinition for the Device Resource representing a PHG (gateway)

Structures: Extension Definitions

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

Accuracy

Structure definition for the accuracy extension.

Coincident Timestamp Reference

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

Confidence95

Structure definition for the confidence 95 extension.

SimpleAlerting

Structure definition for the simple alerting extension.

Terminology: Value Sets

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

ASN1attribute

Value set for those Asn1ToHL7 codes whose PHD source is an attribute, such as the regulation status or time capabilities.

ASN1measurement

Value set for those Asn1ToHL7 codes whose source is a measurement attribute; one of the Enum-observed-value attributes.

CodeableConcept11073MDC

Value set for those MDC attribute codes whose values are represented by CodeableConcepts. These codes are used as slicing discriminators.

Device System Id Identifier

ValueSet for the Codes describing the type of device identifier, such as a system id or Bluetooth address.

Device Transport Address Identifiers

ValueSet for the Codes describing the type of device transport identifier, such the Bluetooth address.

Device Type Specialization IEEE 11073-10101 Nomenclature Codes

ValueSet for the ISO/IEEE 11073-10101 Nomenclatures Describing Device specialization types.

IEEE 11073 MDC Object infrastructure and Device nomenclature

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

MDCValueSet

Value set with all defined MDC codes.

MDCnotObject

Value set for those Observation component elements that come from compound and BITs measurements. These attributes come from several partitions but NOT the MDC Object partition. These codes are used as slicing discriminators to distinguish between those components that represent measurement values in the compound and ASN1 BITs profiles from those components providing additional information about the values. For example, the Supplemental Information would give an extra description about the measurement such as 'duration average' whereas the measurement itself might be acceleration values.

Quantity11073MDC

Value set for those MDC attribute codes whose values are represented by Quantities. These codes are used as slicing discriminators.

Range11073MDC

Value set for those MDC attribute codes whose values are represented by Ranges. These codes are used as slicing discriminators.

Simple Alert Operational States Value Set

ValueSet for the Simple Alert Operational States.

String11073MDC

Value set for those MDC attribute codes whose values are represented by Strings. These codes are used as slicing discriminators.

Terminology: Code Systems

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

ASN1ToHL7

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

ASN1ToHL7Concepts

Concept codes for the ASN1ToHL7 code system properties

ContinuaDeviceIdentifiers

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

ContinuaHFS

Codes for the Continua Health and Fitness interfaces

ContinuaPHD

Codes for the Continua certified PAN interfaces. These codes indicate that the respective platform has been certified for certain transports (Bluetooth, USB, Bluetooth Low Energy, ZigBee) and device specializations.

MDCConcepts

Concept codes for the MDC code system properties

PhdObservationCategories

Category value for observations generated by PHD devices.

SimpleAlertOperationalStates CodeSystem

Simple Alert Operational States Code 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.

ACMEIncPrivateMDCCodes

Example codesystem with Private MDC codes for ACME Inc as example.

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 MDS data from a Blood Pressure PHD. This device did not report Reg-Cert-Data-List information.

Example of a Coincident Time Stamp

This Coincident Time Stamp observation is referenced by other Observation examples.

Example of a Coincident Time Stamp PHG better synchronized

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

Example of a Coincident Time Stamp referenced from BP observation

This Coincident Time Stamp observation is referenced by the Blood Pressure Observation

Example of a Coincident Time Stamp with a Time Fault

This example is a Coincident Time stamp where the PHD has a time fault; it's current time line is unknown and it reported time stamps 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 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 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.