FHIR Release 3 (STU) Current Build
This page is part of FHIR STU 3 (v3.0.1) in it's permanent home (it will always be available at this URL). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .
Patient Administration Work Group Maturity Level : 2   Trial Use Security 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.

Control Cardinality 1..1 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.

PractitionerRole.identifier
Element Id PractitionerRole.identifier
Definition

Business Identifiers that are specific to a role/location.

Note This is a business identifer, identifier, not a resource identifier (see discussion )
Control Cardinality 0..*
Type Identifier
Requirements

Often, specific identities are assigned for the agent.

Summary true
PractitionerRole.active
Element Id PractitionerRole.active
Definition

Whether this practitioner's practitioner role record is in active use.

Control Cardinality 0..1
Type boolean
Default Value Meaning if Missing true 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. error, or otherwise no longer in active use.

Summary true
Comments

Default is true. If the practitioner this value is not in use by one organization, then it should mark false, you may refer to the period on to see when the PractitonerRole with an end date (even if they are active) as they may be active role was in another role. 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.

Control Cardinality 0..1
Type Period
Requirements

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

Summary true
PractitionerRole.practitioner
Element Id PractitionerRole.practitioner
Definition

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

Control Cardinality 0..1
Type Reference ( Practitioner )
Summary true
PractitionerRole.organization
Element Id PractitionerRole.organization
Definition

The organization where the Practitioner performs the roles associated.

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

Control 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. At least one role is required.

PractitionerRole.specialty
Element Id PractitionerRole.specialty
Definition

Specific specialty of the practitioner.

Control Cardinality 0..*
Terminology Binding Practice Setting Code Value Set ( Preferred )
Type CodeableConcept
Summary true
PractitionerRole.location
Element Id PractitionerRole.location
Definition

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

Control 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).

Control Cardinality 0..*
Type Reference ( HealthcareService )
PractitionerRole.telecom
Element Id PractitionerRole.telecom
Definition

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

Control Cardinality 0..*
Type ContactPoint
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.

Summary true
PractitionerRole.availableTime
Element Id PractitionerRole.availableTime
Definition

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

Control Cardinality 0..*
Comments

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

PractitionerRole.availableTime.daysOfWeek
Element Id PractitionerRole.availableTime.daysOfWeek
Definition

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

Control Cardinality 0..*
Terminology Binding DaysOfWeek ( Required )
Type code
PractitionerRole.availableTime.allDay
Element Id PractitionerRole.availableTime.allDay
Definition

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

Control Cardinality 0..1
Type boolean
PractitionerRole.availableTime.availableStartTime
Element Id PractitionerRole.availableTime.availableStartTime
Definition

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

Control Cardinality 0..1
Type time
Comments

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

PractitionerRole.availableTime.availableEndTime
Element Id PractitionerRole.availableTime.availableEndTime
Definition

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

Control Cardinality 0..1
Type time
Comments

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

PractitionerRole.notAvailable
Element Id PractitionerRole.notAvailable
Definition

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

Control Cardinality 0..*
PractitionerRole.notAvailable.description
Element Id PractitionerRole.notAvailable.description
Definition

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

Control Cardinality 1..1
Type string
PractitionerRole.notAvailable.during
Element Id PractitionerRole.notAvailable.during
Definition

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

Control Cardinality 0..1
Type Period
PractitionerRole.availabilityExceptions
Element Id PractitionerRole.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.

Control Cardinality 0..1
Type string
PractitionerRole.endpoint
Element Id PractitionerRole.endpoint
Definition

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

Control Cardinality 0..*
Type Reference ( 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.