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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from CareConnect-PractitionerRole-1

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	CareConnect-PractitionerRole-1	Roles/organizations the practitioner is associated with
id	S	0..1	id	Logical id of this artifact
meta
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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
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. (pre-adopted from R4). URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType Binding: Interweave UkCore Care Service Type (preferred)
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(CareConnect-Practitioner-1)	The practitioner that is able to provide the defined services for the organisation.
reference		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(CareConnect-Organization-1)	The organization where the Practitioner performs the roles associated.
reference		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
code	S	1..*	CodeableConcept	Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (preferred)
specialty	S	0..*	CodeableConcept	Specific specialty of the practitioner Binding: InterweaveUKCorePracticeSettingCode (preferred)
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(CareConnect-Location-1)	The location(s) at which this practitioner provides care.
reference		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
healthcareService		0..0
availableTime		0..0
notAvailable		0..0
availabilityExceptions		0..0
endpoint		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
PractitionerRole.code	preferred	Care Connect SDS Job Role Name
PractitionerRole.specialty	preferred	InterweaveUKCorePracticeSettingCode

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	CareConnect-PractitionerRole-1	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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (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://yhcr.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: Common Tags (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://yhcr.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
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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. (pre-adopted from R4). URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType Binding: Interweave UkCore Care Service Type (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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(CareConnect-Practitioner-1)	The practitioner that is able to provide the defined services for the organisation.
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(CareConnect-Organization-1)	The organization where the Practitioner performs the roles associated.
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 At End by value:coding.system Binding: Care Connect SDS Job Role Name (preferred)
code:sdsJobRoleName	Σ	0..1	CodeableConcept	Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (required)
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: InterweaveUKCorePracticeSettingCode (preferred)
location	Σ	0..*	Reference(CareConnect-Location-1)	The location(s) at which this practitioner provides care.
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
PractitionerRole.meta.security	extensible	All Security Labels
PractitionerRole.meta.tag	example	Common Tags
PractitionerRole.meta.tag:Source	example	Common Tags
PractitionerRole.meta.tag:Provenance	example	Common Tags
PractitionerRole.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.code	preferred	Care Connect SDS Job Role Name
PractitionerRole.code:sdsJobRoleName	required	Care Connect SDS Job Role Name
PractitionerRole.specialty	preferred	InterweaveUKCorePracticeSettingCode

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	CareConnect-PractitionerRole-1	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
id		0..1	string	xml:id (or equivalent in JSON)
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.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
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
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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. (pre-adopted from R4). URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType Binding: Interweave UkCore Care Service Type (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
active	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(CareConnect-Practitioner-1)	The practitioner that is able to provide the defined services for the organisation.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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(CareConnect-Organization-1)	The organization where the Practitioner performs the roles associated.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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 At End by value:coding.system Binding: Care Connect SDS Job Role Name (preferred)
code:sdsJobRoleName	Σ	0..1	CodeableConcept	Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: InterweaveUKCorePracticeSettingCode (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
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	Σ	0..*	Reference(CareConnect-Location-1)	The location(s) at which this practitioner provides care.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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	Σ	0..*	ContactPoint	Contact details that are specific to the role/location/service
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
PractitionerRole.meta.security	extensible	All Security Labels
PractitionerRole.meta.tag	example	Common Tags
PractitionerRole.meta.tag:Source	example	Common Tags
PractitionerRole.meta.tag:Provenance	example	Common Tags
PractitionerRole.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.identifier.use	required	IdentifierUse
PractitionerRole.identifier.type	extensible	Identifier Type Codes
PractitionerRole.code	preferred	Care Connect SDS Job Role Name
PractitionerRole.code:sdsJobRoleName	required	Care Connect SDS Job Role Name
PractitionerRole.specialty	preferred	InterweaveUKCorePracticeSettingCode
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from CareConnect-PractitionerRole-1

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	CareConnect-PractitionerRole-1	Roles/organizations the practitioner is associated with
id	S	0..1	id	Logical id of this artifact
meta
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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
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. (pre-adopted from R4). URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType Binding: Interweave UkCore Care Service Type (preferred)
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(CareConnect-Practitioner-1)	The practitioner that is able to provide the defined services for the organisation.
reference		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(CareConnect-Organization-1)	The organization where the Practitioner performs the roles associated.
reference		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
code	S	1..*	CodeableConcept	Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (preferred)
specialty	S	0..*	CodeableConcept	Specific specialty of the practitioner Binding: InterweaveUKCorePracticeSettingCode (preferred)
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(CareConnect-Location-1)	The location(s) at which this practitioner provides care.
reference		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
healthcareService		0..0
availableTime		0..0
notAvailable		0..0
availabilityExceptions		0..0
endpoint		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
PractitionerRole.code	preferred	Care Connect SDS Job Role Name
PractitionerRole.specialty	preferred	InterweaveUKCorePracticeSettingCode

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	CareConnect-PractitionerRole-1	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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (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://yhcr.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: Common Tags (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://yhcr.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
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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. (pre-adopted from R4). URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType Binding: Interweave UkCore Care Service Type (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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(CareConnect-Practitioner-1)	The practitioner that is able to provide the defined services for the organisation.
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(CareConnect-Organization-1)	The organization where the Practitioner performs the roles associated.
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 At End by value:coding.system Binding: Care Connect SDS Job Role Name (preferred)
code:sdsJobRoleName	Σ	0..1	CodeableConcept	Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (required)
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: InterweaveUKCorePracticeSettingCode (preferred)
location	Σ	0..*	Reference(CareConnect-Location-1)	The location(s) at which this practitioner provides care.
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
PractitionerRole.meta.security	extensible	All Security Labels
PractitionerRole.meta.tag	example	Common Tags
PractitionerRole.meta.tag:Source	example	Common Tags
PractitionerRole.meta.tag:Provenance	example	Common Tags
PractitionerRole.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.code	preferred	Care Connect SDS Job Role Name
PractitionerRole.code:sdsJobRoleName	required	Care Connect SDS Job Role Name
PractitionerRole.specialty	preferred	InterweaveUKCorePracticeSettingCode

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	CareConnect-PractitionerRole-1	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
id		0..1	string	xml:id (or equivalent in JSON)
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.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
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
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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. (pre-adopted from R4). URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType Binding: Interweave UkCore Care Service Type (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
active	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(CareConnect-Practitioner-1)	The practitioner that is able to provide the defined services for the organisation.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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(CareConnect-Organization-1)	The organization where the Practitioner performs the roles associated.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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 At End by value:coding.system Binding: Care Connect SDS Job Role Name (preferred)
code:sdsJobRoleName	Σ	0..1	CodeableConcept	Roles which this practitioner may perform Binding: Care Connect SDS Job Role Name (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: InterweaveUKCorePracticeSettingCode (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
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	Σ	0..*	Reference(CareConnect-Location-1)	The location(s) at which this practitioner provides care.
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
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	Σ	0..*	ContactPoint	Contact details that are specific to the role/location/service
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
PractitionerRole.meta.security	extensible	All Security Labels
PractitionerRole.meta.tag	example	Common Tags
PractitionerRole.meta.tag:Source	example	Common Tags
PractitionerRole.meta.tag:Provenance	example	Common Tags
PractitionerRole.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.identifier.use	required	IdentifierUse
PractitionerRole.identifier.type	extensible	Identifier Type Codes
PractitionerRole.code	preferred	Care Connect SDS Job Role Name
PractitionerRole.code:sdsJobRoleName	required	Care Connect SDS Job Role Name
PractitionerRole.specialty	preferred	InterweaveUKCorePracticeSettingCode
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must 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:

• https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4ServiceType

Slices

This structure defines the following Slices:

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