PractitionerRole
A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
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.
Resource content
These are different views on this resource:
PH_PractitionerRole (PractitionerRole) | I | PractitionerRole | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..0 | Identifier |
active | Σ | 0..0 | boolean |
period | Σ I | 0..0 | Period |
practitioner | Σ I | 0..0 | Reference(Practitioner) |
organization | Σ I | 0..0 | Reference(Organization) |
code | Σ | 0..* | CodeableConcept |
specialty | Σ | 0..0 | CodeableConceptBinding |
location | Σ I | 0..0 | Reference(Location) |
healthcareService | I | 0..0 | Reference(HealthcareService) |
telecom | Σ I | 0..0 | ContactPoint |
availableTime | 0..0 | BackboneElement | |
notAvailable | 0..0 | BackboneElement | |
availabilityExceptions | 0..0 | string | |
endpoint | I | 0..0 | Reference(Endpoint) |
PractitionerRole | |
Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
PractitionerRole.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
PractitionerRole.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
PractitionerRole.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
PractitionerRole.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
PractitionerRole.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
PractitionerRole.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
PractitionerRole.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
PractitionerRole.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
PractitionerRole.identifier | |
Definition | Business Identifiers that are specific to a role/location. |
Cardinality | 0...0 |
Type | Identifier |
Summary | True |
Requirements | Often, specific identities are assigned for the agent. |
Invariants |
|
Mappings |
|
PractitionerRole.active | |
Definition | Whether this practitioner role record is in active use. |
Cardinality | 0...0 |
Type | boolean |
Summary | True |
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. |
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. |
Invariants |
|
Mappings |
|
PractitionerRole.period | |
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. |
Cardinality | 0...0 |
Type | Period |
Summary | True |
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
PractitionerRole.practitioner | |
Definition | Practitioner that is able to provide the defined services for the organization. |
Cardinality | 0...0 |
Type | Reference(Practitioner) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
PractitionerRole.organization | |
Definition | The organization where the Practitioner performs the roles associated. |
Cardinality | 0...0 |
Type | Reference(Organization) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
PractitionerRole.code | |
Definition | Roles which this practitioner is authorized to perform for the organization. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The role a person plays representing an organization. |
Summary | True |
Requirements | Need to know what authority the practitioner has - what can they do? |
Comments | A person may have more than one role. |
Invariants |
|
Mappings |
|
PractitionerRole.specialty | |
Definition | Specific specialty of the practitioner. |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | Specific specialty associated with the agency. |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
PractitionerRole.location | |
Definition | The location(s) at which this practitioner provides care. |
Cardinality | 0...0 |
Type | Reference(Location) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
PractitionerRole.healthcareService | |
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s). |
Cardinality | 0...0 |
Type | Reference(HealthcareService) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
PractitionerRole.telecom | |
Definition | Contact details that are specific to the role/location/service. |
Cardinality | 0...0 |
Type | ContactPoint |
Summary | True |
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. |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime | |
Definition | A collection of times the practitioner is available or performing this role at the location and/or healthcareservice. |
Cardinality | 0...0 |
Type | BackboneElement |
Comments | More detailed availability information may be provided in associated Schedule/Slot resources. |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
PractitionerRole.availableTime.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime.daysOfWeek | |
Definition | Indicates which days of the week are available between the start and end Times. |
Cardinality | 0...* |
Type | code |
Binding | The days of the week. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime.allDay | |
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. |
Cardinality | 0...1 |
Type | boolean |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime.availableStartTime | |
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored. |
Cardinality | 0...1 |
Type | time |
Comments | The timezone is expected to be for where this HealthcareService is provided at. |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime.availableEndTime | |
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored. |
Cardinality | 0...1 |
Type | time |
Comments | The timezone is expected to be for where this HealthcareService is provided at. |
Invariants |
|
Mappings |
|
PractitionerRole.notAvailable | |
Definition | The practitioner is not available or performing this role during this period of time due to the provided reason. |
Cardinality | 0...0 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
PractitionerRole.notAvailable.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
PractitionerRole.notAvailable.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
PractitionerRole.notAvailable.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
PractitionerRole.notAvailable.description | |
Definition | The reason that can be presented to the user as to why this time is not available. |
Cardinality | 1...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
PractitionerRole.notAvailable.during | |
Definition | Service is not available (seasonally or for a public holiday) from this date. |
Cardinality | 0...1 |
Type | Period |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...0 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
PractitionerRole.endpoint | |
Definition | Technical endpoints providing access to services operated for the practitioner with this role. |
Cardinality | 0...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. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <url value="https://example.org/fhir/StructureDefinition/PH_PractitionerRole" /> <name value="PH_PractitionerRole" /> <status value="draft" /> <description value="A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="PractitionerRole" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> <derivation value="constraint" /> <differential> <element id="PractitionerRole.identifier"> <path value="PractitionerRole.identifier" /> <max value="0" /> </element> <element id="PractitionerRole.active"> <path value="PractitionerRole.active" /> <max value="0" /> </element> <element id="PractitionerRole.period"> <path value="PractitionerRole.period" /> <max value="0" /> </element> <element id="PractitionerRole.practitioner"> <path value="PractitionerRole.practitioner" /> <max value="0" /> </element> <element id="PractitionerRole.organization"> <path value="PractitionerRole.organization" /> <max value="0" /> </element> <element id="PractitionerRole.specialty"> <path value="PractitionerRole.specialty" /> <max value="0" /> </element> <element id="PractitionerRole.location"> <path value="PractitionerRole.location" /> <max value="0" /> </element> <element id="PractitionerRole.healthcareService"> <path value="PractitionerRole.healthcareService" /> <max value="0" /> </element> <element id="PractitionerRole.telecom"> <path value="PractitionerRole.telecom" /> <max value="0" /> </element> <element id="PractitionerRole.availableTime"> <path value="PractitionerRole.availableTime" /> <max value="0" /> </element> <element id="PractitionerRole.notAvailable"> <path value="PractitionerRole.notAvailable" /> <max value="0" /> </element> <element id="PractitionerRole.availabilityExceptions"> <path value="PractitionerRole.availabilityExceptions" /> <max value="0" /> </element> <element id="PractitionerRole.endpoint"> <path value="PractitionerRole.endpoint" /> <max value="0" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "url": "https://example.org/fhir/StructureDefinition/PH_PractitionerRole", "name": "PH_PractitionerRole", "status": "draft", "description": "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "PractitionerRole", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "derivation": "constraint", "differential": { "element": [ { "id": "PractitionerRole.identifier", "path": "PractitionerRole.identifier", "max": "0" }, { "id": "PractitionerRole.active", "path": "PractitionerRole.active", "max": "0" }, { "id": "PractitionerRole.period", "path": "PractitionerRole.period", "max": "0" }, { "id": "PractitionerRole.practitioner", "path": "PractitionerRole.practitioner", "max": "0" }, { "id": "PractitionerRole.organization", "path": "PractitionerRole.organization", "max": "0" }, { "id": "PractitionerRole.specialty", "path": "PractitionerRole.specialty", "max": "0" }, { "id": "PractitionerRole.location", "path": "PractitionerRole.location", "max": "0" }, { "id": "PractitionerRole.healthcareService", "path": "PractitionerRole.healthcareService", "max": "0" }, { "id": "PractitionerRole.telecom", "path": "PractitionerRole.telecom", "max": "0" }, { "id": "PractitionerRole.availableTime", "path": "PractitionerRole.availableTime", "max": "0" }, { "id": "PractitionerRole.notAvailable", "path": "PractitionerRole.notAvailable", "max": "0" }, { "id": "PractitionerRole.availabilityExceptions", "path": "PractitionerRole.availabilityExceptions", "max": "0" }, { "id": "PractitionerRole.endpoint", "path": "PractitionerRole.endpoint", "max": "0" } ] } }