Australian Base Implementation Guide
This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions 
AU Base Practitioner [FMM 3]
This profile defines a practitioner structure that localises core concepts, including identifiers and terminology, for use in an Australian context.
The purpose of this profile is to provide national level agreement on core localised concepts.
This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.
These definitions, defined as profiles of Identifier, represent common data held in the Practitioner.identifier element:
Extensions used in this profile:
Where including information from AHPRA about a practitioner, Practitioner.qualification should be instantiated with either the extension ahpraprofession-details or ahpraregistration-details. Detailed guidance on representing AHPRA data in Practitioner is available here.
The ahpraprofession-details extension supports inclusion of an AHPRA profession code and information about conditions, undertakings, reprimands and cautions in a qualification element instance representing a practitioner’s AHPRA profession.
The ahpraregistration-details extension supports inclusion of an AHPRA profession code and information about division, speciality, registration status, endorsements and notations in a qualification element instance representing a practitioner’s AHPRA registration.
Tertiary qualifications and professional memberships should be represented by instantiating an instance of Practitioner.qualification for each qualification to be included. Where a suitable code is not yet available, textual representation may be provided in Practitioner.qualification.code.text. Work around terminology for Australian college memberships is being considered; if completed the concepts are expected to be available in the preferred value set hl7VS-degreeLicenseCertificate - AU Extended.
Practitioner with HPI-I, prescriber number, AHPRA registration number, and CAE identifier
AHPRA registered general practitioner
AHPRA registered practitioner with extended AHPRA data
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-practitioner
This profile defines a practitioner structure that localises core concepts, including identifiers and terminology, for use in an Australian context.
This profile builds on Practitioner.
This profile was published on 2021-07-01 as a active by Health Level Seven Australia (Patient Administration WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | 0..* | Practitioner | A practitioner in an Australian healthcare context | |
  identifier | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumber | An identifier intended for computation | |
| address | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
 qualification | I | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care inv-pra-0: A qualification shall only have AHPRA Profession details if the code is AHPRA Profession inv-pra-1: A qualification shall only have AHPRA Registration details if the code is AHPRA Registration |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 ahpraprofession-details | 0..1 | (Complex) | AHPRA Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | |
| ahpraregistration-details | 0..1 | (Complex) | AHPRA Registration Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details | |
| identifier | 0..* | Identifier, AUAHPRARegistrationNumber | An identifier intended for computation | |
 code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred) | |
| communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner | 0..* | Practitioner | A practitioner in an Australian healthcare context | |||||
 id | Σ | 0..1 | string | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumber | An identifier intended for computation | |||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name | Σ | 0..* | HumanName | The name(s) associated with the practitioner | ||||
| telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| address | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo | 0..* | Attachment | Image of the person | |||||
| qualification | I | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care inv-pra-0: A qualification shall only have AHPRA Profession details if the code is AHPRA Profession inv-pra-1: A qualification shall only have AHPRA Registration details if the code is AHPRA Registration | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| ahpraprofession-details | 0..1 | (Complex) | AHPRA Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | |||||
| ahpraregistration-details | 0..1 | (Complex) | AHPRA Registration Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier | 0..* | Identifier, AUAHPRARegistrationNumber | An identifier intended for computation | |||||
| code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred) | |||||
| period | 0..1 | Period | Period during which the qualification is valid | |||||
 issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |||||
| Documentation for this format | ||||||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | Practitioner | A practitioner in an Australian healthcare context | |
| identifier | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumber | An identifier intended for computation | |
| address | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| qualification | I | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care inv-pra-0: A qualification shall only have AHPRA Profession details if the code is AHPRA Profession inv-pra-1: A qualification shall only have AHPRA Registration details if the code is AHPRA Registration |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ahpraprofession-details | 0..1 | (Complex) | AHPRA Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | |
| ahpraregistration-details | 0..1 | (Complex) | AHPRA Registration Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details | |
| identifier | 0..* | Identifier, AUAHPRARegistrationNumber | An identifier intended for computation | |
| code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred) | |
| communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner | 0..* | Practitioner | A practitioner in an Australian healthcare context | |||||
| id | Σ | 0..1 | string | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAHPRARegistrationNumber | An identifier intended for computation | |||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name | Σ | 0..* | HumanName | The name(s) associated with the practitioner | ||||
| telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| address | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo | 0..* | Attachment | Image of the person | |||||
| qualification | I | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care inv-pra-0: A qualification shall only have AHPRA Profession details if the code is AHPRA Profession inv-pra-1: A qualification shall only have AHPRA Registration details if the code is AHPRA Registration | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| ahpraprofession-details | 0..1 | (Complex) | AHPRA Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details | |||||
| ahpraregistration-details | 0..1 | (Complex) | AHPRA Registration Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier | 0..* | Identifier, AUAHPRARegistrationNumber | An identifier intended for computation | |||||
| code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred) | |||||
| period | 0..1 | Period | Period during which the qualification is valid | |||||
| issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible) | |||||
| Documentation for this format | ||||||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-practitioner
none defined
© AU Base on FHIR R4
(IG Publisher v4.0.1-a53ec6ee1b) generated on Mon, May 30, 2022 21:52+1000. |
