Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: InterweaveSocialCareAssessment

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

Interweave Social Care Assessment resource profile (modelled using FHIR Task) - DRAFT

  Status: DRAFT: Work in Progress

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.

Introduction

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.

Coverage and references

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

Mandatory fields

The following fields are mandatory:

  • status A mandatory flag to indicate whether the assessment is active or not. We limit the valueset to accepted; in-progress; completed; entered-in-error.

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

Must Support fields

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 ReferralReference) 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 “V5 Adult Social Care - Client Level Data” specification and has been made extensible as it is foreseen that this list will grow.

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Optional fields to note include:

  • identifier:localIdentifier - As with most other resources, there is the option to include a local identifier which may help to identify the record at a local level.

  • description Option to provide an additional description of the assessment, over and above the name.

  • context 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.

Discouraged or Removed fields

  • groupIdentifier and partOf - It is not the intention to create a complex grouping or hierarchy of assessments, a simple flat structure is informative and preferred. Therefore, both these fields have been removed.

The following fields have also been removed as they do not capture data relevant to a Social Care Assessment:

  • incrementNumber - A non-relevant Care Connect extension
  • failSafeRuleVersions - A non-relevant Care Connect extension
  • definition
  • statusReason
  • businessStatus
  • priority
  • focus
  • requester
  • performerType
  • reason
  • note
  • relevantHistory
  • restriction
  • input

Usage:

Formal Views of Profile Content

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

This structure is derived from CareConnect-Task-1

Summary

