FHIR CI-Build

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

8.5 Resource PractitionerRole - Content

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

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

Note to Implementers: The name property has been added as a denormalized representation of the various core properties of this resource. The expected usage would be for easily populating the display field in references to this resource. We request feedback on whether implementers have a need for this property and if that need aligns with the proposed element definition.

Feedback is welcome here icon.

8.5.1 Scope and Usage

The PractitionerRole describes the types of services that practitioners provide for an organization at specific location(s).

The PractitionerRole resource can be used in multiple contexts including:

  • Provider Registries where it indicates what a practitioner can perform for an organization (may indicate multiple healthcareservices, locations, and roles)
  • In a Clinical system where it indicates the role, healthcareservice and location details associated with a practitioner that are applicable to the healthcare event (e.g. Observation, Appointment, Condition, CarePlan)
  • In a Clinical system as a point of reference rather than an event, such as a patient's preferred general practitioner (at a specific clinic)

The role, specialty, Location telecom and HealthcareService properties can be repeated if required in other instances of the PractitionerRole. Some systems record a collection of service values for a single location, others record the single service and the list of locations it is available. Both are acceptable options for representing this data.
Where availability, telecom, or other details are not the same across all healthcareservices, or locations a separate PractitionerRole instance should be created.

Many resource types have a choice of a reference to either a Practitioner resource or a PractitionerRole resource. The latter provides organizational context for the practitioners participation when it is required, otherwise a direct reference to the practitioner may be used.
Many implementations may choose to profile the PractitionerRole to a single location/role/healthcareservice for their specific usage.
As the property that references a PractitionerRole typically has a specific context, the code on the PractitionerRole having duplicate code values is not a big concern (and is used for discovery where required).
e.g. These references are all very context specific: Patient.GeneralPractitioner, CarePlan.reported, CarePlan.contributor, Appointment.participant (through the participant.role), Immunization.informationSource, Immunization.performer (through the performer.function property)

For use cases where an organization has activities where a practitioner is not defined/pre-allocated for a specific role (e.g. an un-named surgeon at XYZ Hospital), a PractitionerRole resource can be used with an empty Practitioner property, and the other relevant role properties populated - i.e. code, organization.

8.5.2 Boundaries and Relationships

Qualifications (from the Practitioner resource) do not imply a Role, but might be considered when an Organization allocates practitioners to roles within their organization, and could provide useful information (such as expiry information) which could need to be tracked in some situations to ensure they continue to be eligible for a specific role.

The CareTeam resource is also often used to provide details of a role that a practitioner is allocated to perform, but is usually scoped to a much finer granularity of care, and often within the specific context of a Patient, or functional role (e.g. Crisis planning team). In contrast the PractitionerRole is used in a more general sense to cover all the places that the practitioner is allocated to work (and specific details relevant to that role - such as a specific contact number, or electronic services endpoint).

When referencing a practitioner from clinical (or other) content where the organization and role are important to the context of the reference to the practitioner, then a reference to the PractitionerRole should be used.

8.5.3 Background and Context

Practitioner performs different roles within the same or even different organizations. Depending on jurisdiction and custom, it may be necessary to maintain a specific Practitioner Resource for each such role or have a single Practitioner with multiple roles. The role can be limited to a specific period, after which authorization for this role ends. Note that the represented organization need not necessarily be the (direct) employer of a Practitioner.

8.5.4 References to this Resource

8.5.5 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole TU DomainResource Roles/organizations the practitioner is associated with

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Identifiers for a role/location

... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... organization Σ 0..1 Reference(Organization) Organization where the role is available
... code Σ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Practitioner Role (Example)

... display Σ 0..1 string Denormalized practitioner name, role, organization and location
... specialty Σ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Practice Setting Code Value Set (Preferred)

... location Σ 0..* Reference(Location) Location(s) where the practitioner provides care

... healthcareService 0..* Reference(HealthcareService) Healthcare services provided for this role's Organization/Location(s)

... contact 0..* ExtendedContactDetail Official contact details relating to this PractitionerRole

... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: Service Mode (Example)

... communication 0..* CodeableConcept A language the practitioner (in this role) can use in patient communication
Binding: All Languages (Required)
Additional BindingsPurpose
Common Languages Starter Set


... availability 0..1 Availability Times the Practitioner is available at this location and/or healthcare service (including exceptions)
... endpoint 0..* Reference(Endpoint) Endpoints for interacting with the practitioner in this role


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

PractitionerRole (DomainResource)Business Identifiers that are specific to a role/locationidentifier : Identifier [0..*] 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 employedactive : boolean [0..1]The period during which the person is authorized to act as a practitioner in these role(s) for the organizationperiod : Period [0..1]Practitioner that is able to provide the defined services for the organizationpractitioner : Reference [0..1] « Practitioner »The organization where this role is availableorganization : Reference [0..1] « Organization »Roles which this practitioner is authorized to perform for the organizationcode : CodeableConcept [0..*] « null (Strength=Example)PractitionerRole?? »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 propertydisplay : string [0..1]The specialty of a practitioner that describes the functional role they are practicing at a given organization or locationspecialty : CodeableConcept [0..*] « null (Strength=Preferred)PracticeSettingCodeValueSet? »The location(s) at which this practitioner provides carelocation : Reference [0..*] « Location »The list of healthcare services that this worker provides for this role's Organization/Location(s)healthcareService : Reference [0..*] « HealthcareService »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 sitescontact : ExtendedContactDetail [0..*]Collection of characteristics (attributes)characteristic : CodeableConcept [0..*] « null (Strength=Example)ServiceMode?? »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 searchcommunication : CodeableConcept [0..*] « null (Strength=Required)AllLanguages! »A collection of times the practitioner is available or performing this role at the location and/or healthcareserviceavailability : Availability [0..1] 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 electronicallyendpoint : Reference [0..*] « Endpoint »

XML Template

<PractitionerRole xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Identifiers for a role/location --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this practitioner role record is in active use -->
 <period><!-- 0..1 Period The period during which the practitioner is authorized to perform in these role(s) --></period>
 <practitioner><!-- 0..1 Reference(Practitioner) Practitioner that provides services for the organization --></practitioner>
 <organization><!-- 0..1 Reference(Organization) Organization where the role is available --></organization>
 <code><!-- 0..* CodeableConcept Roles which this practitioner may perform --></code>
 <display value="[string]"/><!-- 0..1 Denormalized practitioner name, role, organization and location -->
 <specialty><!-- 0..* CodeableConcept Specific specialty of the practitioner --></specialty>
 <location><!-- 0..* Reference(Location) Location(s) where the practitioner provides care --></location>
 <healthcareService><!-- 0..* Reference(HealthcareService) Healthcare services provided for this role's Organization/Location(s) --></healthcareService>
 <contact><!-- 0..* ExtendedContactDetail Official contact details relating to this PractitionerRole --></contact>
 <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic>
 <communication><!-- 0..* CodeableConcept A language the practitioner (in this role) can use in patient communication --></communication>
 <availability><!-- 0..1 Availability Times the Practitioner is available at this location and/or healthcare service (including exceptions) --></availability>
 <endpoint><!-- 0..* Reference(Endpoint) Endpoints for interacting with the practitioner in this role --></endpoint>
</PractitionerRole>

JSON Template

