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

Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-SocialCareSupportReason Version: 0.1.0
Draft as of 2022-08-19 Computable Name: InterweaveSocialCareSupportReason

Interweave Social Care Support Reason resource profile (modelled using FHIR Condition) - DRAFT

  Status: DRAFT: Work in Progress

Definition: A reason why a person is receiving support.

Introduction

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

Coverage and references

  • A Data Provider MUST offer FHIR resources to represent its own service users’ support reasons.
  • If the value held in the primarySupportReasonFlag changes, this should end date the current support reason and create a new record.
  • When referencing a Support Reason from another resource, the provider must populate the reference.display with the value held in the Support Reason code.display.

Support Reason Period

The Support Reason Period is the duration where support is given for the specified reason. The Condition resource offered two date fields which seemed to be suitable candidates for holding this data these being ‘onset’ and ‘abatement’. However, the description of these fields, and rules which needed to be applied during their usage in order to be FHIR compliant, made using them unnecessarily complicated. Therefore, we have chosen to remove both date fields, and create our own extension, SupportReasonPeriod, to house this data.

Mandatory fields

The following fields are mandatory:

  • clinicalStatus A mandatory flag to indicate whether the support reason is active or not. We limit the valueset to the following values; active inactive

  • category this provides a level of categorisation i.e. Physical Support, Sensory Support etc. We extend the care connect valueset to include a defined a list of codes derived from the Social Care Client Level Data V5 Specification. The care connect values are not applicable for social care purposes and should be ignored. Unfortunately we are unable to remove them from the valueset, as the care connect profile marks it as extensible.

  • code code is used to house the ‘type’ of support reason. This should always be known, and vital for meaningful display purposes. We have defined a list of codes derived from the Social Care Client Level Data V5 Specification.

  • subject.patient The person which is the subject of the support reason.

  • supportReasonPeriod.start The date that the person started to receive support for this support reason.

Must Support fields

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

  • supportReasonPeriod.end Should be populated with the date that the person stopped receiving support for this reason.

  • primarySupportReason This is an extension required by social care to specify whether this is the person’s primary reason for support. It is simple true/false field and should be offered where 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:

  • note use note to enter further detail on the support reason.

  • assertedDate The date that the support reason was recognised/diagnosed.

    Discouraged or Removed fields

  • context - This field is deprecated in R4 and has been removed from our specification.
  • abatement and onSet - Removed to avoid confusion when supplying the Support Reason Period (See mandatory notes section above).
  • code(SNOMEDCT) - This slice created by Care Connect has been removed to avoid confusion with the list of support reason types generated by the Social Care Data Standards working group.
  • ConditionEpisode-1 A Care connect extension which is not relevant here.

The following fields have been removed as they capture Health Care related data which is not relevant in Social Care:

  • severity
  • bodySite
  • stage
  • evidence

Usage:

Formal Views of Profile Content

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

This structure is derived from CareConnect-Condition-1

Summary

Mandatory: 7 elements (9 nested mandatory elements)
Must-Support: 18 elements
Fixed Value: 3 elements
Prohibited: 10 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 Condition.meta.tag is sliced based on the value of value:system
  • The element Condition.identifier is sliced based on the value of value:system

