Health Connect Australia Provider Directory FHIR Implementation Guide

Extensions

Extensions introduced in this profile:

• PractitionerRole: PractitionerRole Communication
• PractitionerRole: Alternate Name
• PractitionerRole: Suppressed
• PractitionerRole: Deactivated

Suppressed

The extension:suppressed is used to indicate if this resource should be hidden from display in the Provider Directory. Either a Practitioner or an Organisation can initiate a request to hide visibility of a role from those searching the Health Connect Provider Directory system. Presence of the extension indicates the resource is suppressed; the extension's coded value identifies who initiated the suppression (for example, practitioner or organisation). In order to be visible and searchable on the HCPD system, neither code will need to be present. For more details, please see the extension intro notes.

PractitionerRole Communication

The extension:practitioner-role-communication records communication preferences (languages and contact modes) for the practitioner in this role.

Alternate name in role context

The Alternate Name extension allows a practitioner to specify an alternate name for use in the context of a specific role. This name may differ from their registered name and allows practitioners to be known by their alternate name when delivering healthcare services in this role.

Usage notes

Identifiers

Registration Identifiers (exactly one required for the role):

• Ahpra Registration Number - The specific Ahpra registration credential relevant to this practitioner role
• Professional Registration Number (PRN) - The specific professional registration credential relevant to this practitioner role

These registration identifiers must match corresponding registration identifiers held by the referenced Practitioner and should represent the professional credentials that authorize the practitioner to perform this specific role.

Beyond the identifiers already defined above the HC HealthcareService profile explicitly supports the following identifier slice (as indicated by the must support flag):

• HCPD Local Identifier (HCPD-LI) - Unique identifier attributed by the HCPD system.

PractitionerRole code

Only the main role or job of the clinician should be provided, using a code from the SNOMED-CT-AU code system. The preferred value set is Practitioner Role 1. Publishing systems must supply a single code representing the clinician’s primary practitioner role. Any additional codes or roles will be ignored. When a PractitionerRole is provided to a subscribing system, only the primary role (as defined by the SNOMED-CT-AU code from the specified value set) will be included.

The SNOMED code is the authoritative, machine-readable representation and should be used for searching, filtering, and interoperability; the display is the user-facing label and may be normalised by subscribing systems. Additional codes MUST NOT be used to represent multiple roles and will be ignored by the HCPD service.

Guidance on PractitionerRole.specialty

The PractitionerRole.specialty element is marked as Must Support (MS) because this requirement is inherited from AU Core, which also imposes obligations on defined roles. None of the AU Core roles or obligations are relevant to this specification. There is no requirement for implementers of this specification to do anything with this data element.

• It SHOULD be ignored by Health Connect Provider Directory Requester Actors.
• It SHALL NOT be populated by Health Connect Provider Directory Actors.

Data Integrity and Validation

This profile includes invariants to ensure data consistency and integrity between PractitionerRole and the referenced Practitioner resources.

Registration Identifier Matching

The inv-02-identifier-registration-match invariant ensures that registration identifiers on the PractitionerRole match those of the referenced Practitioner. This validation prevents data inconsistencies where a PractitionerRole might reference registration numbers that don't belong to the associated Practitioner.

Requirements:

• If the PractitionerRole has an Ahpra registration identifier, it must match one of the referenced Practitioner's Ahpra registration identifiers.
• If the PractitionerRole has a peak body registration identifier (PRN), it must match one of the referenced Practitioner's peak body registration identifiers.

Business Logic: This ensures referential integrity in provider directory implementations where:

• A PractitionerRole represents a specific professional role.
• The registration credentials for that role must be held by the actual Practitioner.
• Prevents scenarios where role assignments reference incorrect or mismatched professional registrations.

Registration Identifier Requirements

The invariant inv-01-identifier-registration-required ensures that at least one of the Professional Registration Number identifier types are present, either:

• an Ahpra registration number (AHPRA) OR
• a non-Ahpra Peak Body Registration Number (PRN).