Mandatory: 8 elements (11 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 5 elements
Prohibited: 17 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Task.meta.tag is sliced based on the value of value:system
  • The element Task.identifier is sliced based on the value of value:system

This structure is derived from CareConnect-Task-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task 0..*CareConnect-Task-1A task to be performed
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... language 0..1codeEnglish is assumed (not currently a multi-lingual implementation)
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension:incrementNumber 0..0
... extension:failsafeRuleVersion 0..0
... Extension-Interweave-SocialCareAssessmentOutcome S0..*CodeableConceptThe outcome of the assessment.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome
Binding: Interweave Social Care Assessment outcome (extensible)
... Slices for identifier 0..*IdentifierTask Instance Identifier
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierTask Instance Identifier
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareassessment-identifier
..... value S1..1stringThe Local socialcareassessment Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... definition[x] 0..0
... basedOn S0..1Reference(Resource)The assessment (task resource) or contact (referral request resource) which triggered this assesment.
... groupIdentifier 0..0
... partOf 0..0
... status S1..1codeA mandatory flag to indicate the status of the assessment.
Binding: Interweave Social Care Assessment Status (required)
... statusReason 0..0
... businessStatus 0..0
... intent S1..1codeNot relevant to Social Care but is mandated by FHIR therefore we default to Plan
Fixed Value: plan
... priority 0..0
... code S1..1CodeableConceptThe type of assessment.
Binding: Interweave Social Care Assessment Type (preferred)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S1..1stringPlain text representation of the concept
... description 0..1stringAn additional description of the assessment over and above the name.
... focus 0..0
... for S1..1Reference(CareConnect-Patient-1)The person which is subject of the assessment.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... context 0..1Reference(CareConnect-Encounter-1)Optional link to an Encounter resource which maybe associated with the assessment
... executionPeriod S0..1PeriodStart and end time of execution
.... start 0..1dateTimeThe date/time that the assessment commenced (Or is due to commence should the assessment be in a planned status)
.... end 0..1dateTimeThe date/time that the assessment completed.
... authoredOn S1..1dateTimeThe date that the assessment was first entered in to the source system.
... lastModified S1..1dateTimeThe date that the assessment was last updated.
... requester 0..0
... performerType 0..0
... owner S1..1Reference(CareConnect-Organization-1)A reference to the Organizational team which is performing the assessment
... reason 0..0
... note 0..0
... relevantHistory 0..0
... restriction 0..0
... input 0..0
... output
.... type 1..1CodeableConceptLabel for output
Binding: Interweave Social Care Assessment output type (required)
..... coding
...... system 0..1uriIdentity of the terminology system
Fixed Value: DOC
.... value[x] 1..1Reference(CareConnect-DocumentReference-1)Result of output

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task I0..*CareConnect-Task-1A task to be performed
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


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


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


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Extension-Interweave-SocialCareAssessmentOutcome S0..*CodeableConceptThe outcome of the assessment.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome
Binding: Interweave Social Care Assessment outcome (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*IdentifierTask Instance Identifier
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierTask Instance Identifier
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareassessment-identifier
..... value SΣ1..1stringThe Local socialcareassessment Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... basedOn SΣ0..1Reference(Resource)The assessment (task resource) or contact (referral request resource) which triggered this assesment.
... status SΣ1..1codeA mandatory flag to indicate the status of the assessment.
Binding: Interweave Social Care Assessment Status (required)
... intent SΣ1..1codeNot relevant to Social Care but is mandated by FHIR therefore we default to Plan
Binding: RequestIntent (required): Distinguishes whether the task is a proposal, plan or full order


Fixed Value: plan
... code SΣ1..1CodeableConceptThe type of assessment.
Binding: Interweave Social Care Assessment Type (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ1..1stringPlain text representation of the concept
... description Σ0..1stringAn additional description of the assessment over and above the name.
... for SΣ1..1Reference(CareConnect-Patient-1)The person which is subject of the assessment.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... context Σ0..1Reference(CareConnect-Encounter-1)Optional link to an Encounter resource which maybe associated with the assessment
... executionPeriod SΣ0..1PeriodStart and end time of execution
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣI0..1dateTimeThe date/time that the assessment commenced (Or is due to commence should the assessment be in a planned status)
.... end ΣI0..1dateTimeThe date/time that the assessment completed.
... authoredOn SI1..1dateTimeThe date that the assessment was first entered in to the source system.
... lastModified SΣI1..1dateTimeThe date that the assessment was last updated.
... owner SΣ1..1Reference(CareConnect-Organization-1)A reference to the Organizational team which is performing the assessment
... output 0..*BackboneElementInformation produced as part of task
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type 1..1CodeableConceptLabel for output
Binding: Interweave Social Care Assessment output type (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: DOC
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... value[x] 1..1Reference(CareConnect-DocumentReference-1)Result of output

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task I0..*CareConnect-Task-1A task to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile Σ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... tag:Source Σ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... code Σ1..1codeThe Data Provider Id of the system supplying the data
..... display Σ1..1stringName of the system supplying the data
.... tag:Provenance Σ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... code Σ1..1codeThe ODS Code of the organisation responsible for the data
..... display Σ1..1stringName of the organisation supplying the data
... Extension-Interweave-SocialCareAssessmentOutcome 0..*CodeableConceptThe outcome of the assessment.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome
Binding: Interweave Social Care Assessment outcome (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareassessment-identifier
.... value Σ1..1stringThe Local socialcareassessment Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
... basedOn Σ0..1Reference(Resource)The assessment (task resource) or contact (referral request resource) which triggered this assesment.
... status Σ1..1codeA mandatory flag to indicate the status of the assessment.
Binding: Interweave Social Care Assessment Status (required)
... intent Σ1..1codeNot relevant to Social Care but is mandated by FHIR therefore we default to Plan
Binding: RequestIntent (required): Distinguishes whether the task is a proposal, plan or full order


Fixed Value: plan
... code Σ1..1CodeableConceptThe type of assessment.
Binding: Interweave Social Care Assessment Type (preferred)
.... text Σ1..1stringPlain text representation of the concept
... for Σ1..1Reference(CareConnect-Patient-1)The person which is subject of the assessment.
... executionPeriod Σ0..1PeriodStart and end time of execution
... authoredOn I1..1dateTimeThe date that the assessment was first entered in to the source system.
... lastModified ΣI1..1dateTimeThe date that the assessment was last updated.
... owner Σ1..1Reference(CareConnect-Organization-1)A reference to the Organizational team which is performing the assessment

doco Documentation for this format

This structure is derived from CareConnect-Task-1

Summary

Mandatory: 8 elements (11 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 5 elements
Prohibited: 17 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Task.meta.tag is sliced based on the value of value:system
  • The element Task.identifier is sliced based on the value of value:system

Differential View

This structure is derived from CareConnect-Task-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task 0..*CareConnect-Task-1A task to be performed
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... language 0..1codeEnglish is assumed (not currently a multi-lingual implementation)
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension:incrementNumber 0..0
... extension:failsafeRuleVersion 0..0
... Extension-Interweave-SocialCareAssessmentOutcome S0..*CodeableConceptThe outcome of the assessment.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome
Binding: Interweave Social Care Assessment outcome (extensible)
... Slices for identifier 0..*IdentifierTask Instance Identifier
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierTask Instance Identifier
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareassessment-identifier
..... value S1..1stringThe Local socialcareassessment Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... definition[x] 0..0
... basedOn S0..1Reference(Resource)The assessment (task resource) or contact (referral request resource) which triggered this assesment.
... groupIdentifier 0..0
... partOf 0..0
... status S1..1codeA mandatory flag to indicate the status of the assessment.
Binding: Interweave Social Care Assessment Status (required)
... statusReason 0..0
... businessStatus 0..0
... intent S1..1codeNot relevant to Social Care but is mandated by FHIR therefore we default to Plan
Fixed Value: plan
... priority 0..0
... code S1..1CodeableConceptThe type of assessment.
Binding: Interweave Social Care Assessment Type (preferred)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S1..1stringPlain text representation of the concept
... description 0..1stringAn additional description of the assessment over and above the name.
... focus 0..0
... for S1..1Reference(CareConnect-Patient-1)The person which is subject of the assessment.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... context 0..1Reference(CareConnect-Encounter-1)Optional link to an Encounter resource which maybe associated with the assessment
... executionPeriod S0..1PeriodStart and end time of execution
.... start 0..1dateTimeThe date/time that the assessment commenced (Or is due to commence should the assessment be in a planned status)
.... end 0..1dateTimeThe date/time that the assessment completed.
... authoredOn S1..1dateTimeThe date that the assessment was first entered in to the source system.
... lastModified S1..1dateTimeThe date that the assessment was last updated.
... requester 0..0
... performerType 0..0
... owner S1..1Reference(CareConnect-Organization-1)A reference to the Organizational team which is performing the assessment
... reason 0..0
... note 0..0
... relevantHistory 0..0
... restriction 0..0
... input 0..0
... output
.... type 1..1CodeableConceptLabel for output
Binding: Interweave Social Care Assessment output type (required)
..... coding
...... system 0..1uriIdentity of the terminology system
Fixed Value: DOC
.... value[x] 1..1Reference(CareConnect-DocumentReference-1)Result of output

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task I0..*CareConnect-Task-1A task to be performed
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


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


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


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Extension-Interweave-SocialCareAssessmentOutcome S0..*CodeableConceptThe outcome of the assessment.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome
Binding: Interweave Social Care Assessment outcome (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier 0..*IdentifierTask Instance Identifier
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierTask Instance Identifier
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcareassessment-identifier
..... value SΣ1..1stringThe Local socialcareassessment Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... basedOn SΣ0..1Reference(Resource)The assessment (task resource) or contact (referral request resource) which triggered this assesment.
... status SΣ1..1codeA mandatory flag to indicate the status of the assessment.
Binding: Interweave Social Care Assessment Status (required)
... intent SΣ1..1codeNot relevant to Social Care but is mandated by FHIR therefore we default to Plan
Binding: RequestIntent (required): Distinguishes whether the task is a proposal, plan or full order


Fixed Value: plan
... code SΣ1..1CodeableConceptThe type of assessment.
Binding: Interweave Social Care Assessment Type (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ1..1stringPlain text representation of the concept
... description Σ0..1stringAn additional description of the assessment over and above the name.
... for SΣ1..1Reference(CareConnect-Patient-1)The person which is subject of the assessment.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... context Σ0..1Reference(CareConnect-Encounter-1)Optional link to an Encounter resource which maybe associated with the assessment
... executionPeriod SΣ0..1PeriodStart and end time of execution
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣI0..1dateTimeThe date/time that the assessment commenced (Or is due to commence should the assessment be in a planned status)
.... end ΣI0..1dateTimeThe date/time that the assessment completed.
... authoredOn SI1..1dateTimeThe date that the assessment was first entered in to the source system.
... lastModified SΣI1..1dateTimeThe date that the assessment was last updated.
... owner SΣ1..1Reference(CareConnect-Organization-1)A reference to the Organizational team which is performing the assessment
... output 0..*BackboneElementInformation produced as part of task
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type 1..1CodeableConceptLabel for output
Binding: Interweave Social Care Assessment output type (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: DOC
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... value[x] 1..1Reference(CareConnect-DocumentReference-1)Result of output

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Task.meta.securityextensibleAll Security Labels
Task.meta.tagexampleCommon Tags
Task.meta.tag:SourceexampleCommon Tags
Task.meta.tag:ProvenanceexampleCommon Tags
Task.languageextensibleCommon Languages
Max Binding: All Languages
Task.identifier:localIdentifier.userequiredIdentifierUse
Task.identifier:localIdentifier.typeextensibleIdentifier Type Codes
Task.statusrequiredInterweave Social Care Assessment Status
Task.intentrequiredFixed Value: plan
Task.codepreferredInterweave Social Care Assessment Type
Task.input.typeexample
Task.output.typerequiredInterweave Social Care Assessment output type

Constraints

IdGradePathDetailsRequirements
dom-2errorTaskIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1errorTaskIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4errorTaskIf 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-3errorTaskIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
inv-1errorTaskLast modified date must be greater than or equal to authored-on date.
: lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
ele-1errorTask.outputAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())