{doco
  "resourceType" : "PractitionerRole",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Identifiers for a role/location
  "active" : <boolean>, // Whether this practitioner role record is in active use
  "period" : { Period }, // The period during which the practitioner is authorized to perform in these role(s)
  "practitioner" : { Reference(Practitioner) }, // Practitioner that provides services for the organization
  "organization" : { Reference(Organization) }, // Organization where the role is available
  "code" : [{ CodeableConcept }], // Roles which this practitioner may perform
  "display" : "<string>", // Denormalized practitioner name, role, organization and location
  "specialty" : [{ CodeableConcept }], // Specific specialty of the practitioner
  "location" : [{ Reference(Location) }], // Location(s) where the practitioner provides care
  "healthcareService" : [{ Reference(HealthcareService) }], // Healthcare services provided for this role's Organization/Location(s)
  "contact" : [{ ExtendedContactDetail }], // Official contact details relating to this PractitionerRole
  "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
  "communication" : [{ CodeableConcept }], // A language the practitioner (in this role) can use in patient communication
  "availability" : { Availability }, // Times the Practitioner is available at this location and/or healthcare service (including exceptions)
  "endpoint" : [{ Reference(Endpoint) }] // Endpoints for interacting with the practitioner in this role
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:PractitionerRole;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Identifiers for a role/location
  fhir:active [ boolean ] ; # 0..1 Whether this practitioner role record is in active use
  fhir:period [ Period ] ; # 0..1 The period during which the practitioner is authorized to perform in these role(s)
  fhir:practitioner [ Reference(Practitioner) ] ; # 0..1 Practitioner that provides services for the organization
  fhir:organization [ Reference(Organization) ] ; # 0..1 Organization where the role is available
  fhir:code  ( [ CodeableConcept ] ... ) ; # 0..* Roles which this practitioner may perform
  fhir:display [ string ] ; # 0..1 Denormalized practitioner name, role, organization and location
  fhir:specialty  ( [ CodeableConcept ] ... ) ; # 0..* Specific specialty of the practitioner
  fhir:location  ( [ Reference(Location) ] ... ) ; # 0..* Location(s) where the practitioner provides care
  fhir:healthcareService  ( [ Reference(HealthcareService) ] ... ) ; # 0..* Healthcare services provided for this role's Organization/Location(s)
  fhir:contact  ( [ ExtendedContactDetail ] ... ) ; # 0..* Official contact details relating to this PractitionerRole
  fhir:characteristic  ( [ CodeableConcept ] ... ) ; # 0..* Collection of characteristics (attributes)
  fhir:communication  ( [ CodeableConcept ] ... ) ; # 0..* A language the practitioner (in this role) can use in patient communication
  fhir:availability [ Availability ] ; # 0..1 Times the Practitioner is available at this location and/or healthcare service (including exceptions)
  fhir:endpoint  ( [ Reference(Endpoint) ] ... ) ; # 0..* Endpoints for interacting with the practitioner in this role
]

Changes from both R4 and R4B

PractitionerRole
PractitionerRole.display
  • Added Element
PractitionerRole.contact
  • Added Element
PractitionerRole.characteristic
  • Added Element
PractitionerRole.communication
  • Added Element
PractitionerRole.availability
  • Added Element
PractitionerRole.telecom
  • Deleted (-> PractitionerRole.contact.telecom)
PractitionerRole.availableTime
  • Deleted (-> PractitionerRole.availability.availableTime)
PractitionerRole.notAvailable
  • Deleted (-> PractitionerRole.availability.notAvailableTime)
PractitionerRole.availabilityExceptions
  • Deleted (-> PractitionerRole.availability.notAvailableTime.description)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole TU DomainResource Roles/organizations the practitioner is associated with

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Identifiers for a role/location

... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... organization Σ 0..1 Reference(Organization) Organization where the role is available
... code Σ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Practitioner Role (Example)

... display Σ 0..1 string Denormalized practitioner name, role, organization and location
... specialty Σ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Practice Setting Code Value Set (Preferred)

... location Σ 0..* Reference(Location) Location(s) where the practitioner provides care

... healthcareService 0..* Reference(HealthcareService) Healthcare services provided for this role's Organization/Location(s)

... contact 0..* ExtendedContactDetail Official contact details relating to this PractitionerRole

... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: Service Mode (Example)

... communication 0..* CodeableConcept A language the practitioner (in this role) can use in patient communication
Binding: All Languages (Required)
Additional BindingsPurpose
Common Languages Starter Set


... availability 0..1 Availability Times the Practitioner is available at this location and/or healthcare service (including exceptions)
... endpoint 0..* Reference(Endpoint) Endpoints for interacting with the practitioner in this role


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

PractitionerRole (DomainResource)Business Identifiers that are specific to a role/locationidentifier : Identifier [0..*] 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 employedactive : boolean [0..1]The period during which the person is authorized to act as a practitioner in these role(s) for the organizationperiod : Period [0..1]Practitioner that is able to provide the defined services for the organizationpractitioner : Reference [0..1] « Practitioner »The organization where this role is availableorganization : Reference [0..1] « Organization »Roles which this practitioner is authorized to perform for the organizationcode : CodeableConcept [0..*] « null (Strength=Example)PractitionerRole?? »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 propertydisplay : string [0..1]The specialty of a practitioner that describes the functional role they are practicing at a given organization or locationspecialty : CodeableConcept [0..*] « null (Strength=Preferred)PracticeSettingCodeValueSet? »The location(s) at which this practitioner provides carelocation : Reference [0..*] « Location »The list of healthcare services that this worker provides for this role's Organization/Location(s)healthcareService : Reference [0..*] « HealthcareService »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 sitescontact : ExtendedContactDetail [0..*]Collection of characteristics (attributes)characteristic : CodeableConcept [0..*] « null (Strength=Example)ServiceMode?? »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 searchcommunication : CodeableConcept [0..*] « null (Strength=Required)AllLanguages! »A collection of times the practitioner is available or performing this role at the location and/or healthcareserviceavailability : Availability [0..1] 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 electronicallyendpoint : Reference [0..*] « Endpoint »

