R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Patient Administration icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Individual Compartments: Practitioner

Detailed Descriptions for the elements in the PractitionerRole resource.

PractitionerRole
Element IdPractitionerRole
Definition

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

Short DisplayRoles/organizations the practitioner is associated with
Cardinality0..*
TypeDomainResource
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.

Summaryfalse
PractitionerRole.identifier
Element IdPractitionerRole.identifier
Definition

Business Identifiers that are specific to a role/location.

Short DisplayIdentifiers for a role/location
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Often, specific identities are assigned for the agent.

Summarytrue
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 IdPractitionerRole.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 DisplayWhether this practitioner role record is in active use
Cardinality0..1
Typeboolean
Meaning if MissingThis 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.

Summarytrue
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 IdPractitionerRole.period
Definition

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

Short DisplayThe period during which the practitioner is authorized to perform in these role(s)
Cardinality0..1
TypePeriod
Requirements

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

Summarytrue
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 IdPractitionerRole.practitioner
Definition

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

Short DisplayPractitioner that provides services for the organization
Cardinality0..1
TypeReference(Practitioner)
Summarytrue
PractitionerRole.organization
Element IdPractitionerRole.organization
Definition

The organization where the Practitioner performs the roles associated.

Short DisplayOrganization where the roles are available
Cardinality0..1
TypeReference(Organization)
Summarytrue
PractitionerRole.code
Element IdPractitionerRole.code
Definition

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

Short DisplayRoles which this practitioner may perform
Cardinality0..*
Terminology BindingPractitioner Role (Example)
TypeCodeableConcept
Requirements

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

Summarytrue
Comments

A person may have more than one role.

PractitionerRole.specialty
Element IdPractitionerRole.specialty
Definition

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

Short DisplaySpecific specialty of the practitioner
Cardinality0..*
Terminology BindingPractice Setting Code Value Set (Preferred)
TypeCodeableConcept
Summarytrue
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 IdPractitionerRole.location
Definition

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

Short DisplayLocation(s) where the practitioner provides care
Cardinality0..*
TypeReference(Location)
Summarytrue
PractitionerRole.healthcareService
Element IdPractitionerRole.healthcareService
Definition

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

Short DisplayHealthcare services provided for this role's Organization/Location(s)
Cardinality0..*
TypeReference(HealthcareService)
Summaryfalse
PractitionerRole.contact
Element IdPractitionerRole.contact
Definition

The contact details of communication devices available relevant to the specific PractitionerRole. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Short DisplayOfficial contact details relating to this PractitionerRole
Cardinality0..*
TypeExtendedContactDetail
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.

Summaryfalse
PractitionerRole.characteristic
Element IdPractitionerRole.characteristic
Definition

Collection of characteristics (attributes).

Short DisplayCollection of characteristics (attributes)
Cardinality0..*
Terminology BindingService Mode (Example)
TypeCodeableConcept
Summaryfalse
Comments

These could be such things as is the service mode used by this role.

PractitionerRole.communication
Element IdPractitionerRole.communication
Definition

A language the practitioner can use in patient communication. The practitioner may know several languages (listed in practitioner.communication), however these are the languages that could be advertised in a directory for a patient to search.

Short DisplayA language the practitioner (in this role) can use in patient communication
Cardinality0..*
Terminology BindingAll Languages (Required)
Additional BindingsPurpose
Common LanguagesStarter Set
TypeCodeableConcept
Requirements

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

Summaryfalse
Comments

The structure aa-BB with this exact casing is one the most widely used notations for 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 and PractitionerRole only include languages that are available for interacting with patients.

PractitionerRole.availability
Element IdPractitionerRole.availability
Definition

A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

Short DisplayTimes the Practitioner is available at this location and/or healthcare service (including exceptions)
Cardinality0..*
TypeAvailability
Summaryfalse
Comments

More detailed availability information may be provided in associated Schedule/Slot resources.

Systems may choose to render availability differently than it is exchanged on the 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 (for things such as vacation time, or public holidays).

PractitionerRole.endpoint
Element IdPractitionerRole.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 DisplayEndpoints for interacting with the practitioner in this role
Cardinality0..*
TypeReference(Endpoint)
Requirements

Organizations have multiple systems that provide various services and 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.

Summaryfalse