While a practitioner can have more than one professional registration and professions (e.g. nurse and midwife), the relevant registration that is applicable for this role only is captured.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole		0..*	AUCorePractitionerRole(2.0.0)	A person with formal responsibility in a role providing one or more services
PractitionerRole.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PractitionerRole.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy	S This element must be supported.	1..1	Extension	Who initiated the suppression Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.url		1..1	uri	"suppressedBy"
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding	S This element must be supported. Σ This element is included in summaries.	1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf	S This element must be supported.	0..1	Extension	Controls Organization self-suppression Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.url		1..1	uri	"includeSelf"
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.value[x]	S This element must be supported.	0..1	boolean	Value of extension
PractitionerRole.Slices for extension.extension:suppressed.url		1..1	uri	"http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
PractitionerRole.Slices for extension.extension:deactivated	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHALL:ignore Health Connect Provider Directory Requester Actor SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy	S This element must be supported.	1..1	Extension	Who initiated the deactivation Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.url		1..1	uri	"deactivatedBy"
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding	S This element must be supported. Σ This element is included in summaries.	1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
PractitionerRole.Slices for extension.extension:deactivated.url		1..1	uri	"http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
PractitionerRole.Slices for extension.extension:practitioner-role-communication	SO This element has obligations and must be supported.	0..*	CodeableConcept	Practitioner role communication preferences URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/practitioner-role-communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required) Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:alternate-name	SO This element has obligations and must be supported.	0..1	HumanName	Alternate name for this practitioner role URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
PractitionerRole.Slices for identifier	SO This element has obligations and must be supported. Σ This element is included in summaries.	2..*	Identifier(4.0.1) , AUMedicareProviderNumber(6.0.0) , AUNationalProviderIdentifierAtOrganisation(6.0.0) , AUEmployeeNumber(6.0.0)	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:medicareProvider	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUMedicareProviderNumber(6.0.0)	Medicare provider number Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for identifier.identifier:HCPD_Local_Identifier	S This element must be supported. Σ This element is included in summaries.	1..1	HCPD_Local_Identifier(26.0.0)	Local identifier for the PractitionerRole attributed by HC
PractitionerRole.Slices for identifier.identifier:HCPD_Source_Identifier	S This element must be supported. Σ This element is included in summaries.	1..1	HCPD_Source_Identifier(26.0.0)	Identifier attributed from source system. Source for PractitionerRole: PCA.
PractitionerRole.Slices for identifier.identifier:peakbodyregistrationnumber	S This element must be supported. Σ This element is included in summaries.	0..1	Peak_Body_Professional_Registration_Number(26.0.0)	Professional association / Peak body association (for non-Ahpra registered practitioners), as recorded against the HPI-I record
PractitionerRole.Slices for identifier.identifier:ahpraregistrationnumber	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAhpraRegistrationNumber(6.0.0)	Ahpra Registration Number Constraints: inv-ahpra-0
PractitionerRole.active	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	boolean	Whether this practitioner's role is active. Only active externally exposed. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.period	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	Period	The period during which the practitioner is active in this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.practitioner	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..1	Reference(HCPD Practitioner(26.0.0))	Practitioner in the role Constraints: au-core-prarol-01 Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.organization	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(HCPD Organization(26.0.0))	Organisation providing this role. Reference to be the same organisation as the referenced HealthcareService for this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	The primary role of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..*	Coding	The practitioner's occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.code	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	code	The SNOMED CT-AU code of the practitioner occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.display	S This element must be supported. Σ This element is included in summaries.	1..1	string	The SNOMED CT-AU display name of the practitioner occupation or profession or role type
PractitionerRole.specialty	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Specific specialty of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
PractitionerRole.location	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(HCPD Location(26.0.0))	Location at which this role is provided. Reference to be the same Location as the referenced HealthcareService for this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.healthcareService	SO This element has obligations and must be supported.	1..1	Reference(HCPD HealthcareService(26.0.0))	Healthcare service at which this role is provided. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	Contact details for the practitioner in this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.telecom.system	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
PractitionerRole.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.availableTime	SO This element has obligations and must be supported.	0..*	BackboneElement	Times that the practitioner provides the healthcare service in this role at this location. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
PractitionerRole.availableTime.daysOfWeek	SO This element has obligations and must be supported.	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.allDay	SO This element has obligations and must be supported.	0..1	boolean	Always available? e.g. 24 hour service Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableStartTime	SO This element has obligations and must be supported.	0..1	time	Opening time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableStartTime.Slices for extension				Content/Rules for all slices
PractitionerRole.availableTime.availableStartTime.Slices for extension.extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) Constraints: ext-1
PractitionerRole.availableTime.availableEndTime	SO This element has obligations and must be supported.	0..1	time	Closing time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableEndTime.Slices for extension				Content/Rules for all slices
PractitionerRole.availableTime.availableEndTime.Slices for extension.extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) Constraints: ext-1
PractitionerRole.endpoint	SO This element has obligations and must be supported.	0..*	Reference(HCPD Endpoint(26.0.0))	Technical endpoints for this practitioner role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PractitionerRole.extension:suppressed.​extension:suppressedBy.​value[x].coding	Base	required	Responsible Party Type	📍26.0.0	This IG
PractitionerRole.extension:deactivated.​extension:deactivatedBy.​value[x].coding	Base	required	Responsible Party Type	📍26.0.0	This IG
PractitionerRole.code	Base	preferred	https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1	Not State	Unknown
PractitionerRole.specialty	Base	preferred	https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1	Not State	Unknown
PractitionerRole.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
PractitionerRole.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
PractitionerRole.availableTime.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from AUCorePractitionerRole

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole		0..*	AUCorePractitionerRole(2.0.0)	A person with formal responsibility in a role providing one or more services
PractitionerRole.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
PractitionerRole.Slices for extension.extension:suppressed	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy		1..1	Extension	Who initiated the suppression
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x]
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding	S This element must be supported.	1..2	Coding	Code defined by a terminology system
PractitionerRole.Slices for extension.extension:deactivated	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHALL:ignore Health Connect Provider Directory Requester Actor SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy		1..1	Extension	Who initiated the deactivation
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x]
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding	S This element must be supported.	1..2	Coding	Code defined by a terminology system
PractitionerRole.Slices for extension.extension:practitioner-role-communication	SO This element has obligations and must be supported.	0..*	CodeableConcept	Practitioner role communication preferences URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/practitioner-role-communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:alternate-name	SO This element has obligations and must be supported.	0..1	HumanName	Alternate name for this practitioner role URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for identifier	O This element has obligations.	2..*	Identifier(4.0.1), AUMedicareProviderNumber(6.0.0), AUNationalProviderIdentifierAtOrganisation(6.0.0), AUEmployeeNumber(6.0.0)	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:medicareProvider	O This element has obligations.	0..1	AUMedicareProviderNumber(6.0.0)	Medicare provider number Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for identifier.identifier:HCPD_Local_Identifier	S This element must be supported.	1..1	HCPD_Local_Identifier(26.0.0)	Local identifier for the PractitionerRole attributed by HC
PractitionerRole.Slices for identifier.identifier:HCPD_Source_Identifier	S This element must be supported.	1..1	HCPD_Source_Identifier(26.0.0)	Identifier attributed from source system. Source for PractitionerRole: PCA.
PractitionerRole.Slices for identifier.identifier:peakbodyregistrationnumber	S This element must be supported.	0..1	Peak_Body_Professional_Registration_Number(26.0.0)	Professional association / Peak body association (for non-Ahpra registered practitioners), as recorded against the HPI-I record
PractitionerRole.Slices for identifier.identifier:ahpraregistrationnumber	S This element must be supported.	0..1	AUAhpraRegistrationNumber(6.0.0)	Ahpra Registration Number
PractitionerRole.active	SO This element has obligations and must be supported.	1..1	boolean	Whether this practitioner's role is active. Only active externally exposed. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.period	SO This element has obligations and must be supported.	0..1	Period	The period during which the practitioner is active in this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.practitioner	O This element has obligations.	1..1	Reference(HCPD Practitioner(26.0.0))	Practitioner in the role Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.organization	O This element has obligations.	1..1	Reference(HCPD Organization(26.0.0))	Organisation providing this role. Reference to be the same organisation as the referenced HealthcareService for this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code	O This element has obligations.	1..1	CodeableConcept	The primary role of the practitioner Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding	SO This element has obligations and must be supported.	1..*	Coding	The practitioner's occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.code	SO This element has obligations and must be supported.	1..1	code	The SNOMED CT-AU code of the practitioner occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.display	S This element must be supported.	1..1	string	The SNOMED CT-AU display name of the practitioner occupation or profession or role type
PractitionerRole.location	SO This element has obligations and must be supported.	1..1	Reference(HCPD Location(26.0.0))	Location at which this role is provided. Reference to be the same Location as the referenced HealthcareService for this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.healthcareService	SO This element has obligations and must be supported.	1..1	Reference(HCPD HealthcareService(26.0.0))	Healthcare service at which this role is provided. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.telecom	O This element has obligations.	0..*	ContactPoint	Contact details for the practitioner in this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime	SO This element has obligations and must be supported.	0..*	BackboneElement	Times that the practitioner provides the healthcare service in this role at this location. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.daysOfWeek	SO This element has obligations and must be supported.	0..*	code	mon | tue | wed | thu | fri | sat | sun Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.allDay	SO This element has obligations and must be supported.	0..1	boolean	Always available? e.g. 24 hour service Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableStartTime	SO This element has obligations and must be supported.	0..1	time	Opening time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableEndTime	SO This element has obligations and must be supported.	0..1	time	Closing time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.endpoint	SO This element has obligations and must be supported.	0..*	Reference(HCPD Endpoint(26.0.0))	Technical endpoints for this practitioner role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole		0..*	AUCorePractitionerRole(2.0.0)	A person with formal responsibility in a role providing one or more services
PractitionerRole.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
PractitionerRole.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
PractitionerRole.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PractitionerRole.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.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
PractitionerRole.contained		0..*	Resource	Contained, inline Resources
PractitionerRole.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:suppressed.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy	S This element must be supported.	1..1	Extension	Who initiated the suppression Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.url		1..1	uri	"suppressedBy"
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding	S This element must be supported. Σ This element is included in summaries.	1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf	S This element must be supported.	0..1	Extension	Controls Organization self-suppression Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.url		1..1	uri	"includeSelf"
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.value[x]	S This element must be supported.	0..1	boolean	Value of extension
PractitionerRole.Slices for extension.extension:suppressed.url		1..1	uri	"http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
PractitionerRole.Slices for extension.extension:deactivated	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHALL:ignore Health Connect Provider Directory Requester Actor SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:deactivated.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy	S This element must be supported.	1..1	Extension	Who initiated the deactivation Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.url		1..1	uri	"deactivatedBy"
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding	S This element must be supported. Σ This element is included in summaries.	1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
PractitionerRole.Slices for extension.extension:deactivated.url		1..1	uri	"http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
PractitionerRole.Slices for extension.extension:practitioner-role-communication	SO This element has obligations and must be supported.	0..*	CodeableConcept	Practitioner role communication preferences URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/practitioner-role-communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required) Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:alternate-name	SO This element has obligations and must be supported.	0..1	HumanName	Alternate name for this practitioner role URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
PractitionerRole.Slices for identifier	SO This element has obligations and must be supported. Σ This element is included in summaries.	2..*	Identifier(4.0.1) , AUMedicareProviderNumber(6.0.0) , AUNationalProviderIdentifierAtOrganisation(6.0.0) , AUEmployeeNumber(6.0.0)	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:medicareProvider	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUMedicareProviderNumber(6.0.0)	Medicare provider number Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for identifier.identifier:HCPD_Local_Identifier	S This element must be supported. Σ This element is included in summaries.	1..1	HCPD_Local_Identifier(26.0.0)	Local identifier for the PractitionerRole attributed by HC
PractitionerRole.Slices for identifier.identifier:HCPD_Source_Identifier	S This element must be supported. Σ This element is included in summaries.	1..1	HCPD_Source_Identifier(26.0.0)	Identifier attributed from source system. Source for PractitionerRole: PCA.
PractitionerRole.Slices for identifier.identifier:peakbodyregistrationnumber	S This element must be supported. Σ This element is included in summaries.	0..1	Peak_Body_Professional_Registration_Number(26.0.0)	Professional association / Peak body association (for non-Ahpra registered practitioners), as recorded against the HPI-I record
PractitionerRole.Slices for identifier.identifier:ahpraregistrationnumber	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAhpraRegistrationNumber(6.0.0)	Ahpra Registration Number Constraints: inv-ahpra-0
PractitionerRole.active	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	boolean	Whether this practitioner's role is active. Only active externally exposed. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.period	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	Period	The period during which the practitioner is active in this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.practitioner	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..1	Reference(HCPD Practitioner(26.0.0))	Practitioner in the role Constraints: au-core-prarol-01 Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.organization	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(HCPD Organization(26.0.0))	Organisation providing this role. Reference to be the same organisation as the referenced HealthcareService for this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	The primary role of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.code.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.code.coding	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..*	Coding	The practitioner's occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.code.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.code.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
PractitionerRole.code.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
PractitionerRole.code.coding.code	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	code	The SNOMED CT-AU code of the practitioner occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.display	S This element must be supported. Σ This element is included in summaries.	1..1	string	The SNOMED CT-AU display name of the practitioner occupation or profession or role type
PractitionerRole.code.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
PractitionerRole.code.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
PractitionerRole.specialty	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Specific specialty of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
PractitionerRole.location	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(HCPD Location(26.0.0))	Location at which this role is provided. Reference to be the same Location as the referenced HealthcareService for this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.healthcareService	SO This element has obligations and must be supported.	1..1	Reference(HCPD HealthcareService(26.0.0))	Healthcare service at which this role is provided. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	Contact details for the practitioner in this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.telecom.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.telecom.system	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
PractitionerRole.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
PractitionerRole.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
PractitionerRole.availableTime	SO This element has obligations and must be supported.	0..*	BackboneElement	Times that the practitioner provides the healthcare service in this role at this location. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.availableTime.extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
PractitionerRole.availableTime.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
PractitionerRole.availableTime.daysOfWeek	SO This element has obligations and must be supported.	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.allDay	SO This element has obligations and must be supported.	0..1	boolean	Always available? e.g. 24 hour service Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableStartTime	SO This element has obligations and must be supported.	0..1	time	Opening time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableStartTime.id		0..1	string	xml:id (or equivalent in JSON)
PractitionerRole.availableTime.availableStartTime.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.availableTime.availableStartTime.Slices for extension.extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) Constraints: ext-1
PractitionerRole.availableTime.availableStartTime.value		0..1	time	Primitive value for time
PractitionerRole.availableTime.availableEndTime	SO This element has obligations and must be supported.	0..1	time	Closing time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableEndTime.id		0..1	string	xml:id (or equivalent in JSON)
PractitionerRole.availableTime.availableEndTime.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.availableTime.availableEndTime.Slices for extension.extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) Constraints: ext-1
PractitionerRole.availableTime.availableEndTime.value		0..1	time	Primitive value for time
PractitionerRole.notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
PractitionerRole.notAvailable.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.notAvailable.extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
PractitionerRole.notAvailable.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
PractitionerRole.notAvailable.description		1..1	string	Reason presented to the user explaining why time not available
PractitionerRole.notAvailable.during		0..1	Period	Service not available from this date
PractitionerRole.availabilityExceptions		0..1	string	Description of availability exceptions
PractitionerRole.endpoint	SO This element has obligations and must be supported.	0..*	Reference(HCPD Endpoint(26.0.0))	Technical endpoints for this practitioner role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PractitionerRole.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
PractitionerRole.extension:suppressed.​extension:suppressedBy.​value[x].coding	Base	required	Responsible Party Type	📍26.0.0	This IG
PractitionerRole.extension:deactivated.​extension:deactivatedBy.​value[x].coding	Base	required	Responsible Party Type	📍26.0.0	This IG
PractitionerRole.code	Base	preferred	https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1	Not State	Unknown
PractitionerRole.specialty	Base	preferred	https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1	Not State	Unknown
PractitionerRole.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
PractitionerRole.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
PractitionerRole.availableTime.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole		0..*	AUCorePractitionerRole(2.0.0)	A person with formal responsibility in a role providing one or more services
PractitionerRole.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PractitionerRole.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy	S This element must be supported.	1..1	Extension	Who initiated the suppression Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.url		1..1	uri	"suppressedBy"
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding	S This element must be supported. Σ This element is included in summaries.	1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf	S This element must be supported.	0..1	Extension	Controls Organization self-suppression Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.url		1..1	uri	"includeSelf"
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.value[x]	S This element must be supported.	0..1	boolean	Value of extension
PractitionerRole.Slices for extension.extension:suppressed.url		1..1	uri	"http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
PractitionerRole.Slices for extension.extension:deactivated	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHALL:ignore Health Connect Provider Directory Requester Actor SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy	S This element must be supported.	1..1	Extension	Who initiated the deactivation Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.url		1..1	uri	"deactivatedBy"
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding	S This element must be supported. Σ This element is included in summaries.	1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
PractitionerRole.Slices for extension.extension:deactivated.url		1..1	uri	"http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
PractitionerRole.Slices for extension.extension:practitioner-role-communication	SO This element has obligations and must be supported.	0..*	CodeableConcept	Practitioner role communication preferences URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/practitioner-role-communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required) Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:alternate-name	SO This element has obligations and must be supported.	0..1	HumanName	Alternate name for this practitioner role URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
PractitionerRole.Slices for identifier	SO This element has obligations and must be supported. Σ This element is included in summaries.	2..*	Identifier(4.0.1) , AUMedicareProviderNumber(6.0.0) , AUNationalProviderIdentifierAtOrganisation(6.0.0) , AUEmployeeNumber(6.0.0)	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:medicareProvider	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUMedicareProviderNumber(6.0.0)	Medicare provider number Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for identifier.identifier:HCPD_Local_Identifier	S This element must be supported. Σ This element is included in summaries.	1..1	HCPD_Local_Identifier(26.0.0)	Local identifier for the PractitionerRole attributed by HC
PractitionerRole.Slices for identifier.identifier:HCPD_Source_Identifier	S This element must be supported. Σ This element is included in summaries.	1..1	HCPD_Source_Identifier(26.0.0)	Identifier attributed from source system. Source for PractitionerRole: PCA.
PractitionerRole.Slices for identifier.identifier:peakbodyregistrationnumber	S This element must be supported. Σ This element is included in summaries.	0..1	Peak_Body_Professional_Registration_Number(26.0.0)	Professional association / Peak body association (for non-Ahpra registered practitioners), as recorded against the HPI-I record
PractitionerRole.Slices for identifier.identifier:ahpraregistrationnumber	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAhpraRegistrationNumber(6.0.0)	Ahpra Registration Number Constraints: inv-ahpra-0
PractitionerRole.active	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	boolean	Whether this practitioner's role is active. Only active externally exposed. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.period	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	Period	The period during which the practitioner is active in this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.practitioner	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..1	Reference(HCPD Practitioner(26.0.0))	Practitioner in the role Constraints: au-core-prarol-01 Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.organization	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(HCPD Organization(26.0.0))	Organisation providing this role. Reference to be the same organisation as the referenced HealthcareService for this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	The primary role of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..*	Coding	The practitioner's occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.code	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	code	The SNOMED CT-AU code of the practitioner occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.display	S This element must be supported. Σ This element is included in summaries.	1..1	string	The SNOMED CT-AU display name of the practitioner occupation or profession or role type
PractitionerRole.specialty	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Specific specialty of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
PractitionerRole.location	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(HCPD Location(26.0.0))	Location at which this role is provided. Reference to be the same Location as the referenced HealthcareService for this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.healthcareService	SO This element has obligations and must be supported.	1..1	Reference(HCPD HealthcareService(26.0.0))	Healthcare service at which this role is provided. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	Contact details for the practitioner in this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.telecom.system	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
PractitionerRole.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.availableTime	SO This element has obligations and must be supported.	0..*	BackboneElement	Times that the practitioner provides the healthcare service in this role at this location. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
PractitionerRole.availableTime.daysOfWeek	SO This element has obligations and must be supported.	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.allDay	SO This element has obligations and must be supported.	0..1	boolean	Always available? e.g. 24 hour service Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableStartTime	SO This element has obligations and must be supported.	0..1	time	Opening time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableStartTime.Slices for extension				Content/Rules for all slices
PractitionerRole.availableTime.availableStartTime.Slices for extension.extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) Constraints: ext-1
PractitionerRole.availableTime.availableEndTime	SO This element has obligations and must be supported.	0..1	time	Closing time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableEndTime.Slices for extension				Content/Rules for all slices
PractitionerRole.availableTime.availableEndTime.Slices for extension.extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) Constraints: ext-1
PractitionerRole.endpoint	SO This element has obligations and must be supported.	0..*	Reference(HCPD Endpoint(26.0.0))	Technical endpoints for this practitioner role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PractitionerRole.extension:suppressed.​extension:suppressedBy.​value[x].coding	Base	required	Responsible Party Type	📍26.0.0	This IG
PractitionerRole.extension:deactivated.​extension:deactivatedBy.​value[x].coding	Base	required	Responsible Party Type	📍26.0.0	This IG
PractitionerRole.code	Base	preferred	https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1	Not State	Unknown
PractitionerRole.specialty	Base	preferred	https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1	Not State	Unknown
PractitionerRole.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
PractitionerRole.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
PractitionerRole.availableTime.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Differential View

