This page is part of the Application Data Exchange Assessment Framework and Functional Requirements for Mobile Health (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Defines constraints on the Device Resource for data communicating about the source of device data.
The official URL for this profile is:
http://hl7.org/fhir/uv/mhealth-framework/StructureDefinition/mhealth-ade-device
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Device
This structure is derived from Device
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Device | 0..* | Device | Item used in healthcare | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Device | I | 0..* | Device | Item used in healthcare |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | I | 0..* | Identifier | Instance identifier |
definition | I | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device |
udiCarrier | ΣI | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
deviceIdentifier | ΣI | 0..1 | string | Mandatory fixed portion of UDI |
issuer | I | 0..1 | uri | UDI Issuing Organization |
jurisdiction | I | 0..1 | uri | Regional UDI authority |
carrierAIDC | ΣI | 0..1 | base64Binary | UDI Machine Readable Barcode String |
carrierHRF | ΣI | 0..1 | string | UDI Human Readable Barcode String |
entryType | I | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required) |
status | ?!ΣI | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required) |
statusReason | I | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible) |
distinctIdentifier | I | 0..1 | string | The distinct identification string |
manufacturer | I | 0..1 | string | Name of device manufacturer |
manufactureDate | I | 0..1 | dateTime | Date when the device was made |
expirationDate | I | 0..1 | dateTime | Date and time of expiry of this device (if applicable) |
lotNumber | I | 0..1 | string | Lot number of manufacture |
serialNumber | I | 0..1 | string | Serial number assigned by the manufacturer |
deviceName | I | 0..* | BackboneElement | The name of the device as given by the manufacturer |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | I | 1..1 | string | The name of the device |
type | I | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required) |
modelNumber | I | 0..1 | string | The model number for the device |
partNumber | I | 0..1 | string | The part number of the device |
type | I | 0..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example) |
specialization | I | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
systemType | I | 1..1 | CodeableConcept | The standard that is used to operate and communicate |
version | I | 0..1 | string | The version of the standard that is used to operate and communicate |
version | I | 0..* | BackboneElement | The actual design of the device or software version running on the device |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 0..1 | CodeableConcept | The type of the device version |
component | I | 0..1 | Identifier | A single component of the device version |
value | I | 1..1 | string | The version text |
property | I | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) |
valueQuantity | I | 0..* | Quantity | Property value as a quantity |
valueCode | I | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) |
patient | I | 0..1 | Reference(Patient) | Patient to whom Device is affixed |
owner | I | 0..1 | Reference(Organization) | Organization responsible for device |
contact | I | 0..* | ContactPoint | Details for human/organization for support |
location | I | 0..1 | Reference(Location) | Where the device is found |
url | I | 0..1 | uri | Network address to contact device |
note | I | 0..* | Annotation | Device notes and comments |
safety | ΣI | 0..* | CodeableConcept | Safety Characteristics of Device |
parent | I | 0..1 | Reference(Device) | The parent device |
Documentation for this format |
This structure is derived from Device
Differential View
This structure is derived from Device
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Device | 0..* | Device | Item used in healthcare | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Device | I | 0..* | Device | Item used in healthcare |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | I | 0..* | Identifier | Instance identifier |
definition | I | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device |
udiCarrier | ΣI | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
deviceIdentifier | ΣI | 0..1 | string | Mandatory fixed portion of UDI |
issuer | I | 0..1 | uri | UDI Issuing Organization |
jurisdiction | I | 0..1 | uri | Regional UDI authority |
carrierAIDC | ΣI | 0..1 | base64Binary | UDI Machine Readable Barcode String |
carrierHRF | ΣI | 0..1 | string | UDI Human Readable Barcode String |
entryType | I | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required) |
status | ?!ΣI | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required) |
statusReason | I | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible) |
distinctIdentifier | I | 0..1 | string | The distinct identification string |
manufacturer | I | 0..1 | string | Name of device manufacturer |
manufactureDate | I | 0..1 | dateTime | Date when the device was made |
expirationDate | I | 0..1 | dateTime | Date and time of expiry of this device (if applicable) |
lotNumber | I | 0..1 | string | Lot number of manufacture |
serialNumber | I | 0..1 | string | Serial number assigned by the manufacturer |
deviceName | I | 0..* | BackboneElement | The name of the device as given by the manufacturer |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | I | 1..1 | string | The name of the device |
type | I | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required) |
modelNumber | I | 0..1 | string | The model number for the device |
partNumber | I | 0..1 | string | The part number of the device |
type | I | 0..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example) |
specialization | I | 0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
systemType | I | 1..1 | CodeableConcept | The standard that is used to operate and communicate |
version | I | 0..1 | string | The version of the standard that is used to operate and communicate |
version | I | 0..* | BackboneElement | The actual design of the device or software version running on the device |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 0..1 | CodeableConcept | The type of the device version |
component | I | 0..1 | Identifier | A single component of the device version |
value | I | 1..1 | string | The version text |
property | I | 0..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) |
valueQuantity | I | 0..* | Quantity | Property value as a quantity |
valueCode | I | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) |
patient | I | 0..1 | Reference(Patient) | Patient to whom Device is affixed |
owner | I | 0..1 | Reference(Organization) | Organization responsible for device |
contact | I | 0..* | ContactPoint | Details for human/organization for support |
location | I | 0..1 | Reference(Location) | Where the device is found |
url | I | 0..1 | uri | Network address to contact device |
note | I | 0..* | Annotation | Device notes and comments |
safety | ΣI | 0..* | CodeableConcept | Safety Characteristics of Device |
parent | I | 0..1 | Reference(Device) | The parent device |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
Device.language | preferred | CommonLanguages Max Binding: AllLanguages |
Device.udiCarrier.entryType | required | UDIEntryType |
Device.status | required | FHIRDeviceStatus |
Device.statusReason | extensible | FHIRDeviceStatusReason |
Device.deviceName.type | required | DeviceNameType |
Device.type | example | DeviceType |
Id | Path | Details | Requirements |