R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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 Work GroupMaturity Level: 2 Trial Use 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.

Control1..1
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.

PractitionerRole.identifier
Element IdPractitionerRole.identifier
Definition

Business Identifiers that are specific to a role/location.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Often, specific identities are assigned for the agent.

Summarytrue
PractitionerRole.active
Element IdPractitionerRole.active
Definition

Whether this practitioner role record is in active use.

Control0..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.

Control0..1
TypePeriod
Requirements

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

Summarytrue
PractitionerRole.practitioner
Element IdPractitionerRole.practitioner
Definition

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

Control0..1
TypeReference(Practitioner)
Summarytrue
PractitionerRole.organization
Element IdPractitionerRole.organization
Definition

The organization where the Practitioner performs the roles associated.

Control0..1
TypeReference(Organization)
Summarytrue
PractitionerRole.code
Element IdPractitionerRole.code
Definition

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

Control0..*
Terminology BindingPractitionerRole (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. At least one role is required.

PractitionerRole.specialty
Element IdPractitionerRole.specialty
Definition

Specific specialty of the practitioner.

Control0..*
Terminology BindingPractice Setting Code Value Set (Preferred)
TypeCodeableConcept
Summarytrue
PractitionerRole.location
Element IdPractitionerRole.location
Definition

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

Control0..*
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).

Control0..*
TypeReference(HealthcareService)
PractitionerRole.telecom
Element IdPractitionerRole.telecom
Definition

Contact details that are specific to the role/location/service.

Control0..*
TypeContactPoint
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.

Summarytrue
PractitionerRole.availableTime
Element IdPractitionerRole.availableTime
Definition

A collection of times that the Service Site is available.

Control0..*
Comments

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

PractitionerRole.availableTime.daysOfWeek
Element IdPractitionerRole.availableTime.daysOfWeek
Definition

Indicates which days of the week are available between the start and end Times.

Control0..*
Terminology BindingDaysOfWeek (Required)
Typecode
PractitionerRole.availableTime.allDay
Element IdPractitionerRole.availableTime.allDay
Definition

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

Control0..1
Typeboolean
PractitionerRole.availableTime.availableStartTime
Element IdPractitionerRole.availableTime.availableStartTime
Definition

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

Control0..1
Typetime
Comments

The timezone is expected to be for where this HealthcareService is provided at.

PractitionerRole.availableTime.availableEndTime
Element IdPractitionerRole.availableTime.availableEndTime
Definition

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

Control0..1
Typetime
Comments

The timezone is expected to be for where this HealthcareService is provided at.

PractitionerRole.notAvailable
Element IdPractitionerRole.notAvailable
Definition

The HealthcareService is not available during this period of time due to the provided reason.

Control0..*
PractitionerRole.notAvailable.description
Element IdPractitionerRole.notAvailable.description
Definition

The reason that can be presented to the user as to why this time is not available.

Control1..1
Typestring
PractitionerRole.notAvailable.during
Element IdPractitionerRole.notAvailable.during
Definition

Service is not available (seasonally or for a public holiday) from this date.

Control0..1
TypePeriod
PractitionerRole.availabilityExceptions
Element IdPractitionerRole.availabilityExceptions
Definition

A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

Control0..1
Typestring
PractitionerRole.endpoint
Element IdPractitionerRole.endpoint
Definition

Technical endpoints providing access to services operated for the practitioner with this role.

Control0..*
TypeReference(Endpoint)
Requirements

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