Release 4B 5

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0: R5 - STU ). The This is the current published version which supercedes in it's permanent home (it will always be available at this version is 5.0.0 . URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R5 R4B R4 R3

Patient Administration icon Work Group Maturity Level : 2 4   Trial Use Security Category : Individual Compartments : Practitioner

Detailed Descriptions for the elements in the PractitionerRole resource.

PractitionerRole.availableTime.daysOfWeek PractitionerRole.availableTime.allDay Element Id PractitionerRole.availableTime.allDay Cardinality 0..1 Type boolean Summary false PractitionerRole.availabilityExceptions Cardinality 0..1 Type string Summary false
PractitionerRole
Element Id PractitionerRole
Definition

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Short Display Roles/organizations the practitioner is associated with
Cardinality 0..*
Type DomainResource
Requirements

Need to track services that a healthcare provider is able to provide at an organization's location, and the services that they can perform there.

Summary false
PractitionerRole.identifier
Element Id PractitionerRole.identifier
Definition

Business Identifiers that are specific to a role/location.

Short Display Identifiers for a role/location
Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Requirements

Often, specific identities are assigned for the agent.

Summary true
Comments

A specific identifier value (e.g. Minnesota Registration ID) may appear on multiple PractitionerRole instances which could be for different periods, or different Roles (or other reasons). A specific identifier may be included multiple times in the same PractitionerRole instance with different identifier validity periods.

PractitionerRole.active
Element Id PractitionerRole.active
Definition

Whether this practitioner role record is in active use. Some systems may use this property to mark non-active practitioners, such as those that are not currently employed.

Short Display Whether this practitioner role record is in active use
Cardinality 0..1
Type boolean
Meaning if Missing This resource is generally assumed to be active if no value is provided for the active element
Requirements

Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.

Summary true
Comments

If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

PractitionerRole.period
Element Id PractitionerRole.period
Definition

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

Short Display The period during which the practitioner is authorized to perform in these role(s)
Cardinality 0..1
Type Period
Requirements

Even after the agencies is revoked, the fact that it existed must still be recorded.

Summary true
Comments

If a practitioner is performing a role within an organization over multiple, non-adjacent periods, there should be a distinct PractitionerRole instance for each period. For example, if a nurse is employed at a hospital, leaves the organization for a period of time due to pandemic related stress, but returns post-pandemic to the same job role, there would be two PractitionerRole instances for the different periods of employment.

PractitionerRole.practitioner
Element Id PractitionerRole.practitioner
Definition

Practitioner that is able to provide the defined services for the organization.

Short Display Practitioner that provides services for the organization
Cardinality 0..1
Type Reference ( Practitioner )
Summary true
PractitionerRole.organization
Element Id PractitionerRole.organization
Definition

The organization where the Practitioner performs the roles associated.

Short Display Organization where the roles are available
Cardinality 0..1
Type Reference ( Organization )
Summary true
PractitionerRole.code
Element Id PractitionerRole.code
Definition

Roles which this practitioner is authorized to perform for the organization.

Short Display Roles which this practitioner may perform
Cardinality 0..*
Terminology Binding PractitionerRole : Practitioner Role ( Example )
Type CodeableConcept
Requirements

Need to know what authority the practitioner has - what can they do?

Summary true
Comments

A person may have more than one role.

PractitionerRole.specialty
Element Id PractitionerRole.specialty
Definition

Specific The specialty of a practitioner that describes the practitioner. functional role they are practicing at a given organization or location.

Short Display Specific specialty of the practitioner
Cardinality 0..*
Terminology Binding Practice Setting Code Value Set ( Preferred )
Type CodeableConcept
Summary true
Comments

The specialty represents the functional role a practitioner is playing within an organization/location. This role may require the individual have certain qualifications, which would be represented in the Practitioner.qualifications property. Note that qualifications may or might not relate to or be required by the practicing specialty.

PractitionerRole.location
Element Id PractitionerRole.location
Definition

The location(s) at which this practitioner provides care.

Short Display Location(s) where the practitioner provides care
Cardinality 0..*
Type Reference ( Location )
Summary true
PractitionerRole.healthcareService
Element Id PractitionerRole.healthcareService
Definition

The list of healthcare services that this worker provides for this role's Organization/Location(s).

