AU eRequesting Implementation Guide
1.0.0-preview - Preview

AU eRequesting Implementation Guide - Downloaded Version 1.0.0-preview See the Directory of published versions

## Resource Profile: AU eRequesting PractitionerRole

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-practitionerrole | Version: 1.0.0-preview
Standards status: Draft | Maturity Level: 0 | Computable Name: AUeRequestingPractitionerRole
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a PractitionerRole resource that is used to record, search, and fetch a practitioner role for a practitioner associated with a patient. It is based on the AU Core PractitionerRole profile and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the PractitionerRole resource when conforming to this profile.

### Profile Specific Implementation Guidance

- See the general guidance on implementing the PractitionerRole resource in AU Core.

Obligations for AU Core actors (AU Core Requester and AU Core Responder) inherited from AU Core PractitionerRole currently render in the profile view. This is a tooling limitation, and only the AU eRequesting actor obligations should be applied. See Zulip discussion for more information.

Usages:

- Refer to this Profile: AU eRequesting CommunicationRequest CopyTo, AU eRequesting CommunicationRequest Urgent Provider, AU eRequesting CommunicationRequest, AU eRequesting Diagnostic Request... Show 2 more, AU eRequesting Encounter and AU eRequesting Task
- Examples for this Profile: PractitionerRole/diagnostic-mclaughlin-kimberlee, PractitionerRole/generalpractitioner-guthridge-jarred, PractitionerRole/obstetrician-losch-sallie and PractitionerRole/pathologist-herbert-aimee
- CapabilityStatements using this Profile: AU eRequesting Filler CapabilityStatement, AU eRequesting Patient CapabilityStatement, AU eRequesting Placer CapabilityStatement and AU eRequesting Server CapabilityStatement

You can also check for usages in the FHIR IG Statistics

Changes since version 1.0.0-ballot:

- New Content

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
identifier:medicareProvider | SO Σ | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
practitioner | SO Σ C | 1..1 | Reference(AU eRequesting Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
organization | SO Σ | 0..1 | Reference(AU eRequesting Organization) | Organization where the roles are available
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
code | SO Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
specialty | SO Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
telecom | SO Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
system | SO Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.code | Base | preferred | Practitioner Role | ⏿1.0.2 | tx.ontoserver.csiro.au
PractitionerRole.specialty | Base | preferred | Clinical Specialty | ⏿1.0.0 | tx.ontoserver.csiro.au
PractitionerRole.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
PractitionerRole.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present | `(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from AUCorePractitionerRole

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services
identifier | O | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:medicareProvider | O | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
practitioner | O | 1..1 | Reference(AU eRequesting Practitioner) | Practitioner that is able to provide the defined services for the organization
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
organization | O | 0..1 | Reference(AU eRequesting Organization) | Organization where the roles are available
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
code | O | 0..* | CodeableConcept | Roles which this practitioner may perform
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
specialty | O | 0..* | CodeableConcept | Specific specialty of the practitioner
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
telecom | O | 0..* | ContactPoint | Contact details that are specific to the role/location/service
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
system | O | 0..1 | code | phone | fax | email | pager | url | sms | other
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
value | O | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
identifier:medicareProvider | SO Σ | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
practitioner | SO Σ C | 1..1 | Reference(AU eRequesting Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
organization | SO Σ | 0..1 | Reference(AU eRequesting Organization) | Organization where the roles are available
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
code | SO Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
specialty | SO Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService |  | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | SO Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | SO Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:timeZone |  | 0..1 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175)
value |  | 0..1 | time | Primitive value for time
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:timeZone |  | 0..1 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175)
value |  | 0..1 | time | Primitive value for time
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
PractitionerRole.code | Base | preferred | Practitioner Role | ⏿1.0.2 | tx.ontoserver.csiro.au
PractitionerRole.specialty | Base | preferred | Clinical Specialty | ⏿1.0.0 | tx.ontoserver.csiro.au
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
au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present | `(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from AUCorePractitionerRole

Summary

Structures

This structure refers to these other structures:

- AU eRequesting Practitioner (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-practitioner)
- AU eRequesting Organization (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-organization)

Maturity: 0

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
identifier:medicareProvider | SO Σ | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
practitioner | SO Σ C | 1..1 | Reference(AU eRequesting Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
organization | SO Σ | 0..1 | Reference(AU eRequesting Organization) | Organization where the roles are available
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
code | SO Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
specialty | SO Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
telecom | SO Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
system | SO Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.code | Base | preferred | Practitioner Role | ⏿1.0.2 | tx.ontoserver.csiro.au
PractitionerRole.specialty | Base | preferred | Clinical Specialty | ⏿1.0.0 | tx.ontoserver.csiro.au
PractitionerRole.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
PractitionerRole.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present | `(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from AUCorePractitionerRole

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services
identifier | O | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:medicareProvider | O | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
practitioner | O | 1..1 | Reference(AU eRequesting Practitioner) | Practitioner that is able to provide the defined services for the organization
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
organization | O | 0..1 | Reference(AU eRequesting Organization) | Organization where the roles are available
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
code | O | 0..* | CodeableConcept | Roles which this practitioner may perform
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
specialty | O | 0..* | CodeableConcept | Specific specialty of the practitioner
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
telecom | O | 0..* | ContactPoint | Contact details that are specific to the role/location/service
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
system | O | 0..1 | code | phone | fax | email | pager | url | sms | other
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
value | O | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | AUCorePractitionerRole | A person with formal responsibility in a role providing one or more services
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | SO Σ | 0..* | Identifier, AUMedicareProviderNumber, AUNationalProviderIdentifierAtOrganisation, AUEmployeeNumber | Business Identifiers that are specific to a role/location Slice: Unordered, Open by pattern:type
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
identifier:medicareProvider | SO Σ | 0..1 | AUMedicareProviderNumber | Business Identifiers that are specific to a role/location
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
practitioner | SO Σ C | 1..1 | Reference(AU eRequesting Practitioner) | Practitioner that is able to provide the defined services for the organization Constraints: au-core-prarol-01
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
organization | SO Σ | 0..1 | Reference(AU eRequesting Organization) | Organization where the roles are available
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
code | SO Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: Practitioner Role (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
specialty | SO Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Clinical Specialty (preferred)
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService |  | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | SO Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | SO Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
value | SO Σ | 0..1 | string | The actual contact point details
Obligations | Actor | Source
SHALL:populate-if-known | AU Core Responder | from AU Core PractitionerRole
SHALL:no-error | AU Core Requester | from AU Core PractitionerRole
SHALL:populate-if-known & SHALL:populate-if-known | AU Core Responder AU eRequesting Placer | from AU Core PractitionerRole
SHALL:no-error & SHALL:handle | AU Core Requester AU eRequesting Filler | from AU Core PractitionerRole
SHALL:handle | AU eRequesting Server |
SHALL:able-to-populate | AU eRequesting Server |
SHALL:no-error | AU eRequesting Patient |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:timeZone |  | 0..1 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175)
value |  | 0..1 | time | Primitive value for time
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:timeZone |  | 0..1 | code | IANA Timezone Code per BCP 175 URL: http://hl7.org/fhir/StructureDefinition/timezone Binding: IANATimezones (required): IANA Timezones (BCP 175)
value |  | 0..1 | time | Primitive value for time
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
PractitionerRole.code | Base | preferred | Practitioner Role | ⏿1.0.2 | tx.ontoserver.csiro.au
PractitionerRole.specialty | Base | preferred | Clinical Specialty | ⏿1.0.0 | tx.ontoserver.csiro.au
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
au-core-prarol-01 | error | PractitionerRole.practitioner | At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present | `(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()`
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from AUCorePractitionerRole

Summary

Structures

This structure refers to these other structures:

- AU eRequesting Practitioner (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-practitioner)
- AU eRequesting Organization (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-organization)

Maturity: 0

Other representations of profile: CSV, Excel, Schematron

### Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU eRequesting CapabilityStatements for a complete list of supported RESTful interactions for this IG.

FHIR search operations are described here and the syntax used to describe AU eRequesting interactions is defined here.

Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT".

Parameter(s) | Server Conformance | Placer Conformance | Filler Conformance | Patient Conformance | Type(s) | Requirements (when used alone or in combination)
--- | --- | --- | --- | --- | --- | ---
_id | SHALL | MAY | MAY | MAY | `token` |
identifier | SHALL | MAY | MAY | MAY | `token` |
_include=PractitionerRole:practitioner | SHALL | MAY | MAY | MAY | `token` |
_include=PractitionerRole:organization | SHALL | MAY | MAY | MAY | `token` |

#### Search Parameters:

The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.

1. `_id` search parameter
   - including support for these `_include` parameters: `PractitionerRole:practitioner`and `PractitionerRole:organization`

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

   Example:

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

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

2. `identifier` search parameter
   - including support for these `_include` parameters: `PractitionerRole:practitioner`and `PractitionerRole:organization`

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

   Example:

   1. GET [base]/PractitionerRole?identifier=http://ns.electronichealth.net.au/id/medicare-provider-number|2426621B
   2. GET [base]/PractitionerRole?identifier=http://ns.electronichealth.net.au/id/medicare-provider-number|2426621B&_include=PractitionerRole:practitioner&_include=PractitionerRole:organization

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