Australian Base Profiles Implementation Guide

This page is part of the Australian Base IG (v0.5.0: R1 Draft) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 6.0.0. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-device

AU Device [FMM Level 1]

This profile provided for use in an Australian context where some constraint on content is desirable to guarantee the quality of a local device.

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

Australian realm Device profile.

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).

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

AU Base Device profile contains:

  1. Base: Device (as Device)
  2. Optional PAI-D (as Identifier)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*Device used in Australian healthcare
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier 0..1IdentifierPAI-D
.... type 1..1CodeableConceptPAI-D Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 0..1CodingRequired Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NDI"}
..... text 1..1stringPAI-D Identifier Type Descriptive Text
Fixed Value: PAI-D
.... system 1..1uriThe national namespace for PAI-D numbers.
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
.... value I1..1stringinv-paid-0: The identifier shall be an exactly 16 digit number
inv-paid-1: The PAI-D prefix is 8003640003
inv-paid-2: The identifier shall pass the Luhn algorithm check
Example PAI-D number': 8003640003999998
Max Length: 16
... patient 0..1Reference(AU Base Patient
... owner 0..1Reference(AU Base Organisation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Device I0..*Device used in Australian 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: Common Languages (extensible)
... 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 IdentifierInstance identifier
Slice: Unordered, Open by value:system, value:type
... identifier 0..1IdentifierPAI-D
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptPAI-D Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingCode defined by a terminology system

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NDI"}
..... text Σ1..1stringPAI-D Identifier Type Descriptive Text
Fixed Value: PAI-D
.... system Σ1..1uriThe national namespace for PAI-D numbers.
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
.... value ΣI1..1stringThe value that is unique
inv-paid-0: The identifier shall be an exactly 16 digit number
inv-paid-1: The PAI-D prefix is 8003640003
inv-paid-2: The identifier shall pass the Luhn algorithm check
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(OrganizationOrganization 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(AU Base PatientPatient to whom Device is affixed
... owner 0..1Reference(AU Base OrganisationOrganization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... location 0..1Reference(LocationWhere 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

AU Base Device profile contains:

  1. Base: Device (as Device)
  2. Optional PAI-D (as Identifier)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..*Device used in Australian healthcare
... identifier IdentifierSlice: Unordered, Open by value:system, value:type
... identifier 0..1IdentifierPAI-D
.... type 1..1CodeableConceptPAI-D Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... coding 0..1CodingRequired Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NDI"}
..... text 1..1stringPAI-D Identifier Type Descriptive Text
Fixed Value: PAI-D
.... system 1..1uriThe national namespace for PAI-D numbers.
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
.... value I1..1stringinv-paid-0: The identifier shall be an exactly 16 digit number
inv-paid-1: The PAI-D prefix is 8003640003
inv-paid-2: The identifier shall pass the Luhn algorithm check
Example PAI-D number': 8003640003999998
Max Length: 16
... patient 0..1Reference(AU Base Patient
... owner 0..1Reference(AU Base Organisation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device I0..*Device used in Australian 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: Common Languages (extensible)
... 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 IdentifierInstance identifier
Slice: Unordered, Open by value:system, value:type
... identifier 0..1IdentifierPAI-D
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ1..1CodeableConceptPAI-D Identifier Type
Binding: v2 Identifier Type - AU Extended (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding Σ0..1CodingCode defined by a terminology system

Required Pattern: {"system":"http://hl7.org.au/fhir/v2/0203","code":"NDI"}
..... text Σ1..1stringPAI-D Identifier Type Descriptive Text
Fixed Value: PAI-D
.... system Σ1..1uriThe national namespace for PAI-D numbers.
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
.... value ΣI1..1stringThe value that is unique
inv-paid-0: The identifier shall be an exactly 16 digit number
inv-paid-1: The PAI-D prefix is 8003640003
inv-paid-2: The identifier shall pass the Luhn algorithm check
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(OrganizationOrganization 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(AU Base PatientPatient to whom Device is affixed
... owner 0..1Reference(AU Base OrganisationOrganization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... location 0..1Reference(LocationWhere 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