Short Display Healthcare services provided for this role's Organization/Location(s)
Cardinality 0..*
Type Reference ( HealthcareService )
Summary false
PractitionerRole.telecom PractitionerRole.contact
Element Id PractitionerRole.telecom PractitionerRole.contact
Definition

Contact The contact details that are specific of communication devices available relevant to the role/location/service. specific PractitionerRole. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Short Display Official contact details relating to this PractitionerRole
Cardinality 0..*
Type ContactPoint ExtendedContactDetail
Requirements

Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these. Sometimes these also include a named person/organization that handles contact for specific purposes, such as a receptionist, or accounts clerk etc.

Summary true false
PractitionerRole.availableTime PractitionerRole.characteristic
Element Id PractitionerRole.availableTime PractitionerRole.characteristic
Definition

A collection Collection of times the practitioner is available or performing this role at the location and/or healthcareservice. Cardinality 0..* Summary false Comments More detailed availability information may be provided in associated Schedule/Slot resources. characteristics (attributes).

Element Id PractitionerRole.availableTime.daysOfWeek Definition Short Display Indicates which days Collection of the week are available between the start and end Times. characteristics (attributes)
Cardinality 0..*
Terminology Binding DaysOfWeek Service Mode ( Required Example )
Type code CodeableConcept
Summary false
Definition Comments

Is These could be such things as is the service mode used by this always available? (hence times are irrelevant) e.g. 24 hour service. role.

PractitionerRole.availableTime.availableStartTime PractitionerRole.communication
Element Id PractitionerRole.availableTime.availableStartTime PractitionerRole.communication
Definition

A language the practitioner can use in patient communication. The opening time of day. Note: If practitioner may know several languages (listed in practitioner.communication), however these are the AllDay flag is set, then this time is ignored. languages that could be advertised in a directory for a patient to search.

Cardinality Short Display 0..1 A language the practitioner (in this role) can use in patient communication
Type Cardinality time 0..*
Summary Terminology Binding false All Languages ( Required ) Comments Definition
Additional Bindings The timezone is expected to be for where this HealthcareService is provided at. Purpose
Common Languages PractitionerRole.availableTime.availableEndTime Element Id Starter Set PractitionerRole.availableTime.availableEndTime
The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Cardinality Type 0..1 CodeableConcept
Type Requirements time

Knowing which language a practitioner speaks can help in facilitating patients to locate practitioners that speak their language.

Summary false
Comments

The timezone structure aa-BB with this exact casing is expected to be one the most widely used notations for where locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Note that for non-patient oriented communication, see Practitioner.communication. Note that all 'person' type resources (Person, RelatedPerson, Patient, Practitioner) have a communication structure that includes preferences. Role or service oriented resources such as HealthcareService is provided at. and PractitionerRole only include languages that are available for interacting with patients.

PractitionerRole.notAvailable PractitionerRole.availability
Element Id PractitionerRole.notAvailable PractitionerRole.availability
Definition

The A collection of times the practitioner is not available or performing this role during this period of time due to at the provided reason. location and/or healthcareservice.

Cardinality 0..* Summary false PractitionerRole.notAvailable.description Element Id PractitionerRole.notAvailable.description Definition Short Display The reason that can be presented to Times the user as to why this time is not available. Cardinality 1..1 Type string Summary false PractitionerRole.notAvailable.during Element Id PractitionerRole.notAvailable.during Definition Service Practitioner is not available (seasonally or for a public holiday) from at this date. location and/or healthcare service (including exceptions)
Cardinality 0..1 0..*
Type Period Availability
Summary false
Element Id PractitionerRole.availabilityExceptions Definition Comments

A description of site More detailed availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions information may be provided in associated Schedule/Slot resources.

Systems may choose to normal site render availability as details in differently than it is exchanged on the available Times interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm".

The NotAvailableTime(s) included indicate the general days/periods where the practitioner is not available Times. (for things such as vacation time, or public holidays).

PractitionerRole.endpoint
Element Id PractitionerRole.endpoint
Definition

Technical endpoints providing access to services operated for the practitioner with this role. Commonly used for locating scheduling services, or identifying where to send referrals electronically.

Short Display Endpoints for interacting with the practitioner in this role
Cardinality 0..*
Type Reference ( Endpoint )
Requirements

Organizations have multiple systems that provide various services and ,ay may also be different for practitioners too.

So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.

Summary false