Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
Official URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-SocialCareSupportReason | Version: 0.0.1 | |||
Draft as of 2024-07-15 | Computable Name: InterweaveSocialCareSupportReason |
Interweave SocialCare Support Reason resource profile (modelled using UK Core Condition) - DRAFT.
Status: DRAFT: For Review
Definition: A reason why a person is receiving support.
This profile sets minimum expectations for the Social Care Support Reason resource which is modelled using the UK Core 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.
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.
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 - The person which is the subject of the support reason.
In addition, the following fields are "Must Support" - i.e. they must be populated if relevant and known:
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.
recordedDate - The date that the support reason was recognised/diagnosed.
asserter - Optionally provide the practitioner who asserted the support reason.
abatement and onSet - Removed to avoid confusion when supplying the Support Reason Period (See mandatory notes section above).
ConditionEpisode - An 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:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UKCoreCondition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | 0..* | UKCoreCondition | Detailed information about conditions, problems or diagnoses | |
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 | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
extension:conditionEpisode | 0..0 | |||
Slices for extension | Content/Rules for all slices | |||
primarySupportReason | S | 0..1 | boolean | Flag to indicate whether this is the primary support reason URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason |
Slices for extension | Content/Rules for all slices | |||
supportReasonPeriod | S | 1..1 | Period | The period during which the person received support for this support reason. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod |
Slices for identifier | 0..* | Identifier | External Ids for this condition Slice: Unordered, Open by value:system | |
identifier:localIdentifier | 0..1 | Identifier | External Ids for this condition | |
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcaresupportreason-identifier |
value | S | 1..1 | string | The Local socialcaresupportreason 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) | |
clinicalStatus | 1..1 | CodeableConcept | A mandatory flag to indicate whether the support reason is active or not. Valueset restricted to active and inactive only. Binding: InterweaveSocialCareSupportReasonClinicalStatus (required) | |
verificationStatus | 0..0 | |||
category | S | 1..1 | CodeableConcept | A categorisation of the reason why a person is receiving support. Binding: InterweaveSocialCareSupportReasonCategory (required) |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
severity | 0..0 | |||
code | 1..1 | CodeableConcept | The type of support reason. Binding: InterweaveSocialCareSupportReason (required) | |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
bodySite | 0..0 | |||
subject | 1..1 | Reference(InterweavePatient) | The person which is subject of the support reason. | |
reference | 1..1 | string | Reference to a resource (could be Contained) | |
identifier | 0..1 | Identifier | If relevant could include an id | |
display | 1..1 | string | Description of the referenced resource | |
encounter | 0..0 | |||
onset[x] | 0..0 | |||
abatement[x] | 0..0 | |||
recordedDate | 0..1 | dateTime | Optionally supply the date that the support reason was recognised/diagnosed. | |
recorder | 0..0 | |||
asserter | 0..1 | Reference(InterweavePractitioner) | Optionally provide the practitioner who asserted the support reason | |
stage | 0..0 | |||
evidence | 0..0 | |||
note | 0..* | Annotation | Can be used to provide further describe the support reason | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.clinicalStatus | required | InterweaveSocialCareSupportReasonClinicalStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonClinicalStatus from this IG | |
Condition.category | required | InterweaveSocialCareSupportReasonCategoryhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonCategory from this IG | |
Condition.code | required | InterweaveSocialCareSupportReasonhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReason from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | UKCoreCondition | Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
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 | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
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 | |||||
primarySupportReason | S | 0..1 | boolean | Flag to indicate whether this is the primary support reason URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason | ||||
supportReasonPeriod | S | 1..1 | Period | The period during which the person received support for this support reason. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | External Ids for this condition Slice: Unordered, Open by value:system | ||||
identifier:localIdentifier | Σ | 0..1 | Identifier | External Ids for this condition | ||||
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-socialcaresupportreason-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcaresupportreason 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) | ||||
clinicalStatus | ?!SΣC | 1..1 | CodeableConcept | A mandatory flag to indicate whether the support reason is active or not. Valueset restricted to active and inactive only. Binding: InterweaveSocialCareSupportReasonClinicalStatus (required) | ||||
category | S | 1..1 | CodeableConcept | A categorisation of the reason why a person is receiving support. Binding: InterweaveSocialCareSupportReasonCategory (required) | ||||
code | SΣ | 1..1 | CodeableConcept | The type of support reason. Binding: InterweaveSocialCareSupportReason (required) | ||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | The person which is subject of the support reason. | ||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
recordedDate | Σ | 0..1 | dateTime | Optionally supply the date that the support reason was recognised/diagnosed. | ||||
asserter | Σ | 0..1 | Reference(InterweavePractitioner) | Optionally provide the practitioner who asserted the support reason | ||||
note | 0..* | Annotation | Can be used to provide further describe the support reason | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Condition.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Condition.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Condition.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Condition.clinicalStatus | required | InterweaveSocialCareSupportReasonClinicalStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonClinicalStatus from this IG | ||||
Condition.category | required | InterweaveSocialCareSupportReasonCategoryhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonCategory from this IG | ||||
Condition.code | required | InterweaveSocialCareSupportReasonhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReason from this IG |
Id | Grade | Path(s) | Details | Requirements |
con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Condition | If 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-4 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | UKCoreCondition | Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
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 | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
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 | |||||
primarySupportReason | S | 0..1 | boolean | Flag to indicate whether this is the primary support reason URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason | ||||
supportReasonPeriod | S | 1..1 | Period | The period during which the person received support for this support reason. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | External Ids for this condition Slice: Unordered, Open by value:system | ||||
identifier:localIdentifier | Σ | 0..1 | Identifier | External Ids for this condition | ||||
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-socialcaresupportreason-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcaresupportreason 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) | ||||
clinicalStatus | ?!SΣC | 1..1 | CodeableConcept | A mandatory flag to indicate whether the support reason is active or not. Valueset restricted to active and inactive only. Binding: InterweaveSocialCareSupportReasonClinicalStatus (required) | ||||
category | S | 1..1 | CodeableConcept | A categorisation of the reason why a person is receiving support. Binding: InterweaveSocialCareSupportReasonCategory (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
code | SΣ | 1..1 | CodeableConcept | The type of support reason. Binding: InterweaveSocialCareSupportReason (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | The person which is subject of the support reason. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
recordedDate | Σ | 0..1 | dateTime | Optionally supply the date that the support reason was recognised/diagnosed. | ||||
asserter | Σ | 0..1 | Reference(InterweavePractitioner) | Optionally provide the practitioner who asserted the support reason | ||||
note | 0..* | Annotation | Can be used to provide further describe the support reason | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Condition.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Condition.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Condition.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Condition.identifier:localIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Condition.clinicalStatus | required | InterweaveSocialCareSupportReasonClinicalStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonClinicalStatus from this IG | ||||
Condition.category | required | InterweaveSocialCareSupportReasonCategoryhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonCategory from this IG | ||||
Condition.code | required | InterweaveSocialCareSupportReasonhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReason from this IG | ||||
Condition.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Condition.stage.summary | example | ConditionStagehttp://hl7.org/fhir/ValueSet/condition-stage from the FHIR Standard | ||||
Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard | ||||
Condition.evidence.code | example | ManifestationAndSymptomCodeshttp://hl7.org/fhir/ValueSet/manifestation-or-symptom from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Condition | If 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-4 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from UKCoreCondition
Summary
Mandatory: 7 elements(14 nested mandatory elements)
Must-Support: 15 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:
Differential View
This structure is derived from UKCoreCondition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Condition | 0..* | UKCoreCondition | Detailed information about conditions, problems or diagnoses | |
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 | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
extension:conditionEpisode | 0..0 | |||
Slices for extension | Content/Rules for all slices | |||
primarySupportReason | S | 0..1 | boolean | Flag to indicate whether this is the primary support reason URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason |
Slices for extension | Content/Rules for all slices | |||
supportReasonPeriod | S | 1..1 | Period | The period during which the person received support for this support reason. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod |
Slices for identifier | 0..* | Identifier | External Ids for this condition Slice: Unordered, Open by value:system | |
identifier:localIdentifier | 0..1 | Identifier | External Ids for this condition | |
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcaresupportreason-identifier |
value | S | 1..1 | string | The Local socialcaresupportreason 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) | |
clinicalStatus | 1..1 | CodeableConcept | A mandatory flag to indicate whether the support reason is active or not. Valueset restricted to active and inactive only. Binding: InterweaveSocialCareSupportReasonClinicalStatus (required) | |
verificationStatus | 0..0 | |||
category | S | 1..1 | CodeableConcept | A categorisation of the reason why a person is receiving support. Binding: InterweaveSocialCareSupportReasonCategory (required) |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
severity | 0..0 | |||
code | 1..1 | CodeableConcept | The type of support reason. Binding: InterweaveSocialCareSupportReason (required) | |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
bodySite | 0..0 | |||
subject | 1..1 | Reference(InterweavePatient) | The person which is subject of the support reason. | |
reference | 1..1 | string | Reference to a resource (could be Contained) | |
identifier | 0..1 | Identifier | If relevant could include an id | |
display | 1..1 | string | Description of the referenced resource | |
encounter | 0..0 | |||
onset[x] | 0..0 | |||
abatement[x] | 0..0 | |||
recordedDate | 0..1 | dateTime | Optionally supply the date that the support reason was recognised/diagnosed. | |
recorder | 0..0 | |||
asserter | 0..1 | Reference(InterweavePractitioner) | Optionally provide the practitioner who asserted the support reason | |
stage | 0..0 | |||
evidence | 0..0 | |||
note | 0..* | Annotation | Can be used to provide further describe the support reason | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Condition.clinicalStatus | required | InterweaveSocialCareSupportReasonClinicalStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonClinicalStatus from this IG | |
Condition.category | required | InterweaveSocialCareSupportReasonCategoryhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonCategory from this IG | |
Condition.code | required | InterweaveSocialCareSupportReasonhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReason from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | UKCoreCondition | Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
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 | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
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 | |||||
primarySupportReason | S | 0..1 | boolean | Flag to indicate whether this is the primary support reason URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason | ||||
supportReasonPeriod | S | 1..1 | Period | The period during which the person received support for this support reason. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | External Ids for this condition Slice: Unordered, Open by value:system | ||||
identifier:localIdentifier | Σ | 0..1 | Identifier | External Ids for this condition | ||||
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-socialcaresupportreason-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcaresupportreason 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) | ||||
clinicalStatus | ?!SΣC | 1..1 | CodeableConcept | A mandatory flag to indicate whether the support reason is active or not. Valueset restricted to active and inactive only. Binding: InterweaveSocialCareSupportReasonClinicalStatus (required) | ||||
category | S | 1..1 | CodeableConcept | A categorisation of the reason why a person is receiving support. Binding: InterweaveSocialCareSupportReasonCategory (required) | ||||
code | SΣ | 1..1 | CodeableConcept | The type of support reason. Binding: InterweaveSocialCareSupportReason (required) | ||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | The person which is subject of the support reason. | ||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
recordedDate | Σ | 0..1 | dateTime | Optionally supply the date that the support reason was recognised/diagnosed. | ||||
asserter | Σ | 0..1 | Reference(InterweavePractitioner) | Optionally provide the practitioner who asserted the support reason | ||||
note | 0..* | Annotation | Can be used to provide further describe the support reason | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Condition.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Condition.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Condition.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Condition.clinicalStatus | required | InterweaveSocialCareSupportReasonClinicalStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonClinicalStatus from this IG | ||||
Condition.category | required | InterweaveSocialCareSupportReasonCategoryhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonCategory from this IG | ||||
Condition.code | required | InterweaveSocialCareSupportReasonhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReason from this IG |
Id | Grade | Path(s) | Details | Requirements |
con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Condition | If 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-4 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Condition | C | 0..* | UKCoreCondition | Detailed information about conditions, problems or diagnoses con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error | ||||
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 | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
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 | |||||
primarySupportReason | S | 0..1 | boolean | Flag to indicate whether this is the primary support reason URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason | ||||
supportReasonPeriod | S | 1..1 | Period | The period during which the person received support for this support reason. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | External Ids for this condition Slice: Unordered, Open by value:system | ||||
identifier:localIdentifier | Σ | 0..1 | Identifier | External Ids for this condition | ||||
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-socialcaresupportreason-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcaresupportreason 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) | ||||
clinicalStatus | ?!SΣC | 1..1 | CodeableConcept | A mandatory flag to indicate whether the support reason is active or not. Valueset restricted to active and inactive only. Binding: InterweaveSocialCareSupportReasonClinicalStatus (required) | ||||
category | S | 1..1 | CodeableConcept | A categorisation of the reason why a person is receiving support. Binding: InterweaveSocialCareSupportReasonCategory (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
code | SΣ | 1..1 | CodeableConcept | The type of support reason. Binding: InterweaveSocialCareSupportReason (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | The person which is subject of the support reason. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
recordedDate | Σ | 0..1 | dateTime | Optionally supply the date that the support reason was recognised/diagnosed. | ||||
asserter | Σ | 0..1 | Reference(InterweavePractitioner) | Optionally provide the practitioner who asserted the support reason | ||||
note | 0..* | Annotation | Can be used to provide further describe the support reason | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Condition.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Condition.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Condition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Condition.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Condition.identifier:localIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Condition.clinicalStatus | required | InterweaveSocialCareSupportReasonClinicalStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonClinicalStatus from this IG | ||||
Condition.category | required | InterweaveSocialCareSupportReasonCategoryhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonCategory from this IG | ||||
Condition.code | required | InterweaveSocialCareSupportReasonhttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReason from this IG | ||||
Condition.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Condition.stage.summary | example | ConditionStagehttp://hl7.org/fhir/ValueSet/condition-stage from the FHIR Standard | ||||
Condition.stage.type | example | ConditionStageTypehttp://hl7.org/fhir/ValueSet/condition-stage-type from the FHIR Standard | ||||
Condition.evidence.code | example | ManifestationAndSymptomCodeshttp://hl7.org/fhir/ValueSet/manifestation-or-symptom from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
con-3 | best practice | Condition | Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item : clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty() | |
con-4 | error | Condition | If condition is abated, then clinicalStatus must be either inactive, resolved, or remission : abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() | |
con-5 | error | Condition | Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | Condition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Condition | If 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-4 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Condition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Condition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from UKCoreCondition
Summary
Mandatory: 7 elements(14 nested mandatory elements)
Must-Support: 15 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:
Other representations of profile: CSV, Excel, Schematron
Element name | Change type | Old Value | New Value |
---|---|---|---|
extension:primarySupportReason.url | Fixed value | https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason | https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod |
extension:supportReasonPeriod.url | Fixed value | https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportReasonPeriod | https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCarePrimarySupportReason |
identifier:localIdentifier.system | Fixed value | https://fhir.yhcr.nhs.uk/Id/local-socialcaresupportreason-identifier | https://fhir.interweavedigital.nhs.uk/Id/local-socialcaresupportreason-identifier |
clinicalStatus | Required valueSet binding | https://fhir.yhcr.nhs.uk/ValueSet/Interweave-SocialCareSupportReasonClinicalStatus | https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonClinicalStatus |
clinicalStatus | codeSystem | http://hl7.org/fhir/condition-clinical | http://terminology.hl7.org/CodeSystem/condition-clinical |
category | Required valueSet binding | https://fhir.yhcr.nhs.uk/ValueSet/Interweave-InterweaveSocialCareSupportReasonCategory-1 | https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReasonCategory |
category | codeSystem | https://fhir.yhcr.nhs.uk/CodeSystem/Interweave-SocialCareSupportReasonCategory-1 | https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SocialCareSupportReasonCategory |
category | codeSystem (2 codes) | https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-ConditionCategory |
category | codeSystem (2 codes) | https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1 | http://terminology.hl7.org/CodeSystem/condition-category |
code | Required valueSet binding | https://fhir.yhcr.nhs.uk/ValueSet/Interweave-InterweaveSocialCareSupportReason-1 | https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareSupportReason |
code | codeSystem | https://fhir.yhcr.nhs.uk/CodeSystem/Interweave-SocialCareSupportReason-1 | https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SocialCareSupportReason |
recordedDate | Rename | assertedDate | recordedDate |