This structure is derived from AUCorePractitionerRole

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole		0..*	AUCorePractitionerRole(2.0.0)	A person with formal responsibility in a role providing one or more services
PractitionerRole.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
PractitionerRole.Slices for extension.extension:suppressed	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy		1..1	Extension	Who initiated the suppression
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x]
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding	S This element must be supported.	1..2	Coding	Code defined by a terminology system
PractitionerRole.Slices for extension.extension:deactivated	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHALL:ignore Health Connect Provider Directory Requester Actor SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy		1..1	Extension	Who initiated the deactivation
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x]
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding	S This element must be supported.	1..2	Coding	Code defined by a terminology system
PractitionerRole.Slices for extension.extension:practitioner-role-communication	SO This element has obligations and must be supported.	0..*	CodeableConcept	Practitioner role communication preferences URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/practitioner-role-communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:alternate-name	SO This element has obligations and must be supported.	0..1	HumanName	Alternate name for this practitioner role URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for identifier	O This element has obligations.	2..*	Identifier(4.0.1), AUMedicareProviderNumber(6.0.0), AUNationalProviderIdentifierAtOrganisation(6.0.0), AUEmployeeNumber(6.0.0)	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:medicareProvider	O This element has obligations.	0..1	AUMedicareProviderNumber(6.0.0)	Medicare provider number Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for identifier.identifier:HCPD_Local_Identifier	S This element must be supported.	1..1	HCPD_Local_Identifier(26.0.0)	Local identifier for the PractitionerRole attributed by HC
PractitionerRole.Slices for identifier.identifier:HCPD_Source_Identifier	S This element must be supported.	1..1	HCPD_Source_Identifier(26.0.0)	Identifier attributed from source system. Source for PractitionerRole: PCA.
PractitionerRole.Slices for identifier.identifier:peakbodyregistrationnumber	S This element must be supported.	0..1	Peak_Body_Professional_Registration_Number(26.0.0)	Professional association / Peak body association (for non-Ahpra registered practitioners), as recorded against the HPI-I record
PractitionerRole.Slices for identifier.identifier:ahpraregistrationnumber	S This element must be supported.	0..1	AUAhpraRegistrationNumber(6.0.0)	Ahpra Registration Number
PractitionerRole.active	SO This element has obligations and must be supported.	1..1	boolean	Whether this practitioner's role is active. Only active externally exposed. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.period	SO This element has obligations and must be supported.	0..1	Period	The period during which the practitioner is active in this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.practitioner	O This element has obligations.	1..1	Reference(HCPD Practitioner(26.0.0))	Practitioner in the role Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.organization	O This element has obligations.	1..1	Reference(HCPD Organization(26.0.0))	Organisation providing this role. Reference to be the same organisation as the referenced HealthcareService for this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code	O This element has obligations.	1..1	CodeableConcept	The primary role of the practitioner Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding	SO This element has obligations and must be supported.	1..*	Coding	The practitioner's occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.code	SO This element has obligations and must be supported.	1..1	code	The SNOMED CT-AU code of the practitioner occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.display	S This element must be supported.	1..1	string	The SNOMED CT-AU display name of the practitioner occupation or profession or role type
PractitionerRole.location	SO This element has obligations and must be supported.	1..1	Reference(HCPD Location(26.0.0))	Location at which this role is provided. Reference to be the same Location as the referenced HealthcareService for this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.healthcareService	SO This element has obligations and must be supported.	1..1	Reference(HCPD HealthcareService(26.0.0))	Healthcare service at which this role is provided. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.telecom	O This element has obligations.	0..*	ContactPoint	Contact details for the practitioner in this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime	SO This element has obligations and must be supported.	0..*	BackboneElement	Times that the practitioner provides the healthcare service in this role at this location. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.daysOfWeek	SO This element has obligations and must be supported.	0..*	code	mon | tue | wed | thu | fri | sat | sun Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.allDay	SO This element has obligations and must be supported.	0..1	boolean	Always available? e.g. 24 hour service Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableStartTime	SO This element has obligations and must be supported.	0..1	time	Opening time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableEndTime	SO This element has obligations and must be supported.	0..1	time	Closing time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.endpoint	SO This element has obligations and must be supported.	0..*	Reference(HCPD Endpoint(26.0.0))	Technical endpoints for this practitioner role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole		0..*	AUCorePractitionerRole(2.0.0)	A person with formal responsibility in a role providing one or more services
PractitionerRole.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
PractitionerRole.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
PractitionerRole.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PractitionerRole.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.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
PractitionerRole.contained		0..*	Resource	Contained, inline Resources
PractitionerRole.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:suppressed.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy	S This element must be supported.	1..1	Extension	Who initiated the suppression Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.url		1..1	uri	"suppressedBy"
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].coding	S This element must be supported. Σ This element is included in summaries.	1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:suppressedBy.value[x].text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf	S This element must be supported.	0..1	Extension	Controls Organization self-suppression Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.url		1..1	uri	"includeSelf"
PractitionerRole.Slices for extension.extension:suppressed.Slices for extension.extension:includeSelf.value[x]	S This element must be supported.	0..1	boolean	Value of extension
PractitionerRole.Slices for extension.extension:suppressed.url		1..1	uri	"http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
PractitionerRole.Slices for extension.extension:deactivated	SO This element has obligations and must be supported.	0..1	(Complex)	Indicates whether the PractitionerRole should be hidden. URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHALL:ignore Health Connect Provider Directory Requester Actor SHALL:ignore Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:deactivated.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension				Content/Rules for all slices
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy	S This element must be supported.	1..1	Extension	Who initiated the deactivation Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.url		1..1	uri	"deactivatedBy"
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].id		0..1	string	Unique id for inter-element referencing
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].coding	S This element must be supported. Σ This element is included in summaries.	1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
PractitionerRole.Slices for extension.extension:deactivated.Slices for extension.extension:deactivatedBy.value[x].text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
PractitionerRole.Slices for extension.extension:deactivated.url		1..1	uri	"http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
PractitionerRole.Slices for extension.extension:practitioner-role-communication	SO This element has obligations and must be supported.	0..*	CodeableConcept	Practitioner role communication preferences URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/practitioner-role-communication Binding: https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 (required) Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for extension.extension:alternate-name	SO This element has obligations and must be supported.	0..1	HumanName	Alternate name for this practitioner role URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name Constraints: ext-1 Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored Constraints: ext-1
PractitionerRole.Slices for identifier	SO This element has obligations and must be supported. Σ This element is included in summaries.	2..*	Identifier(4.0.1) , AUMedicareProviderNumber(6.0.0) , AUNationalProviderIdentifierAtOrganisation(6.0.0) , AUEmployeeNumber(6.0.0)	Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PractitionerRole.Slices for identifier.identifier:medicareProvider	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	AUMedicareProviderNumber(6.0.0)	Medicare provider number Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.Slices for identifier.identifier:HCPD_Local_Identifier	S This element must be supported. Σ This element is included in summaries.	1..1	HCPD_Local_Identifier(26.0.0)	Local identifier for the PractitionerRole attributed by HC
PractitionerRole.Slices for identifier.identifier:HCPD_Source_Identifier	S This element must be supported. Σ This element is included in summaries.	1..1	HCPD_Source_Identifier(26.0.0)	Identifier attributed from source system. Source for PractitionerRole: PCA.
PractitionerRole.Slices for identifier.identifier:peakbodyregistrationnumber	S This element must be supported. Σ This element is included in summaries.	0..1	Peak_Body_Professional_Registration_Number(26.0.0)	Professional association / Peak body association (for non-Ahpra registered practitioners), as recorded against the HPI-I record
PractitionerRole.Slices for identifier.identifier:ahpraregistrationnumber	S This element must be supported. Σ This element is included in summaries. C	0..1	AUAhpraRegistrationNumber(6.0.0)	Ahpra Registration Number Constraints: inv-ahpra-0
PractitionerRole.active	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	boolean	Whether this practitioner's role is active. Only active externally exposed. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.period	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	Period	The period during which the practitioner is active in this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.practitioner	SO This element has obligations and must be supported. Σ This element is included in summaries. C	1..1	Reference(HCPD Practitioner(26.0.0))	Practitioner in the role Constraints: au-core-prarol-01 Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.organization	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(HCPD Organization(26.0.0))	Organisation providing this role. Reference to be the same organisation as the referenced HealthcareService for this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	The primary role of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.code.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.code.coding	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..*	Coding	The practitioner's occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.code.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.code.coding.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
PractitionerRole.code.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
PractitionerRole.code.coding.code	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	code	The SNOMED CT-AU code of the practitioner occupation or profession or role type Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.code.coding.display	S This element must be supported. Σ This element is included in summaries.	1..1	string	The SNOMED CT-AU display name of the practitioner occupation or profession or role type
PractitionerRole.code.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
PractitionerRole.code.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
PractitionerRole.specialty	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Specific specialty of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
PractitionerRole.location	SO This element has obligations and must be supported. Σ This element is included in summaries.	1..1	Reference(HCPD Location(26.0.0))	Location at which this role is provided. Reference to be the same Location as the referenced HealthcareService for this role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.healthcareService	SO This element has obligations and must be supported.	1..1	Reference(HCPD HealthcareService(26.0.0))	Healthcare service at which this role is provided. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.telecom	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..*	ContactPoint	Contact details for the practitioner in this role. Obligations Actor Source SHALL:populate-if-known Health Connect Provider Directory Responder Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Requester Actor from AU Core PractitionerRole SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.telecom.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.telecom.system	SO This element has obligations and must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value	SO This element has obligations and must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
PractitionerRole.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
PractitionerRole.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
PractitionerRole.availableTime	SO This element has obligations and must be supported.	0..*	BackboneElement	Times that the practitioner provides the healthcare service in this role at this location. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.availableTime.extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
PractitionerRole.availableTime.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
PractitionerRole.availableTime.daysOfWeek	SO This element has obligations and must be supported.	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.allDay	SO This element has obligations and must be supported.	0..1	boolean	Always available? e.g. 24 hour service Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableStartTime	SO This element has obligations and must be supported.	0..1	time	Opening time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableStartTime.id		0..1	string	xml:id (or equivalent in JSON)
PractitionerRole.availableTime.availableStartTime.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.availableTime.availableStartTime.Slices for extension.extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) Constraints: ext-1
PractitionerRole.availableTime.availableStartTime.value		0..1	time	Primitive value for time
PractitionerRole.availableTime.availableEndTime	SO This element has obligations and must be supported.	0..1	time	Closing time of day (ignored if allDay = true) Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
PractitionerRole.availableTime.availableEndTime.id		0..1	string	xml:id (or equivalent in JSON)
PractitionerRole.availableTime.availableEndTime.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
PractitionerRole.availableTime.availableEndTime.Slices for extension.extension:timeZone		0..1	code	IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175) Constraints: ext-1
PractitionerRole.availableTime.availableEndTime.value		0..1	time	Primitive value for time
PractitionerRole.notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
PractitionerRole.notAvailable.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.notAvailable.extension		0..*	Extension	Additional content defined by implementations Constraints: ext-1
PractitionerRole.notAvailable.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized Constraints: ext-1
PractitionerRole.notAvailable.description		1..1	string	Reason presented to the user explaining why time not available
PractitionerRole.notAvailable.during		0..1	Period	Service not available from this date
PractitionerRole.availabilityExceptions		0..1	string	Description of availability exceptions
PractitionerRole.endpoint	SO This element has obligations and must be supported.	0..*	Reference(HCPD Endpoint(26.0.0))	Technical endpoints for this practitioner role. Obligations Actor SHALL:populate-if-known Health Connect Provider Directory Responder Actor SHOULD:handle Health Connect Provider Directory Requester Actor SHOULD:handle Health Connect Provider Directory Bulk Export Requester Actor
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PractitionerRole.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
PractitionerRole.extension:suppressed.​extension:suppressedBy.​value[x].coding	Base	required	Responsible Party Type	📍26.0.0	This IG
PractitionerRole.extension:deactivated.​extension:deactivatedBy.​value[x].coding	Base	required	Responsible Party Type	📍26.0.0	This IG
PractitionerRole.code	Base	preferred	https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1	Not State	Unknown
PractitionerRole.specialty	Base	preferred	https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1	Not State	Unknown
PractitionerRole.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
PractitionerRole.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
PractitionerRole.availableTime.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from AUCorePractitionerRole

Summary

Mandatory: 10 elements
Must-Support: 23 elements

Structures

This structure refers to these other structures:

• HCPD Local Identifier (HCPD-LI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-local-identifier|26.0.0)
• HCPD Source Identifier (HCPD-SI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-source-identifier|26.0.0)
• Peak Body Professional Registration Number (PBPRN) (http://digitalhealth.gov.au/fhir/cc/StructureDefinition/pbprn|26.0.0)
• AU Ahpra Registration Number (http://hl7.org.au/fhir/StructureDefinition/au-ahpraregistrationnumber|6.0.0)
• HCPD Practitioner (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner|26.0.0)
• HCPD Organization (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization|26.0.0)
• HCPD Location (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location|26.0.0)
• HCPD HealthcareService (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-healthcareservice|26.0.0)
• HCPD Endpoint (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint|26.0.0)

Extensions

This structure refers to these extensions:

• http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed|26.0.0
• http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated|26.0.0
• http://digitalhealth.gov.au/fhir/cc/StructureDefinition/practitioner-role-communication|26.0.0
• http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name|26.0.0

Slices

This structure defines the following Slices:

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