Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Resource Profile: InterweavePractitionerRole

Official URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-PractitionerRole Version: 0.0.1
Draft as of 2024-07-15 Computable Name: InterweavePractitionerRole

Interweave Practitioner role resource profile - DRAFT.

Status: DRAFT: For Review

Introduction

This profile sets out the expectations for the interweave practitioner role resource. We use the practitionerRole structure definition as a base to this profile.

This Resource will give the consumer the ability to see information on the specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization within a period of time. For example Consultant or Nurse working within an acute setting and or Private setting or a social care worker within a local authority.

Mandatory fields

  1. active - The default for this field is true, but it can be set to false should the role become inactive or if it has been entered in error.

  2. practitioner - Every practitioner role resource must reference a practitioner, and the practitioner’s name must be present in the 'display' sub field.

  3. code - is used to record the roles which a practitioner is authorised to perform. UK Core have used SNOMED codes representating HealthCare Professional (223366009). We have also added a slice representing NHS SDS Job roles (used for RBAC), should you wish to share the roles assigned to the user. We treat this as the preferred field to populate. However, with prior authorisation, we will accept other code sets which represent the role.

Must Support fields

In addition the following fields are "Must Support" - i.e., they must be populated if relevant and known:

  1. period - The time period during which the practitioner is active in these roles.

  2. organization - The organisation where the practitioner is performing the roles.

  3. Service Type (Extension) - This describes the types of service which a practitioner can perform. We use the value set based on SNOMED refset 1127531000000102 (Services Simple Reference Set), which covers both health and social care.

  4. Specialty – This field represents the clinical specialty of a practitioner. We use the UKCore value set (ukcore-practicesettingcode), which is based on the values in the NHS Data Dictionary MAIN SPECIALTY CODE.

  5. Telecom - It can be useful to provide a contact phone number and/or email if at all possible – to enable further enquiries. However, caution is needed, as these contact details may be widely seen throughout the region. Only work details suitable for receiving external enquires should be included. Specifically, home phone numbers should not be shared.

  6. Location – Option to provide the locations at which the practitioner provides care.

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Points of note include:

  • identifier - option to provide a business identifier that is for a specific practitioner’s role.

Discouraged or Removed fields

  • healthCareService - Removed. The information held in the serviceType extension is adequate to represent the services at a high level, and therefore this reference field is removed to avoid any confusion with the serviceType field.

  • endpoint - Removed. Technical endpoints are captured elsewhere (i.e. via the Participant Registry)

The following fields have also been removed as they are more relevant to a scheduling system rather than a shared care record:

  • availableTime
  • notAvailable
  • availabilityExceptions

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from UKCorePractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole UKCorePractitionerRole
... id S 0..1 id Logical id of this artifact
... meta
.... id 0..0
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... version 0..0
...... code S 1..1 code The Data Provider Id of the system supplying the data
...... display S 1..1 string Name of the system supplying the data
..... tag:Provenance S 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... version 0..0
...... code S 1..1 code The ODS Code of the organisation responsible for the data
...... display S 1..1 string Name of the organisation supplying the data
... implicitRules 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... serviceType S 0..* CodeableConcept The services which the practitioner can offer.
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-ServiceType
Binding: UK Core Care Setting Type (preferred)
... identifier
.... id 0..0
.... extension 0..0
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
.... assigner 0..1 Reference(InterweaveOrganization) Organization that issued id (may be just text)
... active 1..1 boolean Whether this practitioner's “role” record is in active use.
... practitioner 1..1 Reference(InterweavePractitioner) The practitioner that is able to provide the defined services for the organisation.
.... id 0..0
.... extension 0..0
.... reference 1..1 string Reference to a resource (could be Contained)
.... type 0..0
.... identifier 0..1 Identifier If relevant could include an id
.... display 1..1 string Description of the referenced resource
... organization 0..1 Reference(InterweaveOrganization) The organization where the Practitioner performs the roles associated.
.... id 0..0
.... extension 0..0
.... reference 1..1 string Reference to a resource (could be Contained)
.... type 0..0
.... identifier 0..1 Identifier If relevant could include an id
.... display 1..1 string Description of the referenced resource
... Slices for code S 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: PractitionerRole (preferred)
.... code:All Slices Content/Rules for all slices
..... coding
...... id 0..0
...... system 1..1 uri Identity of the terminology system
...... version 0..0
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
.... code:SDSJobRoleName S 0..1 CodeableConcept Roles which this practitioner may perform
Binding: InterweaveSDSJobRoleName (preferred)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SDSJobRoleName
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
... specialty 0..* CodeableConcept Specific specialty of the practitioner.
Binding: UK Core Practice Setting Code (required)
.... id 0..0
.... extension 0..0
.... coding
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
... location 0..* Reference(InterweaveLocation) The location(s) at which this practitioner provides care.
.... id 0..0
.... extension 0..0
.... reference 1..1 string Reference to a resource (could be Contained)
.... type 0..0
.... identifier 0..1 Identifier If relevant could include an id
.... display 0..1 string If relevant, description of the referenced resource
... healthcareService 0..0
... availableTime 0..0
... notAvailable 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PractitionerRole.codepreferredPractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
from the FHIR Standard
PractitionerRole.code:SDSJobRoleNamepreferredInterweaveSDSJobRoleName
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SDSJobRoleName
from this IG
PractitionerRole.specialtyrequiredUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..* UKCorePractitionerRole Roles/organizations the practitioner is associated with
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


