Usage Notes

Profile specific implementation guidance:

At least one of the following defined identifier types, known to this profile, SHALL be supplied:

• AU HPI-I
• AU PBS Prescriber Number
• AU Care Agency Employee Identifier
• AU Ahpra Registration Number

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

This structure is derived from AUBasePractitioner

Name	Flags	Card.	Type	Description & Constraints
Practitioner	CTU	0..*	AUBasePractitioner	Australian Practitioner Directory Entry au-pd-prac-01: At least one defined identifier, known to this AU PD Practitioner profile, must be present
meta		0..1	Meta	Metadata on Practitioner
source	S	0..1	uri	Identifies where the resource comes from
Slices for identifier	S	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
identifier:hpii	S	0..*	AUHPII	HPI-I for Directory Entry Practitioner
active	S	1..1	boolean	Required status
Slices for name		1..*	HumanName	The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use
name:directory-practitioner-name	S	1..*	HumanName	Usual practitioner name
use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Fixed Value: usual
family		1..1	string	Family name (often called 'Surname')
given		1..*	string	Given names (not always 'first'). Includes middle names
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
au-pd-prac-01	error	Practitioner	At least one defined identifier, known to this AU PD Practitioner profile, must be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpii/1.0' or system='http://ns.electronichealth.net.au/id/medicare-prescriber-number' or system='http://ns.electronichealth.net.au/id/pcehr/caei/1.0' or system='http://hl7.org.au/id/ahpra-registration-number').exists()

Name	Flags	Card.	Type	Description & Constraints
Practitioner	C	0..*	AUBasePractitioner	Australian Practitioner Directory Entry au-pd-prac-01: At least one defined identifier, known to this AU PD Practitioner profile, must be present
meta	Σ	0..1	Meta	Metadata on Practitioner
source	SΣ	0..1	uri	Identifies where the resource comes from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
identifier:hpii	SC	0..*	AUHPII	HPI-I for Directory Entry Practitioner 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	SΣ	1..1	boolean	Required status
Slices for name	Σ	1..*	HumanName	The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use
name:directory-practitioner-name	SΣ	1..*	HumanName	Usual practitioner name
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Practitioner.name:directory-practitioner-name.use	required	Fixed Value: usual http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
au-pd-prac-01	error	Practitioner	At least one defined identifier, known to this AU PD Practitioner profile, must be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpii/1.0' or system='http://ns.electronichealth.net.au/id/medicare-prescriber-number' or system='http://ns.electronichealth.net.au/id/pcehr/caei/1.0' or system='http://hl7.org.au/id/ahpra-registration-number').exists()

Name	Flags	Card.	Type	Description & Constraints
Practitioner	C	0..*	AUBasePractitioner	Australian Practitioner Directory Entry au-pd-prac-01: At least one defined identifier, known to this AU PD Practitioner profile, must be present
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata on 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
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
identifier:hpii	SC	0..*	AUHPII	HPI-I for Directory Entry Practitioner 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	SΣ	1..1	boolean	Required status
Slices for name	Σ	1..*	HumanName	The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use
name:directory-practitioner-name	SΣ	1..*	HumanName	Usual practitioner name
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	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..*	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		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		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 / Code	URI
Practitioner.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Practitioner.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Practitioner.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Practitioner.name:directory-practitioner-name.use	required	Fixed Value: usual 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
au-pd-prac-01	error	Practitioner	At least one defined identifier, known to this AU PD Practitioner profile, must be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpii/1.0' or system='http://ns.electronichealth.net.au/id/medicare-prescriber-number' or system='http://ns.electronichealth.net.au/id/pcehr/caei/1.0' or system='http://hl7.org.au/id/ahpra-registration-number').exists()

Differential View

This structure is derived from AUBasePractitioner

