# PractitionerRole

Canonical page: https://docs.ovok.com/api/fhir/r4/practitioner-role

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/PractitionerRole/[id]` |
| Vread | `GET` | `/fhir/R4/PractitionerRole/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/PractitionerRole/[id]` |
| Patch | `PATCH` | `/fhir/R4/PractitionerRole/[id]` |
| Delete | `DELETE` | `/fhir/R4/PractitionerRole/[id]` |
| Create | `POST` | `/fhir/R4/PractitionerRole` |
| Search | `GET` | `/fhir/R4/PractitionerRole` |
| History | `GET` | `/fhir/R4/PractitionerRole/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business Identifiers that are specific to a role/location |
| <span id="element-active"></span>`active` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | Whether this practitioner role record is in active use |
| <span id="element-period"></span>`period` | [Period](/fhir-elements/complex/period) | `0..1` | The period during which the practitioner is authorized to perform in these role(s) |
| <span id="element-practitioner"></span>`practitioner` | [Reference](/fhir-elements/complex/reference) | `0..1` | Practitioner that is able to provide the defined services for the organization |
| <span id="element-organization"></span>`organization` | [Reference](/fhir-elements/complex/reference) | `0..1` | Organization where the roles are available |
| <span id="element-code"></span>`code` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Roles which this practitioner may perform |
| <span id="element-specialty"></span>`specialty` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Specific specialty of the practitioner |
| <span id="element-location"></span>`location` | [Reference](/fhir-elements/complex/reference) | `0..*` | The location(s) at which this practitioner provides care |
| <span id="element-healthcare-service"></span>`healthcareService` | [Reference](/fhir-elements/complex/reference) | `0..*` | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| <span id="element-telecom"></span>`telecom` | [ContactPoint](/fhir-elements/complex/contact-point) | `0..*` | Contact details that are specific to the role/location/service |
| <span id="element-available-time"></span>`availableTime` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Times the Service Site is available |
| <span id="element-not-available"></span>`notAvailable` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Not available during this time due to provided reason |
| <span id="element-availability-exceptions"></span>`availabilityExceptions` | [string](/fhir-elements/primitive/string) | `0..1` | Description of availability exceptions |
| <span id="element-endpoint"></span>`endpoint` | [Reference](/fhir-elements/complex/reference) | `0..*` | Technical endpoints providing access to services operated for the practitioner with this role |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `active` | token | Whether this practitioner role record is in active use |
| `date` | date | The period during which the practitioner is authorized to perform in these role(s) |
| `email` | token | Multiple Resources: Patient: A value in an email contact ; Person: A value in an email contact ; Practitioner: A value in an email contact ; PractitionerRole: A value in an email contact ; RelatedPerson: A value in an email contact  |
| `endpoint` | reference | Technical endpoints providing access to services operated for the practitioner with this role |
| `identifier` | token | A practitioner's Identifier |
| `location` | reference | One of the locations at which this practitioner provides care |
| `organization` | reference | The identity of the organization the practitioner represents / acts on behalf of |
| `phone` | token | Multiple Resources: Patient: A value in a phone contact ; Person: A value in a phone contact ; Practitioner: A value in a phone contact ; PractitionerRole: A value in a phone contact ; RelatedPerson: A value in a phone contact  |
| `practitioner` | reference | Practitioner that is able to provide the defined services for the organization |
| `role` | token | The practitioner can perform this role at for the organization |
| `service` | reference | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| `specialty` | token | The practitioner has this specialty at an organization |
| `telecom` | token | Multiple Resources: Patient: The value in any kind of telecom details of the patient ; Person: The value in any kind of contact ; Practitioner: The value in any kind of contact ; PractitionerRole: The value in any kind of contact ; RelatedPerson: The value in any kind of contact  |

## Reference [#reference]

Official FHIR R4 spec: [PractitionerRole](https://hl7.org/fhir/R4/practitionerrole.html).  
Maturity: Trial Use 2 (FMM 2).
