STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

5.5 Resource PractitionerRole - Content

Patient Administration Work GroupMaturity Level: 0Compartments: Practitioner

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

5.5.1 Scope and Usage

PractitionerRole covers the recording of the location and types of services that Practitioners are able to provide for an organization.

The role, specialty, Location telecom and HealthcareService properties can be repeated if required in other instances of the PractitionerRole. Some systems record a collection of service values for a single location, others record the single service and the list of locations it is available. Both are acceptable options for prepresenting this data.

5.5.2 Boundaries and Relationships

The PractitionerRole BackboneElement on the Practitioner is to be deprecated if this resource is accepted.

The Qualifications are not a part of the PractitionerRole, as they may be appropriate for the role, however they are a property of the Practitioner, not the role they may perform for an Organization.

5.5.3 Background and Context

Practitioner performs different roles within the same or even different organizations. Depending on jurisdiction and custom, it may be necessary to maintain a specific Practitioner Resource for each such role or have a single Practitioner with multiple roles. The role can be limited to a specific period, after which authorization for this role ends. Note that the represented organization need not necessarily be the (direct) employer of a Practitioner.

5.5.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole DomainResourceRoles/organizations the practitioner is associated with
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
... active Σ0..1booleanWhether this practitioner's record is in active use
... practitioner Σ0..1Reference(Practitioner)Practitioner that is able to provide the defined services for the organation
... organization Σ0..1Reference(Organization)Organization where the roles are available
... role Σ0..*CodeableConceptRoles which this practitioner may perform
PractitionerRole (Example)
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Practice Setting Code Value Set (Preferred)
... 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..*ContactPointContact details that are specific to the role/location/service
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... availableTime 0..*BackboneElementTimes the Service Site is available
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
DaysOfWeek (Required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions

doco Documentation for this format

UML Diagram

PractitionerRole (DomainResource)Business Identifiers that are specific to a role/locationidentifier : Identifier [0..*]Whether this practitioner's record is in active useactive : boolean [0..1]Practitioner that is able to provide the defined services for the organationpractitioner : Reference [0..1] « Practitioner »The organization where the Practitioner performs the roles associatedorganization : Reference [0..1] « Organization »Roles which this practitioner is authorized to perform for the organizationrole : CodeableConcept [0..*] « The role a person plays representing an organization (Strength=Example)PractitionerRole?? »Specific specialty of the practitionerspecialty : CodeableConcept [0..*] « Specific specialty associated with the agency (Strength=Preferred)Practice Setting Code Value S...? »The location(s) at which this practitioner provides carelocation : Reference [0..*] « Location »The list of healthcare services that this worker provides for this role's Organization/Location(s)healthcareService : Reference [0..*] « HealthcareService »Contact details that are specific to the role/location/servicetelecom : ContactPoint [0..*]The period during which the person is authorized to act as a practitioner in these role(s) for the organizationperiod : Period [0..1]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 TimesavailabilityExceptions : string [0..1]AvailableTimeIndicates which days of the week are available between the start and end TimesdaysOfWeek : code [0..*] « The days of the week. (Strength=Required)DaysOfWeek! »Is this always available? (hence times are irrelevant) e.g. 24 hour serviceallDay : boolean [0..1]The opening time of day. Note: If the AllDay flag is set, then this time is ignoredavailableStartTime : time [0..1]The closing time of day. Note: If the AllDay flag is set, then this time is ignoredavailableEndTime : time [0..1]NotAvailableThe reason that can be presented to the user as to why this time is not availabledescription : string [1..1]Service is not available (seasonally or for a public holiday) from this dateduring : Period [0..1]A collection of times that the Service Site is availableavailableTime[0..*]The HealthcareService is not available during this period of time due to the provided reasonnotAvailable[0..*]

XML Template

<PractitionerRole xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifiers that are specific to a role/location --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this practitioner's record is in active use -->
 <practitioner><!-- 0..1 Reference(Practitioner) Practitioner that is able to provide the defined services for the organation --></practitioner>
 <organization><!-- 0..1 Reference(Organization) Organization where the roles are available --></organization>
 <role><!-- 0..* CodeableConcept Roles which this practitioner may perform --></role>
 <specialty><!-- 0..* CodeableConcept Specific specialty of the practitioner --></specialty>
 <location><!-- 0..* Reference(Location) The location(s) at which this practitioner provides care --></location>
 <healthcareService><!-- 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s) --></healthcareService>
 <telecom><!-- 0..* ContactPoint Contact details that are specific to the role/location/service --></telecom>
 <period><!-- 0..1 Period The period during which the practitioner is authorized to perform in these role(s) --></period>
 <availableTime>  <!-- 0..* Times the Service Site is available -->
  <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun -->
  <allDay value="[boolean]"/><!-- 0..1 Always available? e.g. 24 hour service -->
  <availableStartTime value="[time]"/><!-- 0..1 Opening time of day (ignored if allDay = true) -->
  <availableEndTime value="[time]"/><!-- 0..1 Closing time of day (ignored if allDay = true) -->
 </availableTime>
 <notAvailable>  <!-- 0..* Not available during this time due to provided reason -->
  <description value="[string]"/><!-- 1..1 Reason presented to the user explaining why time not available -->
  <during><!-- 0..1 Period Service not availablefrom this date --></during>
 </notAvailable>
 <availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions -->
