| Australian Digital Health Agency FHIR Implementation Guide 1.1.0

This page is part of the Australian Digital Health Agency FHIR Implementation Guide 1.1.0. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available previous versions.

### StructureDefinition: ADHA Authoring PractitionerRole [Active]

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

This profile identifies the additional constraints, extensions, and value sets that build on and extend PractitionerRole that are supported.

A PractitionerRole resource is used within the context of a referencing resource.

This profile is designed to set a PractitionerRole standard for:

- Recording or updating an authoring practitioner role referenced by another resource
- Reading authoring practitioner roles referenced by another resource

#### Profile specific guidance

None.

#### Boundaries and relationships

This profile is referenced by ADHA Core Condition, ADHA Core DocumentReference, ADHA Core Flag, ADHA Record of Immunisation from Australian Immunisation Register, ADHA Core Immunization, ADHA Core MedicationRequest, ADHA Core Observation, and ADHA Core Procedure.

#### Formal Views of Profile Content

The official URL for this profile is:

    http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-author-1

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

This profile builds on ADHAPractitionerRoleCore.

This profile was published on 2023-08-07 09:41:43+1000 as a active by Australian Digital Health Agency.

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

- Differential Table
- Snapshot Table
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | ADHAPractitionerRoleCore | A practitioner acting as an author or observer in a healthcare role, on behalf of an organisation
practitioner |  | 1..1 | Reference(ADHA Core Practitioner) | Practitioner that is able to provide the defined services for the organization
reference |  | 1..1 | string | Literal reference, Relative, internal or absolute URL
organization |  | 1..1 | Reference(ADHA Core Organization) | Organization where the roles are available
reference |  | 1..1 | string | Literal reference, Relative, internal or absolute URL
telecom |  | 1..* | ContactPoint | Contact details that are specific to the role/location/service
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | ADHAPractitionerRoleCore | A practitioner acting as an author or observer in a healthcare role, on behalf of an organisation
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S | 1..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:hpii | S C | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I)
identifier:caei | S C | 0..1 | AUCareAgencyEmployeeIdentifier | Care Agency Employee (CAE) Identifier
identifier:medicareProvider | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number
active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use Fixed Value: true
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
practitioner | S Σ C | 1..1 | Reference(ADHA Core Practitioner) | Practitioner that is able to provide the defined services for the organization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
organization | S Σ C | 1..1 | Reference(ADHA Core Organization) | Organization where the roles are available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
location | S Σ C | 0..* | Reference(ADHA Core Location) | The location(s) at which this practitioner provides care
healthcareService | S C | 0..1 | Reference(ADHA Core HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | S Σ | 1..* | ContactPoint | Contact details that are specific to the role/location/service
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
timeZone |  | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value |  | 0..1 | time | Primitive value for time
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
timeZone |  | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value |  | 0..1 | time | Primitive value for time
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Differential View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | ADHAPractitionerRoleCore | A practitioner acting as an author or observer in a healthcare role, on behalf of an organisation
practitioner |  | 1..1 | Reference(ADHA Core Practitioner) | Practitioner that is able to provide the defined services for the organization
reference |  | 1..1 | string | Literal reference, Relative, internal or absolute URL
organization |  | 1..1 | Reference(ADHA Core Organization) | Organization where the roles are available
reference |  | 1..1 | string | Literal reference, Relative, internal or absolute URL
telecom |  | 1..* | ContactPoint | Contact details that are specific to the role/location/service
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | ADHAPractitionerRoleCore | A practitioner acting as an author or observer in a healthcare role, on behalf of an organisation
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S | 1..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
identifier:hpii | S C | 0..1 | AUHPII | Healthcare Provider Identifier – Individual (HPI-I)
identifier:caei | S C | 0..1 | AUCareAgencyEmployeeIdentifier | Care Agency Employee (CAE) Identifier
identifier:medicareProvider | S | 0..1 | AUMedicareProviderNumber | Medicare Provider Number
active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use Fixed Value: true
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
practitioner | S Σ C | 1..1 | Reference(ADHA Core Practitioner) | Practitioner that is able to provide the defined services for the organization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
organization | S Σ C | 1..1 | Reference(ADHA Core Organization) | Organization where the roles are available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1 (preferred)
location | S Σ C | 0..* | Reference(ADHA Core Location) | The location(s) at which this practitioner provides care
healthcareService | S C | 0..1 | Reference(ADHA Core HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | S Σ | 1..* | ContactPoint | Contact details that are specific to the role/location/service
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
timeZone |  | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value |  | 0..1 | time | Primitive value for time
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
timeZone |  | 0..1 | CodeableConcept | AU time zone URL: http://hl7.org.au/fhir/StructureDefinition/au-timezone Binding: AU Time Zone (required)
value |  | 0..1 | time | Primitive value for time
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

#### Terminology Bindings

Path | Conformance | ValueSet
PractitionerRole.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
PractitionerRole.practitioner.type | extensible | ResourceType
PractitionerRole.organization.type | extensible | ResourceType
PractitionerRole.code | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
PractitionerRole.specialty | preferred | https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek

#### Search Parameters

None defined.