Provider Connect Australia (PCA)

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

Usage Notes

Preferred name

In addition to the practitioner's legal name (use = 'offical'), another instance of the name element (with use = 'usual') may record the practitioner's preferred name.

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	AUCorePractitioner	A person with a formal responsibility in the provisioning of services Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:individualPronouns		0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:recordedSexOrGender	C	0..*	(Complex)	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension: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
extension:pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
extension: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	SOΣ	0..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier for the person as this agent Slice: Unordered, Closed by pattern:type, value:system
identifier:hpii	SOΣ	0..1	AUHPII	An identifier for the person as this agent
identifier:ahpraregistrationnumber	SOΣ	0..*	AUAhpraRegistrationNumber	Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
identifier:pca-pi	SOΣ	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	SOΣ	1..*	HumanName	The name(s) associated with the practitioner
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SOΣ	1..1	string	Family name (often called 'Surname')
given	SOΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
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..*	Extension	Ahpra Registration 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	Status	Usage	ValueSet	Version	Source
Practitioner.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Practitioner.qualification.​code	Base	preferred	hl7VS-degreeLicenseCertificate - AU Extended	📦6.0.0-ballot	AU Base Implementation Guide v6.0

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Practitioner	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Practitioner	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Practitioner	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-pra-0	warning	Practitioner	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pra-1	warning	Practitioner	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pra-2	warning	Practitioner	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pra-3	warning	Practitioner	Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-document-type'))
inv-pra-4	warning	Practitioner	Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))

This structure is derived from AUCorePractitioner

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner		0..*	AUCorePractitioner	A person with a formal responsibility in the provisioning of services
Slices for extension				Content/Rules for all slices
extension: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
extension:pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
extension: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 for the person as this agent Slice: Unordered, Closed by pattern:type, value:system
identifier:hpii	S	0..1	AUHPII	An identifier for the person as this agent
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..*	Extension	Ahpra Registration Details
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	AUCorePractitioner	A person with a formal responsibility in the provisioning of services Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:individualPronouns		0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:recordedSexOrGender	C	0..*	(Complex)	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension: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
extension:pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
extension: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	SOΣ	0..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier for the person as this agent Slice: Unordered, Closed by pattern:type, value:system
identifier:hpii	SOΣ	0..1	AUHPII	An identifier for the person as this agent
identifier:ahpraregistrationnumber	SOΣ	0..*	AUAhpraRegistrationNumber	Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
identifier:pca-pi	SOΣ	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	SOΣ	1..*	HumanName	The name(s) associated with the practitioner
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SOΣ	1..1	string	Family name (often called 'Surname')
given	SOΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	PractitionerPersonalContactDetails	Personal contact point (i.e. phone or email)
address	Σ	0..*	Address, AustralianAddress	Address(es) of the practitioner that are not role specific (typically home address)
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	S	0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ahpraRegistration-details		0..*	Extension	Ahpra Registration Details
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..*	Identifier	An identifier for this qualification for the practitioner
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	Status	Usage	ValueSet	Version	Source
Practitioner.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Practitioner.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Practitioner.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Practitioner.qualification.​code	Base	preferred	hl7VS-degreeLicenseCertificate - AU Extended	📦6.0.0-ballot	AU Base Implementation Guide v6.0
Practitioner.communication	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.ontoserver.csiro.au

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Practitioner	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Practitioner	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Practitioner	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-pra-0	warning	Practitioner	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pra-1	warning	Practitioner	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pra-2	warning	Practitioner	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pra-3	warning	Practitioner	Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-document-type'))
inv-pra-4	warning	Practitioner	Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	AUCorePractitioner	A person with a formal responsibility in the provisioning of services Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:individualPronouns		0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:recordedSexOrGender	C	0..*	(Complex)	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension: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
extension:pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
extension: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	SOΣ	0..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier for the person as this agent Slice: Unordered, Closed by pattern:type, value:system
identifier:hpii	SOΣ	0..1	AUHPII	An identifier for the person as this agent
identifier:ahpraregistrationnumber	SOΣ	0..*	AUAhpraRegistrationNumber	Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
identifier:pca-pi	SOΣ	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	SOΣ	1..*	HumanName	The name(s) associated with the practitioner
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SOΣ	1..1	string	Family name (often called 'Surname')
given	SOΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
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..*	Extension	Ahpra Registration 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	Status	Usage	ValueSet	Version	Source
Practitioner.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Practitioner.qualification.​code	Base	preferred	hl7VS-degreeLicenseCertificate - AU Extended	📦6.0.0-ballot	AU Base Implementation Guide v6.0

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Practitioner	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Practitioner	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Practitioner	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-pra-0	warning	Practitioner	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pra-1	warning	Practitioner	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pra-2	warning	Practitioner	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pra-3	warning	Practitioner	Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-document-type'))
inv-pra-4	warning	Practitioner	Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))

Differential View

This structure is derived from AUCorePractitioner

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner		0..*	AUCorePractitioner	A person with a formal responsibility in the provisioning of services
Slices for extension				Content/Rules for all slices
extension: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
extension:pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
extension: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 for the person as this agent Slice: Unordered, Closed by pattern:type, value:system
identifier:hpii	S	0..1	AUHPII	An identifier for the person as this agent
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..*	Extension	Ahpra Registration Details
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	AUCorePractitioner	A person with a formal responsibility in the provisioning of services Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:genderIdentity	C	0..*	(Complex)	Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:individualPronouns		0..*	(Complex)	Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:recordedSexOrGender	C	0..*	(Complex)	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension: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
extension:pca-bank-account	S	0..*	(Complex)	Bank account details URL: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-bank-account
extension: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	SOΣ	0..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier for the person as this agent Slice: Unordered, Closed by pattern:type, value:system
identifier:hpii	SOΣ	0..1	AUHPII	An identifier for the person as this agent
identifier:ahpraregistrationnumber	SOΣ	0..*	AUAhpraRegistrationNumber	Australian Health Practitioner Regulation Agency (Ahpra) Registration Number
identifier:pca-pi	SOΣ	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	SOΣ	1..*	HumanName	The name(s) associated with the practitioner
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SOΣ	1..1	string	Family name (often called 'Surname')
given	SOΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	PractitionerPersonalContactDetails	Personal contact point (i.e. phone or email)
address	Σ	0..*	Address, AustralianAddress	Address(es) of the practitioner that are not role specific (typically home address)
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	S	0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ahpraRegistration-details		0..*	Extension	Ahpra Registration Details
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..*	Identifier	An identifier for this qualification for the practitioner
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	Status	Usage	ValueSet	Version	Source
Practitioner.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Practitioner.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Practitioner.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Practitioner.qualification.​code	Base	preferred	hl7VS-degreeLicenseCertificate - AU Extended	📦6.0.0-ballot	AU Base Implementation Guide v6.0
Practitioner.communication	Base	extensible	Common Languages in Australia	⏿2.2.1	tx.ontoserver.csiro.au

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Practitioner	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Practitioner	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Practitioner	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Practitioner	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
inv-pra-0	warning	Practitioner	Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))
inv-pra-1	warning	Practitioner	Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))
inv-pra-2	warning	Practitioner	Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))
inv-pra-3	warning	Practitioner	Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-document-type'))
inv-pra-4	warning	Practitioner	Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))

This structure is derived from AUCorePractitioner

Summary

Mandatory: 1 element
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 2 is sliced based on the values of Practitioner.identifier (Closed)

No additional search parameters defined for this resource profile.