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: InterweaveSocialCareService

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

Interweave Social Care Service resource profile (modelled using FHIR EpisodeOfCare)

  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

Usage:

Formal Views of Profile Content

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

This structure is derived from CareConnect-EpisodeOfCare-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*CareConnect-EpisodeOfCare-1An 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 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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... category 1..1CodeableConceptSocial Care Service Category
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
... triggeringAssessment 0..1Reference(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..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
..... value S1..1stringThe Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... status S1..1codeA mandatory flag to indicate the status of the service.
Binding: Interweave Social Care Service Status (required)
... statusHistory S0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
... type S1..1CodeableConceptType/class - e.g. specialist referral, disease management
Binding: InterweaveSocialCareServiceType (required)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S1..1stringPlain text representation of the concept
... diagnosis 0..0
... patient S1..1Reference(CareConnectPatient1)The patient who is the focus of this episode of care
... managingOrganization S1..1Reference(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 S0..1dateTimeThe date/time when a service commences
.... end S0..1dateTimeThe date/time that a service ceases
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
... careManager S0..1Reference(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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
EpisodeOfCare.statusrequiredInterweave Social Care Service Status
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*CareConnect-EpisodeOfCare-1An 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..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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... category 1..1CodeableConceptSocial Care Service Category
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
... triggeringAssessment 0..1Reference(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..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... identifier:localIdentifier 0..1IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
..... value SΣ1..1stringThe Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... status ?!SΣ1..1codeA mandatory flag to indicate the status of the service.
Binding: Interweave Social Care Service Status (required)
... statusHistory S0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period 1..1PeriodDuration the EpisodeOfCare was in the specified status
... type SΣ1..1CodeableConceptType/class - e.g. specialist referral, disease management
Binding: InterweaveSocialCareServiceType (required)
.... text SΣ1..1stringPlain text representation of the concept
... patient SΣ1..1Reference(CareConnectPatient1)The patient who is the focus of this episode of care
... managingOrganization SΣ1..1Reference(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..1PeriodInterval during responsibility is assumed
.... start SΣC0..1dateTimeThe date/time when a service commences
.... end SΣC0..1dateTimeThe date/time that a service ceases
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
... careManager S0..1Reference(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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EpisodeOfCare.meta.securityextensibleAll Security Labels
EpisodeOfCare.meta.tagexampleCommon Tags
EpisodeOfCare.meta.tag:SourceexampleCommon Tags
EpisodeOfCare.meta.tag:ProvenanceexampleCommon Tags
EpisodeOfCare.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
EpisodeOfCare.identifier.userequiredIdentifierUse
EpisodeOfCare.identifier:localIdentifier.userequiredIdentifierUse
EpisodeOfCare.statusrequiredInterweave Social Care Service Status
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf 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-4errorEpisodeOfCareIf 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
.. EpisodeOfCare 0..*CareConnect-EpisodeOfCare-1An 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..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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... category 1..1CodeableConceptSocial Care Service Category
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
... triggeringAssessment 0..1Reference(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..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..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)
.... identifier:localIdentifier 0..1IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
..... 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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
..... value SΣ1..1stringThe Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!SΣ1..1codeA mandatory flag to indicate the status of the service.
Binding: Interweave Social Care Service Status (required)
... statusHistory S0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period 1..1PeriodDuration the EpisodeOfCare was in the specified status
... type SΣ1..1CodeableConceptType/class - e.g. specialist referral, disease management
Binding: InterweaveSocialCareServiceType (required)
.... 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 SΣ1..1stringPlain text representation of the concept
... patient SΣ1..1Reference(CareConnectPatient1)The patient who is the focus of this episode of care
... managingOrganization SΣ1..1Reference(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..1PeriodInterval during responsibility is assumed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC0..1dateTimeThe date/time when a service commences
.... end SΣC0..1dateTimeThe date/time that a service ceases
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
... careManager S0..1Reference(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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EpisodeOfCare.meta.securityextensibleAll Security Labels
EpisodeOfCare.meta.tagexampleCommon Tags
EpisodeOfCare.meta.tag:SourceexampleCommon Tags
EpisodeOfCare.meta.tag:ProvenanceexampleCommon Tags
EpisodeOfCare.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
EpisodeOfCare.identifier.userequiredIdentifierUse
EpisodeOfCare.identifier.typeextensibleIdentifier Type Codes
EpisodeOfCare.identifier:localIdentifier.userequiredIdentifierUse
EpisodeOfCare.identifier:localIdentifier.typeextensibleIdentifier Type Codes
EpisodeOfCare.statusrequiredInterweave Social Care Service Status
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole

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-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:

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

Differential View

This structure is derived from CareConnect-EpisodeOfCare-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*CareConnect-EpisodeOfCare-1An 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 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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... category 1..1CodeableConceptSocial Care Service Category
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
... triggeringAssessment 0..1Reference(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..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
..... value S1..1stringThe Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... status S1..1codeA mandatory flag to indicate the status of the service.
Binding: Interweave Social Care Service Status (required)
... statusHistory S0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
... type S1..1CodeableConceptType/class - e.g. specialist referral, disease management
Binding: InterweaveSocialCareServiceType (required)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S1..1stringPlain text representation of the concept
... diagnosis 0..0
... patient S1..1Reference(CareConnectPatient1)The patient who is the focus of this episode of care
... managingOrganization S1..1Reference(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 S0..1dateTimeThe date/time when a service commences
.... end S0..1dateTimeThe date/time that a service ceases
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
... careManager S0..1Reference(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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
EpisodeOfCare.statusrequiredInterweave Social Care Service Status
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..*CareConnect-EpisodeOfCare-1An 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..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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... category 1..1CodeableConceptSocial Care Service Category
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
... triggeringAssessment 0..1Reference(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..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... identifier:localIdentifier 0..1IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
..... value SΣ1..1stringThe Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... status ?!SΣ1..1codeA mandatory flag to indicate the status of the service.
Binding: Interweave Social Care Service Status (required)
... statusHistory S0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period 1..1PeriodDuration the EpisodeOfCare was in the specified status
... type SΣ1..1CodeableConceptType/class - e.g. specialist referral, disease management
Binding: InterweaveSocialCareServiceType (required)
.... text SΣ1..1stringPlain text representation of the concept
... patient SΣ1..1Reference(CareConnectPatient1)The patient who is the focus of this episode of care
... managingOrganization SΣ1..1Reference(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..1PeriodInterval during responsibility is assumed
.... start SΣC0..1dateTimeThe date/time when a service commences
.... end SΣC0..1dateTimeThe date/time that a service ceases
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
... careManager S0..1Reference(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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EpisodeOfCare.meta.securityextensibleAll Security Labels
EpisodeOfCare.meta.tagexampleCommon Tags
EpisodeOfCare.meta.tag:SourceexampleCommon Tags
EpisodeOfCare.meta.tag:ProvenanceexampleCommon Tags
EpisodeOfCare.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
EpisodeOfCare.identifier.userequiredIdentifierUse
EpisodeOfCare.identifier:localIdentifier.userequiredIdentifierUse
EpisodeOfCare.statusrequiredInterweave Social Care Service Status
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorEpisodeOfCareIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEpisodeOfCareIf 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-4errorEpisodeOfCareIf 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
.. EpisodeOfCare 0..*CareConnect-EpisodeOfCare-1An 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..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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... category 1..1CodeableConceptSocial Care Service Category
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
... triggeringAssessment 0..1Reference(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..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..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)
.... identifier:localIdentifier 0..1IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
..... 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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier
..... value SΣ1..1stringThe Local socialcareservice Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!SΣ1..1codeA mandatory flag to indicate the status of the service.
Binding: Interweave Social Care Service Status (required)
... statusHistory S0..*BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
Binding: EpisodeOfCareStatus (required): The status of the episode of care.

.... period 1..1PeriodDuration the EpisodeOfCare was in the specified status
... type SΣ1..1CodeableConceptType/class - e.g. specialist referral, disease management
Binding: InterweaveSocialCareServiceType (required)
.... 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 SΣ1..1stringPlain text representation of the concept
... patient SΣ1..1Reference(CareConnectPatient1)The patient who is the focus of this episode of care
... managingOrganization SΣ1..1Reference(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..1PeriodInterval during responsibility is assumed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC0..1dateTimeThe date/time when a service commences
.... end SΣC0..1dateTimeThe date/time that a service ceases
... referralRequest 0..*Reference(CareConnect-ReferralRequest-1)An optional link to a Social Care Contact (FHIR STU3 ReferralRequest).
... careManager S0..1Reference(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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EpisodeOfCare.meta.securityextensibleAll Security Labels
EpisodeOfCare.meta.tagexampleCommon Tags
EpisodeOfCare.meta.tag:SourceexampleCommon Tags
EpisodeOfCare.meta.tag:ProvenanceexampleCommon Tags
EpisodeOfCare.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
EpisodeOfCare.identifier.userequiredIdentifierUse
EpisodeOfCare.identifier.typeextensibleIdentifier Type Codes
EpisodeOfCare.identifier:localIdentifier.userequiredIdentifierUse
EpisodeOfCare.identifier:localIdentifier.typeextensibleIdentifier Type Codes
EpisodeOfCare.statusrequiredInterweave Social Care Service Status
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole

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-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:

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

 

Other representations of profile: CSV, Excel, Schematron