Provider Connect Australia (PCA)
2.4.3 - active
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
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.
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 introduced in this profile:
Supported service interactions for this profile are defined in the following capability statements:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBasePractitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | AUBasePractitioner | A practitioner in an Australian healthcare context | |
id | S | 0..1 | id | Logical id of this artifact |
meta | S | 0..1 | Meta | Metadata about the resource |
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | When the resource version last changed |
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 |
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 |
name | S | 1..* | HumanName | The name(s) associated with the practitioner |
qualification | S | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care |
extension:ahpraRegistration-details | 0..1 | AhpraRegistrationDetails | Ahpra Registration Details | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | AUBasePractitioner | A practitioner in an Australian healthcare context | |
id | SΣ | 0..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
versionId | SΣ | 0..1 | id | Version specific identifier |
lastUpdated | SΣ | 0..1 | instant | When the resource version last changed |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
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 |
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 |
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 |
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) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0360-extended |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Practitioner | 0..* | AUBasePractitioner | A practitioner in an Australian healthcare context | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags 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..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
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 | ||||
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 | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
address | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 0..1 | date | The date on which the practitioner was born | ||||
photo | 0..* | Attachment | Image of the person | |||||
qualification | 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) | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Practitioner.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0360-extended | ||||
Practitioner.communication | extensible | CommonLanguagesInAustralia 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:
Differential View
This structure is derived from AUBasePractitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | AUBasePractitioner | A practitioner in an Australian healthcare context | |
id | S | 0..1 | id | Logical id of this artifact |
meta | S | 0..1 | Meta | Metadata about the resource |
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | When the resource version last changed |
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 |
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 |
name | S | 1..* | HumanName | The name(s) associated with the practitioner |
qualification | S | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care |
extension:ahpraRegistration-details | 0..1 | AhpraRegistrationDetails | Ahpra Registration Details | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | AUBasePractitioner | A practitioner in an Australian healthcare context | |
id | SΣ | 0..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
versionId | SΣ | 0..1 | id | Version specific identifier |
lastUpdated | SΣ | 0..1 | instant | When the resource version last changed |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
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 |
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 |
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 |
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) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0360-extended |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Practitioner | 0..* | AUBasePractitioner | A practitioner in an Australian healthcare context | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags 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..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
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 | ||||
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 | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
address | 0..* | Address, AustralianAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 0..1 | date | The date on which the practitioner was born | ||||
photo | 0..* | Attachment | Image of the person | |||||
qualification | 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) | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Practitioner.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Practitioner.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Practitioner.qualification.code | preferred | Hl7VSDegreeLicenseCertificateAUExtendedhttp://terminology.hl7.org.au/ValueSet/v2-0360-extended | ||||
Practitioner.communication | extensible | CommonLanguagesInAustralia 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:
Other representations of profile: CSV, Excel, Schematron
No additional search parameters defined for this resource profile.