Status: Active: Approved (STU)

Definition: A collection of activities which deliver support to a person funded by a Local Authority.

Introduction

This profile sets minimum expectations for the Social Care Service resource which is modelled using the FHIR Episode of Care resource. The FHIR Episode of Care resource was chosen to model a Service as it was the most akin in terms of logic and structure. Many of the irrelevant health fields have been stripped from this resource to create a clear and concise model for population. We will simply refer to this resource as a Service throughout the remainder of the notes section.

Coverage and references

• A Data Provider MUST offer FHIR resources that represent the Services provided to its service users. These may be either in-house services and/or services commissioned from external 3rd parties

• When referencing a Service from another resource, the provider must populate the reference.display with the value held in the Service type.display.

Mandatory fields

The following fields are mandatory:

• status It is envisaged that only the following values will be used to describe the status of a Social Care service and therefore we restrict the valueset to these values: active; planned; onhold; finished; entered-in-error

• type is used to house the ‘type’ of service. This should always be known, and vital for meaningful display purposes. We have defined a list of codes derived from the Service Component field of the Social Care Client Level Data V5 Specification. This list has been made extensible as it is foreseen that the list will grow. In addition to providing the ‘display’ field, the type.text must also be populated with the local description of the type of service being provided.

• category An extension has been created which allows for a high-level grouping of service types. This should always be known, and vital for meaningful display purposes. We have defined a list of codes derived from the Service Type field of the Social Care Client Level Data V5 Specification. This list has been made extensible as it is foreseen that this list will grow.

• patient The person who is in receipt of the service. NB: The term Patient and Person can be used interchangeably throughout the FHIR specification.

• managingOrganization The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.

Must Support fields

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

• statusHistory When the service has been through several status changes, it is important to populate this field to share this information.

• period The duration of the service as a whole, including the time when the service may have been in the planning and onhold statuses. Status history can be used to determine the amount of time that the service was in a particular status.

• careManager This field can be used to provide a link to the practitioner delivering the service. Many social care organisations are unable to currently provide this information, however, it is envisaged that this will be something which is available in the future and will be useful if known.

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. Optional fields to note include:

• identifier:localIdentifier - As with most other resources, there is the option to include a local identifier which may help to identify the record at a local level.

• referralRequest - An optional link to a Social Care Contact which is modelled using a referralRequest FHIR resource.

• triggeringAssessment An extension has been created which will allow an optional link to the assessment which triggered the service to be created. We make this optional, as not all services are triggered by an assessment.

Discouraged or Removed fields

• team This field is marked as DISCOURAGED. We have yet to define the careTeam resource which will represent all the individual workers, who may not work within the same Organisational Team or even Organisation, which are assigned to a person to aid in their support.

The following fields have been removed as they are not relevant to social care:

• diagnosis
• account

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

This structure is derived from CareConnect-EpisodeOfCare-1

Name	Flags	Card.	Type	Description & Constraints
EpisodeOfCare		0..*	CareConnect-EpisodeOfCare-1	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
category		1..1	CodeableConcept	Social Care Service Category URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory Binding: InterweaveSocialCareServiceCategory (required)
triggeringAssessment		0..1	Reference(CareConnect-Task-1)	Reference to an assessment which triggered the start of the service. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceTrigger
Slices for identifier		0..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:system
identifier:localIdentifier		0..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
system	S	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
value	S	1..1	string	The Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
period		0..0
status	S	1..1	code	A mandatory flag to indicate the status of the service. Binding: Interweave Social Care Service Status (required)
statusHistory	S	0..*	BackboneElement	Past list of status codes (the current status may be included to cover the start date of the status)
type	S	1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: InterweaveSocialCareServiceType (required)
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
text	S	1..1	string	Plain text representation of the concept
diagnosis		0..0
patient	S	1..1	Reference(CareConnectPatient1)	The patient who is the focus of this episode of care
managingOrganization	S	1..1	Reference(CareConnect-Organization-1)	The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
period
start	S	0..1	dateTime	The date/time when a service commences
end	S	0..1	dateTime	The date/time that a service ceases
referralRequest		0..*	Reference(CareConnect-ReferralRequest-1)	An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
careManager	S	0..1	Reference(CareConnect-Practitioner-1)	An optional link to a practitioner delivering the service.
team		0..*	Reference(CareConnect-CareTeam-1)	DISCOURAGED - The care team resource is yet to be defined (see notes)
account		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
EpisodeOfCare.status	required	Interweave Social Care Service Status
EpisodeOfCare.type	required	InterweaveSocialCareServiceType

Name	Flags	Card.	Type	Description & Constraints
EpisodeOfCare		0..*	CareConnect-EpisodeOfCare-1	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
category		1..1	CodeableConcept	Social Care Service Category URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory Binding: InterweaveSocialCareServiceCategory (required)
triggeringAssessment		0..1	Reference(CareConnect-Task-1)	Reference to an assessment which triggered the start of the service. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceTrigger
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		0..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
identifier:localIdentifier		0..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
value	SΣ	1..1	string	The Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
status	?!SΣ	1..1	code	A mandatory flag to indicate the status of the service. Binding: Interweave Social Care Service Status (required)
statusHistory	S	0..*	BackboneElement	Past list of status codes (the current status may be included to cover the start date of the status)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status		1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care.
period		1..1	Period	Duration the EpisodeOfCare was in the specified status
type	SΣ	1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: InterweaveSocialCareServiceType (required)
text	SΣ	1..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(CareConnectPatient1)	The patient who is the focus of this episode of care
managingOrganization	SΣ	1..1	Reference(CareConnect-Organization-1)	The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
period	Σ	0..1	Period	Interval during responsibility is assumed
start	SΣC	0..1	dateTime	The date/time when a service commences
end	SΣC	0..1	dateTime	The date/time that a service ceases
referralRequest		0..*	Reference(CareConnect-ReferralRequest-1)	An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
careManager	S	0..1	Reference(CareConnect-Practitioner-1)	An optional link to a practitioner delivering the service.
team		0..*	Reference(CareConnect-CareTeam-1)	DISCOURAGED - The care team resource is yet to be defined (see notes)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
EpisodeOfCare.meta.security	extensible	All Security Labels
EpisodeOfCare.meta.tag	example	Common Tags
EpisodeOfCare.meta.tag:Source	example	Common Tags
EpisodeOfCare.meta.tag:Provenance	example	Common Tags
EpisodeOfCare.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.identifier.use	required	IdentifierUse
EpisodeOfCare.identifier:localIdentifier.use	required	IdentifierUse
EpisodeOfCare.status	required	Interweave Social Care Service Status
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus
EpisodeOfCare.type	required	InterweaveSocialCareServiceType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	EpisodeOfCare	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	EpisodeOfCare	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	EpisodeOfCare	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	EpisodeOfCare	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
EpisodeOfCare		0..*	CareConnect-EpisodeOfCare-1	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
category		1..1	CodeableConcept	Social Care Service Category URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory Binding: InterweaveSocialCareServiceCategory (required)
triggeringAssessment		0..1	Reference(CareConnect-Task-1)	Reference to an assessment which triggered the start of the service. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceTrigger
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		0..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..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)
identifier:localIdentifier		0..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
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	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
value	SΣ	1..1	string	The Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	A mandatory flag to indicate the status of the service. Binding: Interweave Social Care Service Status (required)
statusHistory	S	0..*	BackboneElement	Past list of status codes (the current status may be included to cover the start date of the status)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status		1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care.
period		1..1	Period	Duration the EpisodeOfCare was in the specified status
type	SΣ	1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: InterweaveSocialCareServiceType (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	Σ	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	SΣ	1..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(CareConnectPatient1)	The patient who is the focus of this episode of care
managingOrganization	SΣ	1..1	Reference(CareConnect-Organization-1)	The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
period	Σ	0..1	Period	Interval during responsibility is assumed
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	0..1	dateTime	The date/time when a service commences
end	SΣC	0..1	dateTime	The date/time that a service ceases
referralRequest		0..*	Reference(CareConnect-ReferralRequest-1)	An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
careManager	S	0..1	Reference(CareConnect-Practitioner-1)	An optional link to a practitioner delivering the service.
team		0..*	Reference(CareConnect-CareTeam-1)	DISCOURAGED - The care team resource is yet to be defined (see notes)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
EpisodeOfCare.meta.security	extensible	All Security Labels
EpisodeOfCare.meta.tag	example	Common Tags
EpisodeOfCare.meta.tag:Source	example	Common Tags
EpisodeOfCare.meta.tag:Provenance	example	Common Tags
EpisodeOfCare.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.identifier.use	required	IdentifierUse
EpisodeOfCare.identifier.type	extensible	Identifier Type Codes
EpisodeOfCare.identifier:localIdentifier.use	required	IdentifierUse
EpisodeOfCare.identifier:localIdentifier.type	extensible	Identifier Type Codes
EpisodeOfCare.status	required	Interweave Social Care Service Status
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus
EpisodeOfCare.type	required	InterweaveSocialCareServiceType
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole

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-EpisodeOfCare-1

Name	Flags	Card.	Type	Description & Constraints
EpisodeOfCare		0..*	CareConnect-EpisodeOfCare-1	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
category		1..1	CodeableConcept	Social Care Service Category URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory Binding: InterweaveSocialCareServiceCategory (required)
triggeringAssessment		0..1	Reference(CareConnect-Task-1)	Reference to an assessment which triggered the start of the service. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceTrigger
Slices for identifier		0..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:system
identifier:localIdentifier		0..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
system	S	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
value	S	1..1	string	The Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
period		0..0
status	S	1..1	code	A mandatory flag to indicate the status of the service. Binding: Interweave Social Care Service Status (required)
statusHistory	S	0..*	BackboneElement	Past list of status codes (the current status may be included to cover the start date of the status)
type	S	1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: InterweaveSocialCareServiceType (required)
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
text	S	1..1	string	Plain text representation of the concept
diagnosis		0..0
patient	S	1..1	Reference(CareConnectPatient1)	The patient who is the focus of this episode of care
managingOrganization	S	1..1	Reference(CareConnect-Organization-1)	The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
period
start	S	0..1	dateTime	The date/time when a service commences
end	S	0..1	dateTime	The date/time that a service ceases
referralRequest		0..*	Reference(CareConnect-ReferralRequest-1)	An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
careManager	S	0..1	Reference(CareConnect-Practitioner-1)	An optional link to a practitioner delivering the service.
team		0..*	Reference(CareConnect-CareTeam-1)	DISCOURAGED - The care team resource is yet to be defined (see notes)
account		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
EpisodeOfCare.status	required	Interweave Social Care Service Status
EpisodeOfCare.type	required	InterweaveSocialCareServiceType

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
EpisodeOfCare		0..*	CareConnect-EpisodeOfCare-1	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
category		1..1	CodeableConcept	Social Care Service Category URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory Binding: InterweaveSocialCareServiceCategory (required)
triggeringAssessment		0..1	Reference(CareConnect-Task-1)	Reference to an assessment which triggered the start of the service. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceTrigger
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		0..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
identifier:localIdentifier		0..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
value	SΣ	1..1	string	The Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
status	?!SΣ	1..1	code	A mandatory flag to indicate the status of the service. Binding: Interweave Social Care Service Status (required)
statusHistory	S	0..*	BackboneElement	Past list of status codes (the current status may be included to cover the start date of the status)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status		1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care.
period		1..1	Period	Duration the EpisodeOfCare was in the specified status
type	SΣ	1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: InterweaveSocialCareServiceType (required)
text	SΣ	1..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(CareConnectPatient1)	The patient who is the focus of this episode of care
managingOrganization	SΣ	1..1	Reference(CareConnect-Organization-1)	The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
period	Σ	0..1	Period	Interval during responsibility is assumed
start	SΣC	0..1	dateTime	The date/time when a service commences
end	SΣC	0..1	dateTime	The date/time that a service ceases
referralRequest		0..*	Reference(CareConnect-ReferralRequest-1)	An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
careManager	S	0..1	Reference(CareConnect-Practitioner-1)	An optional link to a practitioner delivering the service.
team		0..*	Reference(CareConnect-CareTeam-1)	DISCOURAGED - The care team resource is yet to be defined (see notes)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
EpisodeOfCare.meta.security	extensible	All Security Labels
EpisodeOfCare.meta.tag	example	Common Tags
EpisodeOfCare.meta.tag:Source	example	Common Tags
EpisodeOfCare.meta.tag:Provenance	example	Common Tags
EpisodeOfCare.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.identifier.use	required	IdentifierUse
EpisodeOfCare.identifier:localIdentifier.use	required	IdentifierUse
EpisodeOfCare.status	required	Interweave Social Care Service Status
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus
EpisodeOfCare.type	required	InterweaveSocialCareServiceType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	EpisodeOfCare	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	EpisodeOfCare	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	EpisodeOfCare	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	EpisodeOfCare	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
EpisodeOfCare		0..*	CareConnect-EpisodeOfCare-1	An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
category		1..1	CodeableConcept	Social Care Service Category URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory Binding: InterweaveSocialCareServiceCategory (required)
triggeringAssessment		0..1	Reference(CareConnect-Task-1)	Reference to an assessment which triggered the start of the service. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceTrigger
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier		0..*	Identifier	Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..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)
identifier:localIdentifier		0..1	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
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	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
value	SΣ	1..1	string	The Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	A mandatory flag to indicate the status of the service. Binding: Interweave Social Care Service Status (required)
statusHistory	S	0..*	BackboneElement	Past list of status codes (the current status may be included to cover the start date of the status)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status		1..1	code	planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care.
period		1..1	Period	Duration the EpisodeOfCare was in the specified status
type	SΣ	1..1	CodeableConcept	Type/class - e.g. specialist referral, disease management Binding: InterweaveSocialCareServiceType (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	Σ	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	SΣ	1..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(CareConnectPatient1)	The patient who is the focus of this episode of care
managingOrganization	SΣ	1..1	Reference(CareConnect-Organization-1)	The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
period	Σ	0..1	Period	Interval during responsibility is assumed
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	0..1	dateTime	The date/time when a service commences
end	SΣC	0..1	dateTime	The date/time that a service ceases
referralRequest		0..*	Reference(CareConnect-ReferralRequest-1)	An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
careManager	S	0..1	Reference(CareConnect-Practitioner-1)	An optional link to a practitioner delivering the service.
team		0..*	Reference(CareConnect-CareTeam-1)	DISCOURAGED - The care team resource is yet to be defined (see notes)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
EpisodeOfCare.meta.security	extensible	All Security Labels
EpisodeOfCare.meta.tag	example	Common Tags
EpisodeOfCare.meta.tag:Source	example	Common Tags
EpisodeOfCare.meta.tag:Provenance	example	Common Tags
EpisodeOfCare.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
EpisodeOfCare.identifier.use	required	IdentifierUse
EpisodeOfCare.identifier.type	extensible	Identifier Type Codes
EpisodeOfCare.identifier:localIdentifier.use	required	IdentifierUse
EpisodeOfCare.identifier:localIdentifier.type	extensible	Identifier Type Codes
EpisodeOfCare.status	required	Interweave Social Care Service Status
EpisodeOfCare.statusHistory.status	required	EpisodeOfCareStatus
EpisodeOfCare.type	required	InterweaveSocialCareServiceType
EpisodeOfCare.diagnosis.role	preferred	DiagnosisRole

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-EpisodeOfCare-1

Summary

Mandatory: 5 elements (11 nested mandatory elements)
Must-Support: 21 elements
Fixed Value: 3 elements
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

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

Slices

This structure defines the following Slices:

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