Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
| Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole | Version: 2.4.0 | |||
| Active as of 2023-12-12 | Computable Name: UKCorePractitionerRole | |||
Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
||||
This profile defines the UK constraints and extensions on the International FHIR resource PractitionerRole.
This profile allows exchange of a specific set of roles, specialties and services that a practitioner may perform at an organisation for a period of time.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole |
PractitionerRole | |||
  active |
S | 0..1 | boolean | Whether this practitioner role record is in active use. |
| period |
S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s). |
| practitioner |
S | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization. |
| organization |
S | 0..1 | Reference(Organization) | Organization where the roles are available. |
| specialty |
S | 0..* | CodeableConcept | Specific specialty of the practitioner. Binding: UK Core Practice Setting Code (extensible) |
| location |
S | 0..* | Reference(Location) | The location(s) at which this practitioner provides care. |
 telecom |
S | 0..* | ContactPoint | Contact details that are specific to the role/location/service. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.specialty | extensible | UKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCodefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| active |
SΣ | 0..1 | boolean | Whether this practitioner role record is in active use. |
 period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s). |
 practitioner |
SΣ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization. |
| organization |
SΣ | 0..1 | Reference(Organization) | Organization where the roles are available. |
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner. Binding: UK Core Practice Setting Code (extensible) |
| location |
SΣ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care. |
| telecom |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.specialty | extensible | UKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
| active |
SΣ | 0..1 | boolean | Whether this practitioner role record is in active use. | ||||
| period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s). | ||||
| practitioner |
SΣ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization. | ||||
| organization |
SΣ | 0..1 | Reference(Organization) | Organization where the roles are available. | ||||
| code |
Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner. Binding: UK Core Practice Setting Code (extensible) | ||||
| location |
SΣ | 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 |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service. | ||||
 availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-rolefrom the FHIR Standard | ||||
| PractitionerRole.specialty | extensible | UKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCodefrom this IG | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from PractitionerRole
Differential View
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
PractitionerRole | |||
| active |
S | 0..1 | boolean | Whether this practitioner role record is in active use. |
| period |
S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s). |
| practitioner |
S | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization. |
| organization |
S | 0..1 | Reference(Organization) | Organization where the roles are available. |
| specialty |
S | 0..* | CodeableConcept | Specific specialty of the practitioner. Binding: UK Core Practice Setting Code (extensible) |
| location |
S | 0..* | Reference(Location) | The location(s) at which this practitioner provides care. |
| telecom |
S | 0..* | ContactPoint | Contact details that are specific to the role/location/service. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.specialty | extensible | UKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCodefrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| active |
SΣ | 0..1 | boolean | Whether this practitioner role record is in active use. |
| period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s). |
| practitioner |
SΣ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization. |
| organization |
SΣ | 0..1 | Reference(Organization) | Organization where the roles are available. |
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner. Binding: UK Core Practice Setting Code (extensible) |
| location |
SΣ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care. |
| telecom |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.specialty | extensible | UKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCodefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
| active |
SΣ | 0..1 | boolean | Whether this practitioner role record is in active use. | ||||
| period |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s). | ||||
| practitioner |
SΣ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization. | ||||
| organization |
SΣ | 0..1 | Reference(Organization) | Organization where the roles are available. | ||||
| code |
Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner. Binding: UK Core Practice Setting Code (extensible) | ||||
| location |
SΣ | 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 |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service. | ||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-rolefrom the FHIR Standard | ||||
| PractitionerRole.specialty | extensible | UKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCodefrom this IG | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from PractitionerRole
Other representations of profile: CSV, Excel, Schematron