My Health Record FHIR IG

My Health Record FHIR IG - Local Development build (v1.4.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: ADHA Authoring PractitionerRole

The purpose of this profile is to define a representation of a practitioner acting as an author or observer in a healthcare role, on behalf of an organisation, that is for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

Usages:

• Derived from this Profile: MHR Authoring Care Agency Employee
• Refer to this Profile: MHR Advance Care Planning Document Composition, MHR Personal Health Notes Document Composition, MHR Advance Care Planning Document DocumentReference and MHR Record of Immunisation from Australian Immunisation Register
• Examples for this Profile: PractitionerRole/algrester-greg-gp, PractitionerRole/canberra-gp, PractitionerRole/chong-michelle-oncologist, PractitionerRole/hi-testdata-dentist... Show 8 more, PractitionerRole/hi-testdata-dietician, PractitionerRole/hi-testdata-diversional-therapist, PractitionerRole/hi-testdata-drug-alcohol-counsellor, PractitionerRole/hi-testdata-mothercraft-nurse, PractitionerRole/mds, PractitionerRole/nsw-gp-core, PractitionerRole/pharmacist-retail and PractitionerRole/strempel-sonia-gp

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
PractitionerRole	C	0..*	AUCorePractitionerRole	A practitioner acting as an author or observer in a healthcare role, on behalf of an organisation Constraints: inv-dh-prarol-01, inv-dh-prarol-02, inv-dh-prarol-03
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Σ	1..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:medicareProvider	SOΣ	0..1	AUMedicareProviderNumber	Business Identifiers that are specific to a role/location
identifier:hpii	SOΣ	0..1	AUHPII	Business Identifiers that are specific to a role/location
identifier:caei	SOΣ	0..1	AUCareAgencyEmployeeIdentifier	Business Identifiers that are specific to a role/location
practitioner	SOΣC	1..1	Reference(AU Core Practitioner)	Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
organization	SOΣC	1..1	Reference(AU Core Organization)	Organization where the roles are available
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
code	SOΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred)
specialty	SOΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
location	SΣC	0..*	Reference(AU Core Location)	The location(s) at which this practitioner provides care
healthcareService	SC	0..1	Reference(AU Core HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SOΣ	1..*	ContactPoint	Contact details that are specific to the role/location/service
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()
inv-dh-prarol-01	error	PractitionerRole	If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02	error	PractitionerRole	If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03	error	PractitionerRole	If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

This structure is derived from AUCorePractitionerRole

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole	C	0..*	AUCorePractitionerRole	A practitioner acting as an author or observer in a healthcare role, on behalf of an organisation Constraints: inv-dh-prarol-01, inv-dh-prarol-02, inv-dh-prarol-03
Slices for identifier	S	1..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:hpii	S	0..1	AUHPII	Business Identifiers that are specific to a role/location
identifier:caei	S	0..1	AUCareAgencyEmployeeIdentifier	Business Identifiers that are specific to a role/location
practitioner		1..1	Reference(AU Core Practitioner)	Practitioner that is able to provide the defined services for the organization
reference		1..1	string	Literal reference, Relative, internal or absolute URL
organization	C	1..1	Reference(AU Core Organization)	Organization where the roles are available
reference		1..1	string	Literal reference, Relative, internal or absolute URL
location	SC	0..*	Reference(AU Core Location)	The location(s) at which this practitioner provides care
healthcareService	SC	0..1	Reference(AU Core HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom		1..*	ContactPoint	Contact details that are specific to the role/location/service
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-prarol-01	error	PractitionerRole	If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02	error	PractitionerRole	If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03	error	PractitionerRole	If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole	C	0..*	AUCorePractitionerRole	A practitioner acting as an author or observer in a healthcare role, on behalf of an organisation Constraints: inv-dh-prarol-01, inv-dh-prarol-02, inv-dh-prarol-03
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	1..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:medicareProvider	SOΣ	0..1	AUMedicareProviderNumber	Business Identifiers that are specific to a role/location
identifier:hpii	SOΣ	0..1	AUHPII	Business Identifiers that are specific to a role/location
identifier:caei	SOΣ	0..1	AUCareAgencyEmployeeIdentifier	Business Identifiers that are specific to a role/location
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 Constraints: au-core-prarol-01
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
organization	SOΣC	1..1	Reference(AU Core Organization)	Organization where the roles are available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
code	SOΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred)
specialty	SOΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
location	SΣC	0..*	Reference(AU Core Location)	The location(s) at which this practitioner provides care
healthcareService	SC	0..1	Reference(AU Core HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SOΣ	1..*	ContactPoint	Contact details that are specific to the role/location/service
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
extension: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
extension: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 http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.practitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
PractitionerRole.organization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types 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()
inv-dh-prarol-01	error	PractitionerRole	If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02	error	PractitionerRole	If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03	error	PractitionerRole	If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

This structure is derived from AUCorePractitionerRole

Summary

Mandatory: 5 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

• AU HPI-I (http://hl7.org.au/fhir/StructureDefinition/au-hpii)
• AU Care Agency Employee Identifier (http://hl7.org.au/fhir/StructureDefinition/au-careagencyemployeeidentifier)
• AU Core Location (http://hl7.org.au/fhir/core/StructureDefinition/au-core-location)
• AU Core HealthcareService (http://hl7.org.au/fhir/core/StructureDefinition/au-core-healthcareservice)

Slices

This structure defines the following Slices:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole	C	0..*	AUCorePractitionerRole	A practitioner acting as an author or observer in a healthcare role, on behalf of an organisation Constraints: inv-dh-prarol-01, inv-dh-prarol-02, inv-dh-prarol-03
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Σ	1..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:medicareProvider	SOΣ	0..1	AUMedicareProviderNumber	Business Identifiers that are specific to a role/location
identifier:hpii	SOΣ	0..1	AUHPII	Business Identifiers that are specific to a role/location
identifier:caei	SOΣ	0..1	AUCareAgencyEmployeeIdentifier	Business Identifiers that are specific to a role/location
practitioner	SOΣC	1..1	Reference(AU Core Practitioner)	Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
organization	SOΣC	1..1	Reference(AU Core Organization)	Organization where the roles are available
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
code	SOΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred)
specialty	SOΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
location	SΣC	0..*	Reference(AU Core Location)	The location(s) at which this practitioner provides care
healthcareService	SC	0..1	Reference(AU Core HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SOΣ	1..*	ContactPoint	Contact details that are specific to the role/location/service
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()
inv-dh-prarol-01	error	PractitionerRole	If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02	error	PractitionerRole	If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03	error	PractitionerRole	If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

Differential View

This structure is derived from AUCorePractitionerRole

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole	C	0..*	AUCorePractitionerRole	A practitioner acting as an author or observer in a healthcare role, on behalf of an organisation Constraints: inv-dh-prarol-01, inv-dh-prarol-02, inv-dh-prarol-03
Slices for identifier	S	1..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:hpii	S	0..1	AUHPII	Business Identifiers that are specific to a role/location
identifier:caei	S	0..1	AUCareAgencyEmployeeIdentifier	Business Identifiers that are specific to a role/location
practitioner		1..1	Reference(AU Core Practitioner)	Practitioner that is able to provide the defined services for the organization
reference		1..1	string	Literal reference, Relative, internal or absolute URL
organization	C	1..1	Reference(AU Core Organization)	Organization where the roles are available
reference		1..1	string	Literal reference, Relative, internal or absolute URL
location	SC	0..*	Reference(AU Core Location)	The location(s) at which this practitioner provides care
healthcareService	SC	0..1	Reference(AU Core HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom		1..*	ContactPoint	Contact details that are specific to the role/location/service
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-prarol-01	error	PractitionerRole	If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02	error	PractitionerRole	If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03	error	PractitionerRole	If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole	C	0..*	AUCorePractitionerRole	A practitioner acting as an author or observer in a healthcare role, on behalf of an organisation Constraints: inv-dh-prarol-01, inv-dh-prarol-02, inv-dh-prarol-03
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	1..*	Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:medicareProvider	SOΣ	0..1	AUMedicareProviderNumber	Business Identifiers that are specific to a role/location
identifier:hpii	SOΣ	0..1	AUHPII	Business Identifiers that are specific to a role/location
identifier:caei	SOΣ	0..1	AUCareAgencyEmployeeIdentifier	Business Identifiers that are specific to a role/location
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 Constraints: au-core-prarol-01
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
organization	SOΣC	1..1	Reference(AU Core Organization)	Organization where the roles are available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
code	SOΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Practitioner Role (preferred)
specialty	SOΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
location	SΣC	0..*	Reference(AU Core Location)	The location(s) at which this practitioner provides care
healthcareService	SC	0..1	Reference(AU Core HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SOΣ	1..*	ContactPoint	Contact details that are specific to the role/location/service
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
extension: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
extension: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 http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.practitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
PractitionerRole.organization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types 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()
inv-dh-prarol-01	error	PractitionerRole	If present, an organization shall at least have a reference, an identifier or a display : organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-02	error	PractitionerRole	If present, a location shall at least have a reference, an identifier or a display : location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-prarol-03	error	PractitionerRole	If present, a healthcare service shall at least have a reference, an identifier or a display : healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())

This structure is derived from AUCorePractitionerRole

Summary

Mandatory: 5 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

• AU HPI-I (http://hl7.org.au/fhir/StructureDefinition/au-hpii)
• AU Care Agency Employee Identifier (http://hl7.org.au/fhir/StructureDefinition/au-careagencyemployeeidentifier)
• AU Core Location (http://hl7.org.au/fhir/core/StructureDefinition/au-core-location)
• AU Core HealthcareService (http://hl7.org.au/fhir/core/StructureDefinition/au-core-healthcareservice)

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron