Provider Connect Australia (PCA) - Local Development build (v24.2.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PCA Practitioner

Official URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner Version: 24.2.0.1
Active as of 2024-11-25 Computable Name: PcaPractitioner

Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This profile of Practitioner defines a practitioner, in an Australian healthcare context, as supported by the Provider Connect Australia (PCA) service.

Must support

The meaning of the presence or absence of the must support flag is described in Must support, except for the following elements:

  • For the qualification.ahpraRegistration-details element. When a Practitioner is provided to a publishing or subscribing system the ahpraRegistration-details.ahpraProfession element is populated from the Ahpra Register of Practitioners.
  • For the pca-bank-account extension: any values provided by publishing systems when adding or updating a PCA Practitioner will be ignored by the PCA service. Bank account details must be managed by a practitioner via the PCA Portal. The PCA service will populate the extension when providing the PCA Practitioner resource to subscribing systems.
  • For the pca-practitioner-personal-contact-details extension: any values provided by publishing systems when adding or updating a PCA Practitioner will be ignored by the PCA service. Personal contact details must be managed by a healthcare provider organisation via the PCA Portal. The PCA service will populate the perosnal contact details when providing the PCA Practitioner resource to subscribing systems.
  • For the pca-credential-documents extension: any values provided by publishing systems when adding or updating a PCA Practitioner will be ignored by the PCA service. Credential documents details must be managed by a healthcare provider organisation via the PCA Portal. The PCA service will populate the credential documents details when providing the PCA Practitioner resource to subscribing systems.

Extensions

Extensions introduced in this profile:

Supported interactions

Supported service interactions for this profile are defined in the following capability statements:

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..* AUBasePractitioner A practitioner in an Australian healthcare context
... Slices for extension Content/Rules for all slices
.... pca-active-in-system-of-record S 0..* (Complex) Whether this practitioner's record is active in a system of record (Ahpra, HI Service)
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-in-system-of-record
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-credential-documents S 0..* (Complex) Credential Documents
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-credential-documents
... Slices for identifier 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier intended for computation
Slice: Unordered, Closed by value:system
.... identifier:hpii S 0..1 AUHPII Healthcare Provider Identifier – Individual (HPI-I)
.... identifier:ahpraregistrationnumber S 0..* AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
.... identifier:pca-pi S 0..1 PcaPractitionerIdentifier PCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active S 1..1 boolean Whether this practitioner's record is in active use
... telecom S 0..* PractitionerPersonalContactDetails Personal contact point (i.e. phone or email)
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... Slices for extension Content/Rules for all slices
..... extension:ahpraRegistration-details 0..1 AhpraRegistrationDetails Ahpra Registration Details

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* AUBasePractitioner A practitioner in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... pca-active-in-system-of-record S 0..* (Complex) Whether this practitioner's record is active in a system of record (Ahpra, HI Service)
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-in-system-of-record
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-credential-documents S 0..* (Complex) Credential Documents
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-credential-documents
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:hpii SC 0..1 AUHPII Healthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
.... identifier:ahpraregistrationnumber SC 0..* AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
.... identifier:pca-pi S 0..1 PcaPractitionerIdentifier PCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
... telecom SC 0..* PractitionerPersonalContactDetails Personal contact point (i.e. phone or email)
cpt-2: A system is required if a value is provided.
... qualification SC 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 Content/Rules for all slices
..... 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
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
http://terminology.hl7.org.au/ValueSet/v2-0360-extended
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* AUBasePractitioner A practitioner in an Australian healthcare context
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... pca-active-in-system-of-record S 0..* (Complex) Whether this practitioner's record is active in a system of record (Ahpra, HI Service)
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-in-system-of-record
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-credential-documents S 0..* (Complex) Credential Documents
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-credential-documents
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier intended for computation
Slice: Unordered, Closed by value:system
.... identifier:hpii SC 0..1 AUHPII Healthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
.... identifier:ahpraregistrationnumber SC 0..* AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
.... identifier:pca-pi S 0..1 PcaPractitionerIdentifier PCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
... telecom SC 0..* PractitionerPersonalContactDetails Personal contact point (i.e. phone or email)
cpt-2: A system is required if a value is provided.
... 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 SC 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: Common Languages in Australia . (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
http://terminology.hl7.org.au/ValueSet/v2-0360-extended
Practitioner.communicationextensibleCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

Differential View

This structure is derived from AUBasePractitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* AUBasePractitioner A practitioner in an Australian healthcare context
... Slices for extension Content/Rules for all slices
.... pca-active-in-system-of-record S 0..* (Complex) Whether this practitioner's record is active in a system of record (Ahpra, HI Service)
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-in-system-of-record
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-credential-documents S 0..* (Complex) Credential Documents
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-credential-documents
... Slices for identifier 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier intended for computation
Slice: Unordered, Closed by value:system
.... identifier:hpii S 0..1 AUHPII Healthcare Provider Identifier – Individual (HPI-I)
.... identifier:ahpraregistrationnumber S 0..* AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
.... identifier:pca-pi S 0..1 PcaPractitionerIdentifier PCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active S 1..1 boolean Whether this practitioner's record is in active use
... telecom S 0..* PractitionerPersonalContactDetails Personal contact point (i.e. phone or email)
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... Slices for extension Content/Rules for all slices
..... extension:ahpraRegistration-details 0..1 AhpraRegistrationDetails Ahpra Registration Details

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* AUBasePractitioner A practitioner in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... pca-active-in-system-of-record S 0..* (Complex) Whether this practitioner's record is active in a system of record (Ahpra, HI Service)
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-in-system-of-record
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-credential-documents S 0..* (Complex) Credential Documents
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-credential-documents
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:hpii SC 0..1 AUHPII Healthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
.... identifier:ahpraregistrationnumber SC 0..* AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
.... identifier:pca-pi S 0..1 PcaPractitionerIdentifier PCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
... telecom SC 0..* PractitionerPersonalContactDetails Personal contact point (i.e. phone or email)
cpt-2: A system is required if a value is provided.
... qualification SC 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 Content/Rules for all slices
..... 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
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
http://terminology.hl7.org.au/ValueSet/v2-0360-extended

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* AUBasePractitioner A practitioner in an Australian healthcare context
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... pca-active-in-system-of-record S 0..* (Complex) Whether this practitioner's record is active in a system of record (Ahpra, HI Service)
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-in-system-of-record
.... pca-bank-account S 0..* (Complex) Bank account details
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
.... pca-credential-documents S 0..* (Complex) Credential Documents
URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-credential-documents
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier 0..* Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber An identifier intended for computation
Slice: Unordered, Closed by value:system
.... identifier:hpii SC 0..1 AUHPII Healthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
.... identifier:ahpraregistrationnumber SC 0..* AUAhpraRegistrationNumber Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
.... identifier:pca-pi S 0..1 PcaPractitionerIdentifier PCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
... telecom SC 0..* PractitionerPersonalContactDetails Personal contact point (i.e. phone or email)
cpt-2: A system is required if a value is provided.
... 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 SC 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: Common Languages in Australia . (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codepreferredHl7VSDegreeLicenseCertificateAUExtended
http://terminology.hl7.org.au/ValueSet/v2-0360-extended
Practitioner.communicationextensibleCommonLanguagesInAustralia .
https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2

 

Other representations of profile: CSV, Excel, Schematron

Notes:

No additional search parameters defined for this resource profile.