Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-ahpraregistrationnumber

AU AHPRA Registration Number [FMM Level 0]

This identifier profile defines an Australian Health Practitioner Regulation Agency (AHPRA) Registration Number [1] [2] in an Australian context.

Examples

Practitioner with HPI-I, Prescriber Number and AHPRA Registration Number

Qualified Radiologist

Qualified Pathologist

AHPRA qualified General Practitioner

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-ahpraregistrationnumber

This identifier profile defines an Australian Health Practitioner Regulation Agency (AHPRA) registration number in an Australian context.

This profile builds on Identifier.

This profile was published on Wed Jul 15 00:00:00 AEST 2020 as a draft by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierAustralian Health Practitioner Regulation Agency (AHPRA) Registration Number
inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits
... type 1..1CodeableConceptCoded identifier type for AHPRA registration number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
.... text 1..1stringPlain text representation of the concept
Fixed Value: AHPRA Registration Number
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/ahpra-registration-number
... value 1..1stringThe value that is unique
Example AHPRA registration number: MED0000932846

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierAustralian Health Practitioner Regulation Agency (AHPRA) Registration Number
inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI1..1CodeableConceptCoded identifier type for AHPRA registration number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI1..1stringPlain text representation of the concept
Fixed Value: AHPRA Registration Number
... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/ahpra-registration-number
... value ΣI1..1stringThe value that is unique
Example General: 123456
Example AHPRA registration number: MED0000932846
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierAustralian Health Practitioner Regulation Agency (AHPRA) Registration Number
inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits
... type 1..1CodeableConceptCoded identifier type for AHPRA registration number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
.... text 1..1stringPlain text representation of the concept
Fixed Value: AHPRA Registration Number
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/ahpra-registration-number
... value 1..1stringThe value that is unique
Example AHPRA registration number: MED0000932846

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierAustralian Health Practitioner Regulation Agency (AHPRA) Registration Number
inv-ahpra-0: AHPRA identifier shall be 3 uppercase letters, followed by 10 digits
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI1..1CodeableConceptCoded identifier type for AHPRA registration number
Binding: V2 Identifier Type - AU Extended (required)
Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: AHPRA
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI1..1stringPlain text representation of the concept
Fixed Value: AHPRA Registration Number
... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/ahpra-registration-number
... value ΣI1..1stringThe value that is unique
Example General: 123456
Example AHPRA registration number: MED0000932846
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-ahpraregistrationnumber

none defined