This page is part of the Australian Base IG (v4.2.2-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

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Data Type Profile: AU Ahpra Registration Number

This identifier profile defines an Australian Health Practitioner Regulation Agency (Ahpra) registration number in an Australian context (see Ahpra for further information).

Usage:

• Use this DataType Constraint: AU Base Practitioner

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

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	C	1..1	string	Ahpra registration number Example Ahpra registration number: MED0000932846
Documentation for this format

Constraints

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	ΣC	1..1	string	Ahpra registration number Example General: 123456 Example Ahpra registration number: MED0000932846
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Pattern: AHPRA http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

Constraints

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-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	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: 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	ΣC	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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Pattern: AHPRA http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

Constraints

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-ahpra-0	error	Identifier	Ahpra identifier shall be 3 uppercase letters, followed by 10 digits : value.matches('^[A-Z]{3}[0-9]{10}$')

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 1

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	C	1..1	string	Ahpra registration number Example Ahpra registration number: MED0000932846
Documentation for this format

Constraints

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	ΣC	1..1	string	Ahpra registration number Example General: 123456 Example Ahpra registration number: MED0000932846
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Pattern: AHPRA http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

Constraints

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-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	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: 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	ΣC	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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Pattern: AHPRA http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

Constraints

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-ahpra-0	error	Identifier	Ahpra identifier shall be 3 uppercase letters, followed by 10 digits : value.matches('^[A-Z]{3}[0-9]{10}$')

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 1

Other representations of profile: CSV, Excel, Schematron