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:

• Practitioner: PCA Active In System Of Record
• Practitioner: PCA Bank Account
• Practitioner: PCA Credential Documents

Supported interactions

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

• For publishing systems: PCA Publisher Agent
• For subscribing systems: PCA Subscriber Agent

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from AUBasePractitioner

Name	Flags	Card.	Type	Description & Constraints
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
name	S	1..*	HumanName	The name(s) associated with the practitioner
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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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
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.
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.qualification.code	preferred	Hl7VSDegreeLicenseCertificateAUExtended http://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	Σ	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. Additional Bindings Purpose AllLanguages Max Binding
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Practitioner.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Practitioner.qualification.code	preferred	Hl7VSDegreeLicenseCertificateAUExtended http://terminology.hl7.org.au/ValueSet/v2-0360-extended
Practitioner.communication	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir

Differential View

This structure is derived from AUBasePractitioner

Name	Flags	Card.	Type	Description & Constraints
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
name	S	1..*	HumanName	The name(s) associated with the practitioner
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
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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
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.
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.qualification.code	preferred	Hl7VSDegreeLicenseCertificateAUExtended http://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	Σ	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. Additional Bindings Purpose AllLanguages Max Binding
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Practitioner.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Practitioner.qualification.code	preferred	Hl7VSDegreeLicenseCertificateAUExtended http://terminology.hl7.org.au/ValueSet/v2-0360-extended
Practitioner.communication	extensible	CommonLanguagesInAustralia https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 from https://tx.ontoserver.csiro.au/fhir

This structure is derived from AUBasePractitioner

Summary

Mandatory: 2 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

• AU HPI-I (http://hl7.org.au/fhir/StructureDefinition/au-hpii)
• AU Ahpra Registration Number (http://hl7.org.au/fhir/StructureDefinition/au-ahpraregistrationnumber)
• PCA Practitioner Identifier (PCA-PI) (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-identifier)
• Practitioner Personal Contact Details (http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-personal-contact-details)

Extensions

This structure refers to these extensions:

• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-active-in-system-of-record
• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
• http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-credential-documents

Slices

This structure defines the following Slices:

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

No additional search parameters defined for this resource profile.