Skip to main content

PractitionerRole

PropertyValue
Publisher
NamePractitionerRole
URLhttp://hl7.org/fhir/StructureDefinition/PractitionerRole
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
PractitionerRole0..*PractitionerRoleA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
PractitionerRole.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
PractitionerRole.meta0..1MetaThe 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.implicitRules0..1uriA 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.language0..1codeThe base language in which the resource is written.
PractitionerRole.text0..1NarrativeA 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.contained0..*ResourceThese 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.extension0..*ExtensionMay 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.modifierExtension0..*ExtensionMay 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.identifier0..*IdentifierBusiness Identifiers that are specific to a role/location.
PractitionerRole.active0..1booleanWhether this practitioner role record is in active use.
PractitionerRole.period0..1PeriodThe period during which the person is authorized to act as a practitioner in these role(s) for the organization.
PractitionerRole.practitioner0..1ReferencePractitioner that is able to provide the defined services for the organization.
PractitionerRole.organization0..1ReferenceThe organization where the Practitioner performs the roles associated.
PractitionerRole.code0..*CodeableConceptRoles which this practitioner is authorized to perform for the organization.
PractitionerRole.specialty0..*CodeableConceptSpecific specialty of the practitioner.
PractitionerRole.location0..*ReferenceThe location(s) at which this practitioner provides care.
PractitionerRole.healthcareService0..*ReferenceThe list of healthcare services that this worker provides for this role's Organization/Location(s).
PractitionerRole.telecom0..*ContactPointContact details that are specific to the role/location/service.
PractitionerRole.availableTime0..*BackboneElementA collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
PractitionerRole.availableTime.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PractitionerRole.availableTime.extension0..*ExtensionMay 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.modifierExtension0..*ExtensionMay 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.daysOfWeek0..*codeIndicates which days of the week are available between the start and end Times.
PractitionerRole.availableTime.allDay0..1booleanIs this always available? (hence times are irrelevant) e.g. 24 hour service.
PractitionerRole.availableTime.availableStartTime0..1timeThe opening time of day. Note: If the AllDay flag is set, then this time is ignored.
PractitionerRole.availableTime.availableEndTime0..1timeThe closing time of day. Note: If the AllDay flag is set, then this time is ignored.
PractitionerRole.notAvailable0..*BackboneElementThe practitioner is not available or performing this role during this period of time due to the provided reason.
PractitionerRole.notAvailable.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PractitionerRole.notAvailable.extension0..*ExtensionMay 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.modifierExtension0..*ExtensionMay 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.description1..1stringThe reason that can be presented to the user as to why this time is not available.
PractitionerRole.notAvailable.during0..1PeriodService is not available (seasonally or for a public holiday) from this date.
PractitionerRole.availabilityExceptions0..1stringA 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.endpoint0..*ReferenceTechnical endpoints providing access to services operated for the practitioner with this role.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides 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
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed 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
emailtokenMultiple 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 contactPatient.telecom.where(system='email') / Person.telecom.where(system='email') / Practitioner.telecom.where(system='email') / PractitionerRole.telecom.where(system='email') / RelatedPerson.telecom.where(system='email')
phonetokenMultiple 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 contactPatient.telecom.where(system='phone') / Person.telecom.where(system='phone') / Practitioner.telecom.where(system='phone') / PractitionerRole.telecom.where(system='phone') / RelatedPerson.telecom.where(system='phone')
telecomtokenMultiple 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 contactPatient.telecom / Person.telecom / Practitioner.telecom / PractitionerRole.telecom / RelatedPerson.telecom
activetokenWhether this practitioner role record is in active usePractitionerRole.active
datedateThe period during which the practitioner is authorized to perform in these role(s)PractitionerRole.period
endpointreferenceTechnical endpoints providing access to services operated for the practitioner with this rolePractitionerRole.endpoint
identifiertokenA practitioner's IdentifierPractitionerRole.identifier
locationreferenceOne of the locations at which this practitioner provides carePractitionerRole.location
organizationreferenceThe identity of the organization the practitioner represents / acts on behalf ofPractitionerRole.organization
practitionerreferencePractitioner that is able to provide the defined services for the organizationPractitionerRole.practitioner
roletokenThe practitioner can perform this role at for the organizationPractitionerRole.code
servicereferenceThe list of healthcare services that this worker provides for this role's Organization/Location(s)PractitionerRole.healthcareService
specialtytokenThe practitioner has this specialty at an organizationPractitionerRole.specialty