The PractitionerRole resource implements the FHIR R4 PractitionerRole specification and US Core v3.1.1 PractitionerRole profile
Fields
| Name | Type | Cardinality | Required | Description | |
|---|---|---|---|---|---|
| identifier | Identifier | 0..* | Business Identifiers that are specific to a role/location | ||
| active | boolean | 0..1 | Whether this practitioner role record is in active use | ||
| practitioner | Reference(US Core Practitioner Profile) | 1..1 | * | Practitioner that is able to provide the defined services for the organization | |
| organization | Reference(US Core Organization Profile) | 1..1 | * | Organization where the roles are available | |
| code | CodeableConcept | 0..* | Roles which this practitioner may perform - Binding | ||
| specialty | CodeableConcept | 0..* | Specific specialty of the practitioner | http://hl7.org/fhir/us/core/ValueSet/us-core-provider-specialty | |
| location | Reference(Location) | 0..* | The location(s) at which this practitioner provides care | ||
| telecom | ContactPoint | 0..* | Contact details that are specific to the role/location/service | ||
| telecom.system | code | 1..1 | * | phone | fax | email | pager | url | sms | other | |
| telecom.value | string | 1..1 | * | The actual contact point details | |
| endpoint | Reference(Endpoint) | 0..* | Technical endpoints providing access to services operated for the practitioner with this role |
Interactions
Read
Get an PractitionerRole entry by id
GET /PractitionerRole/:id
Search
Query PractitionerRole resources
GET /PractitionerRole?:query_parameters
Parameters
| Name | Type | Description |
|---|---|---|
| active | token | Whether this practitioner role record is in active use |
| identifier | token | A practitioner’s Identifier |
| location | reference | One of the locations at which this practitioner provides care |
| practitioner | reference | Practitioner that is able to provide the defined services for the organization |
| practitioner.name | string | Name of the practitioner |
| practitioner.identifier | token | Practitioner’s identifier |
| role | token | The practitioner can perform this role at for the organization |
| specialty | token | The practitioner has this specialty at an organization |
| _include | PractitionerRole:practitioner | |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |