My Health Record FHIR IG
1.2.0 - active

My Health Record FHIR IG - Local Development build (v1.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: ADHA System Device

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-device-system-1 | Version: 1.2.0
Active as of 2024-09-19 | Computable Name: ADHADeviceSystem
Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to define a representation of a device as a system in the role of an author or exchange target or source for exchange usage scenarios to support the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile identifies the additional constraints, extensions, and value sets that build on and extend Device that are supported.

The Device resource, profiled as a system device, is used within the context of a referencing resource.

This profile is designed to set a Device standard for:

- Recording or updating a system device referenced by another resource
- Reading system devices referenced by another resource

#### Profile specific guidance

None.

Usage:

- Refer to this Resource Profile: ADHA Core DocumentReference and ADHA Core Flag
- Examples for this Resource Profile: Device/medicare-rs-01 and Device/mhr-01

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Device

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Device |  | 0..* | Device | Item used in healthcare
Slices for identifier | S | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:type
identifier:paid | S | 0..1 | AUPAIDIdentifier | My Health Record Assigned Identity - Device (PAI-D) Identifier
deviceName | S | 0..* | BackboneElement | The name of the device as given by the manufacturer
name | S | 1..1 | string | The name of the device
type | S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
type | S | 0..1 | CodeableConcept | The kind or type of device Binding: Information System Device Type (extensible)
owner | S C | 1..1 | Reference(ADHA Core Organization) | Organization responsible for device inv-dh-dev-01: At least reference, display, or a valid identifier shall be present
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Device.type | extensible | InformationSystemDeviceType `https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-dev-01 | error | Device.owner | At least reference, display, or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Device |  | 0..* | Device | Item used in healthcare
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:type
identifier:paid | S C | 0..1 | AUPAIDIdentifier | My Health Record Assigned Identity - Device (PAI-D) Identifier inv-paid-0: PAI-D shall be 16 digits inv-paid-1: PAI-D prefix shall be 800364 inv-paid-2: PAI-D shall pass the Luhn algorithm
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
deviceName | S | 0..* | BackboneElement | The name of the device as given by the manufacturer
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S | 1..1 | string | The name of the device
type | S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by.
type | S | 0..1 | CodeableConcept | The kind or type of device Binding: Information System Device Type (extensible)
owner | S C | 1..1 | Reference(ADHA Core Organization) | Organization responsible for device inv-dh-dev-01: At least reference, display, or a valid identifier shall be present
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Device.status | required | FHIRDeviceStatus `http://hl7.org/fhir/ValueSet/device-status|4.0.1` from the FHIR Standard
Device.deviceName.type | required | DeviceNameType `http://hl7.org/fhir/ValueSet/device-nametype|4.0.1` from the FHIR Standard
Device.type | extensible | InformationSystemDeviceType `https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-dev-01 | error | Device.owner | At least reference, display, or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Device |  | 0..* | Device | Item used in healthcare
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:type
identifier:paid | S C | 0..1 | AUPAIDIdentifier | My Health Record Assigned Identity - Device (PAI-D) Identifier inv-paid-0: PAI-D shall be 16 digits inv-paid-1: PAI-D prefix shall be 800364 inv-paid-2: PAI-D shall pass the Luhn algorithm
definition |  | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device
udiCarrier | Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
deviceIdentifier | Σ | 0..1 | string | Mandatory fixed portion of UDI
issuer |  | 0..1 | uri | UDI Issuing Organization
jurisdiction |  | 0..1 | uri | Regional UDI authority
carrierAIDC | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String
carrierHRF | Σ | 0..1 | string | UDI Human Readable Barcode String
entryType |  | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
statusReason |  | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.
distinctIdentifier |  | 0..1 | string | The distinct identification string
manufacturer |  | 0..1 | string | Name of device manufacturer
manufactureDate |  | 0..1 | dateTime | Date when the device was made
expirationDate |  | 0..1 | dateTime | Date and time of expiry of this device (if applicable)
lotNumber |  | 0..1 | string | Lot number of manufacture
serialNumber |  | 0..1 | string | Serial number assigned by the manufacturer
deviceName | S | 0..* | BackboneElement | The name of the device as given by the manufacturer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S | 1..1 | string | The name of the device
type | S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by.
modelNumber |  | 0..1 | string | The model number for the device
partNumber |  | 0..1 | string | The part number of the device
type | S | 0..1 | CodeableConcept | The kind or type of device Binding: Information System Device Type (extensible)
specialization |  | 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 |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
systemType |  | 1..1 | CodeableConcept | The standard that is used to operate and communicate
version |  | 0..1 | string | The version of the standard that is used to operate and communicate
version |  | 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 |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 0..1 | CodeableConcept | The type of the device version
component |  | 0..1 | Identifier | A single component of the device version
value |  | 1..1 | string | The version text
property |  | 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 |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
valueQuantity |  | 0..* | Quantity | Property value as a quantity
valueCode |  | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP)
patient |  | 0..1 | Reference(Patient) | Patient to whom Device is affixed
owner | S C | 1..1 | Reference(ADHA Core Organization) | Organization responsible for device inv-dh-dev-01: At least reference, display, or a valid identifier shall be present
contact |  | 0..* | ContactPoint | Details for human/organization for support
location |  | 0..1 | Reference(Location) | Where the device is found
url |  | 0..1 | uri | Network address to contact device
note |  | 0..* | Annotation | Device notes and comments
safety | Σ | 0..* | CodeableConcept | Safety Characteristics of Device
parent |  | 0..1 | Reference(Device) | The parent device
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Device.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Device.udiCarrier.entryType | required | UDIEntryType `http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1` from the FHIR Standard
Device.status | required | FHIRDeviceStatus `http://hl7.org/fhir/ValueSet/device-status|4.0.1` from the FHIR Standard
Device.statusReason | extensible | FHIRDeviceStatusReason `http://hl7.org/fhir/ValueSet/device-status-reason` from the FHIR Standard
Device.deviceName.type | required | DeviceNameType `http://hl7.org/fhir/ValueSet/device-nametype|4.0.1` from the FHIR Standard
Device.type | extensible | InformationSystemDeviceType `https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-dev-01 | error | Device.owner | At least reference, display, or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |

This structure is derived from Device

Summary

Mandatory: 2 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

- AU PAI-D Identifier (http://hl7.org.au/fhir/StructureDefinition/au-paididentifier)
- ADHA Core Organization (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-organization-core-1)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Device.identifier

Differential View

This structure is derived from Device

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Device |  | 0..* | Device | Item used in healthcare
Slices for identifier | S | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:type
identifier:paid | S | 0..1 | AUPAIDIdentifier | My Health Record Assigned Identity - Device (PAI-D) Identifier
deviceName | S | 0..* | BackboneElement | The name of the device as given by the manufacturer
name | S | 1..1 | string | The name of the device
type | S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
type | S | 0..1 | CodeableConcept | The kind or type of device Binding: Information System Device Type (extensible)
owner | S C | 1..1 | Reference(ADHA Core Organization) | Organization responsible for device inv-dh-dev-01: At least reference, display, or a valid identifier shall be present
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Device.type | extensible | InformationSystemDeviceType `https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-dev-01 | error | Device.owner | At least reference, display, or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Device |  | 0..* | Device | Item used in healthcare
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:type
identifier:paid | S C | 0..1 | AUPAIDIdentifier | My Health Record Assigned Identity - Device (PAI-D) Identifier inv-paid-0: PAI-D shall be 16 digits inv-paid-1: PAI-D prefix shall be 800364 inv-paid-2: PAI-D shall pass the Luhn algorithm
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
deviceName | S | 0..* | BackboneElement | The name of the device as given by the manufacturer
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S | 1..1 | string | The name of the device
type | S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by.
type | S | 0..1 | CodeableConcept | The kind or type of device Binding: Information System Device Type (extensible)
owner | S C | 1..1 | Reference(ADHA Core Organization) | Organization responsible for device inv-dh-dev-01: At least reference, display, or a valid identifier shall be present
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Device.status | required | FHIRDeviceStatus `http://hl7.org/fhir/ValueSet/device-status|4.0.1` from the FHIR Standard
Device.deviceName.type | required | DeviceNameType `http://hl7.org/fhir/ValueSet/device-nametype|4.0.1` from the FHIR Standard
Device.type | extensible | InformationSystemDeviceType `https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-dev-01 | error | Device.owner | At least reference, display, or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Device |  | 0..* | Device | Item used in healthcare
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S | 1..* | Identifier | Instance identifier Slice: Unordered, Open by pattern:type
identifier:paid | S C | 0..1 | AUPAIDIdentifier | My Health Record Assigned Identity - Device (PAI-D) Identifier inv-paid-0: PAI-D shall be 16 digits inv-paid-1: PAI-D prefix shall be 800364 inv-paid-2: PAI-D shall pass the Luhn algorithm
definition |  | 0..1 | Reference(DeviceDefinition) | The reference to the definition for the device
udiCarrier | Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
deviceIdentifier | Σ | 0..1 | string | Mandatory fixed portion of UDI
issuer |  | 0..1 | uri | UDI Issuing Organization
jurisdiction |  | 0..1 | uri | Regional UDI authority
carrierAIDC | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String
carrierHRF | Σ | 0..1 | string | UDI Human Readable Barcode String
entryType |  | 0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
statusReason |  | 0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.
distinctIdentifier |  | 0..1 | string | The distinct identification string
manufacturer |  | 0..1 | string | Name of device manufacturer
manufactureDate |  | 0..1 | dateTime | Date when the device was made
expirationDate |  | 0..1 | dateTime | Date and time of expiry of this device (if applicable)
lotNumber |  | 0..1 | string | Lot number of manufacture
serialNumber |  | 0..1 | string | Serial number assigned by the manufacturer
deviceName | S | 0..* | BackboneElement | The name of the device as given by the manufacturer
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S | 1..1 | string | The name of the device
type | S | 1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by.
modelNumber |  | 0..1 | string | The model number for the device
partNumber |  | 0..1 | string | The part number of the device
type | S | 0..1 | CodeableConcept | The kind or type of device Binding: Information System Device Type (extensible)
specialization |  | 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 |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
systemType |  | 1..1 | CodeableConcept | The standard that is used to operate and communicate
version |  | 0..1 | string | The version of the standard that is used to operate and communicate
version |  | 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 |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 0..1 | CodeableConcept | The type of the device version
component |  | 0..1 | Identifier | A single component of the device version
value |  | 1..1 | string | The version text
property |  | 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 |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
valueQuantity |  | 0..* | Quantity | Property value as a quantity
valueCode |  | 0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP)
patient |  | 0..1 | Reference(Patient) | Patient to whom Device is affixed
owner | S C | 1..1 | Reference(ADHA Core Organization) | Organization responsible for device inv-dh-dev-01: At least reference, display, or a valid identifier shall be present
contact |  | 0..* | ContactPoint | Details for human/organization for support
location |  | 0..1 | Reference(Location) | Where the device is found
url |  | 0..1 | uri | Network address to contact device
note |  | 0..* | Annotation | Device notes and comments
safety | Σ | 0..* | CodeableConcept | Safety Characteristics of Device
parent |  | 0..1 | Reference(Device) | The parent device
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Device.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Device.udiCarrier.entryType | required | UDIEntryType `http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1` from the FHIR Standard
Device.status | required | FHIRDeviceStatus `http://hl7.org/fhir/ValueSet/device-status|4.0.1` from the FHIR Standard
Device.statusReason | extensible | FHIRDeviceStatusReason `http://hl7.org/fhir/ValueSet/device-status-reason` from the FHIR Standard
Device.deviceName.type | required | DeviceNameType `http://hl7.org/fhir/ValueSet/device-nametype|4.0.1` from the FHIR Standard
Device.type | extensible | InformationSystemDeviceType `https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-dh-dev-01 | error | Device.owner | At least reference, display, or a valid identifier shall be present : reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists() |

This structure is derived from Device

Summary

Mandatory: 2 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

- AU PAI-D Identifier (http://hl7.org.au/fhir/StructureDefinition/au-paididentifier)
- ADHA Core Organization (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-organization-core-1)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Device.identifier

Other representations of profile: CSV, Excel, Schematron