AU Base Implementation Guide
4.1.0-ballot - CI Build AU

This page is part of AU Base v4.1.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

Data Type Profile: AU PAI-D Identifier

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-paididentifier Version: 4.1.0-ballot
Draft as of 2022-11-10 Maturity Level: 0 Computable Name: AUPAIDIdentifier

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This identifier profile defines a My Health Record Assigned Identity - Device (PAI-D) identifier[1] in an Australian context.

A PAI-D is typically used to identify a device that plays a role, for example an authoring or observing, in the exchange of digital health data with the My Health Record system.

Usage:

  • This DataType Constraint is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
inv-paid-0: PAI-D shall be 16 digits
inv-paid-1: PAI-D prefix shall be 800364
inv-paid-2: PAI-D shall pass the Luhn algorithm
... type 1..1CodeableConceptCoded identifier type for PAI-D
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://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NDI
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
... value 1..1stringPAI-D
Example PAI-D: 8003640013000057
Max Length: 16

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-paid-0errorIdentifierPAI-D shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-paid-1errorIdentifierPAI-D prefix shall be 800364
: value.startsWith('800364')
inv-paid-2errorIdentifierPAI-D shall pass the Luhn algorithm
: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
inv-paid-0: PAI-D shall be 16 digits
inv-paid-1: PAI-D prefix shall be 800364
inv-paid-2: PAI-D shall pass the Luhn algorithm
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptCoded identifier type for PAI-D
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NDI
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: NDI

Constraints

IdGradePath(s)DetailsRequirements
inv-paid-0errorIdentifierPAI-D shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-paid-1errorIdentifierPAI-D prefix shall be 800364
: value.startsWith('800364')
inv-paid-2errorIdentifierPAI-D shall pass the Luhn algorithm
: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
inv-paid-0: PAI-D shall be 16 digits
inv-paid-1: PAI-D prefix shall be 800364
inv-paid-2: PAI-D shall pass the Luhn algorithm
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... id0..1idUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/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
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
... value Σ1..1stringPAI-D
Example General: 123456
Example PAI-D: 8003640013000057
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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: NDI

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed Value: 1 element

Maturity: 0

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
inv-paid-0: PAI-D shall be 16 digits
inv-paid-1: PAI-D prefix shall be 800364
inv-paid-2: PAI-D shall pass the Luhn algorithm
... type 1..1CodeableConceptCoded identifier type for PAI-D
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://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NDI
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
... value 1..1stringPAI-D
Example PAI-D: 8003640013000057
Max Length: 16

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-paid-0errorIdentifierPAI-D shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-paid-1errorIdentifierPAI-D prefix shall be 800364
: value.startsWith('800364')
inv-paid-2errorIdentifierPAI-D shall pass the Luhn algorithm
: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
inv-paid-0: PAI-D shall be 16 digits
inv-paid-1: PAI-D prefix shall be 800364
inv-paid-2: PAI-D shall pass the Luhn algorithm
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptCoded identifier type for PAI-D
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NDI
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: NDI

Constraints

IdGradePath(s)DetailsRequirements
inv-paid-0errorIdentifierPAI-D shall be 16 digits
: value.matches('^([0-9]{16})$')
inv-paid-1errorIdentifierPAI-D prefix shall be 800364
: value.startsWith('800364')
inv-paid-2errorIdentifierPAI-D shall pass the Luhn algorithm
: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierMy Health Record Assigned Identity - Device (PAI-D) Identifier
inv-paid-0: PAI-D shall be 16 digits
inv-paid-1: PAI-D prefix shall be 800364
inv-paid-2: PAI-D shall pass the Luhn algorithm
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... id0..1idUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/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
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paid/1.0
... value Σ1..1stringPAI-D
Example General: 123456
Example PAI-D: 8003640013000057
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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: NDI

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed Value: 1 element

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Notes:

none defined