AU PAI-O Identifier - AU Base Implementation Guide v7.0.0-ci-build

AU Base Implementation Guide
7.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Data Type Profile: AU PAI-O Identifier

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-paioidentifier		Version: 7.0.0-ci-build
Standards status: Trial-use	Maturity Level: 2	Computable Name: AUPAIOIdentifier
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This identifier profile defines a My Health Record Assigned Identity - Organisation (PAI-O) identifier in an Australian context. A PAI-O may be issued to organisations who wish to participate in the My Health Record and who are not eligible for a Healthcare Provider Identifier - Organisation (HPI-O).

Usage Notes

Usages:

Use this DataType Profile: AU Base Organization

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

The data elements list has changed

Formal Views of Profile Content

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

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Identifier	C	0..*	Identifier	My Health Record Assigned Identity - Organisation (PAI-O) Identifier Constraints: inv-paio-0, inv-paio-1, inv-paio-2
Identifier.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type	This element is included in summaries.	1..1	CodeableConcept	Coded identifier type for PAI-O 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: `{ "coding" : [ { "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203", "code" : "PAIO" } ] }`
Identifier.system	This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 (no extensions allowed)
Identifier.value	This element is included in summaries. C	1..1	string	PAI-O Example General: 123456 Example PAI-O: 8003640011000059 Max Length:16
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
inv-paio-0	error	Identifier	PAI-O shall be 16 digits	`value.matches('^([0-9]{16})$')`
inv-paio-1	error	Identifier	PAI-O prefix shall be 800364	`value.startsWith('800364')`
inv-paio-2	error	Identifier	PAI-O shall pass the Luhn algorithm	(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Identifier	C	0..*	Identifier	My Health Record Assigned Identity - Organisation (PAI-O) Identifier Constraints: inv-paio-0, inv-paio-1, inv-paio-2
Identifier.type		1..1	CodeableConcept	Coded identifier type for PAI-O Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203", "code" : "PAIO" } ] }`
Identifier.system		1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 (no extensions allowed)
Identifier.value	C	1..1	string	PAI-O Example PAI-O: 8003640011000059 Max Length:16
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
inv-paio-0	error	Identifier	PAI-O shall be 16 digits	`value.matches('^([0-9]{16})$')`
inv-paio-1	error	Identifier	PAI-O prefix shall be 800364	`value.startsWith('800364')`
inv-paio-2	error	Identifier	PAI-O shall pass the Luhn algorithm	(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Identifier	C	0..*	Identifier	My Health Record Assigned Identity - Organisation (PAI-O) Identifier Constraints: inv-paio-0, inv-paio-1, inv-paio-2
Identifier.id		0..1	string	Unique id for inter-element referencing
Identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Identifier.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type	This element is included in summaries.	1..1	CodeableConcept	Coded identifier type for PAI-O 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: `{ "coding" : [ { "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203", "code" : "PAIO" } ] }`
Identifier.system	This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 (no extensions allowed)
Identifier.value	This element is included in summaries. C	1..1	string	PAI-O Example General: 123456 Example PAI-O: 8003640011000059 Max Length:16
Identifier.period	This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Identifier.assigner	This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
inv-paio-0	error	Identifier	PAI-O shall be 16 digits	`value.matches('^([0-9]{16})$')`
inv-paio-1	error	Identifier	PAI-O prefix shall be 800364	`value.startsWith('800364')`
inv-paio-2	error	Identifier	PAI-O shall pass the Luhn algorithm	(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 2

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Identifier	C	0..*	Identifier	My Health Record Assigned Identity - Organisation (PAI-O) Identifier Constraints: inv-paio-0, inv-paio-1, inv-paio-2
Identifier.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type	This element is included in summaries.	1..1	CodeableConcept	Coded identifier type for PAI-O 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: `{ "coding" : [ { "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203", "code" : "PAIO" } ] }`
Identifier.system	This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 (no extensions allowed)
Identifier.value	This element is included in summaries. C	1..1	string	PAI-O Example General: 123456 Example PAI-O: 8003640011000059 Max Length:16
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
inv-paio-0	error	Identifier	PAI-O shall be 16 digits	`value.matches('^([0-9]{16})$')`
inv-paio-1	error	Identifier	PAI-O prefix shall be 800364	`value.startsWith('800364')`
inv-paio-2	error	Identifier	PAI-O shall pass the Luhn algorithm	(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

Differential View

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Identifier	C	0..*	Identifier	My Health Record Assigned Identity - Organisation (PAI-O) Identifier Constraints: inv-paio-0, inv-paio-1, inv-paio-2
Identifier.type		1..1	CodeableConcept	Coded identifier type for PAI-O Required Pattern: `{ "coding" : [ { "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203", "code" : "PAIO" } ] }`
Identifier.system		1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 (no extensions allowed)
Identifier.value	C	1..1	string	PAI-O Example PAI-O: 8003640011000059 Max Length:16
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
inv-paio-0	error	Identifier	PAI-O shall be 16 digits	`value.matches('^([0-9]{16})$')`
inv-paio-1	error	Identifier	PAI-O prefix shall be 800364	`value.startsWith('800364')`
inv-paio-2	error	Identifier	PAI-O shall pass the Luhn algorithm	(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

Snapshot View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Identifier	C	0..*	Identifier	My Health Record Assigned Identity - Organisation (PAI-O) Identifier Constraints: inv-paio-0, inv-paio-1, inv-paio-2
Identifier.id		0..1	string	Unique id for inter-element referencing
Identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Identifier.use	This element is a modifier element. This element is included in summaries.	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type	This element is included in summaries.	1..1	CodeableConcept	Coded identifier type for PAI-O 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: `{ "coding" : [ { "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203", "code" : "PAIO" } ] }`
Identifier.system	This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 (no extensions allowed)
Identifier.value	This element is included in summaries. C	1..1	string	PAI-O Example General: 123456 Example PAI-O: 8003640011000059 Max Length:16
Identifier.period	This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Identifier.assigner	This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	ALL elements	All FHIR elements must have a @value or children	`hasValue() or (children().count() > id.count())`
ext-1	error	ALL extensions	Must have either extensions or value[x], not both	`extension.exists() != value.exists()`
inv-paio-0	error	Identifier	PAI-O shall be 16 digits	`value.matches('^([0-9]{16})$')`
inv-paio-1	error	Identifier	PAI-O prefix shall be 800364	`value.startsWith('800364')`
inv-paio-2	error	Identifier	PAI-O shall pass the Luhn algorithm	(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 2

Other representations of profile: CSV, Excel, Schematron

IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#7.0.0-ci-build based on FHIR 4.0.1. Generated 2026-10-19
Links: Table of Contents | QA Report | Version History | | Propose a change