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-SocialCareAssessment | Version: 0.0.1 | |||
Draft as of 2024-07-15 | Computable Name: InterweaveSocialCareAssessment |
Interweave SocialCare Assessment resource profile (modelled using FHIR Task) - DRAFT.
Status: DRAFT: For Review
Definition: A record of an assessment to determine a person’s support needs. An assessment record may be in progress, has already taken place, or is planned to be performed in the future.
This profile sets minimum expectations for the Social Care Asessment resource which is modelled using the FHIR Task resource. The FHIR Task resource was chosen to model the Assessment as it was the most akin in terms of logic and structure. Many of the irrelevant health fields have been stripped from this resource to create a clear and concise model for population. We will simply refer to this resource as an Assessment throughout the remainder of the notes section.
We are primarily interested in recording that an assessment is being / has been performed and the high-level outcomes of that assessment – we are not attempting to capture the detailed content of the assessment at this stage. In particular we are not attempting to capture detailed coded information about the findings and plans – although this could be added via other FHIR Resources in future.
A Data Provider MUST offer FHIR resources to represent its own Assessments.
When referencing an Assessment from another resource, the provider must populate the reference.display with the value held in the Assessment code.display.
The following fields are mandatory:
intent - Although this field is not relevant to Social Care, it is mandatory within FHIR, therefore we default its value to 'plan'.
code - code is used to house the 'category' of assessment. This should always be known, and vital for meaningful display purposes.Currently social care providers have vast lists of assessment types, so here we aim to categorise the type and then use code.text for displaying the more granular local assessment type. code.text must always be populated, if there is no divergence between the local assessment name and the code.display, simply repeat the code.display here.
for - A reference to the person (Patient FHIR resource) which is the subject of the assessment.
authoredOn - The date that the assessment was first entered into the source system.
lastModified - The date that the assessment record was last updated.
owner - The Organisational Team which has overall responsibility for the assessment.
In addition, the following fields are "Must Support" - i.e. they must be populated if relevant and known:
basedOn - This is a reference to either the Social Care Assessment (FHIR Task) or Contact (FHIR ServiceRequest) which triggered this Assessment to be carried out.
execution.period.start - The date/time that the assessment commenced (Or is due to commence should the assessment be in a planned status).
execution.period.end - The date/time that the assessment completed.
outcome - This is an extension required by social care to specify the outcome of the assessment. The list of available codes has been derived from the "Event Outcome" field of the "Adult Social Care - Client Level Data" specification and has been made extensible as it is foreseen that this list will grow.
performer - Option to provide the practitioner which either performed, is going to perform or is performing the assessment.
Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Optional fields to note include:
identifier:localIdentifier - As with most other resources, there is the option to include a local identifier which may help to identify the record at a local level.
description - Option to provide an additional description of the assessment, over and above the name.
encounter - Optional link back to an encounter resource – a use case has been identified to link Hospital Discharge assessment back to the hospitals encounter.
output - We give the option here to attach a local document which contains further detail of the asssessment carried out such as detailed coding information, findings and plans. Please ensure that any documents attached are relevant for regional sharing.
The following fields have also been removed as they do not capture data relevant to a Social Care Assessment:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Task
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | 0..* | Task | A task to be performed | |
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 | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
outcome | S | 0..* | CodeableConcept | The outcome of the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: InterweaveSocialCareAssessmentOutcome (required) |
performer | S | 0..1 | Reference(InterweavePractitioner) | The practitioner performing the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentPerformer |
Slices for identifier | 0..* | Identifier | Task Instance Identifier Slice: Unordered, Open by value:system | |
identifier:localIdentifier | 0..1 | Identifier | Task Instance Identifier | |
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcareassessment-identifier |
value | S | 1..1 | string | The Local socialcareassessment 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) | |
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | S | 0..1 | Reference(InterweaveSocialCareAssessment | InterweaveSocialCareContact) | The assessment (task resource) or contact (referral request resource) which triggered this assesment. |
groupIdentifier | 0..0 | |||
partOf | 0..0 | |||
status | S | 1..1 | code | A mandatory flag to indicate the status of the assessment. Binding: InterweaveSocialCareAssessmentStatus (required) |
statusReason | 0..0 | |||
businessStatus | 0..0 | |||
intent | S | 1..1 | code | Not relevant to Social Care but is mandated by FHIR therefore we default to Plan Fixed Value: plan |
priority | 0..0 | |||
code | S | 1..1 | CodeableConcept | The type of assessment. Binding: InterweaveSocialCareAssessmentType (preferred) |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
text | S | 1..1 | string | Plain text representation of the concept |
description | 0..1 | string | An additional description of the assessment over and above the name. | |
focus | 0..0 | |||
for | S | 1..1 | Reference(InterweavePatient) | The person which is subject of the assessment. |
id | 0..0 | |||
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..1 | Reference(InterweaveEncounter) | Optional link to an Encounter resource which maybe associated with the assessment | |
executionPeriod | S | 0..1 | Period | Start and end time of execution |
start | 0..1 | dateTime | The date/time that the assessment commenced (Or is due to commence should the assessment be in a planned status) | |
end | 0..1 | dateTime | The date/time that the assessment completed. | |
authoredOn | S | 1..1 | dateTime | The date that the assessment was first entered in to the source system. |
lastModified | S | 1..1 | dateTime | The date that the assessment was last updated. |
requester | 0..0 | |||
performerType | 0..0 | |||
owner | S | 1..1 | Reference(InterweaveOrganization) | A reference to the Organizational team which is performing the assessment. |
location | 0..0 | |||
reasonCode | 0..0 | |||
reasonReference | 0..0 | |||
insurance | 0..0 | |||
note | 0..0 | |||
relevantHistory | 0..0 | |||
restriction | 0..0 | |||
input | 0..0 | |||
output | ||||
id | 0..0 | |||
type | 1..1 | CodeableConcept | Label for output Binding: InterweaveSocialCareAssessmentOutputType (required) | |
id | 0..0 | |||
coding | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SocialCareAssessmentOutputType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DOC | |
display | 1..1 | string | Representation defined by the system Fixed Value: DocumentReference | |
value[x] | 1..1 | Reference(InterweaveDocumentReference) | Result of output | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Task.status | required | InterweaveSocialCareAssessmentStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentStatus from this IG | |
Task.code | preferred | InterweaveSocialCareAssessmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentType from this IG | |
Task.output.type | required | InterweaveSocialCareAssessmentOutputTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentOutputType from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. | ||||
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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
outcome | S | 0..* | CodeableConcept | The outcome of the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: InterweaveSocialCareAssessmentOutcome (required) | ||||
performer | S | 0..1 | Reference(InterweavePractitioner) | The practitioner performing the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentPerformer | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | 0..* | Identifier | Task Instance Identifier Slice: Unordered, Open by value:system | |||||
identifier:localIdentifier | 0..1 | Identifier | Task Instance Identifier | |||||
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-socialcareassessment-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcareassessment 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) | ||||
basedOn | SΣ | 0..1 | Reference(InterweaveSocialCareAssessment | InterweaveSocialCareContact) | The assessment (task resource) or contact (referral request resource) which triggered this assesment. | ||||
status | ?!SΣ | 1..1 | code | A mandatory flag to indicate the status of the assessment. Binding: InterweaveSocialCareAssessmentStatus (required) | ||||
intent | SΣ | 1..1 | code | Not relevant to Social Care but is mandated by FHIR therefore we default to Plan Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: plan | ||||
code | SΣ | 1..1 | CodeableConcept | The type of assessment. Binding: InterweaveSocialCareAssessmentType (preferred) | ||||
text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
description | Σ | 0..1 | string | An additional description of the assessment over and above the name. | ||||
for | SΣ | 1..1 | Reference(InterweavePatient) | The person which is subject of the assessment. | ||||
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 | ||||
encounter | Σ | 0..1 | Reference(InterweaveEncounter) | Optional link to an Encounter resource which maybe associated with the assessment | ||||
executionPeriod | SΣ | 0..1 | Period | Start and end time of execution | ||||
start | ΣC | 0..1 | dateTime | The date/time that the assessment commenced (Or is due to commence should the assessment be in a planned status) | ||||
end | ΣC | 0..1 | dateTime | The date/time that the assessment completed. | ||||
authoredOn | SC | 1..1 | dateTime | The date that the assessment was first entered in to the source system. | ||||
lastModified | SΣC | 1..1 | dateTime | The date that the assessment was last updated. | ||||
owner | SΣ | 1..1 | Reference(InterweaveOrganization) | A reference to the Organizational team which is performing the assessment. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Task.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Task.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Task.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Task.status | required | InterweaveSocialCareAssessmentStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentStatus from this IG | ||||
Task.intent | required | Fixed Value: planhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard | ||||
Task.code | preferred | InterweaveSocialCareAssessmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentType from this IG | ||||
Task.input.type | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Task | 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 | Task | 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 | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Task | 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() | |
inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. | ||||
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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
outcome | S | 0..* | CodeableConcept | The outcome of the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: InterweaveSocialCareAssessmentOutcome (required) | ||||
performer | S | 0..1 | Reference(InterweavePractitioner) | The practitioner performing the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentPerformer | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | 0..* | Identifier | Task Instance Identifier Slice: Unordered, Open by value:system | |||||
identifier:localIdentifier | 0..1 | Identifier | Task Instance Identifier | |||||
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-socialcareassessment-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcareassessment 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) | ||||
basedOn | SΣ | 0..1 | Reference(InterweaveSocialCareAssessment | InterweaveSocialCareContact) | The assessment (task resource) or contact (referral request resource) which triggered this assesment. | ||||
status | ?!SΣ | 1..1 | code | A mandatory flag to indicate the status of the assessment. Binding: InterweaveSocialCareAssessmentStatus (required) | ||||
intent | SΣ | 1..1 | code | Not relevant to Social Care but is mandated by FHIR therefore we default to Plan Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: plan | ||||
code | SΣ | 1..1 | CodeableConcept | The type of assessment. Binding: InterweaveSocialCareAssessmentType (preferred) | ||||
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 | SΣ | 1..1 | string | Plain text representation of the concept | ||||
description | Σ | 0..1 | string | An additional description of the assessment over and above the name. | ||||
for | SΣ | 1..1 | Reference(InterweavePatient) | The person which is subject of the assessment. | ||||
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 | ||||
encounter | Σ | 0..1 | Reference(InterweaveEncounter) | Optional link to an Encounter resource which maybe associated with the assessment | ||||
executionPeriod | SΣ | 0..1 | Period | Start and end time of execution | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | ΣC | 0..1 | dateTime | The date/time that the assessment commenced (Or is due to commence should the assessment be in a planned status) | ||||
end | ΣC | 0..1 | dateTime | The date/time that the assessment completed. | ||||
authoredOn | SC | 1..1 | dateTime | The date that the assessment was first entered in to the source system. | ||||
lastModified | SΣC | 1..1 | dateTime | The date that the assessment was last updated. | ||||
owner | SΣ | 1..1 | Reference(InterweaveOrganization) | A reference to the Organizational team which is performing the assessment. | ||||
output | 0..* | BackboneElement | Information produced as part of task | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding: InterweaveSocialCareAssessmentOutputType (required) | |||||
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 Fixed Value: https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SocialCareAssessmentOutputType | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DOC | ||||
display | Σ | 1..1 | string | Representation defined by the system Fixed Value: DocumentReference | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
value[x] | 1..1 | Reference(InterweaveDocumentReference) | Result of output | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Task.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Task.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Task.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Task.identifier:localIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Task.status | required | InterweaveSocialCareAssessmentStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentStatus from this IG | ||||
Task.intent | required | Fixed Value: planhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard | ||||
Task.code | preferred | InterweaveSocialCareAssessmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentType from this IG | ||||
Task.for.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Task.input.type | example | |||||
Task.output.type | required | InterweaveSocialCareAssessmentOutputTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentOutputType from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Task | 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 | Task | 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 | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Task | 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() | |
inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
This structure is derived from Task
Summary
Mandatory: 8 elements(14 nested mandatory elements)
Must-Support: 24 elements
Fixed: 7 elements
Prohibited: 27 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 Task
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | 0..* | Task | A task to be performed | |
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 | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
outcome | S | 0..* | CodeableConcept | The outcome of the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: InterweaveSocialCareAssessmentOutcome (required) |
performer | S | 0..1 | Reference(InterweavePractitioner) | The practitioner performing the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentPerformer |
Slices for identifier | 0..* | Identifier | Task Instance Identifier Slice: Unordered, Open by value:system | |
identifier:localIdentifier | 0..1 | Identifier | Task Instance Identifier | |
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-socialcareassessment-identifier |
value | S | 1..1 | string | The Local socialcareassessment 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) | |
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | S | 0..1 | Reference(InterweaveSocialCareAssessment | InterweaveSocialCareContact) | The assessment (task resource) or contact (referral request resource) which triggered this assesment. |
groupIdentifier | 0..0 | |||
partOf | 0..0 | |||
status | S | 1..1 | code | A mandatory flag to indicate the status of the assessment. Binding: InterweaveSocialCareAssessmentStatus (required) |
statusReason | 0..0 | |||
businessStatus | 0..0 | |||
intent | S | 1..1 | code | Not relevant to Social Care but is mandated by FHIR therefore we default to Plan Fixed Value: plan |
priority | 0..0 | |||
code | S | 1..1 | CodeableConcept | The type of assessment. Binding: InterweaveSocialCareAssessmentType (preferred) |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
text | S | 1..1 | string | Plain text representation of the concept |
description | 0..1 | string | An additional description of the assessment over and above the name. | |
focus | 0..0 | |||
for | S | 1..1 | Reference(InterweavePatient) | The person which is subject of the assessment. |
id | 0..0 | |||
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..1 | Reference(InterweaveEncounter) | Optional link to an Encounter resource which maybe associated with the assessment | |
executionPeriod | S | 0..1 | Period | Start and end time of execution |
start | 0..1 | dateTime | The date/time that the assessment commenced (Or is due to commence should the assessment be in a planned status) | |
end | 0..1 | dateTime | The date/time that the assessment completed. | |
authoredOn | S | 1..1 | dateTime | The date that the assessment was first entered in to the source system. |
lastModified | S | 1..1 | dateTime | The date that the assessment was last updated. |
requester | 0..0 | |||
performerType | 0..0 | |||
owner | S | 1..1 | Reference(InterweaveOrganization) | A reference to the Organizational team which is performing the assessment. |
location | 0..0 | |||
reasonCode | 0..0 | |||
reasonReference | 0..0 | |||
insurance | 0..0 | |||
note | 0..0 | |||
relevantHistory | 0..0 | |||
restriction | 0..0 | |||
input | 0..0 | |||
output | ||||
id | 0..0 | |||
type | 1..1 | CodeableConcept | Label for output Binding: InterweaveSocialCareAssessmentOutputType (required) | |
id | 0..0 | |||
coding | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SocialCareAssessmentOutputType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DOC | |
display | 1..1 | string | Representation defined by the system Fixed Value: DocumentReference | |
value[x] | 1..1 | Reference(InterweaveDocumentReference) | Result of output | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Task.status | required | InterweaveSocialCareAssessmentStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentStatus from this IG | |
Task.code | preferred | InterweaveSocialCareAssessmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentType from this IG | |
Task.output.type | required | InterweaveSocialCareAssessmentOutputTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentOutputType from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. | ||||
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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
outcome | S | 0..* | CodeableConcept | The outcome of the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: InterweaveSocialCareAssessmentOutcome (required) | ||||
performer | S | 0..1 | Reference(InterweavePractitioner) | The practitioner performing the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentPerformer | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | 0..* | Identifier | Task Instance Identifier Slice: Unordered, Open by value:system | |||||
identifier:localIdentifier | 0..1 | Identifier | Task Instance Identifier | |||||
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-socialcareassessment-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcareassessment 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) | ||||
basedOn | SΣ | 0..1 | Reference(InterweaveSocialCareAssessment | InterweaveSocialCareContact) | The assessment (task resource) or contact (referral request resource) which triggered this assesment. | ||||
status | ?!SΣ | 1..1 | code | A mandatory flag to indicate the status of the assessment. Binding: InterweaveSocialCareAssessmentStatus (required) | ||||
intent | SΣ | 1..1 | code | Not relevant to Social Care but is mandated by FHIR therefore we default to Plan Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: plan | ||||
code | SΣ | 1..1 | CodeableConcept | The type of assessment. Binding: InterweaveSocialCareAssessmentType (preferred) | ||||
text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
description | Σ | 0..1 | string | An additional description of the assessment over and above the name. | ||||
for | SΣ | 1..1 | Reference(InterweavePatient) | The person which is subject of the assessment. | ||||
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 | ||||
encounter | Σ | 0..1 | Reference(InterweaveEncounter) | Optional link to an Encounter resource which maybe associated with the assessment | ||||
executionPeriod | SΣ | 0..1 | Period | Start and end time of execution | ||||
start | ΣC | 0..1 | dateTime | The date/time that the assessment commenced (Or is due to commence should the assessment be in a planned status) | ||||
end | ΣC | 0..1 | dateTime | The date/time that the assessment completed. | ||||
authoredOn | SC | 1..1 | dateTime | The date that the assessment was first entered in to the source system. | ||||
lastModified | SΣC | 1..1 | dateTime | The date that the assessment was last updated. | ||||
owner | SΣ | 1..1 | Reference(InterweaveOrganization) | A reference to the Organizational team which is performing the assessment. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Task.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Task.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Task.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Task.status | required | InterweaveSocialCareAssessmentStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentStatus from this IG | ||||
Task.intent | required | Fixed Value: planhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard | ||||
Task.code | preferred | InterweaveSocialCareAssessmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentType from this IG | ||||
Task.input.type | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Task | 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 | Task | 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 | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Task | 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() | |
inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. | ||||
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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
outcome | S | 0..* | CodeableConcept | The outcome of the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: InterweaveSocialCareAssessmentOutcome (required) | ||||
performer | S | 0..1 | Reference(InterweavePractitioner) | The practitioner performing the assessment. URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareAssessmentPerformer | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | 0..* | Identifier | Task Instance Identifier Slice: Unordered, Open by value:system | |||||
identifier:localIdentifier | 0..1 | Identifier | Task Instance Identifier | |||||
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-socialcareassessment-identifier | ||||
value | SΣ | 1..1 | string | The Local socialcareassessment 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) | ||||
basedOn | SΣ | 0..1 | Reference(InterweaveSocialCareAssessment | InterweaveSocialCareContact) | The assessment (task resource) or contact (referral request resource) which triggered this assesment. | ||||
status | ?!SΣ | 1..1 | code | A mandatory flag to indicate the status of the assessment. Binding: InterweaveSocialCareAssessmentStatus (required) | ||||
intent | SΣ | 1..1 | code | Not relevant to Social Care but is mandated by FHIR therefore we default to Plan Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: plan | ||||
code | SΣ | 1..1 | CodeableConcept | The type of assessment. Binding: InterweaveSocialCareAssessmentType (preferred) | ||||
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 | SΣ | 1..1 | string | Plain text representation of the concept | ||||
description | Σ | 0..1 | string | An additional description of the assessment over and above the name. | ||||
for | SΣ | 1..1 | Reference(InterweavePatient) | The person which is subject of the assessment. | ||||
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 | ||||
encounter | Σ | 0..1 | Reference(InterweaveEncounter) | Optional link to an Encounter resource which maybe associated with the assessment | ||||
executionPeriod | SΣ | 0..1 | Period | Start and end time of execution | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | ΣC | 0..1 | dateTime | The date/time that the assessment commenced (Or is due to commence should the assessment be in a planned status) | ||||
end | ΣC | 0..1 | dateTime | The date/time that the assessment completed. | ||||
authoredOn | SC | 1..1 | dateTime | The date that the assessment was first entered in to the source system. | ||||
lastModified | SΣC | 1..1 | dateTime | The date that the assessment was last updated. | ||||
owner | SΣ | 1..1 | Reference(InterweaveOrganization) | A reference to the Organizational team which is performing the assessment. | ||||
output | 0..* | BackboneElement | Information produced as part of task | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding: InterweaveSocialCareAssessmentOutputType (required) | |||||
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 Fixed Value: https://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SocialCareAssessmentOutputType | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DOC | ||||
display | Σ | 1..1 | string | Representation defined by the system Fixed Value: DocumentReference | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
value[x] | 1..1 | Reference(InterweaveDocumentReference) | Result of output | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Task.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Task.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Task.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Task.identifier:localIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Task.identifier:localIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Task.status | required | InterweaveSocialCareAssessmentStatushttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentStatus from this IG | ||||
Task.intent | required | Fixed Value: planhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard | ||||
Task.code | preferred | InterweaveSocialCareAssessmentTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentType from this IG | ||||
Task.for.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Task.input.type | example | |||||
Task.output.type | required | InterweaveSocialCareAssessmentOutputTypehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SocialCareAssessmentOutputType from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Task | 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 | Task | 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 | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Task | 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() | |
inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
This structure is derived from Task
Summary
Mandatory: 8 elements(14 nested mandatory elements)
Must-Support: 24 elements
Fixed: 7 elements
Prohibited: 27 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 details |
---|---|
extension:outcome |
|
extension:performer |
|
identifier:localIdentifier.system |
|
status |
|
code |
|
encounter |
|
output.type |
|