PractitionerRole

ResourceBase · IndividualsTrial useMaturity 2

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

13 of 13 parameters tested

Structure

Show inherited elements (14)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Business Identifiers that are specific to 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)
practitionerΣ	0..1	Reference(Practitioner)	Practitioner that is able to provide the defined services for the organization
organizationΣ	0..1	Reference(Organization)	Organization where the roles are available
codeΣ	0..*	CodeableConcept	Roles which this practitioner may performBinding (example): practitioner-role
specialtyΣ	0..*	CodeableConcept	Specific specialty of the practitionerBinding (preferred): c80-practice-codes
locationΣ	0..*	Reference(Location)	The location(s) at which this practitioner provides care
healthcareService	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecomΣ	0..*	ContactPoint	Contact details that are specific to the role/location/service
availableTime	0..*	BackboneElement	Times the Service Site is available
daysOfWeek	0..*	code	mon | tue | wed | thu | fri | sat | sunBinding (required): days-of-week
allDay	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime	0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	0..*	BackboneElement	Not available during this time due to provided reason
descriptionRequired	1..1	string	Reason presented to the user explaining why time not available
during	0..1	Period	Service not available from this date
availabilityExceptions	0..1	string	Description of availability exceptions
endpoint	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/PractitionerRole?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
active	token	Whether this practitioner role record is in active use PractitionerRole.active
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.telecom.where(system='email')
endpoint	reference	Technical endpoints providing access to services operated for the practitioner with this role PractitionerRole.endpoint
identifier	token	A practitioner's Identifier PractitionerRole.identifier
location	reference	One of the locations at which this practitioner provides care PractitionerRole.location
organization	reference	The identity of the organization the practitioner represents / acts on behalf of PractitionerRole.organization
phone	token	A value in a phone contact PractitionerRole.telecom.where(system='phone')
practitioner	reference	Practitioner that is able to provide the defined services for the organization PractitionerRole.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
specialty	token	The practitioner has this specialty at an organization PractitionerRole.specialty
telecom	token	The value in any kind of contact PractitionerRole.telecom

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition