Skip to main content

PractitionerRole

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

Properties

NameRequiredTypeDescription
identifierIdentifier[]

Business Identifiers that are specific to a role/location

Details

Business Identifiers that are specific to a role/location.

activeboolean

Whether this practitioner role record is in active use

Details

Whether this practitioner role record is in active use.

If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

periodPeriod

The period during which the practitioner is authorized to perform in these role(s)

Details

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

practitionerReference<Practitioner>

Practitioner that is able to provide the defined services for the organization

Details

Practitioner that is able to provide the defined services for the organization.

organizationReference<Organization>

Organization where the roles are available

Details

The organization where the Practitioner performs the roles associated.

codeCodeableConcept[]

Roles which this practitioner may perform

Details

Roles which this practitioner is authorized to perform for the organization.

A person may have more than one role.

specialtyCodeableConcept[]

Specific specialty of the practitioner

Details

Specific specialty of the practitioner.

locationReference<Location>[]

The location(s) at which this practitioner provides care

Details

The location(s) at which this practitioner provides care.

healthcareServiceReference<HealthcareService>[]

The list of healthcare services that this worker provides for this role's Organization/Location(s)

Details

The list of healthcare services that this worker provides for this role's Organization/Location(s).

telecomContactPoint[]

Contact details that are specific to the role/location/service

Details

Contact details that are specific to the role/location/service.

availableTimePractitionerRoleAvailableTime[]

Times the Service Site is available

Details

A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

More detailed availability information may be provided in associated Schedule/Slot resources.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

daysOfWeekcode[]

mon | tue | wed | thu | fri | sat | sun

Details

Indicates which days of the week are available between the start and end Times.

allDayboolean

Always available? e.g. 24 hour service

Details

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

availableStartTimetime

Opening time of day (ignored if allDay = true)

Details

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

The timezone is expected to be for where this HealthcareService is provided at.

availableEndTimetime

Closing time of day (ignored if allDay = true)

Details

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

The timezone is expected to be for where this HealthcareService is provided at.

notAvailablePractitionerRoleNotAvailable[]

Not available during this time due to provided reason

Details

The practitioner is not available or performing this role during this period of time due to the provided reason.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

descriptionstring

Reason presented to the user explaining why time not available

Details

The reason that can be presented to the user as to why this time is not available.

duringPeriod

Service not available from this date

Details

Service is not available (seasonally or for a public holiday) from this date.

availabilityExceptionsstring

Description of availability exceptions

Details

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.

endpointReference<Endpoint>[]

Technical endpoints providing access to services operated for the practitioner with this role

Details

Technical endpoints providing access to services operated for the practitioner with this role.

Search Parameters

NameTypeDescriptionExpression
emailtoken A value in an email contact PractitionerRole.telecom.where(system = 'email')
phonetoken A value in a phone contact PractitionerRole.telecom.where(system = 'phone')
telecomtoken The value in any kind of contact PractitionerRole.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

Inherited Properties

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

metaMeta

Metadata about the resource

Details

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.

implicitRulesuri

A set of rules under which this content was created

Details

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.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

languagecode

Language of the resource content

Details

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

textNarrative

Text summary of the resource, for human interpretation

Details

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.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

containedResource[]

Contained, inline Resources

Details

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.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

extensionExtension[]

Additional content defined by implementations

Details

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.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

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).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.