..... tag:Source SΣ 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... code SΣ 1..1 code The Data Provider Id of the system supplying the data
...... display SΣ 1..1 string Name of the system supplying the data
..... tag:Provenance SΣ 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... serviceType S 0..* CodeableConcept The services which the practitioner can offer.
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-ServiceType
Binding: UK Core Care Setting Type (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
.... extension 0..0
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... assigner Σ 0..1 Reference(InterweaveOrganization) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner's “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Σ 1..1 Reference(InterweavePractitioner) The practitioner that is able to provide the defined services for the organisation.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 1..1 string Description of the referenced resource
... organization SΣ 0..1 Reference(InterweaveOrganization) The organization where the Practitioner performs the roles associated.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 1..1 string Description of the referenced resource
... Slices for code SΣ 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: PractitionerRole (preferred)
.... code:SDSJobRoleName SΣ 0..1 CodeableConcept Roles which this practitioner may perform
Binding: InterweaveSDSJobRoleName (preferred)
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner.
Binding: UK Core Practice Setting Code (required)
.... extension 0..0
... location SΣ 0..* Reference(InterweaveLocation) The location(s) at which this practitioner provides care.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 0..1 string If relevant, description of the referenced resource
... telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
PractitionerRole.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.codepreferredPractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
from the FHIR Standard
PractitionerRole.code:SDSJobRoleNamepreferredInterweaveSDSJobRoleName
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SDSJobRoleName
from this IG
PractitionerRole.specialtyrequiredUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..* UKCorePractitionerRole Roles/organizations the practitioner is associated with
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


..... tag:Source SΣ 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... 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.interweavedigital.nhs.uk/Source
...... code SΣ 1..1 code The Data Provider Id of the system supplying the data
...... display SΣ 1..1 string Name of the system supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... tag:Provenance SΣ 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... 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.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... serviceType S 0..* CodeableConcept The services which the practitioner can offer.
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-ServiceType
Binding: UK Core Care Setting Type (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
.... extension 0..0
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (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 SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 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(InterweaveOrganization) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner's “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Σ 1..1 Reference(InterweavePractitioner) The practitioner that is able to provide the defined services for the organisation.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 1..1 string Description of the referenced resource
... organization SΣ 0..1 Reference(InterweaveOrganization) The organization where the Practitioner performs the roles associated.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 1..1 string Description of the referenced resource
... Slices for code SΣ 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: PractitionerRole (preferred)
.... code:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... 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
.... code:SDSJobRoleName SΣ 0..1 CodeableConcept Roles which this practitioner may perform
Binding: InterweaveSDSJobRoleName (preferred)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... 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.interweavedigital.nhs.uk/CodeSystem/Interweave-SDSJobRoleName
...... 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 SΣ 0..* CodeableConcept Specific specialty of the practitioner.
Binding: UK Core Practice Setting Code (required)
.... extension 0..0
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
..... 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
... location SΣ 0..* Reference(InterweaveLocation) The location(s) at which this practitioner provides care.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 0..1 string If relevant, description of the referenced resource
... telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
PractitionerRole.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PractitionerRole.codepreferredPractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
from the FHIR Standard
PractitionerRole.code:SDSJobRoleNamepreferredInterweaveSDSJobRoleName
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SDSJobRoleName
from this IG
PractitionerRole.specialtyrequiredUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from UKCorePractitionerRole

Summary

Mandatory: 5 elements(20 nested mandatory elements)
Must-Support: 15 elements
Fixed: 3 elements
Prohibited: 25 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PractitionerRole.meta.tag
  • The element 1 is sliced based on the value of PractitionerRole.code

Differential View

This structure is derived from UKCorePractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole UKCorePractitionerRole
... id S 0..1 id Logical id of this artifact
... meta
.... id 0..0
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... version 0..0
...... code S 1..1 code The Data Provider Id of the system supplying the data
...... display S 1..1 string Name of the system supplying the data
..... tag:Provenance S 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... version 0..0
...... code S 1..1 code The ODS Code of the organisation responsible for the data
...... display S 1..1 string Name of the organisation supplying the data
... implicitRules 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... serviceType S 0..* CodeableConcept The services which the practitioner can offer.
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-ServiceType
Binding: UK Core Care Setting Type (preferred)
... identifier
.... id 0..0
.... extension 0..0
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
.... assigner 0..1 Reference(InterweaveOrganization) Organization that issued id (may be just text)
... active 1..1 boolean Whether this practitioner's “role” record is in active use.
... practitioner 1..1 Reference(InterweavePractitioner) The practitioner that is able to provide the defined services for the organisation.
.... id 0..0
.... extension 0..0
.... reference 1..1 string Reference to a resource (could be Contained)
.... type 0..0
.... identifier 0..1 Identifier If relevant could include an id
.... display 1..1 string Description of the referenced resource
... organization 0..1 Reference(InterweaveOrganization) The organization where the Practitioner performs the roles associated.
.... id 0..0
.... extension 0..0
.... reference 1..1 string Reference to a resource (could be Contained)
.... type 0..0
.... identifier 0..1 Identifier If relevant could include an id
.... display 1..1 string Description of the referenced resource
... Slices for code S 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: PractitionerRole (preferred)
.... code:All Slices Content/Rules for all slices
..... coding
...... id 0..0
...... system 1..1 uri Identity of the terminology system
...... version 0..0
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
.... code:SDSJobRoleName S 0..1 CodeableConcept Roles which this practitioner may perform
Binding: InterweaveSDSJobRoleName (preferred)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SDSJobRoleName
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
... specialty 0..* CodeableConcept Specific specialty of the practitioner.
Binding: UK Core Practice Setting Code (required)
.... id 0..0
.... extension 0..0
.... coding
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
... location 0..* Reference(InterweaveLocation) The location(s) at which this practitioner provides care.
.... id 0..0
.... extension 0..0
.... reference 1..1 string Reference to a resource (could be Contained)
.... type 0..0
.... identifier 0..1 Identifier If relevant could include an id
.... display 0..1 string If relevant, description of the referenced resource
... healthcareService 0..0
... availableTime 0..0
... notAvailable 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PractitionerRole.codepreferredPractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
from the FHIR Standard
PractitionerRole.code:SDSJobRoleNamepreferredInterweaveSDSJobRoleName
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SDSJobRoleName
from this IG
PractitionerRole.specialtyrequiredUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..* UKCorePractitionerRole Roles/organizations the practitioner is associated with
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


..... tag:Source SΣ 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... code SΣ 1..1 code The Data Provider Id of the system supplying the data
...... display SΣ 1..1 string Name of the system supplying the data
..... tag:Provenance SΣ 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... serviceType S 0..* CodeableConcept The services which the practitioner can offer.
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-ServiceType
Binding: UK Core Care Setting Type (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
.... extension 0..0
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... assigner Σ 0..1 Reference(InterweaveOrganization) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner's “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Σ 1..1 Reference(InterweavePractitioner) The practitioner that is able to provide the defined services for the organisation.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 1..1 string Description of the referenced resource
... organization SΣ 0..1 Reference(InterweaveOrganization) The organization where the Practitioner performs the roles associated.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 1..1 string Description of the referenced resource
... Slices for code SΣ 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: PractitionerRole (preferred)
.... code:SDSJobRoleName SΣ 0..1 CodeableConcept Roles which this practitioner may perform
Binding: InterweaveSDSJobRoleName (preferred)
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner.
Binding: UK Core Practice Setting Code (required)
.... extension 0..0
... location SΣ 0..* Reference(InterweaveLocation) The location(s) at which this practitioner provides care.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 0..1 string If relevant, description of the referenced resource
... telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
PractitionerRole.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.codepreferredPractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
from the FHIR Standard
PractitionerRole.code:SDSJobRoleNamepreferredInterweaveSDSJobRoleName
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SDSJobRoleName
from this IG
PractitionerRole.specialtyrequiredUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..* UKCorePractitionerRole Roles/organizations the practitioner is associated with
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


..... tag:Source SΣ 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... 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.interweavedigital.nhs.uk/Source
...... code SΣ 1..1 code The Data Provider Id of the system supplying the data
...... display SΣ 1..1 string Name of the system supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... tag:Provenance SΣ 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... 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.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... serviceType S 0..* CodeableConcept The services which the practitioner can offer.
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-ServiceType
Binding: UK Core Care Setting Type (preferred)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
.... extension 0..0
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (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 SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 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(InterweaveOrganization) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner's “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Σ 1..1 Reference(InterweavePractitioner) The practitioner that is able to provide the defined services for the organisation.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 1..1 string Description of the referenced resource
... organization SΣ 0..1 Reference(InterweaveOrganization) The organization where the Practitioner performs the roles associated.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 1..1 string Description of the referenced resource
... Slices for code SΣ 1..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:coding.system
Binding: PractitionerRole (preferred)
.... code:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... 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
.... code:SDSJobRoleName SΣ 0..1 CodeableConcept Roles which this practitioner may perform
Binding: InterweaveSDSJobRoleName (preferred)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... 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.interweavedigital.nhs.uk/CodeSystem/Interweave-SDSJobRoleName
...... 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 SΣ 0..* CodeableConcept Specific specialty of the practitioner.
Binding: UK Core Practice Setting Code (required)
.... extension 0..0
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
..... 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
... location SΣ 0..* Reference(InterweaveLocation) The location(s) at which this practitioner provides care.
.... extension 0..0
.... reference ΣC 1..1 string Reference to a resource (could be Contained)
.... identifier Σ 0..1 Identifier If relevant could include an id
.... display Σ 0..1 string If relevant, description of the referenced resource
... telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
PractitionerRole.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PractitionerRole.codepreferredPractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
from the FHIR Standard
PractitionerRole.code:SDSJobRoleNamepreferredInterweaveSDSJobRoleName
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SDSJobRoleName
from this IG
PractitionerRole.specialtyrequiredUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from UKCorePractitionerRole

Summary

Mandatory: 5 elements(20 nested mandatory elements)
Must-Support: 15 elements
Fixed: 3 elements
Prohibited: 25 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PractitionerRole.meta.tag
  • The element 1 is sliced based on the value of PractitionerRole.code

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Differences between Interweave STU3 and R4 profiles

Element name Change details
extension:serviceType
  • Changed valueSet from https://fhir.yhcr.nhs.uk/ValueSet/Interweave-UkCoreCareServiceType to https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType
extension:serviceType.url
  • Changed fixed value from https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType to https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-ServiceType
code
  • Added preferred binding to http://hl7.org/fhir/ValueSet/practitioner-role
code:sdsJobRoleName
  • Changed valueSet from https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-SDSJobRoleName-1 to https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SDSJobRoleName
  • Change of codeSystem from https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1 to https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SDSJobRoleName
specialty
  • Changed valueSet from https://fhir.yhcr.nhs.uk/ValueSet/Interweave-UKCorePracticeSettingCode to https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
  • Change of codeSystem from https://fhir.yhcr.nhs.uk/CodeSystem/Interweave-UKCorePracticeSettingCode to https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode

Graphical relationship diagram

Graphical relationship diagram of practitioner role resource