PractitionerRole

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

Element	Type	Cardinality	Description
id	string	0..1	Logical id of this artifact
meta	Meta	0..1	Metadata about the resource
implicitRules	uri	0..1	A set of rules under which this content was created
language	code	0..1	Language of the resource content
text	Narrative	0..1	Text summary of the resource, for human interpretation
contained	Resource	0..*	Contained, inline Resources
extension	Extension	0..*	Additional content defined by implementations
modifierExtension	Extension	0..*	Extensions that cannot be ignored
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
period	Period	0..1	The period during which the practitioner is authorized to perform in these role(s)
practitioner	Reference	0..1	Practitioner that is able to provide the defined services for the organization
organization	Reference	0..1	Organization where the roles are available
code	CodeableConcept	0..*	Roles which this practitioner may perform
specialty	CodeableConcept	0..*	Specific specialty of the practitioner
location	Reference	0..*	The location(s) at which this practitioner provides care
healthcareService	Reference	0..*	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	ContactPoint	0..*	Contact details that are specific to the role/location/service
availableTime	BackboneElement	0..*	Times the Service Site is available
notAvailable	BackboneElement	0..*	Not available during this time due to provided reason
availabilityExceptions	string	0..1	Description of availability exceptions
endpoint	Reference	0..*	Technical endpoints providing access to services operated for the practitioner with this role

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

Official FHIR R4 spec: PractitionerRole.
Maturity: Trial Use 2 (FMM 2).