Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-device-participant-1 | Version: 0.0.3 | |||
| Draft as of 2024-09-12 | Computable Name: ADHADeviceParticipant | |||
Copyright/Legal: Copyright © 2023 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 acting as an observer or performer 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.
In the context of an exchange of health information a participant device is part of the context established for a set of healthcare-related information or it forms part of a target or source for the exchange.
This profile identifies the additional constraints, extensions, and value sets that build on and extend Device that are supported.
The Device resource as profiled as a participant device is used within the context of a referencing resource.
This profile is designed to set a Device standard for:
None.
This profile is not referenced by another profile in this implementation guide.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Device |
C | 0..* | Device | Item used in healthcare inv-dh-dev-01: If present, an owner shall at least have a reference or display or a valid identifier inv-dh-dev-02: If present, a location shall at least have a reference or display or a valid identifier |
  identifier |
S | 0..* | Identifier | Instance identifier |
| manufacturer |
S | 1..1 | string | Name of device manufacturer |
| modelNumber |
S | 1..1 | string | The model number for the device |
| type |
S | 1..1 | CodeableConcept | The kind or type of device |
 owner |
SC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for device |
 location |
SC | 0..1 | Reference(ADHA Core Location) | Where the device is found |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-dev-01 | error | Device | If present, an owner shall at least have a reference or display or a valid identifier : owner.exists() implies owner.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
| inv-dh-dev-02 | error | Device | If present, a location shall at least have a reference or display or a valid identifier : location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Device |
C | 0..* | Device | Item used in healthcare inv-dh-dev-01: If present, an owner shall at least have a reference or display or a valid identifier inv-dh-dev-02: If present, a location shall at least have a reference or display or a valid identifier |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
S | 0..* | Identifier | Instance identifier |
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
| manufacturer |
S | 1..1 | string | Name of device manufacturer |
| modelNumber |
S | 1..1 | string | The model number for the device |
| type |
S | 1..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. |
| owner |
SC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for device |
| location |
SC | 0..1 | Reference(ADHA Core Location) | Where the device is found |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1from the FHIR Standard | |
| Device.type | example | DeviceTypehttp://hl7.org/fhir/ValueSet/device-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-dev-01 | error | Device | If present, an owner shall at least have a reference or display or a valid identifier : owner.exists() implies owner.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
| inv-dh-dev-02 | error | Device | If present, a location shall at least have a reference or display or a valid identifier : location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Device |
C | 0..* | Device | Item used in healthcare inv-dh-dev-01: If present, an owner shall at least have a reference or display or a valid identifier inv-dh-dev-02: If present, a location shall at least have a reference or display or a valid identifier | ||||
| 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.
| |||||
| 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 | ||||
| identifier |
S | 0..* | Identifier | Instance identifier | ||||
| 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 |
S | 1..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 |
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 |
1..1 | string | The name of the device | |||||
| type |
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 |
S | 1..1 | string | The model number for the device | ||||
| partNumber |
0..1 | string | The part number of the device | |||||
| type |
S | 1..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. | ||||
| 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 |
SC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for device | ||||
| contact |
0..* | ContactPoint | Details for human/organization for support | |||||
| location |
SC | 0..1 | Reference(ADHA Core 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Device.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Device.udiCarrier.entryType | required | UDIEntryTypehttp://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1from the FHIR Standard | ||||
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1from the FHIR Standard | ||||
| Device.statusReason | extensible | FHIRDeviceStatusReasonhttp://hl7.org/fhir/ValueSet/device-status-reasonfrom the FHIR Standard | ||||
| Device.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1from the FHIR Standard | ||||
| Device.type | example | DeviceTypehttp://hl7.org/fhir/ValueSet/device-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-dev-01 | error | Device | If present, an owner shall at least have a reference or display or a valid identifier : owner.exists() implies owner.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
| inv-dh-dev-02 | error | Device | If present, a location shall at least have a reference or display or a valid identifier : location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) |
This structure is derived from Device
Differential View
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Device |
C | 0..* | Device | Item used in healthcare inv-dh-dev-01: If present, an owner shall at least have a reference or display or a valid identifier inv-dh-dev-02: If present, a location shall at least have a reference or display or a valid identifier |
| identifier |
S | 0..* | Identifier | Instance identifier |
| manufacturer |
S | 1..1 | string | Name of device manufacturer |
| modelNumber |
S | 1..1 | string | The model number for the device |
| type |
S | 1..1 | CodeableConcept | The kind or type of device |
| owner |
SC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for device |
| location |
SC | 0..1 | Reference(ADHA Core Location) | Where the device is found |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-dev-01 | error | Device | If present, an owner shall at least have a reference or display or a valid identifier : owner.exists() implies owner.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
| inv-dh-dev-02 | error | Device | If present, a location shall at least have a reference or display or a valid identifier : location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Device |
C | 0..* | Device | Item used in healthcare inv-dh-dev-01: If present, an owner shall at least have a reference or display or a valid identifier inv-dh-dev-02: If present, a location shall at least have a reference or display or a valid identifier |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
S | 0..* | Identifier | Instance identifier |
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. |
| manufacturer |
S | 1..1 | string | Name of device manufacturer |
| modelNumber |
S | 1..1 | string | The model number for the device |
| type |
S | 1..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. |
| owner |
SC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for device |
| location |
SC | 0..1 | Reference(ADHA Core Location) | Where the device is found |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1from the FHIR Standard | |
| Device.type | example | DeviceTypehttp://hl7.org/fhir/ValueSet/device-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-dev-01 | error | Device | If present, an owner shall at least have a reference or display or a valid identifier : owner.exists() implies owner.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
| inv-dh-dev-02 | error | Device | If present, a location shall at least have a reference or display or a valid identifier : location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Device |
C | 0..* | Device | Item used in healthcare inv-dh-dev-01: If present, an owner shall at least have a reference or display or a valid identifier inv-dh-dev-02: If present, a location shall at least have a reference or display or a valid identifier | ||||
| 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.
| |||||
| 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 | ||||
| identifier |
S | 0..* | Identifier | Instance identifier | ||||
| 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 |
S | 1..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 |
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 |
1..1 | string | The name of the device | |||||
| type |
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 |
S | 1..1 | string | The model number for the device | ||||
| partNumber |
0..1 | string | The part number of the device | |||||
| type |
S | 1..1 | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. | ||||
| 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 |
SC | 0..1 | Reference(ADHA Core Organization) | Organization responsible for device | ||||
| contact |
0..* | ContactPoint | Details for human/organization for support | |||||
| location |
SC | 0..1 | Reference(ADHA Core 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Device.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Device.udiCarrier.entryType | required | UDIEntryTypehttp://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1from the FHIR Standard | ||||
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1from the FHIR Standard | ||||
| Device.statusReason | extensible | FHIRDeviceStatusReasonhttp://hl7.org/fhir/ValueSet/device-status-reasonfrom the FHIR Standard | ||||
| Device.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1from the FHIR Standard | ||||
| Device.type | example | DeviceTypehttp://hl7.org/fhir/ValueSet/device-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-dev-01 | error | Device | If present, an owner shall at least have a reference or display or a valid identifier : owner.exists() implies owner.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) | |
| inv-dh-dev-02 | error | Device | If present, a location shall at least have a reference or display or a valid identifier : location.exists() implies location.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()) |
This structure is derived from Device
Other representations of profile: CSV, Excel, Schematron
No mandatory or optional search parameters for ADHA Device Participant profile.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-09-12
Links: Table of Contents |
QA Report
| Version History
| Report an issue or propose a change