Name	Flags	Card.	Type	Description & Constraints
Practitioner	CTU	0..*	AUBasePractitioner	Australian Practitioner Directory Entry au-pd-prac-01: At least one defined identifier, known to this AU PD Practitioner profile, must be present
meta		0..1	Meta	Metadata on Practitioner
source	S	0..1	uri	Identifies where the resource comes from
Slices for identifier	S	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
identifier:hpii	S	0..*	AUHPII	HPI-I for Directory Entry Practitioner
active	S	1..1	boolean	Required status
Slices for name		1..*	HumanName	The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use
name:directory-practitioner-name	S	1..*	HumanName	Usual practitioner name
use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Fixed Value: usual
family		1..1	string	Family name (often called 'Surname')
given		1..*	string	Given names (not always 'first'). Includes middle names
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
au-pd-prac-01	error	Practitioner	At least one defined identifier, known to this AU PD Practitioner profile, must be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpii/1.0' or system='http://ns.electronichealth.net.au/id/medicare-prescriber-number' or system='http://ns.electronichealth.net.au/id/pcehr/caei/1.0' or system='http://hl7.org.au/id/ahpra-registration-number').exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Practitioner	C	0..*	AUBasePractitioner	Australian Practitioner Directory Entry au-pd-prac-01: At least one defined identifier, known to this AU PD Practitioner profile, must be present
meta	Σ	0..1	Meta	Metadata on Practitioner
source	SΣ	0..1	uri	Identifies where the resource comes from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
identifier:hpii	SC	0..*	AUHPII	HPI-I for Directory Entry Practitioner 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	SΣ	1..1	boolean	Required status
Slices for name	Σ	1..*	HumanName	The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use
name:directory-practitioner-name	SΣ	1..*	HumanName	Usual practitioner name
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Practitioner.name:directory-practitioner-name.use	required	Fixed Value: usual http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
au-pd-prac-01	error	Practitioner	At least one defined identifier, known to this AU PD Practitioner profile, must be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpii/1.0' or system='http://ns.electronichealth.net.au/id/medicare-prescriber-number' or system='http://ns.electronichealth.net.au/id/pcehr/caei/1.0' or system='http://hl7.org.au/id/ahpra-registration-number').exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Practitioner	C	0..*	AUBasePractitioner	Australian Practitioner Directory Entry au-pd-prac-01: At least one defined identifier, known to this AU PD Practitioner profile, must be present
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata on 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
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	An identifier intended for computation Slice: Unordered, Open by pattern:type
identifier:hpii	SC	0..*	AUHPII	HPI-I for Directory Entry Practitioner 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	SΣ	1..1	boolean	Required status
Slices for name	Σ	1..*	HumanName	The name(s) associated with the practitioner Slice: Unordered, Open At End by value:use
name:directory-practitioner-name	SΣ	1..*	HumanName	Usual practitioner name
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	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: usual
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..*	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		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		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 / Code	URI
Practitioner.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Practitioner.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Practitioner.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Practitioner.name:directory-practitioner-name.use	required	Fixed Value: usual 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
au-pd-prac-01	error	Practitioner	At least one defined identifier, known to this AU PD Practitioner profile, must be present : identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpii/1.0' or system='http://ns.electronichealth.net.au/id/medicare-prescriber-number' or system='http://ns.electronichealth.net.au/id/pcehr/caei/1.0' or system='http://hl7.org.au/id/ahpra-registration-number').exists()

This structure is derived from AUBasePractitioner

Summary

Mandatory: 7 elements
Must-Support: 5 elements
Fixed: 1 element

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
• The element 1 is sliced based on the value of Practitioner.name (Open at End)

Maturity: 0

Read: Practitioner

Read identified practitioner resource content.

GET [base]/Practitioner/[id]

Example: GET [base]/Practitioner/1234

Support: MUST support read Practitioner

Implementation Notes: (how to read resource)

Search: Active Status

Search based on active status of the practitioner record.

GET [base]/Practitioner?active=[status]

Example: GET [base]/Practitioner?active=true

Support: MUST support search Practitioner by active status (true | false).

Implementation Notes: (how to search by token)

Search: Practitioner Name

Search based on family, given and/or any name.

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

GET [base]/Practitioner?family=[string]&given=[string]

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

Example:

GET [base]/Practitioner?family=Smith

GET [base]/Practitioner?family=Smith&practitioner.given=John

GET [base]/Practitioner?name=Smith

Support: SHOULD support search by family, given and name.

Implementation Notes: (how to search by string)

Search: HPI-I

Search based on identifier token.

GET [base]/Practitioner?identifier=[system]|[value]

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

Support: SHOULD support search by HPI-I.

Implementation Notes: (how to search by token)