XML Template

<PractitionerRole xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Identifiers for a role/location --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this practitioner role record is in active use -->
 <period><!-- 0..1 Period The period during which the practitioner is authorized to perform in these role(s) --></period>
 <practitioner><!-- 0..1 Reference(Practitioner) Practitioner that provides services for the organization --></practitioner>
 <organization><!-- 0..1 Reference(Organization) Organization where the role is available --></organization>
 <code><!-- 0..* CodeableConcept Roles which this practitioner may perform --></code>
 <display value="[string]"/><!-- 0..1 Denormalized practitioner name, role, organization and location -->
 <specialty><!-- 0..* CodeableConcept Specific specialty of the practitioner --></specialty>
 <location><!-- 0..* Reference(Location) Location(s) where the practitioner provides care --></location>
 <healthcareService><!-- 0..* Reference(HealthcareService) Healthcare services provided for this role's Organization/Location(s) --></healthcareService>
 <contact><!-- 0..* ExtendedContactDetail Official contact details relating to this PractitionerRole --></contact>
 <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic>
 <communication><!-- 0..* CodeableConcept A language the practitioner (in this role) can use in patient communication --></communication>
 <availability><!-- 0..1 Availability Times the Practitioner is available at this location and/or healthcare service (including exceptions) --></availability>
 <endpoint><!-- 0..* Reference(Endpoint) Endpoints for interacting with the practitioner in this role --></endpoint>
</PractitionerRole>

JSON Template

{doco
  "resourceType" : "PractitionerRole",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Identifiers for a role/location
  "active" : <boolean>, // Whether this practitioner role record is in active use
  "period" : { Period }, // The period during which the practitioner is authorized to perform in these role(s)
  "practitioner" : { Reference(Practitioner) }, // Practitioner that provides services for the organization
  "organization" : { Reference(Organization) }, // Organization where the role is available
  "code" : [{ CodeableConcept }], // Roles which this practitioner may perform
  "display" : "<string>", // Denormalized practitioner name, role, organization and location
  "specialty" : [{ CodeableConcept }], // Specific specialty of the practitioner
  "location" : [{ Reference(Location) }], // Location(s) where the practitioner provides care
  "healthcareService" : [{ Reference(HealthcareService) }], // Healthcare services provided for this role's Organization/Location(s)
  "contact" : [{ ExtendedContactDetail }], // Official contact details relating to this PractitionerRole
  "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
  "communication" : [{ CodeableConcept }], // A language the practitioner (in this role) can use in patient communication
  "availability" : { Availability }, // Times the Practitioner is available at this location and/or healthcare service (including exceptions)
  "endpoint" : [{ Reference(Endpoint) }] // Endpoints for interacting with the practitioner in this role
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:PractitionerRole;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Identifiers for a role/location
  fhir:active [ boolean ] ; # 0..1 Whether this practitioner role record is in active use
  fhir:period [ Period ] ; # 0..1 The period during which the practitioner is authorized to perform in these role(s)
  fhir:practitioner [ Reference(Practitioner) ] ; # 0..1 Practitioner that provides services for the organization
  fhir:organization [ Reference(Organization) ] ; # 0..1 Organization where the role is available
  fhir:code  ( [ CodeableConcept ] ... ) ; # 0..* Roles which this practitioner may perform
  fhir:display [ string ] ; # 0..1 Denormalized practitioner name, role, organization and location
  fhir:specialty  ( [ CodeableConcept ] ... ) ; # 0..* Specific specialty of the practitioner
  fhir:location  ( [ Reference(Location) ] ... ) ; # 0..* Location(s) where the practitioner provides care
  fhir:healthcareService  ( [ Reference(HealthcareService) ] ... ) ; # 0..* Healthcare services provided for this role's Organization/Location(s)
  fhir:contact  ( [ ExtendedContactDetail ] ... ) ; # 0..* Official contact details relating to this PractitionerRole
  fhir:characteristic  ( [ CodeableConcept ] ... ) ; # 0..* Collection of characteristics (attributes)
  fhir:communication  ( [ CodeableConcept ] ... ) ; # 0..* A language the practitioner (in this role) can use in patient communication
  fhir:availability [ Availability ] ; # 0..1 Times the Practitioner is available at this location and/or healthcare service (including exceptions)
  fhir:endpoint  ( [ Reference(Endpoint) ] ... ) ; # 0..* Endpoints for interacting with the practitioner in this role
]

