AU Core Implementation Guide
0.2.0-preview - QA Preview Australia flag

This page is part of the Australian Core IG (v0.2.0-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Practitioner

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner Version: 0.2.0-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUCorePractitioner

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Practitioner resource to record, search, and fetch basic demographics and other administrative information about an individual practitioner. It is based on the AU Base Practitioner profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Practitioner when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Record or update information about a practitioner referenced by another resource
  • Read information about a practitioner referenced by another resource

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • When constructing an address
    • an international address can be represented using the core Address data type
    • an Australian address SHOULD be represented using the Australian Address data type profile
  • Because PractitionerRole supplies a provider’s location, contact information, and reference to the Practitioner, it SHOULD be referenced in CareTeam.member instead of the a Practitioner resource. If a system only supports Practitioner, the system SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.
  • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBasePractitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA person with a formal responsibility in the provisioning of services
... Slices for identifier S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumberAn identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:hpii S0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
... active 0..1booleanWhether this practitioner's record is in active use
Fixed Value: true
... name SC1..*HumanNameThe name(s) associated with the practitioner
au-core-prac-01: At least text or family name shall be present
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... qualification S0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... identifier S0..*Identifier, AUAhpraRegistrationNumberAn identifier intended for computation
.... code S1..1CodeableConceptCoded representation of the qualification
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-prac-01errorPractitioner.nameAt least text or family name shall be present
: text.exists() or family.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA person with a formal responsibility in the provisioning of services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumberAn identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:hpii SC0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
... name SΣC1..*HumanNameThe name(s) associated with the practitioner
au-core-prac-01: At least text or family name shall be present
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... qualification SC0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... 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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*Identifier, AUAhpraRegistrationNumberAn identifier intended for computation
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
Practitioner.communicationextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

IdGradePath(s)DetailsRequirements
au-core-prac-01errorPractitioner.nameAt least text or family name shall be present
: text.exists() or family.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA person with a formal responsibility in the provisioning of services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumberAn identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:hpii SC0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
... active Σ0..1booleanWhether this practitioner's record is in active use
Fixed Value: true
... name SΣC1..*HumanNameThe name(s) associated with the practitioner
au-core-prac-01: At least text or family name shall be present
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification SC0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*Identifier, AUAhpraRegistrationNumberAn identifier intended for computation
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
Practitioner.communicationextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

IdGradePath(s)DetailsRequirements
au-core-prac-01errorPractitioner.nameAt least text or family name shall be present
: text.exists() or family.exists()

This structure is derived from AUBasePractitioner

Summary

Mandatory: 1 element
Must-Support: 11 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of pattern:type

Maturity: 0

Differential View

This structure is derived from AUBasePractitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA person with a formal responsibility in the provisioning of services
... Slices for identifier S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumberAn identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:hpii S0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
... active 0..1booleanWhether this practitioner's record is in active use
Fixed Value: true
... name SC1..*HumanNameThe name(s) associated with the practitioner
au-core-prac-01: At least text or family name shall be present
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... qualification S0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... identifier S0..*Identifier, AUAhpraRegistrationNumberAn identifier intended for computation
.... code S1..1CodeableConceptCoded representation of the qualification
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-prac-01errorPractitioner.nameAt least text or family name shall be present
: text.exists() or family.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA person with a formal responsibility in the provisioning of services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumberAn identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:hpii SC0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
... name SΣC1..*HumanNameThe name(s) associated with the practitioner
au-core-prac-01: At least text or family name shall be present
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... qualification SC0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... 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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*Identifier, AUAhpraRegistrationNumberAn identifier intended for computation
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
Practitioner.communicationextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

IdGradePath(s)DetailsRequirements
au-core-prac-01errorPractitioner.nameAt least text or family name shall be present
: text.exists() or family.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA person with a formal responsibility in the provisioning of services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumberAn identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:hpii SC0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
... active Σ0..1booleanWhether this practitioner's record is in active use
Fixed Value: true
... name SΣC1..*HumanNameThe name(s) associated with the practitioner
au-core-prac-01: At least text or family name shall be present
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address S0..*Address, AustralianAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification SC0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*Identifier, AUAhpraRegistrationNumberAn identifier intended for computation
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S0..1Reference(Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
Practitioner.communicationextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Constraints

IdGradePath(s)DetailsRequirements
au-core-prac-01errorPractitioner.nameAt least text or family name shall be present
: text.exists() or family.exists()

This structure is derived from AUBasePractitioner

Summary

Mandatory: 1 element
Must-Support: 11 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of pattern:type

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
identifier SHALL token The client SHALL provide at least a code value and SHOULD provide both the system and code values. The server SHALL support both.

The client SHOULD support search using a HPI-I identifier as defined in the profile. The server SHOULD support search using the using a HPI-I identifier as defined in the profile.
_id SHOULD token
name SHOULD string

Mandatory Search Parameters

The following search parameters SHALL be supported:

  1. SHALL support searching a practitioner by an identifier using the identifier search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/Practitioner?identifier={system|}[code]

    Example:

    1. GET [base]/Practitioner?identifier=http://ns.electronichealth.net.au/id/hi/hpii/1.0|8003619900015717
    2. GET [base]/Practitioner?identifier=http://ns.electronichealth.net.au/id/medicare-prescriber-number|553255

    Implementation Notes: Fetches a bundle containing any Practitioner resources matching the identifier (how to search by token)

Optional Search Parameters:

The following search parameters SHOULD be supported:

  1. SHOULD support fetching a Practitioner using the _id search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/Practitioner/[id] or GET [base]/Practitioner?_id=[id]

    Example:

    1. GET [base]/Practitioner/5678
    2. GET [base]/Practitioner?_id=5678

    Implementation Notes: Returns a single Practitioner resource. (how to search by the logical id of the resource)

  2. SHOULD support searching for a practitioner based on text name using the name search parameter:
    • SHALL support these _revinclude parameters: Provenance:target

    GET [base]/Practitioner?name=[string]

    Example:

    1. GET [base]/Practitioner?name=Sandyson
    2. GET [base]/Practitioner?name=Sandyson&_revinclude=Provenance:target

    Implementation Notes: Fetches a bundle of all Practitioner resources matching the name (how to search by string)