PractitionerRole

Property	Value
Publisher
Name	PractitionerRole
URL	http://hl7.org/fhir/StructureDefinition/PractitionerRole
Status	draft
Description
Abstract	false

Structure

Path	Cardinality	Type	Description
PractitionerRole	0..*	PractitionerRole	A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
PractitionerRole.id	0..1	http://hl7.org/fhirpath/System.String	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
PractitionerRole.meta	0..1	Meta	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.
PractitionerRole.implicitRules	0..1	uri	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.
PractitionerRole.language	0..1	code	The base language in which the resource is written.
PractitionerRole.text	0..1	Narrative	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.
PractitionerRole.contained	0..*	Resource	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.
PractitionerRole.extension	0..*	Extension	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.
PractitionerRole.modifierExtension	0..*	Extension	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).
PractitionerRole.identifier	0..*	Identifier	Business Identifiers that are specific to a role/location.
PractitionerRole.active	0..1	boolean	Whether this practitioner role record is in active use.
PractitionerRole.period	0..1	Period	The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
PractitionerRole.practitioner	0..1	Reference	Practitioner that is able to provide the defined services for the organization.
PractitionerRole.organization	0..1	Reference	The organization where the Practitioner performs the roles associated.
PractitionerRole.code	0..*	CodeableConcept	Roles which this practitioner is authorized to perform for the organization.
PractitionerRole.specialty	0..*	CodeableConcept	Specific specialty of the practitioner.
PractitionerRole.location	0..*	Reference	The location(s) at which this practitioner provides care.
PractitionerRole.healthcareService	0..*	Reference	The list of healthcare services that this worker provides for this role's Organization/Location(s).
PractitionerRole.telecom	0..*	ContactPoint	Contact details that are specific to the role/location/service.
PractitionerRole.availableTime	0..*	BackboneElement	A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
PractitionerRole.availableTime.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PractitionerRole.availableTime.extension	0..*	Extension	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.
PractitionerRole.availableTime.modifierExtension	0..*	Extension	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).
PractitionerRole.availableTime.daysOfWeek	0..*	code	Indicates which days of the week are available between the start and end Times.
PractitionerRole.availableTime.allDay	0..1	boolean	Is this always available? (hence times are irrelevant) e.g. 24 hour service.
PractitionerRole.availableTime.availableStartTime	0..1	time	The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
PractitionerRole.availableTime.availableEndTime	0..1	time	The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
PractitionerRole.notAvailable	0..*	BackboneElement	The practitioner is not available or performing this role during this period of time due to the provided reason.
PractitionerRole.notAvailable.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PractitionerRole.notAvailable.extension	0..*	Extension	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.
PractitionerRole.notAvailable.modifierExtension	0..*	Extension	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).
PractitionerRole.notAvailable.description	1..1	string	The reason that can be presented to the user as to why this time is not available.
PractitionerRole.notAvailable.during	0..1	Period	Service is not available (seasonally or for a public holiday) from this date.
PractitionerRole.availabilityExceptions	0..1	string	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.
PractitionerRole.endpoint	0..*	Reference	Technical endpoints providing access to services operated for the practitioner with this role.

Search Parameters

Name	Type	Description	Expression
_text	string	Search on the narrative of the resource
_content	string	Search on the entire content of the resource
_filter	token	Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_has	string	Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_id	token	Logical id of this artifact	Resource.id
_lastUpdated	date	When the resource version last changed	Resource.meta.lastUpdated
_list	string	All resources in nominated list (by id, Type/id, url or one of the magic List types)
_profile	uri	Profiles this resource claims to conform to	Resource.meta.profile
_query	token	A custom search profile that describes a specific defined query operation
_security	token	Security Labels applied to this resource	Resource.meta.security
_source	uri	Identifies where the resource comes from	Resource.meta.source
_tag	token	Tags applied to this resource	Resource.meta.tag
_text	string	Search on the narrative text (html) of the resource
_type	token	Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
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	Patient.telecom.where(system='email') / Person.telecom.where(system='email') / Practitioner.telecom.where(system='email') / PractitionerRole.telecom.where(system='email') / RelatedPerson.telecom.where(system='email')
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	Patient.telecom.where(system='phone') / Person.telecom.where(system='phone') / Practitioner.telecom.where(system='phone') / PractitionerRole.telecom.where(system='phone') / RelatedPerson.telecom.where(system='phone')
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	Patient.telecom / Person.telecom / Practitioner.telecom / PractitionerRole.telecom / RelatedPerson.telecom
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
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
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