AU Core Implementation Guide
0.2.1-preview - Preview Australia flag

This page is part of the Australian Core IG (v0.2.1-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core System Device

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-device-system Version: 0.2.1-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.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for basic information for a system device by name or identifier
  • Recording or updating basic information for a system device

Comparison with other national and international specifications

No equivalent International Patient Access, International Patient Summary, or US Core profile.

Profile specific implementation guidance

  • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.

Usage:

Formal Views of Profile Content

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

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceItem used in healthcare
... Slices for identifier S1..*IdentifierInstance identifier
Slice: Unordered, Open by pattern:type
.... identifier:paid S0..1AUPAIDIdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
... deviceName S0..*BackboneElementThe name of the device as given by the manufacturer
.... name S1..1stringThe name of the device
.... type S1..1codeudi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
... type S0..1CodeableConceptThe kind or type of device
Binding: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Device.typeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceItem used in healthcare
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*IdentifierInstance identifier
Slice: Unordered, Open by pattern:type
.... identifier:paid SC0..1AUPAIDIdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
... deviceName S0..*BackboneElementThe name of the device as given by the manufacturer
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name S1..1stringThe name of the device
.... type S1..1codeudi-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 S0..1CodeableConceptThe kind or type of device
Binding: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (extensible)
... owner S1..1Reference(AU Core Organization)Organization responsible for device

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Device.statusrequiredFHIRDeviceStatus
Device.deviceName.typerequiredDeviceNameType
Device.typeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceItem used in healthcare
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*IdentifierInstance identifier
Slice: Unordered, Open by pattern:type
.... identifier:paid SC0..1AUPAIDIdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
... definition 0..1Reference(DeviceDefinition)The reference to the definition for the device
... udiCarrier Σ0..*BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... deviceIdentifier Σ0..1stringMandatory fixed portion of UDI
.... issuer 0..1uriUDI Issuing Organization
.... jurisdiction 0..1uriRegional UDI authority
.... carrierAIDC Σ0..1base64BinaryUDI Machine Readable Barcode String
.... carrierHRF Σ0..1stringUDI Human Readable Barcode String
.... entryType 0..1codebarcode | rfid | manual +
Binding: UDIEntryType (required): Codes to identify how UDI data was entered.

... status ?!Σ0..1codeactive | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.

... statusReason 0..*CodeableConceptonline | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.


... distinctIdentifier 0..1stringThe distinct identification string
... manufacturer 0..1stringName of device manufacturer
... manufactureDate 0..1dateTimeDate when the device was made
... expirationDate 0..1dateTimeDate and time of expiry of this device (if applicable)
... lotNumber 0..1stringLot number of manufacture
... serialNumber 0..1stringSerial number assigned by the manufacturer
... deviceName S0..*BackboneElementThe name of the device as given by the manufacturer
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name S1..1stringThe name of the device
.... type S1..1codeudi-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..1stringThe model number for the device
... partNumber 0..1stringThe part number of the device
... type S0..1CodeableConceptThe kind or type of device
Binding: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (extensible)
... specialization 0..*BackboneElementThe capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... systemType 1..1CodeableConceptThe standard that is used to operate and communicate
.... version 0..1stringThe version of the standard that is used to operate and communicate
... version 0..*BackboneElementThe actual design of the device or software version running on the device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptThe type of the device version
.... component 0..1IdentifierA single component of the device version
.... value 1..1stringThe version text
... property 0..*BackboneElementThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptCode that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuantity 0..*QuantityProperty value as a quantity
.... valueCode 0..*CodeableConceptProperty value as a code, e.g., NTP4 (synced to NTP)
... patient 0..1Reference(Patient)Patient to whom Device is affixed
... owner S1..1Reference(AU Core Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... location 0..1Reference(Location)Where the device is found
... url 0..1uriNetwork address to contact device
... note 0..*AnnotationDevice notes and comments
... safety Σ0..*CodeableConceptSafety Characteristics of Device
... parent 0..1Reference(Device)The parent device

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Device.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Device.udiCarrier.entryTyperequiredUDIEntryType
Device.statusrequiredFHIRDeviceStatus
Device.statusReasonextensibleFHIRDeviceStatusReason
Device.deviceName.typerequiredDeviceNameType
Device.typeextensiblehttps://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:

  • The element Device.identifier is sliced based on the value of pattern:type

Maturity: 0

Differential View

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceItem used in healthcare
... Slices for identifier S1..*IdentifierInstance identifier
Slice: Unordered, Open by pattern:type
.... identifier:paid S0..1AUPAIDIdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
... deviceName S0..*BackboneElementThe name of the device as given by the manufacturer
.... name S1..1stringThe name of the device
.... type S1..1codeudi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
... type S0..1CodeableConceptThe kind or type of device
Binding: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Device.typeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceItem used in healthcare
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*IdentifierInstance identifier
Slice: Unordered, Open by pattern:type
.... identifier:paid SC0..1AUPAIDIdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
... deviceName S0..*BackboneElementThe name of the device as given by the manufacturer
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name S1..1stringThe name of the device
.... type S1..1codeudi-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 S0..1CodeableConceptThe kind or type of device
Binding: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (extensible)
... owner S1..1Reference(AU Core Organization)Organization responsible for device

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Device.statusrequiredFHIRDeviceStatus
Device.deviceName.typerequiredDeviceNameType
Device.typeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceItem used in healthcare
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..*IdentifierInstance identifier
Slice: Unordered, Open by pattern:type
.... identifier:paid SC0..1AUPAIDIdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
... definition 0..1Reference(DeviceDefinition)The reference to the definition for the device
... udiCarrier Σ0..*BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... deviceIdentifier Σ0..1stringMandatory fixed portion of UDI
.... issuer 0..1uriUDI Issuing Organization
.... jurisdiction 0..1uriRegional UDI authority
.... carrierAIDC Σ0..1base64BinaryUDI Machine Readable Barcode String
.... carrierHRF Σ0..1stringUDI Human Readable Barcode String
.... entryType 0..1codebarcode | rfid | manual +
Binding: UDIEntryType (required): Codes to identify how UDI data was entered.

... status ?!Σ0..1codeactive | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status of the device.

... statusReason 0..*CodeableConceptonline | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.


... distinctIdentifier 0..1stringThe distinct identification string
... manufacturer 0..1stringName of device manufacturer
... manufactureDate 0..1dateTimeDate when the device was made
... expirationDate 0..1dateTimeDate and time of expiry of this device (if applicable)
... lotNumber 0..1stringLot number of manufacture
... serialNumber 0..1stringSerial number assigned by the manufacturer
... deviceName S0..*BackboneElementThe name of the device as given by the manufacturer
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name S1..1stringThe name of the device
.... type S1..1codeudi-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..1stringThe model number for the device
... partNumber 0..1stringThe part number of the device
... type S0..1CodeableConceptThe kind or type of device
Binding: https://healthterminologies.gov.au/fhir/ValueSet/information-system-device-type-1 (extensible)
... specialization 0..*BackboneElementThe capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... systemType 1..1CodeableConceptThe standard that is used to operate and communicate
.... version 0..1stringThe version of the standard that is used to operate and communicate
... version 0..*BackboneElementThe actual design of the device or software version running on the device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptThe type of the device version
.... component 0..1IdentifierA single component of the device version
.... value 1..1stringThe version text
... property 0..*BackboneElementThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptCode that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuantity 0..*QuantityProperty value as a quantity
.... valueCode 0..*CodeableConceptProperty value as a code, e.g., NTP4 (synced to NTP)
... patient 0..1Reference(Patient)Patient to whom Device is affixed
... owner S1..1Reference(AU Core Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... location 0..1Reference(Location)Where the device is found
... url 0..1uriNetwork address to contact device
... note 0..*AnnotationDevice notes and comments
... safety Σ0..*CodeableConceptSafety Characteristics of Device
... parent 0..1Reference(Device)The parent device

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Device.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Device.udiCarrier.entryTyperequiredUDIEntryType
Device.statusrequiredFHIRDeviceStatus
Device.statusReasonextensibleFHIRDeviceStatusReason
Device.deviceName.typerequiredDeviceNameType
Device.typeextensiblehttps://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:

  • The element Device.identifier is sliced based on the value of pattern:type

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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.

Mandatory Search Parameters

No mandatory search parameters for this profile.

Optional Search Parameters

The following search parameters and search parameter combinations SHOULD be supported:

  1. SHOULD support fetching a Device using the _id search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/Device/[id] or GET [base]/Device?_id=[id]

    Example:

    1. GET [base]/Device/2169591
    2. GET [base]/Device?_id=2169591

    Implementation Notes: Fetches a single Device. (how to search by the logical id of the resource)

  2. SHOULD support searching for a device by an identifier using the identifier search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/Device?identifier={system|}[code]

    Example:

    1. GET [base]/Device?identifier=http://ns.electronichealth.net.au/id/pcehr/paid/1.0|8003640003000026
    2. GET [base]/Device?identifier=http://ns.electronichealth.net.au/id/pcehr/paid/1.0|8003640003000026&_revinclude=Provenance:target

    Implementation Notes: Fetches a bundle containing any Device resources matching the identifier (how to search by token)