Usage scenarios

The following are supported usage scenarios for this profile:

• Record or update information about a practitioner referenced by another resource
• Read information about a practitioner referenced by another resource

Comparison with other national and international IGs

A resource conforming to this profile is conformant to:

• IPA-Practitioner
• Practitioner (IPS)
• and MAY be conformant to US Core Practitioner if Practitioner.identifier is supplied

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

• Because PractitionerRole supplies a provider’s location, contact information, and reference to the Practitioner, it SHOULD be referenced in CareTeam.member instead of the Practitioner resource. If a system only supports Practitioner, the system SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.
• See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.

• 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 person with a formal responsibility in the provisioning of services
Slices for identifier	S	0..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
identifier:hpii	S	0..1	AUHPII	Healthcare Provider Identifier – Individual (HPI-I)
name	S	1..*	HumanName	The name(s) associated with the practitioner
family	S	1..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Practitioner	C	0..*	AUBasePractitioner	A person with a formal responsibility in the provisioning of services inv-pra-2: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pra-3: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
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
individualPronouns	C	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
recordedSexOrGender		0..*	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	0..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
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
name	SΣ	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	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	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
address	C	0..*	Address, AustralianAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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-hpii-0	error	Practitioner.identifier:hpii	HPI-I shall be 16 digits : value.matches('^([0-9]{16})$')
inv-hpii-1	error	Practitioner.identifier:hpii	HPI-I prefix shall be 800361 : value.startsWith('800361')
inv-hpii-2	error	Practitioner.identifier:hpii	HPI-I shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
inv-pra-2	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').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')
inv-pra-3	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').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')

Name	Flags	Card.	Type	Description & Constraints
Practitioner	C	0..*	AUBasePractitioner	A person with a formal responsibility in the provisioning of services inv-pra-2: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pra-3: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
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
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
individualPronouns	C	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
recordedSexOrGender		0..*	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	0..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
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
active	Σ	0..1	boolean	Whether this practitioner's record is in active use
name	SΣ	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	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	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	Σ	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
address	C	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	C	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	C	0..1	(Complex)	Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details
ahpraRegistration-details	C	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	C	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.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 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

Constraints

Id	Grade	Path(s)	Details	Requirements
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-hpii-0	error	Practitioner.identifier:hpii	HPI-I shall be 16 digits : value.matches('^([0-9]{16})$')
inv-hpii-1	error	Practitioner.identifier:hpii	HPI-I prefix shall be 800361 : value.startsWith('800361')
inv-hpii-2	error	Practitioner.identifier:hpii	HPI-I shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
inv-pra-0	error	Practitioner.qualification	A qualification shall only have Ahpra Profession details if the code is Ahpra Profession : extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists()
inv-pra-1	error	Practitioner.qualification	A qualification shall only have Ahpra Registration details if the code is Ahpra Registration : extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists()
inv-pra-2	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').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')
inv-pra-3	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').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')

Differential View

This structure is derived from AUBasePractitioner

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	AUBasePractitioner	A person with a formal responsibility in the provisioning of services
Slices for identifier	S	0..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
identifier:hpii	S	0..1	AUHPII	Healthcare Provider Identifier – Individual (HPI-I)
name	S	1..*	HumanName	The name(s) associated with the practitioner
family	S	1..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Practitioner	C	0..*	AUBasePractitioner	A person with a formal responsibility in the provisioning of services inv-pra-2: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pra-3: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
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
individualPronouns	C	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
recordedSexOrGender		0..*	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	0..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
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
name	SΣ	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	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	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
address	C	0..*	Address, AustralianAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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-hpii-0	error	Practitioner.identifier:hpii	HPI-I shall be 16 digits : value.matches('^([0-9]{16})$')
inv-hpii-1	error	Practitioner.identifier:hpii	HPI-I prefix shall be 800361 : value.startsWith('800361')
inv-hpii-2	error	Practitioner.identifier:hpii	HPI-I shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
inv-pra-2	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').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')
inv-pra-3	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').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Practitioner	C	0..*	AUBasePractitioner	A person with a formal responsibility in the provisioning of services inv-pra-2: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply inv-pra-3: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply
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
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
individualPronouns	C	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
recordedSexOrGender		0..*	(Complex)	A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	0..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
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
active	Σ	0..1	boolean	Whether this practitioner's record is in active use
name	SΣ	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	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	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	Σ	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
address	C	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	C	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	C	0..1	(Complex)	Ahpra Profession Details URL: http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details
ahpraRegistration-details	C	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	C	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.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 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

Constraints

Id	Grade	Path(s)	Details	Requirements
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-hpii-0	error	Practitioner.identifier:hpii	HPI-I shall be 16 digits : value.matches('^([0-9]{16})$')
inv-hpii-1	error	Practitioner.identifier:hpii	HPI-I prefix shall be 800361 : value.startsWith('800361')
inv-hpii-2	error	Practitioner.identifier:hpii	HPI-I shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
inv-pra-0	error	Practitioner.qualification	A qualification shall only have Ahpra Profession details if the code is Ahpra Profession : extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists()
inv-pra-1	error	Practitioner.qualification	A qualification shall only have Ahpra Registration details if the code is Ahpra Registration : extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists()
inv-pra-2	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').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')
inv-pra-3	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').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')

This structure is derived from AUBasePractitioner

Summary

Mandatory: 2 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

• AU HPI-I (http://hl7.org.au/fhir/StructureDefinition/au-hpii)

Slices

This structure defines the following Slices:

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

Maturity: 0

Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.

FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Mandatory Search Parameters

The following search parameters SHALL be supported:

1. SHALL support searching a practitioner by an identifier using the identifier search parameter:

   GET [base]/Practitioner?identifier={system|}[code]

   Example:

   1. GET [base]/Practitioner?identifier=http://ns.electronichealth.net.au/id/hi/hpii/1.0|8003619900015717

   Implementation Notes: Fetches a bundle containing any Practitioner resources matching the identifier (how to search by token)

Optional Search Parameters:

The following search parameters SHOULD be supported:

1. SHOULD support fetching a Practitioner using the _id search parameter:

   GET [base]/Practitioner/[id] or GET [base]/Practitioner?_id=[id]

   Example:

   1. GET [base]/Practitioner/5678
   2. GET [base]/Practitioner?_id=5678

   Implementation Notes: Returns a single Practitioner resource (how to search by the logical id of the resource)

2. SHOULD support searching for a practitioner based on text name using the name search parameter:

   GET [base]/Practitioner?name=[string]

   Example:

   1. GET [base]/Practitioner?name=Sandyson
   2. GET [base]/Practitioner?name=Sandyson&

   Implementation Notes: Fetches a bundle of all Practitioner resources matching the name (how to search by string)