This structure is derived from CareConnect-Condition-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..*CareConnect-Condition-1Detailed information about conditions, problems or diagnoses
... 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
... extension 1..*ExtensionExtension
... extension:episodisity 0..0
... Extension-Interweave-SocialCarePrimarySupportReason S0..1booleanFlag to indicate whether this is the primary support reason
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason
... Extension-Interweave-SocialCareSupportReasonPeriod S1..1PeriodThe period during which the person received support for this support reason.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod
... Slices for identifier 0..*IdentifierExternal Ids for this condition
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierExternal Ids for this condition
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcaresupportreasoncondition-identifier
..... value S1..1stringThe Local socialcaresupportreasoncondition Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... clinicalStatus S1..1codeA mandatory flag to indicate whether the support reason is active or not. Valueset restricted to active and inactive only.
Binding: Interweave Social Care Support Reason Clinical Status (required)
... category S1..1CodeableConceptA categorisation of the reason why a person is receiving support.
Binding: Interweave Social Care Support Reason Category (required)
... severity 0..0
... code S1..1CodeableConceptThe type of support reason.
Binding: Interweave Social Care Support Reason (required)
.... coding 0..*CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... coding:snomedCT 0..0
... bodySite 0..0
... subject S1..1Reference(CareConnect-Patient-1)The person which is subject of the support reason.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... context 0..0
... onset[x] 0..0
... abatement[x] 0..0
... assertedDate 0..1dateTimeOptionally supply the date that the support reason was recognised/diagnosed.
... asserter 0..1Reference(CareConnect-Practitioner-1)Optionally provide the practitioner who asserted the support reason
... stage 0..0
... evidence 0..0
... note 0..*AnnotationCan be used to provide further describe the support reason

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition I0..*CareConnect-Condition-1Detailed information about conditions, problems or diagnoses
... 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
... Extension-Interweave-SocialCarePrimarySupportReason S0..1booleanFlag to indicate whether this is the primary support reason
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason
... Extension-Interweave-SocialCareSupportReasonPeriod S1..1PeriodThe period during which the person received support for this support reason.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this condition
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 Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:localIdentifier Σ0..1IdentifierExternal Ids for this condition
..... 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-socialcaresupportreasoncondition-identifier
..... value SΣ1..1stringThe Local socialcaresupportreasoncondition 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)
... clinicalStatus ?!SΣI1..1codeA mandatory flag to indicate whether the support reason is active or not. Valueset restricted to active and inactive only.
Binding: Interweave Social Care Support Reason Clinical Status (required)
... category S1..1CodeableConceptA categorisation of the reason why a person is receiving support.
Binding: Interweave Social Care Support Reason Category (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 Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptThe type of support reason.
Binding: Interweave Social Care Support Reason (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding: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
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(CareConnect-Patient-1)The person which is subject of the support reason.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... assertedDate Σ0..1dateTimeOptionally supply the date that the support reason was recognised/diagnosed.
... asserter Σ0..1Reference(CareConnect-Practitioner-1)Optionally provide the practitioner who asserted the support reason
... note 0..*AnnotationCan be used to provide further describe the support reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(RelatedPerson | CareConnect-Practitioner-1 | CareConnect-Patient-1)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition I0..*CareConnect-Condition-1Detailed information about conditions, problems or diagnoses
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile Σ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... tag:Source Σ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"


..... code Σ1..1codeThe Data Provider Id of the system supplying the data
..... display Σ1..1stringName of the system supplying the data
.... tag:Provenance Σ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"


..... code Σ1..1codeThe ODS Code of the organisation responsible for the data
..... display Σ1..1stringName of the organisation supplying the data
... Extension-Interweave-SocialCarePrimarySupportReason 0..1booleanFlag to indicate whether this is the primary support reason
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason
... identifier:localIdentifier Σ0..1IdentifierExternal Ids for this condition
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcaresupportreasoncondition-identifier
.... value Σ1..1stringThe Local socialcaresupportreasoncondition Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
... clinicalStatus ?!ΣI1..1codeA mandatory flag to indicate whether the support reason is active or not. Valueset restricted to active and inactive only.
Binding: Interweave Social Care Support Reason Clinical Status (required)
... category 1..1CodeableConceptA categorisation of the reason why a person is receiving support.
Binding: Interweave Social Care Support Reason Category (required)
... code Σ1..1CodeableConceptThe type of support reason.
Binding: Interweave Social Care Support Reason (required)
... subject Σ1..1Reference(CareConnect-Patient-1)The person which is subject of the support reason.

doco Documentation for this format

This structure is derived from CareConnect-Condition-1

Summary

Mandatory: 7 elements (9 nested mandatory elements)
Must-Support: 18 elements
Fixed Value: 3 elements
Prohibited: 10 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 Condition.meta.tag is sliced based on the value of value:system
  • The element Condition.identifier is sliced based on the value of value:system

Differential View

This structure is derived from CareConnect-Condition-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..*CareConnect-Condition-1Detailed information about conditions, problems or diagnoses
... 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
... extension 1..*ExtensionExtension
... extension:episodisity 0..0
... Extension-Interweave-SocialCarePrimarySupportReason S0..1booleanFlag to indicate whether this is the primary support reason
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason
... Extension-Interweave-SocialCareSupportReasonPeriod S1..1PeriodThe period during which the person received support for this support reason.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod
... Slices for identifier 0..*IdentifierExternal Ids for this condition
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierExternal Ids for this condition
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcaresupportreasoncondition-identifier
..... value S1..1stringThe Local socialcaresupportreasoncondition Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... clinicalStatus S1..1codeA mandatory flag to indicate whether the support reason is active or not. Valueset restricted to active and inactive only.
Binding: Interweave Social Care Support Reason Clinical Status (required)
... category S1..1CodeableConceptA categorisation of the reason why a person is receiving support.
Binding: Interweave Social Care Support Reason Category (required)
... severity 0..0
... code S1..1CodeableConceptThe type of support reason.
Binding: Interweave Social Care Support Reason (required)
.... coding 0..*CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... coding:snomedCT 0..0
... bodySite 0..0
... subject S1..1Reference(CareConnect-Patient-1)The person which is subject of the support reason.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... context 0..0
... onset[x] 0..0
... abatement[x] 0..0
... assertedDate 0..1dateTimeOptionally supply the date that the support reason was recognised/diagnosed.
... asserter 0..1Reference(CareConnect-Practitioner-1)Optionally provide the practitioner who asserted the support reason
... stage 0..0
... evidence 0..0
... note 0..*AnnotationCan be used to provide further describe the support reason

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition I0..*CareConnect-Condition-1Detailed information about conditions, problems or diagnoses
... 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
... Extension-Interweave-SocialCarePrimarySupportReason S0..1booleanFlag to indicate whether this is the primary support reason
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason
... Extension-Interweave-SocialCareSupportReasonPeriod S1..1PeriodThe period during which the person received support for this support reason.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this condition
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 Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:localIdentifier Σ0..1IdentifierExternal Ids for this condition
..... 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-socialcaresupportreasoncondition-identifier
..... value SΣ1..1stringThe Local socialcaresupportreasoncondition 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)
... clinicalStatus ?!SΣI1..1codeA mandatory flag to indicate whether the support reason is active or not. Valueset restricted to active and inactive only.
Binding: Interweave Social Care Support Reason Clinical Status (required)
... category S1..1CodeableConceptA categorisation of the reason why a person is receiving support.
Binding: Interweave Social Care Support Reason Category (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 Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptThe type of support reason.
Binding: Interweave Social Care Support Reason (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding: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
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(CareConnect-Patient-1)The person which is subject of the support reason.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... assertedDate Σ0..1dateTimeOptionally supply the date that the support reason was recognised/diagnosed.
... asserter Σ0..1Reference(CareConnect-Practitioner-1)Optionally provide the practitioner who asserted the support reason
... note 0..*AnnotationCan be used to provide further describe the support reason
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(RelatedPerson | CareConnect-Practitioner-1 | CareConnect-Patient-1)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Condition.meta.securityextensibleAll Security Labels
Condition.meta.tagexampleCommon Tags
Condition.meta.tag:SourceexampleCommon Tags
Condition.meta.tag:ProvenanceexampleCommon Tags
Condition.languageextensibleCommon Languages
Max Binding: All Languages
Condition.identifier.userequiredIdentifierUse
Condition.identifier.typeextensibleIdentifier Type Codes
Condition.identifier:localIdentifier.userequiredIdentifierUse
Condition.identifier:localIdentifier.typeextensibleIdentifier Type Codes
Condition.clinicalStatusrequiredInterweave Social Care Support Reason Clinical Status
Condition.categoryrequiredInterweave Social Care Support Reason Category
Condition.coderequiredInterweave Social Care Support Reason
Condition.bodySite.coding:snomedCTrequiredCare Connect Body Site
Condition.stage.summaryexampleCondition Stage
Condition.evidence.codeexampleManifestation and Symptom Codes

Constraints

IdGradePathDetailsRequirements
dom-2errorConditionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1errorConditionIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4errorConditionIf 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-3errorConditionIf 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()
con-4errorConditionIf condition is abated, then clinicalStatus must be either inactive, resolved, or remission
: abatement.empty() or (abatement as boolean).not() or clinicalStatus='resolved' or clinicalStatus='remission' or clinicalStatus='inactive'
con-3errorConditionCondition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error
: verificationStatus='entered-in-error' or clinicalStatus.exists()