Health Connect Australia Provider Directory FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 0.2.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HealthConnect/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/hc/StructureDefinition/hc-pbprn | Version: 0.2.0-preview | |||
| Standards status: Draft | Computable Name: HCPeakBodyRegistrationNumber | |||
Usage:Jurisdiction: Australia |
||||
Copyright/Legal: Copyright © 2025 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/ |
||||
This identifier profile defines a professional registration number allocated to a healthcare practitioner, in a Health Connect Provider Directory context.
No data is entered directly into Health Connect; all Directory content is sourced from authoritative systems including PCA, HI-Service, and NHSD.
The HC Peak Body Registration Number (PRN) profile defines an identifier for a healthcare practitioner’s professional registration, as recorded in the Health Connect Provider Directory context. This identifier is used to capture the registration number assigned by a professional association or peak body, particularly for practitioners who are not Ahpra-registered, and is recorded against the HPI-I record.
identifier element on HC Practitioner and HC PractitionerRole.0..*), while HC PractitionerRole allows only 0 to 1 PRN identifier (0..1).type element to the v2 identifier code PRN (Provider number) from the v2-0203 code system (this is implemented in the profile as type = $v2-0203-int#PRN). Implementations SHOULD use the following coding when constructing the type element:
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "PRN",
"display": "Provider number"
}
]
}
value element is mandatory (cardinality 1..) and holds the practitioner's registration number as assigned by the authority (for example 1234567).assigner element is not constrained by this profile (it may be populated to reference the issuing organisation where available, but it is not required). Implementers are encouraged to populate assigner.display to improve provenance and traceability when the issuing Organization resource is not available.inv-01-system-or-assigner checks that either a system and or assigner is present to ensure proper identification of the authoritative body that issued the registration number.Implementers must ensure that the HC Peak Body Registration Number is used only for valid, assigned registration numbers and that all required elements are present and correct. This supports accurate practitioner identification and data integrity across the Health Connect Provider Directory.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Identifier(4.0.1) | Peak Body Professional Registration Number Constraints: inv-01-system-or-assigner |
![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Coded identifier type for professional registration number 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 |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() |
SΣ | 0..1 | uri | Professional registration number system. Example General: http://www.acme.com/identifiers/patient |
![]() ![]() |
SΣ | 1..1 | string | Professional registration number value. Example General: 123456 |
![]() ![]() |
SΣ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
SΣ | 1..1 | string | Text alternative for the Organization |
Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | Identifier, Identifier.use, Identifier.type, Identifier.system, Identifier.value, Identifier.assigner, Identifier.assigner.display | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| inv-01-system-or-assigner | warning | Identifier | PRN identifiers should have either a system and or assigner present |
system.exists() or assigner.exists()
|
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Identifier(4.0.1) | Peak Body Professional Registration Number |
![]() ![]() |
S | 1..1 | CodeableConcept | Coded identifier type for professional registration number Required Pattern: At least the following |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
![]() ![]() |
S | 0..1 | uri | Professional registration number system. |
![]() ![]() |
S | 1..1 | string | Professional registration number value. |
![]() ![]() |
S | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
S | 1..1 | string | Text alternative for the Organization |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Identifier(4.0.1) | Peak Body Professional Registration Number Constraints: inv-01-system-or-assigner |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Coded identifier type for professional registration number 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 |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() |
SΣ | 0..1 | uri | Professional registration number system. Example General: http://www.acme.com/identifiers/patient |
![]() ![]() |
SΣ | 1..1 | string | Professional registration number value. Example General: 123456 |
![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() |
SΣ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
SΣ | 1..1 | string | Text alternative for the Organization |
Documentation for this format | ||||
| 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. |
| Identifier.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | Identifier, Identifier.extension, Identifier.use, Identifier.type, Identifier.system, Identifier.value, Identifier.period, Identifier.assigner, Identifier.assigner.extension, Identifier.assigner.reference, Identifier.assigner.type, Identifier.assigner.identifier, Identifier.assigner.display | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Identifier.extension, Identifier.assigner.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-01-system-or-assigner | warning | Identifier | PRN identifiers should have either a system and or assigner present |
system.exists() or assigner.exists()
|
This structure is derived from Identifier
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Identifier(4.0.1) | Peak Body Professional Registration Number Constraints: inv-01-system-or-assigner |
![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Coded identifier type for professional registration number 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 |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() |
SΣ | 0..1 | uri | Professional registration number system. Example General: http://www.acme.com/identifiers/patient |
![]() ![]() |
SΣ | 1..1 | string | Professional registration number value. Example General: 123456 |
![]() ![]() |
SΣ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
SΣ | 1..1 | string | Text alternative for the Organization |
Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | Identifier, Identifier.use, Identifier.type, Identifier.system, Identifier.value, Identifier.assigner, Identifier.assigner.display | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| inv-01-system-or-assigner | warning | Identifier | PRN identifiers should have either a system and or assigner present |
system.exists() or assigner.exists()
|
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Identifier(4.0.1) | Peak Body Professional Registration Number |
![]() ![]() |
S | 1..1 | CodeableConcept | Coded identifier type for professional registration number Required Pattern: At least the following |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
![]() ![]() |
S | 0..1 | uri | Professional registration number system. |
![]() ![]() |
S | 1..1 | string | Professional registration number value. |
![]() ![]() |
S | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
S | 1..1 | string | Text alternative for the Organization |
Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Identifier(4.0.1) | Peak Body Professional Registration Number Constraints: inv-01-system-or-assigner |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Coded identifier type for professional registration number 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 |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() |
SΣ | 0..1 | uri | Professional registration number system. Example General: http://www.acme.com/identifiers/patient |
![]() ![]() |
SΣ | 1..1 | string | Professional registration number value. Example General: 123456 |
![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() |
SΣ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() |
SΣ | 1..1 | string | Text alternative for the Organization |
Documentation for this format | ||||
| 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. |
| Identifier.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | Identifier, Identifier.extension, Identifier.use, Identifier.type, Identifier.system, Identifier.value, Identifier.period, Identifier.assigner, Identifier.assigner.extension, Identifier.assigner.reference, Identifier.assigner.type, Identifier.assigner.identifier, Identifier.assigner.display | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Identifier.extension, Identifier.assigner.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-01-system-or-assigner | warning | Identifier | PRN identifiers should have either a system and or assigner present |
system.exists() or assigner.exists()
|
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron