Clinical Note Document

Clinical Note Document - Local Development build (v26.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON
• TTL

Resource Profile: CND Practitioner

This profile constrains AU Core Practitioner to meet the requirements of this Implementation Guide for a practitioner. Implementers are highly encouraged to review AU Core Practitioner profile before using this profile. This profile defines a practitioner, in a Clinical Note Document context.

This profile defines practitioner identification and demographic requirements for a Clinical Note Document in Australia, ensuring consistent capture of healthcare provider details including professional identifiers, qualifications, and contact information for clinical note authoring attribution.

Usages:

• Use this Profile: CND Bundle
• Refer to this Profile: CND PractitionerRole
• Examples for this Profile: Practitioner/ex-practitioner-helen

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	AUCorePractitioner	Clinical Note Document Practitioner Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5
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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣC	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	Healthcare provider's identifier Slice: Unordered, Open by pattern:type Constraints: inv-01-practitioner-identifier-length Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
identifier:hpii	SOΣ	0..1	AUHPII	An identifier for the person as this agent Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
name	SOΣ	1..*	HumanName	The name(s) associated with the practitioner Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core 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	Healthcare provider's family name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
given	SOΣ	0..*	string	Healthcare provider's given name This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
Slices for telecom	Σ	0..*	ContactPoint	Healthcare provider's electronic communication details Slice: Unordered, Open by value:use
telecom:workplaceCommunicationDetails	Σ	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work
Slices for address	Σ	0..*	Address, AustralianAddress	Healthcare provider's address Slice: Unordered, Open by value:use
address:workplaceAddress	Σ	0..*	Address, AustralianAddress	Address(es) of the practitioner that are not role specific (typically home address)
use	?!Σ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: work
qualification		0..*	BackboneElement	Healthcare provider's profession
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.telecom:workplaceCommunicationDetails.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Practitioner.address:workplaceAddress.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Practitioner.qualification.​code	Base	preferred	hl7VS-degreeLicenseCertificate - AU Extended	📦6.0.0	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-01-practitioner-identifier-length	error	Practitioner.identifier	Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters.	value.length() >= 1 and value.length() <= 20
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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pra-5	warning	Practitioner	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

This structure is derived from AUCorePractitioner

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner		0..*	AUCorePractitioner	Clinical Note Document Practitioner
identifier	C	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	Healthcare provider's identifier Constraints: inv-01-practitioner-identifier-length
name
family		1..1	string	Healthcare provider's family name
given		0..*	string	Healthcare provider's given name
Slices for telecom		0..*	ContactPoint	Healthcare provider's electronic communication details Slice: Unordered, Open by value:use
telecom:workplaceCommunicationDetails		0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Fixed Value: work
Slices for address		0..*	Address, AustralianAddress	Healthcare provider's address Slice: Unordered, Open by value:use
address:workplaceAddress		0..*	Address, AustralianAddress	Address(es) of the practitioner that are not role specific (typically home address)
use		1..1	code	home | work | temp | old | billing - purpose of this address Fixed Value: work
qualification		0..*	BackboneElement	Healthcare provider's profession
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
inv-01-practitioner-identifier-length	error	Practitioner.identifier	Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters.	value.length() >= 1 and value.length() <= 20

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	AUCorePractitioner	Clinical Note Document Practitioner Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5
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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣC	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	Healthcare provider's identifier Slice: Unordered, Open by pattern:type Constraints: inv-01-practitioner-identifier-length Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
identifier:hpii	SOΣ	0..1	AUHPII	An identifier for the person as this agent Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
active	Σ	0..1	boolean	Whether this practitioner's record is in active use
name	SOΣ	1..*	HumanName	The name(s) associated with the practitioner Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core 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	Healthcare provider's family name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
given	SOΣ	0..*	string	Healthcare provider's given name This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
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
Slices for telecom	Σ	0..*	ContactPoint	Healthcare provider's electronic communication details Slice: Unordered, Open by value:use
telecom:workplaceCommunicationDetails	Σ	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
Slices for address	Σ	0..*	Address, AustralianAddress	Healthcare provider's address Slice: Unordered, Open by value:use
address:workplaceAddress	Σ	0..*	Address, AustralianAddress	Address(es) of the practitioner that are not role specific (typically home address)
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: work
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
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		0..*	BackboneElement	Healthcare provider's profession
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
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.telecom:workplaceCommunicationDetails.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Practitioner.telecom:workplaceCommunicationDetails.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Practitioner.address:workplaceAddress.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Practitioner.address:workplaceAddress.​type	Base	required	AddressType	📍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	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-01-practitioner-identifier-length	error	Practitioner.identifier	Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters.	value.length() >= 1 and value.length() <= 20
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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pra-5	warning	Practitioner	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

This structure is derived from AUCorePractitioner

Summary

Mandatory: 1 element(2 nested mandatory elements)
Fixed: 2 elements

Slices

This structure defines the following Slices:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	AUCorePractitioner	Clinical Note Document Practitioner Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5
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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣC	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	Healthcare provider's identifier Slice: Unordered, Open by pattern:type Constraints: inv-01-practitioner-identifier-length Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
identifier:hpii	SOΣ	0..1	AUHPII	An identifier for the person as this agent Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
name	SOΣ	1..*	HumanName	The name(s) associated with the practitioner Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core 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	Healthcare provider's family name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
given	SOΣ	0..*	string	Healthcare provider's given name This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
Slices for telecom	Σ	0..*	ContactPoint	Healthcare provider's electronic communication details Slice: Unordered, Open by value:use
telecom:workplaceCommunicationDetails	Σ	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work
Slices for address	Σ	0..*	Address, AustralianAddress	Healthcare provider's address Slice: Unordered, Open by value:use
address:workplaceAddress	Σ	0..*	Address, AustralianAddress	Address(es) of the practitioner that are not role specific (typically home address)
use	?!Σ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: work
qualification		0..*	BackboneElement	Healthcare provider's profession
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.telecom:workplaceCommunicationDetails.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Practitioner.address:workplaceAddress.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Practitioner.qualification.​code	Base	preferred	hl7VS-degreeLicenseCertificate - AU Extended	📦6.0.0	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-01-practitioner-identifier-length	error	Practitioner.identifier	Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters.	value.length() >= 1 and value.length() <= 20
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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pra-5	warning	Practitioner	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

Differential View

This structure is derived from AUCorePractitioner

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner		0..*	AUCorePractitioner	Clinical Note Document Practitioner
identifier	C	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	Healthcare provider's identifier Constraints: inv-01-practitioner-identifier-length
name
family		1..1	string	Healthcare provider's family name
given		0..*	string	Healthcare provider's given name
Slices for telecom		0..*	ContactPoint	Healthcare provider's electronic communication details Slice: Unordered, Open by value:use
telecom:workplaceCommunicationDetails		0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Fixed Value: work
Slices for address		0..*	Address, AustralianAddress	Healthcare provider's address Slice: Unordered, Open by value:use
address:workplaceAddress		0..*	Address, AustralianAddress	Address(es) of the practitioner that are not role specific (typically home address)
use		1..1	code	home | work | temp | old | billing - purpose of this address Fixed Value: work
qualification		0..*	BackboneElement	Healthcare provider's profession
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
inv-01-practitioner-identifier-length	error	Practitioner.identifier	Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters.	value.length() >= 1 and value.length() <= 20

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	AUCorePractitioner	Clinical Note Document Practitioner Constraints: inv-pra-0, inv-pra-1, inv-pra-2, inv-pra-3, inv-pra-4, inv-pra-5
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. Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply. URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣC	1..*	Identifier, AUHPII, AUPBSPrescriberNumber, AUCareAgencyEmployeeIdentifier, AUAhpraRegistrationNumber	Healthcare provider's identifier Slice: Unordered, Open by pattern:type Constraints: inv-01-practitioner-identifier-length Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
identifier:hpii	SOΣ	0..1	AUHPII	An identifier for the person as this agent Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
active	Σ	0..1	boolean	Whether this practitioner's record is in active use
name	SOΣ	1..*	HumanName	The name(s) associated with the practitioner Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core 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	Healthcare provider's family name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
given	SOΣ	0..*	string	Healthcare provider's given name This repeating element order: Given Names appear in the correct order for presenting the name Obligations Actor Source SHALL:populate-if-known AU Core Responder from AU Core Practitioner SHALL:no-error AU Core Requester from AU Core Practitioner
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
Slices for telecom	Σ	0..*	ContactPoint	Healthcare provider's electronic communication details Slice: Unordered, Open by value:use
telecom:workplaceCommunicationDetails	Σ	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
Slices for address	Σ	0..*	Address, AustralianAddress	Healthcare provider's address Slice: Unordered, Open by value:use
address:workplaceAddress	Σ	0..*	Address, AustralianAddress	Address(es) of the practitioner that are not role specific (typically home address)
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: work
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
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		0..*	BackboneElement	Healthcare provider's profession
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
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.telecom:workplaceCommunicationDetails.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Practitioner.telecom:workplaceCommunicationDetails.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Practitioner.address:workplaceAddress.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Practitioner.address:workplaceAddress.​type	Base	required	AddressType	📍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	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-01-practitioner-identifier-length	error	Practitioner.identifier	Identifier must be between 1 and 20 characters, allowing the alphabetic and numeric character sets (including special characters), and may contain blank characters.	value.length() >= 1 and value.length() <= 20
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').extension('value').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').extension('value').value.all(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').extension('value').value.all(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').extension('type').value.all(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').extension('sourceDocument').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-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').extension('jurisdiction').value.all(memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))
inv-pra-5	warning	Practitioner	Recorded sex or gender source shall be a member of the AU Recorded Sex or Gender (RSG) Source value set if any codes within that value set can apply	extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('source').value.ofType(CodeableConcept).all(memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source'))

This structure is derived from AUCorePractitioner

Summary

Mandatory: 1 element(2 nested mandatory elements)
Fixed: 2 elements

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron