AU Core Implementation Guide
0.2.2-preview - Preview
AU Core Implementation Guide
0.2.2-preview - Preview
This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-device-system | Version: 0.2.2-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreDeviceSystem | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a Device resource to record, search, and fetch basic identifying and other administrative information about an information system device. It is based on the core Device resource and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Device when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
No equivalent International Patient Access, International Patient Summary, or US Core profile.
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 | 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: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (extensible) |
 owner | S | 1..1 | Reference(AU Core Organization) | Organization responsible for device |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.type | extensible | https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 |
| 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 | SC | 0..1 | AUPAIDIdentifier | My Health Record Assigned Identity - Device (PAI-D) Identifier |
| 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: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (extensible) |
| owner | S | 1..1 | Reference(AU Core Organization) | Organization responsible for device |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.status | required | FHIRDeviceStatus |
| Device.deviceName.type | required | DeviceNameType |
| Device.type | extensible | https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 |
| 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.
| |||||
| 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 | SC | 0..1 | AUPAIDIdentifier | My Health Record Assigned Identity - Device (PAI-D) 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 | 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: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (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 | 1..1 | Reference(AU Core Organization) | Organization responsible for device | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| Device.language | preferred | CommonLanguages
| ||||
| Device.udiCarrier.entryType | required | UDIEntryType | ||||
| Device.status | required | FHIRDeviceStatus | ||||
| Device.statusReason | extensible | FHIRDeviceStatusReason | ||||
| Device.deviceName.type | required | DeviceNameType | ||||
| Device.type | extensible | https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 |
This structure is derived from Device
Summary
Mandatory: 2 elements
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
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: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (extensible) |
| owner | S | 1..1 | Reference(AU Core Organization) | Organization responsible for device |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.type | extensible | https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 |
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 | SC | 0..1 | AUPAIDIdentifier | My Health Record Assigned Identity - Device (PAI-D) Identifier |
| 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: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (extensible) |
| owner | S | 1..1 | Reference(AU Core Organization) | Organization responsible for device |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.status | required | FHIRDeviceStatus |
| Device.deviceName.type | required | DeviceNameType |
| Device.type | extensible | https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 |
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.
| |||||
| 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 | SC | 0..1 | AUPAIDIdentifier | My Health Record Assigned Identity - Device (PAI-D) 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 | 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: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (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 | 1..1 | Reference(AU Core Organization) | Organization responsible for device | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| Device.language | preferred | CommonLanguages
| ||||
| Device.udiCarrier.entryType | required | UDIEntryType | ||||
| Device.status | required | FHIRDeviceStatus | ||||
| Device.statusReason | extensible | FHIRDeviceStatusReason | ||||
| Device.deviceName.type | required | DeviceNameType | ||||
| Device.type | extensible | https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 |
This structure is derived from Device
Summary
Mandatory: 2 elements
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| _id | SHOULD | token |
|
| identifier | SHOULD | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
| type | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
No mandatory search parameters for this profile.
The following search parameters and search parameter combinations SHOULD be supported:
_id search parameter:
_revinclude parameters: Provenance:targetGET [base]/Device/[id] or GET [base]/Device?_id=[id]
Example:
Implementation Notes: Fetches a single Device (how to search by the logical id of the resource)
identifier search parameter:
_revinclude parameters: Provenance:targetGET [base]/Device?identifier={system|}[code]
Example:
Implementation Notes: Fetches a bundle containing any Device resources matching the identifier (how to search by token)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.2.2-preview based on FHIR 4.0.1. Generated 2023-11-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change