FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

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

Detailed Descriptions for the elements in the PractitionerRole resource.

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 this role is available.

Short Display Organization where the role is available
Cardinality 0..1
Type Reference(Organization)
Summary true
Comments

Some relationships (represented as PractitionerRoles) that may exist between practitioners and organizations include:

  • A practitioner may act as a pediatrician when associated with an organization that runs a family clinic. PractitionerRole.organization would represent the family clinic.
  • The same practitioner may act as a physician when providing physicals for an athletics department at a school. PractitionerRole.organization would represent the school.
  • A practitioner may perform coumadin / anticoagulation services for a clinic run by a health system. PractitionerRole.organization would represent the coumadin clinic.
  • A practitioner may act as an inpatient pharmacist reviewing and dispensing medications. PractitionerRole.organization would represent the hospital pharmacy.
  • A practitioner may perform medication management and adherence services for an internal medicine clinic. PractitionerRole.organization would represent the internal medicine clinic.
  • A practitioner is part of a payer's network (such as a preferred provider organization (PPO), or health maintenance organizations (HMO)). PractitionerRole.organization would represent the payer's network.

Each of the examples above above, would be represented as different PractitionerRole instances, each with a different values for PractitionerRole.organization.

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 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.display
Element Id PractitionerRole.display
Definition

A value that describes the intersection of the practitioner, organization, and the role of the practitioner within the organization. This is not the human name of the practitioner, though the textual representation of that human name may be a part of this property.

Short Display Denormalized practitioner name, role, organization and location
Cardinality 0..1
Type string
Summary true
Comments

The PractitionerRole display value may be considered a de-normalized value from Practitioner and/or Organization for the purposes of convenient display in both the PractitionerRole resources and reference to it. When a system is consuming a PractitionerRole resource and displaying a name to a user, they may choose to use PractitionerRole.display, or they could use one or both of the names from the referenced Practitioner and/or Organization resources along with the role or other relevant properties in PractitionerRole.

PractitionerRole.specialty
Element Id PractitionerRole.specialty
Definition

The specialty of a practitioner that describes the 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.contact
Element Id PractitionerRole.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 Display Official contact details relating to this PractitionerRole
Cardinality 0..*
Type 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 false
PractitionerRole.characteristic
Element Id PractitionerRole.characteristic
Definition

Collection of characteristics (attributes).

Short Display Collection of characteristics (attributes)
Cardinality 0..*
Terminology Binding Service Mode (Example)
Type CodeableConcept
Summary false
Comments

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

PractitionerRole.communication
Element Id PractitionerRole.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 Display A language the practitioner (in this role) can use in patient communication
Cardinality 0..*
Terminology Binding All Languages (Required)
Additional BindingsPurpose
Common Languages Starter Set
Type CodeableConcept
Requirements

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

Summary false
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 Id PractitionerRole.availability
Definition

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

Short Display Times the Practitioner is available at this location and/or healthcare service (including exceptions)
Cardinality 0..1
Type Availability
Summary false
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 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 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