AU Base Implementation Guide
4.2.1-preview - Preview
AU Base Implementation Guide
4.2.1-preview - Preview
This page is part of the Australian Base IG (v4.2.1-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/StructureDefinition/au-paioidentifier | Version: 4.2.1-preview | |||
| 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Identifier |
C | 0..* | Identifier | My Health Record Assigned Identity - Organisation (PAI-O) Identifier inv-paio-0: PAI-O shall be 16 digits inv-paio-1: PAI-O prefix shall be 800364 inv-paio-2: PAI-O shall pass the Luhn algorithm |
 type |
1..1 | CodeableConcept | Coded identifier type for PAI-O 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://terminology.hl7.org.au/CodeSystem/v2-0203 | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NOI | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 | |
| value |
C | 1..1 | string | PAI-O Example PAI-O: 8003640011000059 Max Length: 16 |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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, $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) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier | My Health Record Assigned Identity - Organisation (PAI-O) Identifier inv-paio-0: PAI-O shall be 16 digits inv-paio-1: PAI-O prefix shall be 800364 inv-paio-2: PAI-O shall pass the Luhn algorithm |
 use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
 type |
Σ | 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: 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://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NOI | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 |
| value |
ΣC | 1..1 | string | PAI-O Example General: 123456 Example PAI-O: 8003640011000059 Max Length: 16 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Pattern: NOIhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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, $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) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier | My Health Record Assigned Identity - Organisation (PAI-O) Identifier inv-paio-0: PAI-O shall be 16 digits inv-paio-1: PAI-O prefix shall be 800364 inv-paio-2: PAI-O shall pass the Luhn algorithm |
| id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 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: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/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: NOI | |
| 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 | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 |
| value |
ΣC | 1..1 | string | PAI-O Example General: 123456 Example PAI-O: 8003640011000059 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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Pattern: NOIhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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, $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) |
This structure is derived from Identifier
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier | My Health Record Assigned Identity - Organisation (PAI-O) Identifier inv-paio-0: PAI-O shall be 16 digits inv-paio-1: PAI-O prefix shall be 800364 inv-paio-2: PAI-O shall pass the Luhn algorithm |
| type |
1..1 | CodeableConcept | Coded identifier type for PAI-O 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://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NOI | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 | |
| value |
C | 1..1 | string | PAI-O Example PAI-O: 8003640011000059 Max Length: 16 |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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, $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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier | My Health Record Assigned Identity - Organisation (PAI-O) Identifier inv-paio-0: PAI-O shall be 16 digits inv-paio-1: PAI-O prefix shall be 800364 inv-paio-2: PAI-O shall pass the Luhn algorithm |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 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: 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://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NOI | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 |
| value |
ΣC | 1..1 | string | PAI-O Example General: 123456 Example PAI-O: 8003640011000059 Max Length: 16 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Pattern: NOIhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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, $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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
C | 0..* | Identifier | My Health Record Assigned Identity - Organisation (PAI-O) Identifier inv-paio-0: PAI-O shall be 16 digits inv-paio-1: PAI-O prefix shall be 800364 inv-paio-2: PAI-O shall pass the Luhn algorithm |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
Σ | 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: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/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: NOI | |
| 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 | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 |
| value |
ΣC | 1..1 | string | PAI-O Example General: 123456 Example PAI-O: 8003640011000059 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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Pattern: NOIhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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, $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) |
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.2.1-preview based on FHIR 4.0.1. Generated 2024-06-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change