Changes from both R4 and R4B

PractitionerRole
PractitionerRole.display
  • Added Element
PractitionerRole.contact
  • Added Element
PractitionerRole.characteristic
  • Added Element
PractitionerRole.communication
  • Added Element
PractitionerRole.availability
  • Added Element
PractitionerRole.telecom
  • Deleted (-> PractitionerRole.contact.telecom)
PractitionerRole.availableTime
  • Deleted (-> PractitionerRole.availability.availableTime)
PractitionerRole.notAvailable
  • Deleted (-> PractitionerRole.availability.notAvailableTime)
PractitionerRole.availabilityExceptions
  • Deleted (-> PractitionerRole.availability.notAvailableTime.description)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

8.5.5.1 Terminology Bindings

Path ValueSet Type Documentation
PractitionerRole.code PractitionerRole Example

This example value set defines a set of codes that can be used to indicate the role of a Practitioner.
PractitionerRole.specialty PracticeSettingCodeValueSet Preferred

This is the code representing the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. The value set used for clinical specialty has been limited by HITSP to the value set reproduced from HITSP C80 Table 2-149 Clinical Specialty Value Set Definition.
PractitionerRole.characteristic ServiceMode Example

An example set of Service Modes that could be applicable to use to characterize HealthcareServices or PractitionerRoles while searching
PractitionerRole.communication AllLanguages (a valid code from Tags for the Identification of Languages icon) Required

This value set includes all possible codes from BCP-47 (see http://tools.ietf.org/html/bcp47)
  Common Languages starter

8.5.6 Notes

  • There is no address on the PractitionerRole as the location that is defined here contains the address.
    This prevents having to duplicate the address values across multiple resources.
  • As briefly noted in the boundaries and relationships section the PractitionerRole resource can be used to represent multiple locations in the one resource instance, however this should be done with care. When representing multiple locations in an instance, and/or multiple specialties, all details apply to all locations. Using that approach you cannot differentiate a different contact number, different availabilities, or different services at each location.
    Hence maintaining these records needs to ensure that when changing a value, such as availability, it applies to all locations. If different values are required for the different locations, then a new instance will need to be created, and then split as appropriate. Existing resources referencing the original PractitionerRole instance will need to be updated to refer to the appropriate record.
    For this reason we expect that it will be common to profile the location element down to a single location, simplifying overall usage, and the availabilities are clear that they apply to this location, and any referenced healthcare services.

8.5.7 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
active token Whether this practitioner role record is in active use PractitionerRole.active
characteristic token One of the PractitionerRole's characteristics PractitionerRole.characteristic
communication token One of the languages that the practitioner can communicate with PractitionerRole.communication
date date The period during which the practitioner is authorized to perform in these role(s) PractitionerRole.period
email token A value in an email contact PractitionerRole.contact.telecom.where(system='email') 5 Resources
endpoint reference Technical endpoints providing access to services operated for the practitioner with this role PractitionerRole.endpoint
(Endpoint)
identifier token A practitioner's Identifier PractitionerRole.identifier
location reference One of the locations at which this practitioner provides care PractitionerRole.location
(Location)
organization reference The identity of the organization the practitioner represents / acts on behalf of PractitionerRole.organization
(Organization)
phone token A value in a phone contact PractitionerRole.contact.telecom.where(system='phone') 5 Resources
practitioner reference Practitioner that is able to provide the defined services for the organization PractitionerRole.practitioner
(Practitioner)
role token The practitioner can perform this role at for the organization PractitionerRole.code
service reference The list of healthcare services that this worker provides for this role's Organization/Location(s) PractitionerRole.healthcareService
(HealthcareService)
specialty token The practitioner has this specialty at an organization PractitionerRole.specialty
telecom token The value in any kind of contact PractitionerRole.contact.telecom 5 Resources