</PractitionerRole>

JSON Template

{doco
  "resourceType" : "PractitionerRole",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifiers that are specific to a role/location
  "active" : <boolean>, // Whether this practitioner's record is in active use
  "practitioner" : { Reference(Practitioner) }, // Practitioner that is able to provide the defined services for the organation
  "organization" : { Reference(Organization) }, // Organization where the roles are available
  "role" : [{ CodeableConcept }], // Roles which this practitioner may perform
  "specialty" : [{ CodeableConcept }], // Specific specialty of the practitioner
  "location" : [{ Reference(Location) }], // The location(s) at which this practitioner provides care
  "healthcareService" : [{ Reference(HealthcareService) }], // The list of healthcare services that this worker provides for this role's Organization/Location(s)
  "telecom" : [{ ContactPoint }], // Contact details that are specific to the role/location/service
  "period" : { Period }, // The period during which the practitioner is authorized to perform in these role(s)
  "availableTime" : [{ // Times the Service Site is available
    "daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
    "allDay" : <boolean>, // Always available? e.g. 24 hour service
    "availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true)
    "availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true)
  }],
  "notAvailable" : [{ // Not available during this time due to provided reason
    "description" : "<string>", // R!  Reason presented to the user explaining why time not available
    "during" : { Period } // Service not availablefrom this date
  }],
  "availabilityExceptions" : "<string>" // Description of availability exceptions
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole DomainResourceRoles/organizations the practitioner is associated with
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
... active Σ0..1booleanWhether this practitioner's record is in active use
... practitioner Σ0..1Reference(Practitioner)Practitioner that is able to provide the defined services for the organation
... organization Σ0..1Reference(Organization)Organization where the roles are available
... role Σ0..*CodeableConceptRoles which this practitioner may perform
PractitionerRole (Example)
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Practice Setting Code Value Set (Preferred)
... 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..*ContactPointContact details that are specific to the role/location/service
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... availableTime 0..*BackboneElementTimes the Service Site is available
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
DaysOfWeek (Required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions

doco Documentation for this format

UML Diagram

PractitionerRole (DomainResource)Business Identifiers that are specific to a role/locationidentifier : Identifier [0..*]Whether this practitioner's record is in active useactive : boolean [0..1]Practitioner that is able to provide the defined services for the organationpractitioner : Reference [0..1] « Practitioner »The organization where the Practitioner performs the roles associatedorganization : Reference [0..1] « Organization »Roles which this practitioner is authorized to perform for the organizationrole : CodeableConcept [0..*] « The role a person plays representing an organization (Strength=Example)PractitionerRole?? »Specific specialty of the practitionerspecialty : CodeableConcept [0..*] « Specific specialty associated with the agency (Strength=Preferred)Practice Setting Code Value S...? »The location(s) at which this practitioner provides carelocation : Reference [0..*] « Location »The list of healthcare services that this worker provides for this role's Organization/Location(s)healthcareService : Reference [0..*] « HealthcareService »Contact details that are specific to the role/location/servicetelecom : ContactPoint [0..*]The period during which the person is authorized to act as a practitioner in these role(s) for the organizationperiod : Period [0..1]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 TimesavailabilityExceptions : string [0..1]AvailableTimeIndicates which days of the week are available between the start and end TimesdaysOfWeek : code [0..*] « The days of the week. (Strength=Required)DaysOfWeek! »Is this always available? (hence times are irrelevant) e.g. 24 hour serviceallDay : boolean [0..1]The opening time of day. Note: If the AllDay flag is set, then this time is ignoredavailableStartTime : time [0..1]The closing time of day. Note: If the AllDay flag is set, then this time is ignoredavailableEndTime : time [0..1]NotAvailableThe reason that can be presented to the user as to why this time is not availabledescription : string [1..1]Service is not available (seasonally or for a public holiday) from this dateduring : Period [0..1]A collection of times that the Service Site is availableavailableTime[0..*]The HealthcareService is not available during this period of time due to the provided reasonnotAvailable[0..*]

XML Template

<PractitionerRole xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifiers that are specific to a role/location --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this practitioner's record is in active use -->
 <practitioner><!-- 0..1 Reference(Practitioner) Practitioner that is able to provide the defined services for the organation --></practitioner>
 <organization><!-- 0..1 Reference(Organization) Organization where the roles are available --></organization>
 <role><!-- 0..* CodeableConcept Roles which this practitioner may perform --></role>
 <specialty><!-- 0..* CodeableConcept Specific specialty of the practitioner --></specialty>
 <location><!-- 0..* Reference(Location) The location(s) at which this practitioner provides care --></location>
 <healthcareService><!-- 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s) --></healthcareService>
 <telecom><!-- 0..* ContactPoint Contact details that are specific to the role/location/service --></telecom>
 <period><!-- 0..1 Period The period during which the practitioner is authorized to perform in these role(s) --></period>
 <availableTime>  <!-- 0..* Times the Service Site is available -->
  <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun -->
  <allDay value="[boolean]"/><!-- 0..1 Always available? e.g. 24 hour service -->
  <availableStartTime value="[time]"/><!-- 0..1 Opening time of day (ignored if allDay = true) -->
  <availableEndTime value="[time]"/><!-- 0..1 Closing time of day (ignored if allDay = true) -->
 </availableTime>
 <notAvailable>  <!-- 0..* Not available during this time due to provided reason -->
  <description value="[string]"/><!-- 1..1 Reason presented to the user explaining why time not available -->
  <during><!-- 0..1 Period Service not availablefrom this date --></during>
 </notAvailable>
 <availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions -->
</PractitionerRole>

JSON Template

{doco
  "resourceType" : "PractitionerRole",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifiers that are specific to a role/location
  "active" : <boolean>, // Whether this practitioner's record is in active use
  "practitioner" : { Reference(Practitioner) }, // Practitioner that is able to provide the defined services for the organation
  "organization" : { Reference(Organization) }, // Organization where the roles are available
  "role" : [{ CodeableConcept }], // Roles which this practitioner may perform
  "specialty" : [{ CodeableConcept }], // Specific specialty of the practitioner
  "location" : [{ Reference(Location) }], // The location(s) at which this practitioner provides care
  "healthcareService" : [{ Reference(HealthcareService) }], // The list of healthcare services that this worker provides for this role's Organization/Location(s)
  "telecom" : [{ ContactPoint }], // Contact details that are specific to the role/location/service
  "period" : { Period }, // The period during which the practitioner is authorized to perform in these role(s)
  "availableTime" : [{ // Times the Service Site is available
    "daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
    "allDay" : <boolean>, // Always available? e.g. 24 hour service
    "availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true)
    "availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true)
  }],
  "notAvailable" : [{ // Not available during this time due to provided reason
    "description" : "<string>", // R!  Reason presented to the user explaining why time not available
    "during" : { Period } // Service not availablefrom this date
  }],
  "availabilityExceptions" : "<string>" // Description of availability exceptions
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

5.5.4.1 Terminology Bindings

PathDefinitionTypeReference
PractitionerRole.role The role a person plays representing an organizationExamplePractitionerRole
PractitionerRole.specialty Specific specialty associated with the agencyPreferredPractice Setting Code Value Set
PractitionerRole.availableTime.daysOfWeek The days of the week.RequiredDaysOfWeek

5.5.5 Notes:

  • There is no address on the PractitionerRole as the location that is defined here contains the address.
    This prevents having to duplicate the address values across multiple resources.

5.5.6 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
emailtokenA value in an email contactPractitionerRole.telecom(system=email)
identifiertokenA practitioner's IdentifierPractitionerRole.identifier
locationreferenceOne of the locations at which this practitioner provides carePractitionerRole.location
(Location)
organizationreferenceThe identity of the organization the practitioner represents / acts on behalf ofPractitionerRole.organization
(Organization)
phonetokenA value in a phone contactPractitionerRole.telecom(system=phone)
practitionerreferencePractitioner that is able to provide the defined services for the organationPractitionerRole.practitioner
(Practitioner)
roletokenThe practitioner can perform this role at for the organizationPractitionerRole.role
specialtytokenThe practitioner has this specialty at an organizationPractitionerRole.specialty
telecomtokenThe value in any kind of contactPractitionerRole.telecom