AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
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 
| Official URL: http://hl7.org.au/fhir/StructureDefinition/au-ahpraregistrationnumber | Version: 4.1.0-ballot | |||
| Draft as of 2022-11-10 | Maturity Level: 1 | Computable Name: AUAHPRARegistrationNumber | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This identifier profile defines an Australian Health Practitioner Regulation Agency (AHPRA) registration number ([1], [2]) in an Australian context.
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 | Australian Health Practitioner Regulation Agency (AHPRA) Registration Number inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits |
 type | 1..1 | CodeableConcept | Description of identifier 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: AHPRA | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/ahpra-registration-number | |
| value | 1..1 | string | AHPRA registration number Example AHPRA registration number: MED0000932846 | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-ahpra-0 | error | Identifier | AHPRA identifier shall be 3 uppercase letters, followed by 10 digits : value.matches('^[A-Z]{3}[0-9]{10}$') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | C | 0..* | Identifier | Australian Health Practitioner Regulation Agency (AHPRA) Registration Number inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits |
 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 | Description of identifier 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: AHPRA | |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/ahpra-registration-number |
| value | Σ | 1..1 | string | AHPRA registration number Example General: 123456 Example AHPRA registration number: MED0000932846 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: AHPRA |
| Id | Grade | Path(s) | Details | Requirements |
| inv-ahpra-0 | error | Identifier | AHPRA identifier shall be 3 uppercase letters, followed by 10 digits : value.matches('^[A-Z]{3}[0-9]{10}$') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | C | 0..* | Identifier | Australian Health Practitioner Regulation Agency (AHPRA) Registration Number inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits |
| 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 | Description of identifier 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 | id | 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 | id | 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: AHPRA | |
| 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://hl7.org.au/id/ahpra-registration-number |
| value | Σ | 1..1 | string | AHPRA registration number Example General: 123456 Example AHPRA registration number: MED0000932846 |
| 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 |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: AHPRA |
This structure is derived from Identifier
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | C | 0..* | Identifier | Australian Health Practitioner Regulation Agency (AHPRA) Registration Number inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits |
| type | 1..1 | CodeableConcept | Description of identifier 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: AHPRA | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/ahpra-registration-number | |
| value | 1..1 | string | AHPRA registration number Example AHPRA registration number: MED0000932846 | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| inv-ahpra-0 | error | Identifier | AHPRA identifier shall be 3 uppercase letters, followed by 10 digits : value.matches('^[A-Z]{3}[0-9]{10}$') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | C | 0..* | Identifier | Australian Health Practitioner Regulation Agency (AHPRA) Registration Number inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits |
| 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 | Description of identifier 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: AHPRA | |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/ahpra-registration-number |
| value | Σ | 1..1 | string | AHPRA registration number Example General: 123456 Example AHPRA registration number: MED0000932846 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: AHPRA |
| Id | Grade | Path(s) | Details | Requirements |
| inv-ahpra-0 | error | Identifier | AHPRA identifier shall be 3 uppercase letters, followed by 10 digits : value.matches('^[A-Z]{3}[0-9]{10}$') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | C | 0..* | Identifier | Australian Health Practitioner Regulation Agency (AHPRA) Registration Number inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits |
| 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 | Description of identifier 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 | id | 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 | id | 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: AHPRA | |
| 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://hl7.org.au/id/ahpra-registration-number |
| value | Σ | 1..1 | string | AHPRA registration number Example General: 123456 Example AHPRA registration number: MED0000932846 |
| 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 |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: AHPRA |
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron
none defined
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.1.0-ballot based on FHIR 4.0.1. Generated 2022-11-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change