Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: InterweavePractitionerRole

Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-PractitionerRole Version: 0.1.0
Active as of 2024-06-10 Computable Name: InterweavePractitionerRole

Interweave Practitioner role resource profile.

  Status: Active: Approved (STU)

Introduction

This profile sets out the expectations for the interweave practitioner role resource. 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.

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. Care connect have created a slice on this field which has a required binding to the practitioner’s RBAC role. 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 also pre-adopt the UKCore 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 pre-adopt the UKCore value set (ukcore-practicesettingcode), which is based on the values in the NHS Data Dictionary MAIN SPECIALTY CODE.

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.
  • 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.
  • Location – Option to provide the locations at which the practitioner provides care.

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 CareConnect-PractitionerRole-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*CareConnect-PractitionerRole-1Roles/organizations the practitioner is associated with
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... serviceType S0..*CodeableConceptThe services which the practitioner can offer. (pre-adopted from R4).
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType
Binding: Interweave UkCore Care Service Type (preferred)
... active S1..1booleanWhether this practitioner's “role” record is in active use.
... period S0..1PeriodThe period during which the practitioner is authorized to perform in these role(s).
... practitioner S1..1Reference(CareConnect-Practitioner-1)The practitioner that is able to provide the defined services for the organisation.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... organization S0..1Reference(CareConnect-Organization-1)The organization where the Practitioner performs the roles associated.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... code S1..*CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (preferred)
... specialty S0..*CodeableConceptSpecific specialty of the practitioner
Binding: InterweaveUKCorePracticeSettingCode (preferred)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... location 0..*Reference(CareConnect-Location-1)The location(s) at which this practitioner provides care.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 0..1stringIf 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)

