Australian Base Implementation Guide (AU Base 1.1.1)

This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-device

AU Device [FMM Level 2]

This profile defines a device administration details structure that includes core localisation concepts for use in an Australian context.

Identifiers

These definitions represent common data held in the Device.identifier element:

  • My Health Record Assigned (formerly known as PCEHR) Identity for Devices - PAI-D [1]

Usage Notes

This device profile is a general profile for devices. One particular use is a software device as a My Health Record document producer (with PAI-D identifier) but other types of logical and physical devices may also be supported. Examples

Australian Device

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-device

This profile defines a device administration details structure that includes core localisation concepts for use in an Australian context.

This profile builds on Device.

This profile was published on Tue Sep 26 15:50:09 AEST 2017 as a draft by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceA device in an Australian healthcare context
... identifier 0..*(Slice Definition)Slice: Unordered, Open by pattern:type, value:system
.... identifier:paid I0..1IdentifierMy Health Record Assigned Identity for Devices (PAI-D)
inv-paid-value-0: PAI-D shall be an exactly 16 digit number
inv-paid-value-1: PAI-D prefix is 8003640003
inv-paid-value-2: The identifier shall pass the Luhn algorithm check
..... type 0..1CodeableConceptCoded identifier type for PAI-D
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NDI
...... text 0..1stringFixed Value: PAI-D
..... system 1..1uriNamespace for PAI-D
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
..... value 1..1stringPAI-D number
Example PAI-D number: 8003640003999998
Max Length: 16
... udi 0..1BackboneElement

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Device I0..*DeviceA device in an Australian healthcare context
... 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..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
... identifier 0..*(Slice Definition)Instance identifier
Slice: Unordered, Open by pattern:type, value:system
.... identifier:paid I0..1IdentifierMy Health Record Assigned Identity for Devices (PAI-D)
inv-paid-value-0: PAI-D shall be an exactly 16 digit number
inv-paid-value-1: PAI-D prefix is 8003640003
inv-paid-value-2: The identifier shall pass the Luhn algorithm check
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptCoded identifier type for PAI-D
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NDI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ0..1stringPlain text representation of the concept
Fixed Value: PAI-D
..... system Σ1..1uriNamespace for PAI-D
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
..... value Σ1..1stringPAI-D number
Example General: 123456
Example PAI-D number: 8003640003999998
Max Length: 16
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... udi ΣI0..1BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... deviceIdentifier Σ0..1stringMandatory fixed portion of UDI
.... name Σ0..1stringDevice Name as appears on UDI label
.... jurisdiction 0..1uriRegional UDI authority
.... carrierHRF Σ0..1stringUDI Human Readable Barcode String
.... carrierAIDC Σ0..1base64BinaryUDI Machine Readable Barcode String
.... issuer 0..1uriUDI Issuing Organization
.... entryType 0..1codebarcode | rfid | manual +
Binding: UDIEntryType (required)
... status ?!Σ0..1codeactive | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required)
... type 0..1CodeableConceptWhat kind of device this is
Binding: FHIR Device Types (example)
... lotNumber 0..1stringLot number of manufacture
... 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)
... model 0..1stringModel id assigned by the manufacturer
... version 0..1stringVersion number (i.e. software)
... patient 0..1Reference(Patient)Patient to whom Device is affixed
... owner 0..1Reference(Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... location 0..1Reference(Location)Where the resource is found
... url 0..1uriNetwork address to contact device
... note 0..*AnnotationDevice notes and comments
... safety Σ0..*CodeableConceptSafety Characteristics of Device
Binding: DeviceSafety (example)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*DeviceA device in an Australian healthcare context
... identifier 0..*(Slice Definition)Slice: Unordered, Open by pattern:type, value:system
.... identifier:paid I0..1IdentifierMy Health Record Assigned Identity for Devices (PAI-D)
inv-paid-value-0: PAI-D shall be an exactly 16 digit number
inv-paid-value-1: PAI-D prefix is 8003640003
inv-paid-value-2: The identifier shall pass the Luhn algorithm check
..... type 0..1CodeableConceptCoded identifier type for PAI-D
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NDI
...... text 0..1stringFixed Value: PAI-D
..... system 1..1uriNamespace for PAI-D
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
..... value 1..1stringPAI-D number
Example PAI-D number: 8003640003999998
Max Length: 16
... udi 0..1BackboneElement

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device I0..*DeviceA device in an Australian healthcare context
... 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..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
... identifier 0..*(Slice Definition)Instance identifier
Slice: Unordered, Open by pattern:type, value:system
.... identifier:paid I0..1IdentifierMy Health Record Assigned Identity for Devices (PAI-D)
inv-paid-value-0: PAI-D shall be an exactly 16 digit number
inv-paid-value-1: PAI-D prefix is 8003640003
inv-paid-value-2: The identifier shall pass the Luhn algorithm check
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptCoded identifier type for PAI-D
Binding: v2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org.au/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NDI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ0..1stringPlain text representation of the concept
Fixed Value: PAI-D
..... system Σ1..1uriNamespace for PAI-D
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
..... value Σ1..1stringPAI-D number
Example General: 123456
Example PAI-D number: 8003640003999998
Max Length: 16
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... udi ΣI0..1BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... deviceIdentifier Σ0..1stringMandatory fixed portion of UDI
.... name Σ0..1stringDevice Name as appears on UDI label
.... jurisdiction 0..1uriRegional UDI authority
.... carrierHRF Σ0..1stringUDI Human Readable Barcode String
.... carrierAIDC Σ0..1base64BinaryUDI Machine Readable Barcode String
.... issuer 0..1uriUDI Issuing Organization
.... entryType 0..1codebarcode | rfid | manual +
Binding: UDIEntryType (required)
... status ?!Σ0..1codeactive | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required)
... type 0..1CodeableConceptWhat kind of device this is
Binding: FHIR Device Types (example)
... lotNumber 0..1stringLot number of manufacture
... 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)
... model 0..1stringModel id assigned by the manufacturer
... version 0..1stringVersion number (i.e. software)
... patient 0..1Reference(Patient)Patient to whom Device is affixed
... owner 0..1Reference(Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... location 0..1Reference(Location)Where the resource is found
... url 0..1uriNetwork address to contact device
... note 0..*AnnotationDevice notes and comments
... safety Σ0..*CodeableConceptSafety Characteristics of Device
Binding: DeviceSafety (example)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-device

none defined