AU Base 1.1.1 on FHIR STU3

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.

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Device	A device in an Australian healthcare context
identifier		0..*	(Slice Definition)	Slice: Unordered, Open by pattern:type, value:system
identifier:paid	I	0..1	Identifier	My 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..1	CodeableConcept	Coded identifier type for PAI-D Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NDI
text		0..1	string	Fixed Value: PAI-D
system		1..1	uri	Namespace for PAI-D Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
value		1..1	string	PAI-D number Example PAI-D number: 8003640003999998 Max Length: 16
udi		0..1	BackboneElement
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Device	I	0..*	Device	A device in an Australian healthcare context
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: Common Languages (extensible) Max Binding: All Languages
text	I	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		0..*	(Slice Definition)	Instance identifier Slice: Unordered, Open by pattern:type, value:system
identifier:paid	I	0..1	Identifier	My 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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Coded identifier type for PAI-D Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NDI
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: PAI-D
system	Σ	1..1	uri	Namespace for PAI-D Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
value	Σ	1..1	string	PAI-D number Example General: 123456 Example PAI-D number: 8003640003999998 Max Length: 16
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
udi	ΣI	0..1	BackboneElement	Unique Device Identifier (UDI) Barcode string
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
deviceIdentifier	Σ	0..1	string	Mandatory fixed portion of UDI
name	Σ	0..1	string	Device Name as appears on UDI label
jurisdiction		0..1	uri	Regional UDI authority
carrierHRF	Σ	0..1	string	UDI Human Readable Barcode String
carrierAIDC	Σ	0..1	base64Binary	UDI Machine Readable Barcode String
issuer		0..1	uri	UDI Issuing Organization
entryType		0..1	code	barcode \| rfid \| manual + Binding: UDIEntryType (required)
status	?!Σ	0..1	code	active \| inactive \| entered-in-error \| unknown Binding: FHIRDeviceStatus (required)
type		0..1	CodeableConcept	What kind of device this is Binding: FHIR Device Types (example)
lotNumber		0..1	string	Lot number of manufacture
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)
model		0..1	string	Model id assigned by the manufacturer
version		0..1	string	Version number (i.e. software)
patient		0..1	Reference(Patient)	Patient to whom Device is affixed
owner		0..1	Reference(Organization)	Organization responsible for device
contact		0..*	ContactPoint	Details for human/organization for support
location		0..1	Reference(Location)	Where the resource 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 Binding: DeviceSafety (example)
Documentation for this format

Differential View

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Device	A device in an Australian healthcare context
identifier		0..*	(Slice Definition)	Slice: Unordered, Open by pattern:type, value:system
identifier:paid	I	0..1	Identifier	My 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..1	CodeableConcept	Coded identifier type for PAI-D Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NDI
text		0..1	string	Fixed Value: PAI-D
system		1..1	uri	Namespace for PAI-D Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
value		1..1	string	PAI-D number Example PAI-D number: 8003640003999998 Max Length: 16
udi		0..1	BackboneElement
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Device	I	0..*	Device	A device in an Australian healthcare context
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: Common Languages (extensible) Max Binding: All Languages
text	I	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		0..*	(Slice Definition)	Instance identifier Slice: Unordered, Open by pattern:type, value:system
identifier:paid	I	0..1	Identifier	My 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..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Coded identifier type for PAI-D Binding: v2 Identifier Type - AU Extended (required) Required Pattern: At least the following
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org.au/fhir/v2/0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: NDI
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Plain text representation of the concept Fixed Value: PAI-D
system	Σ	1..1	uri	Namespace for PAI-D Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
value	Σ	1..1	string	PAI-D number Example General: 123456 Example PAI-D number: 8003640003999998 Max Length: 16
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
udi	ΣI	0..1	BackboneElement	Unique Device Identifier (UDI) Barcode string
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
deviceIdentifier	Σ	0..1	string	Mandatory fixed portion of UDI
name	Σ	0..1	string	Device Name as appears on UDI label
jurisdiction		0..1	uri	Regional UDI authority
carrierHRF	Σ	0..1	string	UDI Human Readable Barcode String
carrierAIDC	Σ	0..1	base64Binary	UDI Machine Readable Barcode String
issuer		0..1	uri	UDI Issuing Organization
entryType		0..1	code	barcode \| rfid \| manual + Binding: UDIEntryType (required)
status	?!Σ	0..1	code	active \| inactive \| entered-in-error \| unknown Binding: FHIRDeviceStatus (required)
type		0..1	CodeableConcept	What kind of device this is Binding: FHIR Device Types (example)
lotNumber		0..1	string	Lot number of manufacture
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)
model		0..1	string	Model id assigned by the manufacturer
version		0..1	string	Version number (i.e. software)
patient		0..1	Reference(Patient)	Patient to whom Device is affixed
owner		0..1	Reference(Organization)	Organization responsible for device
contact		0..*	ContactPoint	Details for human/organization for support
location		0..1	Reference(Location)	Where the resource 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 Binding: DeviceSafety (example)
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