See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

Usage scenarios

The following are supported usage scenarios for this profile:

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

Profile specific implementation guidance

• Even though AU Core Profiles allow both PractitionerRole and Practitioner to be referenced, because PractitionerRole supplies a provider’s location, contact information, and reference to the Practitioner, it SHOULD be referenced 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.
• Requesters can request responders return the Practitioner resource using _include, see the Notes section below.
• 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 AUBasePractitionerRole

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	AUBasePractitionerRole	A person with formal responsibility in a role providing one or more services
Slices for identifier	SO	0..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
identifier:medicareProvider	SO	0..1	AUMedicareProviderNumber	Medicare Provider Number Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
practitioner	SOC	1..1	Reference(AU Core Practitioner)	Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
organization	SO	0..1	Reference(AU Core Organization)	Organization where the roles are available Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
code	SO	0..*	CodeableConcept	Roles which this practitioner may perform Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
specialty	SO	0..*	CodeableConcept	Specific specialty of the practitioner Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
telecom	SO	0..*	ContactPoint	Contact details that are specific to the role/location/service Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-prarol-01	error	PractitionerRole.practitioner	At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present : (reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	AUBasePractitionerRole	A person with formal responsibility in a role providing one or more services
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	SO	0..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
identifier:medicareProvider	SO	0..1	AUMedicareProviderNumber	Medicare Provider Number Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
practitioner	SOΣC	1..1	Reference(AU Core Practitioner)	Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
organization	SOΣ	0..1	Reference(AU Core Organization)	Organization where the roles are available Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
code	SOΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
specialty	SOΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
telecom	SOΣ	0..*	ContactPoint	Contact details that are specific to the role/location/service Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.code	preferred	PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.specialty	preferred	ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-prarol-01	error	PractitionerRole.practitioner	At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present : (reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	PractitionerRole	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	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	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()

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	AUBasePractitionerRole	A person with formal responsibility in a role providing one or more services
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SO	0..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
identifier:medicareProvider	SO	0..1	AUMedicareProviderNumber	Medicare Provider Number Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
active	Σ	0..1	boolean	Whether this practitioner role record is in active use
period	Σ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	SOΣC	1..1	Reference(AU Core Practitioner)	Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
organization	SOΣ	0..1	Reference(AU Core Organization)	Organization where the roles are available Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
code	SOΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
specialty	SOΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
location	Σ	0..*	Reference(Location)	The location(s) at which this practitioner provides care
healthcareService		0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SOΣ	0..*	ContactPoint	Contact details that are specific to the role/location/service Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
availableTime		0..*	BackboneElement	Times the Service Site is available
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
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timeZone		0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value		0..1	time	Primitive value for time
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timeZone		0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value		0..1	time	Primitive value for time
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
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
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
PractitionerRole.code	preferred	PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.specialty	preferred	ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-prarol-01	error	PractitionerRole.practitioner	At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present : (reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	PractitionerRole	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	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	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()

Differential View

This structure is derived from AUBasePractitionerRole

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	AUBasePractitionerRole	A person with formal responsibility in a role providing one or more services
Slices for identifier	SO	0..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
identifier:medicareProvider	SO	0..1	AUMedicareProviderNumber	Medicare Provider Number Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
practitioner	SOC	1..1	Reference(AU Core Practitioner)	Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
organization	SO	0..1	Reference(AU Core Organization)	Organization where the roles are available Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
code	SO	0..*	CodeableConcept	Roles which this practitioner may perform Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
specialty	SO	0..*	CodeableConcept	Specific specialty of the practitioner Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
telecom	SO	0..*	ContactPoint	Contact details that are specific to the role/location/service Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-prarol-01	error	PractitionerRole.practitioner	At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present : (reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	AUBasePractitionerRole	A person with formal responsibility in a role providing one or more services
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	SO	0..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
identifier:medicareProvider	SO	0..1	AUMedicareProviderNumber	Medicare Provider Number Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
practitioner	SOΣC	1..1	Reference(AU Core Practitioner)	Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
organization	SOΣ	0..1	Reference(AU Core Organization)	Organization where the roles are available Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
code	SOΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
specialty	SOΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
telecom	SOΣ	0..*	ContactPoint	Contact details that are specific to the role/location/service Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.code	preferred	PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.specialty	preferred	ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-prarol-01	error	PractitionerRole.practitioner	At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present : (reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	PractitionerRole	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	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	AUBasePractitionerRole	A person with formal responsibility in a role providing one or more services
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SO	0..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
identifier:medicareProvider	SO	0..1	AUMedicareProviderNumber	Medicare Provider Number Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
active	Σ	0..1	boolean	Whether this practitioner role record is in active use
period	Σ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	SOΣC	1..1	Reference(AU Core Practitioner)	Practitioner that is able to provide the defined services for the organization au-core-prarol-01: At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
organization	SOΣ	0..1	Reference(AU Core Organization)	Organization where the roles are available Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
code	SOΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
specialty	SOΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred) Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
location	Σ	0..*	Reference(Location)	The location(s) at which this practitioner provides care
healthcareService		0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SOΣ	0..*	ContactPoint	Contact details that are specific to the role/location/service Obligations Actor SHALL:populate-if-known AU Core Responder SHALL:no-error AU Core Requester
availableTime		0..*	BackboneElement	Times the Service Site is available
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
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timeZone		0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value		0..1	time	Primitive value for time
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timeZone		0..1	CodeableConcept	AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value		0..1	time	Primitive value for time
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
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
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
PractitionerRole.code	preferred	PractitionerRole https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.specialty	preferred	ClinicalSpecialty https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 from https://tx.ontoserver.csiro.au/fhir
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
au-core-prarol-01	error	PractitionerRole.practitioner	At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present : (reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	PractitionerRole	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	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	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()

This structure is derived from AUBasePractitionerRole

Summary

Mandatory: 1 element
Must-Support: 7 elements

Structures

This structure refers to these other structures:

• AU Medicare Provider Number (http://hl7.org.au/fhir/StructureDefinition/au-medicareprovidernumber)
• AU Core Practitioner (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner)
• AU Core Organization (http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization)

Slices

This structure defines the following Slices:

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

Maturity: 1

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 using the identifier search parameter:
   • SHOULD support these _include parameters: PractitionerRole:practitioner

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

   Example:

   1. GET [base]/PractitionerRole?identifier=http://ns.electronichealth.net.au/id/medicare-prescriber-number|553255&_include=PractitionerRole:practitioner
   2. GET [base]/PractitionerRole?identifier=http://ns.electronichealth.net.au/id/medicare-prescriber-number|553255
   3. GET [base]/PractitionerRole?identifier=553255

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

2. SHALL support searching using the practitioner search parameters:
   • SHOULD support chained searching of practitioner canonical identifier practitioner.identifier (e.g. practitioner.identifier=[system|][code])
   • SHOULD support these _include parameters: PractitionerRole:practitioner

   GET [base]/PractitionerRole?practitioner={Type/}[id] or optionally GET [base]/PractitionerRole?practitioner.identifier=[system|][code]

   Example:

   1. GET [base]/PractitionerRole?practitioner=Practitioner/sandyson-sandy
   2. GET [base]/PractitionerRole?practitioner=Practitioner/sandyson-sandy&_include=PractitionerRole:practitioner
   3. GET [base]/PractitionerRole?practitioner.identifier=http://ns.electronichealth.net.au/id/hi/hpii/1.0|8003619900015717

   Implementation Notes: Fetches a bundle of all PractitionerRole resources matching the specified practitioner (how to search by reference and how to search by token)

Optional Search Parameters

The following search parameters and search parameter combinations SHOULD be supported:

1. SHOULD support searching using the _id search parameter:
   • SHOULD support these _include parameters: PractitionerRole:practitioner

   GET [base]/PractitionerRole?_id=[id]

   Example:

   1. GET [base]/PractitionerRole/_id=5678
   2. GET [base]/PractitionerRole?_id=5678&_include=PractitionerRole:practitioner

   Implementation Notes: Fetches a bundle with the requested PractitionerRole, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)

2. SHOULD support searching using the specialty search parameter:
   • SHOULD support these _include parameters: PractitionerRole:practitioner

   GET [base]/PractitionerRole?specialty={system|}[code]

   Example:

   1. GET [base]/PractitionerRole?specialty=http://snomed.info/sct|62247001
   2. GET [base]/PractitionerRole?specialty=http://snomed.info/sct|62247001
   3. GET [base]/PractitionerRole?specialty=http://snomed.info/sct|62247001&_include=PractitionerRole:practitioner

   Implementation Notes: Fetches a bundle of all PractitionerRole resources for the specified specialty (how to search by token)