Health Connect Australia Provider Directory FHIR Implementation Guide
26.0.0
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 26.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HCPD/ and changes regularly. See the Directory of published versions
| Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner | Version: 26.0.0 | |||
| Active as of 2026-11-03 | Computable Name: HCPD_Practitioner | |||
Copyright/Legal: This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/ |
||||
This profile defines a Health Connect Provider Directory entry for a healthcare practitioner.
This profile addresses the business requirement for standardised practitioner information representation in the Health Connect Provider Directory, ensuring consistent capture of healthcare practitioner details including professional identifiers and qualifications for directory search and referral purposes.
No data is entered directly into Health Connect; all Directory content is sourced from authoritative systems including PCA, HI-Service, and NHSD.
Extensions introduced in this profile:
The extension:suppressed is used to indicate if this resource should be hidden from display in the Provider Directory. A Practitioner may elect to hide their visibility from those searching the Health Connect Provider Directory system. Presence of the extension indicates the resource is suppressed. When this extension is applied to a HCPD Practitioner resource, its use is constrained to just the practitioner-initiated code. For more details, please see the extension intro notes.
The following guidance maps key information requirements for HCPD Practitioner records to fields in the profile. Where a requirement references the HI Service as the authoritative source, publishers SHOULD prefer and validate values-such as practitioner identifiers, and names.
Required Identifier:
Professional registration should be carried in the qualification element. The registration number of the Practitioner should be populated in qualification.identifier; the practitioner's profession should be sent as free text in qualification.code.text.
qualification.identifier: Registration number issued by the regulatory body (either issued by Ahpra or a non-Ahpra peak body). Follow the applicable identifier profile for format and issuer information.qualification.code.text: The practitioner's profession linked to the registration number as a human-readable string. Because there is no single, authoritative ValueSet that covers all professions reliably, send the profession in code.text.qualification.code.coding (optional): Only use coded values when you have an authoritative, stable code system for that profession. When coding is included, also populate code.text with the same label.Notes:
qualification.identifier. If you can map the profession to a reliable Ahpra code you may include qualification.code.coding, but still provide qualification.code.text.qualification.issuer.display or, when attaching issuer details to the identifier itself, use qualification.identifier.assigner.display or qualification.identifier.system as appropriate.This profile requires profession to be present as human-readable text in qualification.code.text when the profession is known; coded professions are optional.
Practitioners may optionally provide personal contact details for inclusion in the Provider Directory. This includes personalPhoneNumber and personalEmailAddress. Publishing systems MUST only include and display these personal contact details if the practitioner has explicitly opted in to being listed; treat these fields as sensitive and do not expose them publicly unless the practitioner has consented.
HCPD is currently not authorised to collect, store, use, disclose, or use as search parameters the following Practitioner data attributes. Where a search parameter exists, use of these elements as search parameters is discouraged:
For practitioner sex or gender searches in HCPD, use the supported data element Recorded Sex or gender (RSG) rather than gender or gender identity. Where a search or display requirement refers to sex or gender, publishers SHOULD map to RSG and SHOULD NOT expose gender or gender identity as user-facing search parameters.
This profile includes invariants to ensure data consistency and proper professional credentialing.
inv-01-qualification-registration-required (error):
Ensures at least one professional registration is present in qualifications:
Implementation Validation:
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:  | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Practitioner |
C | 0..* | AUCorePractitioner(2.0.0) | Healthcare Provider Individual Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5 | ||||||||||||
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||||||
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
   extension:genderIdentity |
C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Constraints: ext-1 | ||||||||||||
| extension:individualPronouns |
0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns Constraints: ext-1 | |||||||||||||
| extension:recordedSexOrGender |
C | 1..1 | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Constraints: ext-1 | ||||||||||||
 extension:suppressed |
0..1 | (Complex) | indicates whether the Practitioner should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1 | |||||||||||||
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||||||
 extension:suppressedBy |
1..1 | Extension | Who initiated the suppression Constraints: ext-1 | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "suppressedBy" | |||||||||||||
  value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
  coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
 extension:includeSelf |
0..1 | Extension | Controls Organization self-suppression Constraints: ext-1 | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "includeSelf" | |||||||||||||
 value[x] |
0..1 | boolean | Value of extension | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed" | |||||||||||||
| extension:deactivated |
0..1 | (Complex) | indicates whether the Practitioner should be hidden. URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1 | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation Constraints: ext-1 | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "deactivatedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated" | |||||||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||||||||||
| Slices for identifier |
1..* | Identifier(4.0.1)  , AUHPII(6.0.0) , AUPBSPrescriberNumber(6.0.0) , AUCareAgencyEmployeeIdentifier(6.0.0) , AUAhpraRegistrationNumber(6.0.0) |
An identifier for the person as this agent Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
 identifier:hpii |
C | 1..1 | HCPD_HPII_Identifier(26.0.0) | HPI-I identifier Constraints: inv-hpii-0, inv-hpii-1, inv-hpii-2
| ||||||||||||
| Slices for name |
1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Open by value:use
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
 name:All Slices |
Content/Rules for all slices | |||||||||||||||
| use |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||||||||||
| family |
1..1 | string | Family name (often called 'Surname') | |||||||||||||
| given |
0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | |||||||||||||
| name:officialName |
1..1 | HumanName | Legal Registered Name | |||||||||||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |||||||||||||
| family |
1..1 | string | Practitioner's family name
| |||||||||||||
| given |
0..* | string | Practitioner's given name This repeating element order: Given Names appear in the correct order for presenting the name
| |||||||||||||
| prefix |
0..1 | string | Title This repeating element order: Prefixes appear in the correct order for presenting the name | |||||||||||||
| name:alternate-name |
0..1 | HumanName | Alternate name or alias of a practitioner | |||||||||||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual (no extensions allowed) | |||||||||||||
| family |
1..1 | string | Practitioner's family name
| |||||||||||||
| given |
0..* | string | Practitioner's given name This repeating element order: Given Names appear in the correct order for presenting the name
| |||||||||||||
| Slices for telecom |
0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system, value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| telecom:personalPhoneNumber |
0..1 | ContactPoint | Personal phone number | |||||||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone (no extensions allowed) | ||||||||||||
| value |
1..1 | string | The actual contact point details | |||||||||||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home (no extensions allowed) | |||||||||||||
| telecom:personalEmailAddress |
0..1 | ContactPoint | Personal Email address | |||||||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email (no extensions allowed) | ||||||||||||
| value |
1..1 | string | The actual contact point details | |||||||||||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home (no extensions allowed) | |||||||||||||
 qualification |
