Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Resource Profile: CareConnectPractitionerRole1
| Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-PractitionerRole-1 | Version: 0.1.0 | |||
| Draft as of 2018-11-05 | Computable Name: CareConnect-PractitionerRole-1 | |||
Copyright/Legal: Copyright © 2016 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 |
||||
The PractitionerRole resource represents a specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/
Usage:
- Derived from this Resource Profile: InterweavePractitionerRole
- Examples for this Resource Profile: PractitionerRole/InterweavePractitionerRoleExample
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
  identifier | ||||
  system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
  assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
| practitioner | 0..1 | Reference(CareConnect-Practitioner-1) | Practitioner that is able to provide the defined services for the organisation | |
| organization | 0..1 | Reference(CareConnect-Organization-1) | Organization where the roles are available | |
 Slices for code | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open At End by value:coding.system | |
  code:sdsJobRoleName | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (required) | |
  coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1 | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| location | 0..* | Reference(CareConnect-Location-1) | The location(s) at which this practitioner provides care | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| PractitionerRole.code:sdsJobRoleName | required | Care Connect SDS Job Role Name |
| 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 |
| practitioner | Σ | 0..1 | Reference(CareConnect-Practitioner-1) | Practitioner that is able to provide the defined services for the organisation |
| organization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization where the roles are available |
| Slices for code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open At End by value:coding.system Binding: PractitionerRole (example): The role a person plays representing an organization |
| code:sdsJobRoleName | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (required) |
 coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1 |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| location | Σ | 0..* | Reference(CareConnect-Location-1) | The location(s) at which this practitioner provides care |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| PractitionerRole.code | example | PractitionerRole |
| PractitionerRole.code:sdsJobRoleName | required | Care Connect SDS Job Role Name |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| 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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() |
| 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: Common Languages (extensible): 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 | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner | Σ | 0..1 | Reference(CareConnect-Practitioner-1) | Practitioner that is able to provide the defined services for the organisation | ||||
| organization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization where the roles are available | ||||
| Slices for code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open At End by value:coding.system Binding: PractitionerRole (example): The role a person plays representing an organization | ||||
| code:sdsJobRoleName | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (required) | ||||
 id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
 coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
 id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1 | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
 text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Practice Setting Code Value Set (preferred): Specific specialty associated with the agency | ||||
| location | Σ | 0..* | Reference(CareConnect-Location-1) | 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..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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 | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
| during | 0..1 | Period | Service not availablefrom 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 | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| PractitionerRole.language | extensible | Common Languages
| ||||
| PractitionerRole.identifier.use | required | IdentifierUse | ||||
| PractitionerRole.identifier.type | extensible | Identifier Type Codes | ||||
| PractitionerRole.code | example | PractitionerRole | ||||
| PractitionerRole.code:sdsJobRoleName | required | Care Connect SDS Job Role Name | ||||
| PractitionerRole.specialty | preferred | Practice Setting Code Value Set | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
This structure is derived from PractitionerRole
Summary
Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
- CareConnect-Organization-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1)
- CareConnect-Practitioner-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1)
- CareConnect-Location-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1)
Slices
This structure defines the following Slices:
- The element PractitionerRole.code is sliced based on the value of value:coding.system (Open at End)
Differential View
This structure is derived from PractitionerRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
| identifier | ||||
| system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
| assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
| practitioner | 0..1 | Reference(CareConnect-Practitioner-1) | Practitioner that is able to provide the defined services for the organisation | |
| organization | 0..1 | Reference(CareConnect-Organization-1) | Organization where the roles are available | |
| Slices for code | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open At End by value:coding.system | |
| code:sdsJobRoleName | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (required) | |
| coding | 1..1 | Coding | Code defined by a terminology system | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1 | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| location | 0..* | Reference(CareConnect-Location-1) | The location(s) at which this practitioner provides care | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| PractitionerRole.code:sdsJobRoleName | required | Care Connect SDS Job Role Name |
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 |
| practitioner | Σ | 0..1 | Reference(CareConnect-Practitioner-1) | Practitioner that is able to provide the defined services for the organisation |
| organization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization where the roles are available |
| Slices for code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open At End by value:coding.system Binding: PractitionerRole (example): The role a person plays representing an organization |
| code:sdsJobRoleName | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (required) |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1 |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| location | Σ | 0..* | Reference(CareConnect-Location-1) | The location(s) at which this practitioner provides care |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| PractitionerRole.code | example | PractitionerRole |
| PractitionerRole.code:sdsJobRoleName | required | Care Connect SDS Job Role Name |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| 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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() |
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: Common Languages (extensible): 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 | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner | Σ | 0..1 | Reference(CareConnect-Practitioner-1) | Practitioner that is able to provide the defined services for the organisation | ||||
| organization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization where the roles are available | ||||
| Slices for code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open At End by value:coding.system Binding: PractitionerRole (example): The role a person plays representing an organization | ||||
| code:sdsJobRoleName | Σ | 0..1 | CodeableConcept | Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (required) | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1 | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Practice Setting Code Value Set (preferred): Specific specialty associated with the agency | ||||
| location | Σ | 0..* | Reference(CareConnect-Location-1) | 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..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| availableTime | 0..* | BackboneElement | Times the Service Site is available | |||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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 | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
| during | 0..1 | Period | Service not availablefrom 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 | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| PractitionerRole.language | extensible | Common Languages
| ||||
| PractitionerRole.identifier.use | required | IdentifierUse | ||||
| PractitionerRole.identifier.type | extensible | Identifier Type Codes | ||||
| PractitionerRole.code | example | PractitionerRole | ||||
| PractitionerRole.code:sdsJobRoleName | required | Care Connect SDS Job Role Name | ||||
| PractitionerRole.specialty | preferred | Practice Setting Code Value Set | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
This structure is derived from PractitionerRole
Summary
Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
- CareConnect-Organization-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1)
- CareConnect-Practitioner-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1)
- CareConnect-Location-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1)
Slices
This structure defines the following Slices:
- The element PractitionerRole.code is sliced based on the value of value:coding.system (Open at End)
Other representations of profile: CSV, Excel, Schematron