PathConformanceValueSet
PractitionerRole.codepreferredCare Connect SDS Job Role Name
PractitionerRole.specialtypreferredInterweaveUKCorePracticeSettingCode
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*CareConnect-PractitionerRole-1Roles/organizations the practitioner is associated with
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - 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..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


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


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... serviceType S0..*CodeableConceptThe services which the practitioner can offer. (pre-adopted from R4).
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType
Binding: Interweave UkCore Care Service Type (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active SΣ1..1booleanWhether this practitioner's “role” record is in active use.
... period SΣ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s).
... practitioner SΣ1..1Reference(CareConnect-Practitioner-1)The practitioner that is able to provide the defined services for the organisation.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... organization SΣ0..1Reference(CareConnect-Organization-1)The organization where the Practitioner performs the roles associated.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... Slices for code SΣ1..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open At End by value:coding.system
Binding: Care Connect SDS Job Role Name (preferred)
.... code:sdsJobRoleName Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (required)
..... coding Σ1..1CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: InterweaveUKCorePracticeSettingCode (preferred)
... location Σ0..*Reference(CareConnect-Location-1)The location(s) at which this practitioner provides care.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ0..1stringIf relevant, description of the referenced resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.meta.securityextensibleAll Security Labels
PractitionerRole.meta.tagexampleCommon Tags
PractitionerRole.meta.tag:SourceexampleCommon Tags
PractitionerRole.meta.tag:ProvenanceexampleCommon Tags
PractitionerRole.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.codepreferredCare Connect SDS Job Role Name
PractitionerRole.code:sdsJobRoleNamerequiredCare Connect SDS Job Role Name
PractitionerRole.specialtypreferredInterweaveUKCorePracticeSettingCode

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (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..*CareConnect-PractitionerRole-1Roles/organizations the practitioner is associated with
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - 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..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


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


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... serviceType S0..*CodeableConceptThe services which the practitioner can offer. (pre-adopted from R4).
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType
Binding: Interweave UkCore Care Service Type (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner's “role” record is in active use.
... period SΣ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s).
... practitioner SΣ1..1Reference(CareConnect-Practitioner-1)The practitioner that is able to provide the defined services for the organisation.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... organization SΣ0..1Reference(CareConnect-Organization-1)The organization where the Practitioner performs the roles associated.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... Slices for code SΣ1..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open At End by value:coding.system
Binding: Care Connect SDS Job Role Name (preferred)
.... code:sdsJobRoleName Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: InterweaveUKCorePracticeSettingCode (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... location Σ0..*Reference(CareConnect-Location-1)The location(s) at which this practitioner provides care.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ0..1stringIf relevant, description of the referenced resource
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.meta.securityextensibleAll Security Labels
PractitionerRole.meta.tagexampleCommon Tags
PractitionerRole.meta.tag:SourceexampleCommon Tags
PractitionerRole.meta.tag:ProvenanceexampleCommon Tags
PractitionerRole.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.identifier.userequiredIdentifierUse
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
PractitionerRole.codepreferredCare Connect SDS Job Role Name
PractitionerRole.code:sdsJobRoleNamerequiredCare Connect SDS Job Role Name
PractitionerRole.specialtypreferredInterweaveUKCorePracticeSettingCode
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (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 CareConnect-PractitionerRole-1

Summary

Mandatory: 5 elements (12 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 2 elements
Prohibited: 5 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element PractitionerRole.meta.tag is sliced based on the value of value:system

Differential View

This structure is derived from CareConnect-PractitionerRole-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*CareConnect-PractitionerRole-1Roles/organizations the practitioner is associated with
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... serviceType S0..*CodeableConceptThe services which the practitioner can offer. (pre-adopted from R4).
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType
Binding: Interweave UkCore Care Service Type (preferred)
... active S1..1booleanWhether this practitioner's “role” record is in active use.
... period S0..1PeriodThe period during which the practitioner is authorized to perform in these role(s).
... practitioner S1..1Reference(CareConnect-Practitioner-1)The practitioner that is able to provide the defined services for the organisation.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... organization S0..1Reference(CareConnect-Organization-1)The organization where the Practitioner performs the roles associated.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... code S1..*CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (preferred)
... specialty S0..*CodeableConceptSpecific specialty of the practitioner
Binding: InterweaveUKCorePracticeSettingCode (preferred)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... location 0..*Reference(CareConnect-Location-1)The location(s) at which this practitioner provides care.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 0..1stringIf 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)

PathConformanceValueSet
PractitionerRole.codepreferredCare Connect SDS Job Role Name
PractitionerRole.specialtypreferredInterweaveUKCorePracticeSettingCode

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*CareConnect-PractitionerRole-1Roles/organizations the practitioner is associated with
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - 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..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


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


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... serviceType S0..*CodeableConceptThe services which the practitioner can offer. (pre-adopted from R4).
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType
Binding: Interweave UkCore Care Service Type (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active SΣ1..1booleanWhether this practitioner's “role” record is in active use.
... period SΣ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s).
... practitioner SΣ1..1Reference(CareConnect-Practitioner-1)The practitioner that is able to provide the defined services for the organisation.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... organization SΣ0..1Reference(CareConnect-Organization-1)The organization where the Practitioner performs the roles associated.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... Slices for code SΣ1..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open At End by value:coding.system
Binding: Care Connect SDS Job Role Name (preferred)
.... code:sdsJobRoleName Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (required)
..... coding Σ1..1CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: InterweaveUKCorePracticeSettingCode (preferred)
... location Σ0..*Reference(CareConnect-Location-1)The location(s) at which this practitioner provides care.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ0..1stringIf relevant, description of the referenced resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.meta.securityextensibleAll Security Labels
PractitionerRole.meta.tagexampleCommon Tags
PractitionerRole.meta.tag:SourceexampleCommon Tags
PractitionerRole.meta.tag:ProvenanceexampleCommon Tags
PractitionerRole.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.codepreferredCare Connect SDS Job Role Name
PractitionerRole.code:sdsJobRoleNamerequiredCare Connect SDS Job Role Name
PractitionerRole.specialtypreferredInterweaveUKCorePracticeSettingCode

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
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
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (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..*CareConnect-PractitionerRole-1Roles/organizations the practitioner is associated with
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - 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..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


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


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - 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..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... serviceType S0..*CodeableConceptThe services which the practitioner can offer. (pre-adopted from R4).
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType
Binding: Interweave UkCore Care Service Type (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner's “role” record is in active use.
... period SΣ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s).
... practitioner SΣ1..1Reference(CareConnect-Practitioner-1)The practitioner that is able to provide the defined services for the organisation.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... organization SΣ0..1Reference(CareConnect-Organization-1)The organization where the Practitioner performs the roles associated.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... Slices for code SΣ1..*CodeableConceptRoles which this practitioner may perform
Slice: Unordered, Open At End by value:coding.system
Binding: Care Connect SDS Job Role Name (preferred)
.... code:sdsJobRoleName Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: Care Connect SDS Job Role Name (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... specialty SΣ0..*CodeableConceptSpecific specialty of the practitioner
Binding: InterweaveUKCorePracticeSettingCode (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... location Σ0..*Reference(CareConnect-Location-1)The location(s) at which this practitioner provides care.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ0..1stringIf relevant, description of the referenced resource
... telecom Σ0..*ContactPointContact details that are specific to the role/location/service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.meta.securityextensibleAll Security Labels
PractitionerRole.meta.tagexampleCommon Tags
PractitionerRole.meta.tag:SourceexampleCommon Tags
PractitionerRole.meta.tag:ProvenanceexampleCommon Tags
PractitionerRole.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.identifier.userequiredIdentifierUse
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
PractitionerRole.codepreferredCare Connect SDS Job Role Name
PractitionerRole.code:sdsJobRoleNamerequiredCare Connect SDS Job Role Name
PractitionerRole.specialtypreferredInterweaveUKCorePracticeSettingCode
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (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 CareConnect-PractitionerRole-1

Summary

Mandatory: 5 elements (12 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 2 elements
Prohibited: 5 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element PractitionerRole.meta.tag is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron