Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

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

Resource Profile: InterweaveSocialCareService

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

Interweave SocialCareService resource profile (modelled using FHIR EpisodeOfCare)- DRAFT.

Status: DRAFT: For Review

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:

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

  2. 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.

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

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from EpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare 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
.... id 0..0
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... version 0..0
...... code S 1..1 code The Data Provider Id of the system supplying the data
...... display S 1..1 string Name of the system supplying the data
..... tag:Provenance S 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... version 0..0
...... code S 1..1 code The ODS Code of the organisation responsible for the data
...... display S 1..1 string Name of the organisation supplying the data
... implicitRules 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... category S 1..1 CodeableConcept Social Care Service Category
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
.... triggeringAssessment 0..1 Reference(InterweaveSocialCareAssessment) Reference to an assessment which triggered the start of the service.
URL: https://fhir.interweavedigital.nhs.uk/R4/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.interweavedigital.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
..... assigner 0..1 Reference(InterweaveOrganization) Organization that issued id (may be just text)
... status S 1..1 code A mandatory flag to indicate the status of the service.
Binding: InterweaveSocialCareServiceStatus (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..0
.... extension 0..0
... type S 1..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: InterweaveSocialCareServiceType (required)
.... id 0..0
.... extension 0..0
.... coding
..... id 0..0
..... extension 0..0
..... 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
... managingOrganization S 1..1 Reference(InterweaveOrganization) The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
... period S 0..1 Period Interval during responsibility is assumed
.... id 0..0
.... extension 0..0
.... 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(ServiceRequest) An optional link to a Social Care Contact (ServiceRequest).
... careManager S 0..1 Reference(Practitioner | PractitionerRole) An optional link to a practitioner delivering the service.
... team 0..* Reference(CareTeam) DISCOURAGED - The care team resource is yet to be defined (see notes)
... account 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EpisodeOfCare.statusrequiredInterweaveSocialCareServiceStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceStatus
from this IG
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceType
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare 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..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


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


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


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


...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... category S 1..1 CodeableConcept Social Care Service Category
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
.... triggeringAssessment 0..1 Reference(InterweaveSocialCareAssessment) Reference to an assessment which triggered the start of the service.
URL: https://fhir.interweavedigital.nhs.uk/R4/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:localIdentifier 0..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.interweavedigital.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(InterweaveOrganization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code A mandatory flag to indicate the status of the service.
Binding: InterweaveSocialCareServiceStatus (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 even if unrecognized
.... 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)
.... extension 0..0
.... text SΣ 1..1 string Plain text representation of the concept
... patient Σ 1..1 Reference(Patient) The patient who is the focus of this episode of care
... managingOrganization SΣ 1..1 Reference(InterweaveOrganization) The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
... period SΣ 0..1 Period Interval during responsibility is assumed
.... extension 0..0
.... 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(ServiceRequest) An optional link to a Social Care Contact (ServiceRequest).
... careManager S 0..1 Reference(Practitioner | PractitionerRole) An optional link to a practitioner delivering the service.
... team 0..* Reference(CareTeam) DISCOURAGED - The care team resource is yet to be defined (see notes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
EpisodeOfCare.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.identifier:localIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.statusrequiredInterweaveSocialCareServiceStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceStatus
from this IG
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceType
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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 or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
dom-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare 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
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


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


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


...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... code SΣ 1..1 code The Data Provider Id of the system supplying the data
...... display SΣ 1..1 string Name of the system supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... tag:Provenance SΣ 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... category S 1..1 CodeableConcept Social Care Service Category
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
.... triggeringAssessment 0..1 Reference(InterweaveSocialCareAssessment) Reference to an assessment which triggered the start of the service.
URL: https://fhir.interweavedigital.nhs.uk/R4/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:localIdentifier 0..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.interweavedigital.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(InterweaveOrganization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code A mandatory flag to indicate the status of the service.
Binding: InterweaveSocialCareServiceStatus (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 even if unrecognized
.... 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)
.... extension 0..0
.... coding Σ 0..* Coding Code defined by a terminology system
..... extension 0..0
..... 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 Σ 1..1 Reference(Patient) The patient who is the focus of this episode of care
... managingOrganization SΣ 1..1 Reference(InterweaveOrganization) The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
... period SΣ 0..1 Period Interval during responsibility is assumed
.... extension 0..0
.... 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(ServiceRequest) An optional link to a Social Care Contact (ServiceRequest).
... careManager S 0..1 Reference(Practitioner | PractitionerRole) An optional link to a practitioner delivering the service.
... team 0..* Reference(CareTeam) DISCOURAGED - The care team resource is yet to be defined (see notes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
EpisodeOfCare.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.identifier:localIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.identifier:localIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
EpisodeOfCare.statusrequiredInterweaveSocialCareServiceStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceStatus
from this IG
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceType
from this IG
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
dom-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EpisodeOfCare

Summary

Mandatory: 5 elements(11 nested mandatory elements)
Must-Support: 22 elements
Fixed: 3 elements
Prohibited: 16 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from EpisodeOfCare

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare 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
.... id 0..0
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... version 0..0
...... code S 1..1 code The Data Provider Id of the system supplying the data
...... display S 1..1 string Name of the system supplying the data
..... tag:Provenance S 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... version 0..0
...... code S 1..1 code The ODS Code of the organisation responsible for the data
...... display S 1..1 string Name of the organisation supplying the data
... implicitRules 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... category S 1..1 CodeableConcept Social Care Service Category
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
.... triggeringAssessment 0..1 Reference(InterweaveSocialCareAssessment) Reference to an assessment which triggered the start of the service.
URL: https://fhir.interweavedigital.nhs.uk/R4/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.interweavedigital.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
..... assigner 0..1 Reference(InterweaveOrganization) Organization that issued id (may be just text)
... status S 1..1 code A mandatory flag to indicate the status of the service.
Binding: InterweaveSocialCareServiceStatus (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..0
.... extension 0..0
... type S 1..1 CodeableConcept Type/class - e.g. specialist referral, disease management
Binding: InterweaveSocialCareServiceType (required)
.... id 0..0
.... extension 0..0
.... coding
..... id 0..0
..... extension 0..0
..... 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
... managingOrganization S 1..1 Reference(InterweaveOrganization) The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
... period S 0..1 Period Interval during responsibility is assumed
.... id 0..0
.... extension 0..0
.... 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(ServiceRequest) An optional link to a Social Care Contact (ServiceRequest).
... careManager S 0..1 Reference(Practitioner | PractitionerRole) An optional link to a practitioner delivering the service.
... team 0..* Reference(CareTeam) DISCOURAGED - The care team resource is yet to be defined (see notes)
... account 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EpisodeOfCare.statusrequiredInterweaveSocialCareServiceStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceStatus
from this IG
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceType
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare 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..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


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


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


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


...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... category S 1..1 CodeableConcept Social Care Service Category
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
.... triggeringAssessment 0..1 Reference(InterweaveSocialCareAssessment) Reference to an assessment which triggered the start of the service.
URL: https://fhir.interweavedigital.nhs.uk/R4/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:localIdentifier 0..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.interweavedigital.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(InterweaveOrganization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code A mandatory flag to indicate the status of the service.
Binding: InterweaveSocialCareServiceStatus (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 even if unrecognized
.... 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)
.... extension 0..0
.... text SΣ 1..1 string Plain text representation of the concept
... patient Σ 1..1 Reference(Patient) The patient who is the focus of this episode of care
... managingOrganization SΣ 1..1 Reference(InterweaveOrganization) The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
... period SΣ 0..1 Period Interval during responsibility is assumed
.... extension 0..0
.... 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(ServiceRequest) An optional link to a Social Care Contact (ServiceRequest).
... careManager S 0..1 Reference(Practitioner | PractitionerRole) An optional link to a practitioner delivering the service.
... team 0..* Reference(CareTeam) DISCOURAGED - The care team resource is yet to be defined (see notes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
EpisodeOfCare.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.identifier:localIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.statusrequiredInterweaveSocialCareServiceStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceStatus
from this IG
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceType
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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 or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
dom-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EpisodeOfCare 0..* EpisodeOfCare 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
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


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


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


...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... code SΣ 1..1 code The Data Provider Id of the system supplying the data
...... display SΣ 1..1 string Name of the system supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... tag:Provenance SΣ 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... category S 1..1 CodeableConcept Social Care Service Category
URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
Binding: InterweaveSocialCareServiceCategory (required)
.... triggeringAssessment 0..1 Reference(InterweaveSocialCareAssessment) Reference to an assessment which triggered the start of the service.
URL: https://fhir.interweavedigital.nhs.uk/R4/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:localIdentifier 0..1 Identifier Business Identifier(s) relevant for this EpisodeOfCare
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.interweavedigital.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(InterweaveOrganization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code A mandatory flag to indicate the status of the service.
Binding: InterweaveSocialCareServiceStatus (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 even if unrecognized
.... 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)
.... extension 0..0
.... coding Σ 0..* Coding Code defined by a terminology system
..... extension 0..0
..... 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 Σ 1..1 Reference(Patient) The patient who is the focus of this episode of care
... managingOrganization SΣ 1..1 Reference(InterweaveOrganization) The organisation which is providing the service. This can be a reference to either and external provider or an organisational team.
... period SΣ 0..1 Period Interval during responsibility is assumed
.... extension 0..0
.... 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(ServiceRequest) An optional link to a Social Care Contact (ServiceRequest).
... careManager S 0..1 Reference(Practitioner | PractitionerRole) An optional link to a practitioner delivering the service.
... team 0..* Reference(CareTeam) DISCOURAGED - The care team resource is yet to be defined (see notes)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EpisodeOfCare.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
EpisodeOfCare.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
EpisodeOfCare.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
EpisodeOfCare.identifier:localIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
EpisodeOfCare.identifier:localIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
EpisodeOfCare.statusrequiredInterweaveSocialCareServiceStatus
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceStatus
from this IG
EpisodeOfCare.statusHistory.statusrequiredEpisodeOfCareStatus
http://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
from the FHIR Standard
EpisodeOfCare.typerequiredInterweaveSocialCareServiceType
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceType
from this IG
EpisodeOfCare.diagnosis.rolepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
dom-5errorEpisodeOfCareIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEpisodeOfCareA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EpisodeOfCare

Summary

Mandatory: 5 elements(11 nested mandatory elements)
Must-Support: 22 elements
Fixed: 3 elements
Prohibited: 16 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Differences between Interweave STU3 and R4 profiles

Element name Change type Old Value New Value
extension:category.url Fixed value https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceCategory https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareServiceCategory
extension:category.valueCodeableConcept Required valueSet binding https://fhir.yhcr.nhs.uk/ValueSet/Interweave-SocialCareServiceCategory-1 https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceCategory
extension:category.valueCodeableConcept codeSystem https://fhir.yhcr.nhs.uk/CodeSystem/Interweave-SocialCareServiceCategory-1 https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SocialCareServiceCategory
extension:triggeringAssessment.url Fixed value https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareServiceTrigger https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareServiceTrigger
identifier:localIdentifier.system Fixed value https://fhir.yhcr.nhs.uk/Id/local-socialcareservice-identifier https://fhir.interweavedigital.nhs.uk/Id/local-socialcareservice-identifier
status Required valueSet binding https://fhir.yhcr.nhs.uk/ValueSet/Interweave-SocialCareServiceStatus https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceStatus
type Required valueSet binding https://fhir.yhcr.nhs.uk/ValueSet/Interweave-SocialCareServiceType-1 https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareServiceType
type codeSystem https://fhir.yhcr.nhs.uk/CodeSystem/Interweave-SocialCareServiceType-1 https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SocialCareServiceType
referralRequest Type Reference: Target type change ReferralRequest ServiceRequest
careManager Type Reference: added Target type Practitioner Practitioner | PractitionerRole

Graphical relationship diagram

Graphical relationship diagram of social care service resource