1..* | BackboneElement | Professional registration details of the practitioner | |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||
| Slices for identifier |
0..1 | Identifier | An identifier for this qualification Slice: Unordered, Open by pattern:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| identifier:ahpraregistrationnumber |
C | 0..1 | AUAhpraRegistrationNumber(6.0.0) | Ahpra registration number Constraints: inv-ahpra-0 | ||||||||||||
| identifier:peakbodyregistrationnumber |
0..1 | Peak_Body_Professional_Registration_Number(26.0.0) | Peak body, association or societal professional registration number for non-Ahpra practitioners | |||||||||||||
| code |
1..1 | CodeableConcept | Profession of the Practitioner. Binding: Hl7VSDegreeLicenseCertificateAUExtended (6.0.0) (preferred) | |||||||||||||
| text |
1..1 | string | Text representation of the Practitioner Profession. | |||||||||||||
 issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.extension:suppressed.extension:suppressedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Practitioner.extension:deactivated.extension:deactivatedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:officialName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:alternate-name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalPhoneNumber.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalPhoneNumber.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalEmailAddress.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalEmailAddress.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.qualification.code | Base | preferred | hl7VS-degreeLicenseCertificate - AU Extended | 📍6.0.0 | AU Base Implementation Guide v6.0 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from AUCorePractitioner
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
C | 0..* | AUCorePractitioner(2.0.0) | Healthcare Provider Individual Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5 | ||||||||||||
| id |
0..1 | id | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| extension:genderIdentity |
C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Constraints: ext-1 | ||||||||||||
| extension:individualPronouns |
0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns Constraints: ext-1 | |||||||||||||
| extension:recordedSexOrGender |
C | 1..1 | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Constraints: ext-1
| ||||||||||||
| extension:suppressed |
0..1 | (Complex) | indicates whether the Practitioner should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:suppressedBy |
1..1 | Extension | Who initiated the suppression Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "suppressedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| extension:includeSelf |
0..1 | Extension | Controls Organization self-suppression Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "includeSelf" | |||||||||||||
| value[x] |
0..1 | boolean | Value of extension | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed" | |||||||||||||
| extension:deactivated |
0..1 | (Complex) | indicates whether the Practitioner should be hidden. URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "deactivatedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated" | |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||||||||||
| Slices for identifier |
1..* | Identifier(4.0.1) , AUHPII(6.0.0) , AUPBSPrescriberNumber(6.0.0) , AUCareAgencyEmployeeIdentifier(6.0.0) , AUAhpraRegistrationNumber(6.0.0) |
An identifier for the person as this agent Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| identifier:hpii |
C | 1..1 | HCPD_HPII_Identifier(26.0.0) | HPI-I identifier Constraints: inv-hpii-0, inv-hpii-1, inv-hpii-2
| ||||||||||||
| active |
0..1 | boolean | Whether this practitioner's record is in active use | |||||||||||||
| Slices for name |
1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Open by value:use
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| name:All Slices |
Content/Rules for all slices | |||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| use |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||||||||||
| text |
0..1 | string | Text representation of the full name | |||||||||||||
| family |
1..1 | string | Family name (often called 'Surname') | |||||||||||||
| given |
0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | |||||||||||||
| prefix |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||||||||||
| suffix |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||||||||||
| period |
0..1 | Period | Time period when name was/is in use | |||||||||||||
| name:officialName |
1..1 | HumanName | Legal Registered Name | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |||||||||||||
| text |
0..1 | string | Text representation of the full name | |||||||||||||
| family |
1..1 | string | Practitioner's family name
| |||||||||||||
| given |
0..* | string | Practitioner's given name This repeating element order: Given Names appear in the correct order for presenting the name
| |||||||||||||
| prefix |
0..1 | string | Title This repeating element order: Prefixes appear in the correct order for presenting the name
| |||||||||||||
| suffix |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||||||||||
| period |
0..1 | Period | Time period when name was/is in use | |||||||||||||
| name:alternate-name |
0..1 | HumanName | Alternate name or alias of a practitioner | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual (no extensions allowed) | |||||||||||||
| text |
0..1 | string | Text representation of the full name | |||||||||||||
| family |
1..1 | string | Practitioner's family name
| |||||||||||||
| given |
0..* | string | Practitioner's given name This repeating element order: Given Names appear in the correct order for presenting the name
| |||||||||||||
| prefix |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||||||||||
| suffix |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||||||||||
| period |
0..1 | Period | Time period when name was/is in use | |||||||||||||
| Slices for telecom |
0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system, value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| telecom:personalPhoneNumber |
0..1 | ContactPoint | Personal phone number
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone (no extensions allowed) | ||||||||||||
| value |
1..1 | string | The actual contact point details | |||||||||||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home (no extensions allowed) | |||||||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||||||
| telecom:personalEmailAddress |
0..1 | ContactPoint | Personal Email address
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email (no extensions allowed) | ||||||||||||
| value |
1..1 | string | The actual contact point details | |||||||||||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home (no extensions allowed) | |||||||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||||||
| address |
0..* | Address(4.0.1) , AustralianAddress(6.0.0) |
Address(es) of the practitioner that are not role specific (typically home address) | |||||||||||||
| 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 |
1..* | BackboneElement | Professional registration details of the practitioner
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||
| Slices for identifier |
0..1 | Identifier | An identifier for this qualification Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| identifier:ahpraregistrationnumber |
C | 0..1 | AUAhpraRegistrationNumber(6.0.0) | Ahpra registration number Constraints: inv-ahpra-0 | ||||||||||||
| identifier:peakbodyregistrationnumber |
0..1 | Peak_Body_Professional_Registration_Number(26.0.0) | Peak body, association or societal professional registration number for non-Ahpra practitioners | |||||||||||||
| code |
1..1 | CodeableConcept | Profession of the Practitioner. Binding: Hl7VSDegreeLicenseCertificateAUExtended (6.0.0) (preferred)
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||||||||||
| text |
1..1 | string | Text representation of the Practitioner Profession. | |||||||||||||
| 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 | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Practitioner.extension:suppressed.extension:suppressedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Practitioner.extension:deactivated.extension:deactivatedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:officialName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:alternate-name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalPhoneNumber.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalPhoneNumber.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalEmailAddress.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalEmailAddress.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Practitioner.qualification.code | Base | preferred | hl7VS-degreeLicenseCertificate - AU Extended | 📍6.0.0 | AU Base Implementation Guide v6.0 |
| Practitioner.communication | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from AUCorePractitioner
Summary
Mandatory: 8 elements(7 nested mandatory elements)
Must-Support: 17 elements
Fixed: 8 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
C | 0..* | AUCorePractitioner(2.0.0) | Healthcare Provider Individual Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5 | ||||||||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| extension:genderIdentity |
C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Constraints: ext-1 | ||||||||||||
| extension:individualPronouns |
0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns Constraints: ext-1 | |||||||||||||
| extension:recordedSexOrGender |
C | 1..1 | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Constraints: ext-1
| ||||||||||||
| extension:suppressed |
0..1 | (Complex) | indicates whether the Practitioner should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
| |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:suppressedBy |
1..1 | Extension | Who initiated the suppression Constraints: ext-1 | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "suppressedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| extension:includeSelf |
0..1 | Extension | Controls Organization self-suppression Constraints: ext-1 | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "includeSelf" | |||||||||||||
| value[x] |
0..1 | boolean | Value of extension | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed" | |||||||||||||
| extension:deactivated |
0..1 | (Complex) | indicates whether the Practitioner should be hidden. URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
| |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation Constraints: ext-1 | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "deactivatedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated" | |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||||||||||
| Slices for identifier |
1..* | Identifier(4.0.1) , AUHPII(6.0.0) , AUPBSPrescriberNumber(6.0.0) , AUCareAgencyEmployeeIdentifier(6.0.0) , AUAhpraRegistrationNumber(6.0.0) |
An identifier for the person as this agent Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| identifier:hpii |
C | 1..1 | HCPD_HPII_Identifier(26.0.0) | HPI-I identifier Constraints: inv-hpii-0, inv-hpii-1, inv-hpii-2
| ||||||||||||
| Slices for name |
1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Open by value:use
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| name:All Slices |
Content/Rules for all slices | |||||||||||||||
| use |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||||||||||
| family |
1..1 | string | Family name (often called 'Surname') | |||||||||||||
| given |
0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | |||||||||||||
| name:officialName |
1..1 | HumanName | Legal Registered Name | |||||||||||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |||||||||||||
| family |
1..1 | string | Practitioner's family name
| |||||||||||||
| given |
0..* | string | Practitioner's given name This repeating element order: Given Names appear in the correct order for presenting the name
| |||||||||||||
| prefix |
0..1 | string | Title This repeating element order: Prefixes appear in the correct order for presenting the name
| |||||||||||||
| name:alternate-name |
0..1 | HumanName | Alternate name or alias of a practitioner | |||||||||||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual (no extensions allowed) | |||||||||||||
| family |
1..1 | string | Practitioner's family name
| |||||||||||||
| given |
0..* | string | Practitioner's given name This repeating element order: Given Names appear in the correct order for presenting the name
| |||||||||||||
| Slices for telecom |
0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system, value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| telecom:personalPhoneNumber |
0..1 | ContactPoint | Personal phone number
| |||||||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone (no extensions allowed) | ||||||||||||
| value |
1..1 | string | The actual contact point details | |||||||||||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home (no extensions allowed) | |||||||||||||
| telecom:personalEmailAddress |
0..1 | ContactPoint | Personal Email address
| |||||||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email (no extensions allowed) | ||||||||||||
| value |
1..1 | string | The actual contact point details | |||||||||||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home (no extensions allowed) | |||||||||||||
| qualification |
1..* | BackboneElement | Professional registration details of the practitioner
| |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||
| Slices for identifier |
0..1 | Identifier | An identifier for this qualification Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| identifier:ahpraregistrationnumber |
C | 0..1 | AUAhpraRegistrationNumber(6.0.0) | Ahpra registration number Constraints: inv-ahpra-0 | ||||||||||||
| identifier:peakbodyregistrationnumber |
0..1 | Peak_Body_Professional_Registration_Number(26.0.0) | Peak body, association or societal professional registration number for non-Ahpra practitioners | |||||||||||||
| code |
1..1 | CodeableConcept | Profession of the Practitioner. Binding: Hl7VSDegreeLicenseCertificateAUExtended (6.0.0) (preferred)
| |||||||||||||
| text |
1..1 | string | Text representation of the Practitioner Profession. | |||||||||||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.extension:suppressed.extension:suppressedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Practitioner.extension:deactivated.extension:deactivatedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:officialName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:alternate-name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalPhoneNumber.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalPhoneNumber.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalEmailAddress.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalEmailAddress.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.qualification.code | Base | preferred | hl7VS-degreeLicenseCertificate - AU Extended | 📍6.0.0 | AU Base Implementation Guide v6.0 |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from AUCorePractitioner
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | AUCorePractitioner(2.0.0) | Healthcare Provider Individual | |||||||||||||
| extension |
1..* | Extension | Extension | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:recordedSexOrGender |
1..1 | RecordedSexOrGender(5.4.0) | A recorded sex or gender property for the individual
| |||||||||||||
| extension:suppressed |
0..1 | (Complex) | indicates whether the Practitioner should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
| |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:suppressedBy |
1..1 | Extension | Who initiated the suppression | |||||||||||||
| value[x] |
||||||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: | |||||||||||||
| extension:deactivated |
0..1 | (Complex) | indicates whether the Practitioner should be hidden. URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
| |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation | |||||||||||||
| value[x] |
||||||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: | |||||||||||||
| identifier |
1..* | Identifier(4.0.1), AUHPII(6.0.0), AUPBSPrescriberNumber(6.0.0), AUCareAgencyEmployeeIdentifier(6.0.0), AUAhpraRegistrationNumber(6.0.0) | An identifier for the person as this agent
| |||||||||||||
| Slices for identifier |
Content/Rules for all slices | |||||||||||||||
| identifier:hpii |
1..1 | HCPD_HPII_Identifier(26.0.0) | HPI-I identifier
| |||||||||||||
| Slices for name |
1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Open by value:use
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| name:officialName |
1..1 | HumanName | Legal Registered Name | |||||||||||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official (no extensions allowed) | |||||||||||||
| family |
1..1 | string | Practitioner's family name
| |||||||||||||
| given |
0..* | string | Practitioner's given name
| |||||||||||||
| prefix |
0..1 | string | Title
| |||||||||||||
| name:alternate-name |
0..1 | HumanName | Alternate name or alias of a practitioner | |||||||||||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: usual (no extensions allowed) | |||||||||||||
| family |
1..1 | string | Practitioner's family name
| |||||||||||||
| given |
0..* | string | Practitioner's given name
| |||||||||||||
| Slices for telecom |
0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system, value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| telecom:personalPhoneNumber |
0..1 | ContactPoint | Personal phone number
| |||||||||||||
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone (no extensions allowed) | |||||||||||||
| value |
1..1 | string | The actual contact point details | |||||||||||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home (no extensions allowed) | |||||||||||||
| telecom:personalEmailAddress |
0..1 | ContactPoint | Personal Email address
| |||||||||||||
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email (no extensions allowed) | |||||||||||||
| value |
1..1 | string | The actual contact point details | |||||||||||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home (no extensions allowed) | |||||||||||||
| qualification |
1..* | BackboneElement | Professional registration details of the practitioner
| |||||||||||||
| Slices for identifier |
0..1 | Identifier | An identifier for this qualification Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| identifier:ahpraregistrationnumber |
0..1 | AUAhpraRegistrationNumber(6.0.0) | Ahpra registration number | |||||||||||||
| identifier:peakbodyregistrationnumber |
0..1 | Peak_Body_Professional_Registration_Number(26.0.0) | Peak body, association or societal professional registration number for non-Ahpra practitioners | |||||||||||||
| code |
1..1 | CodeableConcept | Profession of the Practitioner.
| |||||||||||||
| text |
1..1 | string | Text representation of the Practitioner Profession. | |||||||||||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||||||||||
| Documentation for this format | ||||||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Practitioner |
C | 0..* | AUCorePractitioner(2.0.0) | Healthcare Provider Individual Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5 | ||||||||||||
| id |
0..1 | id | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| extension:genderIdentity |
C | 0..* | (Complex) | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity Constraints: ext-1 | ||||||||||||
| extension:individualPronouns |
0..* | (Complex) | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns Constraints: ext-1 | |||||||||||||
| extension:recordedSexOrGender |
C | 1..1 | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender Constraints: ext-1
| ||||||||||||
| extension:suppressed |
0..1 | (Complex) | indicates whether the Practitioner should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:suppressedBy |
1..1 | Extension | Who initiated the suppression Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "suppressedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| extension:includeSelf |
0..1 | Extension | Controls Organization self-suppression Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "includeSelf" | |||||||||||||
| value[x] |
0..1 | boolean | Value of extension | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed" | |||||||||||||
| extension:deactivated |
0..1 | (Complex) | indicates whether the Practitioner should be hidden. URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation Constraints: ext-1 | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||
| url |
1..1 | uri | "deactivatedBy" | |||||||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated" | |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||||||||||
| Slices for identifier |
1..* | Identifier(4.0.1) , AUHPII(6.0.0) , AUPBSPrescriberNumber(6.0.0) , AUCareAgencyEmployeeIdentifier(6.0.0) , AUAhpraRegistrationNumber(6.0.0) |
An identifier for the person as this agent Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| identifier:hpii |
C | 1..1 | HCPD_HPII_Identifier(26.0.0) | HPI-I identifier Constraints: inv-hpii-0, inv-hpii-1, inv-hpii-2
| ||||||||||||
| active |
0..1 | boolean | Whether this practitioner's record is in active use | |||||||||||||
| Slices for name |
1..* | HumanName | The name(s) associated with the practitioner Slice: Unordered, Open by value:use
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| name:All Slices |
Content/Rules for all slices | |||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| use |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||||||||||
| text |
0..1 | string | Text representation of the full name | |||||||||||||
| family |
1..1 | string | Family name (often called 'Surname') | |||||||||||||
| given |
0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | |||||||||||||
| prefix |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||||||||||
| suffix |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||||||||||
| period |
0..1 | Period | Time period when name was/is in use | |||||||||||||
| name:officialName |
1..1 | HumanName | Legal Registered Name | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |||||||||||||
| text |
0..1 | string | Text representation of the full name | |||||||||||||
| family |
1..1 | string | Practitioner's family name
| |||||||||||||
| given |
0..* | string | Practitioner's given name This repeating element order: Given Names appear in the correct order for presenting the name
| |||||||||||||
| prefix |
0..1 | string | Title This repeating element order: Prefixes appear in the correct order for presenting the name
| |||||||||||||
| suffix |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||||||||||
| period |
0..1 | Period | Time period when name was/is in use | |||||||||||||
| name:alternate-name |
0..1 | HumanName | Alternate name or alias of a practitioner | |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| use |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual (no extensions allowed) | |||||||||||||
| text |
0..1 | string | Text representation of the full name | |||||||||||||
| family |
1..1 | string | Practitioner's family name
| |||||||||||||
| given |
0..* | string | Practitioner's given name This repeating element order: Given Names appear in the correct order for presenting the name
| |||||||||||||
| prefix |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||||||||||
| suffix |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||||||||||
| period |
0..1 | Period | Time period when name was/is in use | |||||||||||||
| Slices for telecom |
0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) Slice: Unordered, Open by value:system, value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| telecom:personalPhoneNumber |
0..1 | ContactPoint | Personal phone number
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone (no extensions allowed) | ||||||||||||
| value |
1..1 | string | The actual contact point details | |||||||||||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home (no extensions allowed) | |||||||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||||||
| telecom:personalEmailAddress |
0..1 | ContactPoint | Personal Email address
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email (no extensions allowed) | ||||||||||||
| value |
1..1 | string | The actual contact point details | |||||||||||||
| use |
1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home (no extensions allowed) | |||||||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||||||
| address |
0..* | Address(4.0.1) , AustralianAddress(6.0.0) |
Address(es) of the practitioner that are not role specific (typically home address) | |||||||||||||
| 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 |
1..* | BackboneElement | Professional registration details of the practitioner
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||||||||||
| Slices for identifier |
0..1 | Identifier | An identifier for this qualification Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||
| identifier:ahpraregistrationnumber |
C | 0..1 | AUAhpraRegistrationNumber(6.0.0) | Ahpra registration number Constraints: inv-ahpra-0 | ||||||||||||
| identifier:peakbodyregistrationnumber |
0..1 | Peak_Body_Professional_Registration_Number(26.0.0) | Peak body, association or societal professional registration number for non-Ahpra practitioners | |||||||||||||
| code |
1..1 | CodeableConcept | Profession of the Practitioner. Binding: Hl7VSDegreeLicenseCertificateAUExtended (6.0.0) (preferred)
| |||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||||||||||
| text |
1..1 | string | Text representation of the Practitioner Profession. | |||||||||||||
| 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 | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Practitioner.extension:suppressed.extension:suppressedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Practitioner.extension:deactivated.extension:deactivatedBy.value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG |
| Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:officialName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.name:alternate-name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalPhoneNumber.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalPhoneNumber.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalEmailAddress.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Practitioner.telecom:personalEmailAddress.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Practitioner.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Practitioner.qualification.code | Base | preferred | hl7VS-degreeLicenseCertificate - AU Extended | 📍6.0.0 | AU Base Implementation Guide v6.0 |
| Practitioner.communication | Base | extensible | https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from AUCorePractitioner
Summary
Mandatory: 8 elements(7 nested mandatory elements)
Must-Support: 17 elements
Fixed: 8 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
This IG provides a small set of convenience SearchParameters to make it easier to find HC Practitioner resources; it also expects implementers to support common Practitioner parameters from AU Core & AU Base.
How search queries can be performed using the HPI-I are described in AU Core documentation.
The following standard FHIR R4 search parameters are recommended for practitioner identifier and name searches:
identifier (Practitioner.identifier)
| Search practitioners by HPI-I. The AU Core guidance favours using the system | value (token) form. |
Example: GET /Practitioner?identifier=http://ns.electronichealth.net.au/id/hi/hpii/1.0|8003619900015717
Note: This standard search parameter does NOT work on identifiers nested within the qualification data element. Therefore, a custom search parameter identifier-r5 is described below.
name (Practitioner.name)
:contains modifier for partial matchingGET /Practitioner?name:contains=DrGET /Practitioner?name:contains=HelenGET /Practitioner?name:contains=John&name:contains=Helenname:contains=John,Helen finds "John" OR "Helen")active (Practitioner.active)
Example: GET /Practitioner?active=true
Note: Adding ?active=false returns records that are inactive, Implementers should be aware that returned results MAY include records marked for suppression; it is the responsibility of the implementer that suppressed records SHALL be filtered out before display.
The following search parameters are defined by this IG and SHOULD be supported:
identifier-r5 (Practitioner.identifier |
Practitioner.qualification.identifier) |
Practitioner.identifier and Practitioner.qualification.identifier.peakbodyregistrationnumber OR ahpraregistrationnumber is supplied with or without an accompanying system.
Note that when a system is not supplied this may result in duplicate value matches, originating from multiple different issuing organizations.GET /Practitioner?identifier-r5=http://ns.electronichealth.net.au/id/hi/hpii/1.0|8003619900015717GET /Practitioner?identifier-r5=8003619900015717GET /Practitioner?identifier-r5=http://hl7.org.au/id/ahpra-registration-number|MED0000932945GET /Practitioner?identifier-r5=MED0000932945GET /Practitioner?identifier-r5=http://example.org/fhir/identifier/acha-prn|PRN-123456GET /Practitioner?identifier-r5=PRN-123456rsg (Practitioner.extension(recordedSexorGender).valueCodeableConcept)
type, source, sourceDocument, effectivePeriod should be appraised as a whole.GET /Practitioner?rsg=http://hl7.org/fhir/administrative-gender|malesuppressed (Practitioner.extension where url = suppressedBy extension)
GET /Practitioner?suppressed=http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type|practitioner-initiatedGET /Practitioner?suppressed=practitioner-initiatedGET /Practitioner?suppressed=http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type|regprof (Practitioner.qualification.code.text) Supports both :contains & :exact modifiers.
:contains modifier for partial matching, :exact modifier for precise matching.GET /Practitioner?regprof=Psychologist
Note: Support for _id is mandatory for a responder and optional for a requester. Where the expectation for a search parameter differs between actors, the table below will reflect the stronger conformance requirement.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| _id | SHOULD | token |
|
| identifier (R4) | SHOULD | token |
Use this parameter to search identifiers such as HPI-I using system|value or value or system format. **note** This does NOT work on identifiers nested within the qualification data element. |
| identifier-r5 | SHOULD | token |
Search by any identifier, i.e AHPRA, HPI-I or PRN. R5-style identifier search across Practitioner.identifier and Practitioner.qualification.identifier |
| name (R4) | SHOULD | string |
Search by practitioner's name across all name types (official, preferred, etc.). Standard FHIR R4 search parameter. |
| active (R4) | SHOULD | token |
|
| suppressed | SHOULD | token |
|
| regprof | SHOULD | string |
Search by registered profession using string values in `qualification.code.text`. |
| identifier-r5+rsg | SHOULD | token+token |
|
| name+rsg | SHOULD | string+token |
|
| identifier-r5+rsg | SHOULD | token+token |
Search by any identifier and recorded sex or gender |
| regprof+rsg | SHOULD | string+token |
Search by registered profession and recorded sex/gender |
This implementation supports the following _revinclude parameters when searching for Practitioner resources:
_revinclude=PractitionerRole:practitioner - Include PractitionerRole resources that reference this Practitioner_revinclude=Provenance:target - Include Provenance resources that track changes to this PractitionerGET /Practitioner?_revinclude=PractitionerRole:practitioner
This query returns all Practitioner resources and their associated roles and positions.
GET /Practitioner?_revinclude=PractitionerRole:practitioner
This query returns all Practitioner resources and their associated roles and positions.
IG © 2026+ Australian Digital Health Agency. Package au.gov.digitalhealth.fhir.hcpd#26.0.0 based on FHIR 4.0.1. Generated 2026-11-03
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
