Path | Short | Definition | Comments |
---|---|---|---|
Roles/organizations the practitioner is associated with | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. | ||
identifier | Business Identifiers that are specific to a role/location | Business Identifiers that are specific to a role/location. | |
active | Whether this practitioner role record is in active use | 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. |
period | The period during which the practitioner is authorized to perform in these role(s) | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. | |
practitioner | Practitioner that is able to provide the defined services for the organization | Practitioner that is able to provide the defined services for the organization. | |
organization | Organization where the roles are available | The organization where the Practitioner performs the roles associated. | |
code | Roles which this practitioner may perform | Roles which this practitioner is authorized to perform for the organization. | A person may have more than one role. |
specialty | Specific specialty of the practitioner | Specific specialty of the practitioner. | |
location | The location(s) at which this practitioner provides care | The location(s) at which this practitioner provides care. | |
healthcareService | The list of healthcare services that this worker provides for this role's Organization/Location(s) | The list of healthcare services that this worker provides for this role's Organization/Location(s). | |
telecom | Contact details that are specific to the role/location/service | Contact details that are specific to the role/location/service. | |
availableTime | Times the Service Site is available | 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. |
availableTime.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
availableTime.extension | Additional content defined by implementations | 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. |
availableTime.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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. |
availableTime.daysOfWeek | mon | tue | wed | thu | fri | sat | sun | Indicates which days of the week are available between the start and end Times. | |
availableTime.allDay | Always available? e.g. 24 hour service | Is this always available? (hence times are irrelevant) e.g. 24 hour service. | |
availableTime.availableStartTime | Opening time of day (ignored if allDay = true) | 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. |
availableTime.availableEndTime | Closing time of day (ignored if allDay = true) | 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. |
notAvailable | Not available during this time due to provided reason | The practitioner is not available or performing this role during this period of time due to the provided reason. | |
notAvailable.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
notAvailable.extension | Additional content defined by implementations | 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. |
notAvailable.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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. |
notAvailable.description | Reason presented to the user explaining why time not available | The reason that can be presented to the user as to why this time is not available. | |
notAvailable.during | Service not available from this date | Service is not available (seasonally or for a public holiday) from this date. | |
availabilityExceptions | Description of availability exceptions | 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. | |
endpoint | Technical endpoints providing access to services operated for the practitioner with this role | Technical endpoints providing access to services operated for the practitioner with this role. |
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 representing this data.
Qualifications (from the Practitioner resource) do not imply a Role, but might be considered when an Organization allocates practitioners to roles within their organization, and could provide useful information (such as expiry information) which could need to be tracked in some situations to ensure they continue to be eligible for a specific role.
The CareTeam resource is also often used to provide details of a role that a practitioner is allocated to perform, but is usually scoped to a much finer granularity of care, and often within the specific context of a Patient, or functional role (e.g. Crisis planning team). In contrast the PractitionerRole is used in a more general sense to cover all the places that the practitioner is allocated to work (and specific details relevant to that role - such as a specific contact number, or electronic services endpoint).
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.
active | Whether this practitioner role record is in active use | PractitionerRole.active |
date | The period during which the practitioner is authorized to perform in these role(s) | PractitionerRole.period |
endpoint | Technical endpoints providing access to services operated for the practitioner with this role | PractitionerRole.endpoint |
identifier | A practitioner's Identifier | PractitionerRole.identifier |
location | One of the locations at which this practitioner provides care | PractitionerRole.location |
organization | The identity of the organization the practitioner represents / acts on behalf of | PractitionerRole.organization |
practitioner | Practitioner that is able to provide the defined services for the organization | PractitionerRole.practitioner |
role | The practitioner can perform this role at for the organization | PractitionerRole.code |
service | The list of healthcare services that this worker provides for this role's Organization/Location(s) | PractitionerRole.healthcareService |
specialty | The practitioner has this specialty at an organization | PractitionerRole.specialty |