Provider Connect Australia (PCA)
2.4.3 - active Australia flag

Provider Connect Australia (PCA) - Local Development build (v2.4.3) 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: 2.4.3
Active as of 2024-03-19 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 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.

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..*AUBasePractitionerA practitioner in an Australian healthcare context
... id S0..1idLogical id of this artifact
... meta S0..1MetaMetadata about the resource
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantWhen the resource version last changed
... pca-active-in-system-of-record S0..*(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
.... identifier:hpii S0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
.... identifier:ahpraregistrationnumber S0..*AUAhpraRegistrationNumberAustralian Health Practitioner Regulation Agency (Ahpra) Registration Number
.... identifier:pca-pi S0..1PcaPractitionerIdentifierPCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active S1..1booleanWhether this practitioner's record is in active use
... name S1..*HumanNameThe name(s) associated with the practitioner
... qualification S0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... extension:ahpraRegistration-details 0..1AhpraRegistrationDetailsAhpra Registration Details

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA practitioner in an Australian healthcare context
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumberAn identifier intended for computation
Slice: Unordered, Closed by value:system
.... identifier:hpii SC0..1AUHPIIHealthcare 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 SC0..*AUAhpraRegistrationNumberAustralian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
.... identifier:pca-pi S0..1PcaPractitionerIdentifierPCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active SΣ1..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
... qualification SC0..*BackboneElementCertification, 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
.... 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
.... code 1..1CodeableConceptCoded 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..*AUBasePractitionerA practitioner in an Australian healthcare context
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-active-in-system-of-record S0..*(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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumberAn identifier intended for computation
Slice: Unordered, Closed by value:system
.... identifier:hpii SC0..1AUHPIIHealthcare 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 SC0..*AUAhpraRegistrationNumberAustralian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
.... identifier:pca-pi S0..1PcaPractitionerIdentifierPCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active SΣ1..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address 0..*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
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..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 0..*Identifier, AUAhpraRegistrationNumberAn identifier intended for computation
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner can use in patient communication
Binding: Common Languages in Australia . (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Practitioner.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
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

This structure is derived from AUBasePractitioner

Summary

Mandatory: 2 elements
Must-Support: 11 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of value:system (Closed)

Differential View

This structure is derived from AUBasePractitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA practitioner in an Australian healthcare context
... id S0..1idLogical id of this artifact
... meta S0..1MetaMetadata about the resource
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantWhen the resource version last changed
... pca-active-in-system-of-record S0..*(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
.... identifier:hpii S0..1AUHPIIHealthcare Provider Identifier – Individual (HPI-I)
.... identifier:ahpraregistrationnumber S0..*AUAhpraRegistrationNumberAustralian Health Practitioner Regulation Agency (Ahpra) Registration Number
.... identifier:pca-pi S0..1PcaPractitionerIdentifierPCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active S1..1booleanWhether this practitioner's record is in active use
... name S1..*HumanNameThe name(s) associated with the practitioner
... qualification S0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... extension:ahpraRegistration-details 0..1AhpraRegistrationDetailsAhpra Registration Details

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*AUBasePractitionerA practitioner in an Australian healthcare context
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumberAn identifier intended for computation
Slice: Unordered, Closed by value:system
.... identifier:hpii SC0..1AUHPIIHealthcare 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 SC0..*AUAhpraRegistrationNumberAustralian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
.... identifier:pca-pi S0..1PcaPractitionerIdentifierPCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active SΣ1..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
... qualification SC0..*BackboneElementCertification, 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
.... 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
.... code 1..1CodeableConceptCoded 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..*AUBasePractitionerA practitioner in an Australian healthcare context
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pca-active-in-system-of-record S0..*(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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumberAn identifier intended for computation
Slice: Unordered, Closed by value:system
.... identifier:hpii SC0..1AUHPIIHealthcare 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 SC0..*AUAhpraRegistrationNumberAustralian Health Practitioner Regulation Agency (Ahpra) Registration Number
inv-ahpra-0: Ahpra identifier shall be 3 uppercase letters, followed by 10 digits
.... identifier:pca-pi S0..1PcaPractitionerIdentifierPCA Practitioner Identifier (PCA-PI) issued by the PCA service
... active SΣ1..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address 0..*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
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..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 0..*Identifier, AUAhpraRegistrationNumberAn identifier intended for computation
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: hl7VS-degreeLicenseCertificate - AU Extended (preferred)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner can use in patient communication
Binding: Common Languages in Australia . (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Practitioner.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
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

This structure is derived from AUBasePractitioner

Summary

Mandatory: 2 elements
Must-Support: 11 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of value:system (Closed)

 

Other representations of profile: CSV, Excel, Schematron

Notes:

No additional search parameters defined for this resource profile.