Status: Active: Approved (STU)

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.

• performer Option to provide the practitioner which either performed, is going to perform or is performing the assessment.

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from CareConnect-Task-1

Name	Flags	Card.	Type	Description & Constraints
Task		0..*	CareConnect-Task-1	A task to be performed
id	S	0..1	id	Logical id of this artifact
meta
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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
extension:incrementNumber		0..0
extension:failsafeRuleVersion		0..0
outcome	S	0..*	CodeableConcept	The outcome of the assessment. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: Interweave Social Care Assessment outcome (required)
performer	S	0..1	Reference(CareConnect-Practitioner-1)	The practitioner performing the assessment. URL: https://fhir.yhcr.nhs.uk/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.yhcr.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
definition[x]		0..0
basedOn	S	0..1	Reference(Resource)	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: Interweave Social Care Assessment Status (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: Interweave Social Care Assessment Type (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(CareConnectPatient1)	The person which is subject of the assessment.
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
context		0..1	Reference(CareConnect-Encounter-1)	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(InterweaveOrganizationalTeam)	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..1	CodeableConcept	Label for output Binding: Interweave Social Care Assessment output type (required)
coding
code		0..1	code	Symbol in syntax defined by the system Fixed Value: DOC
value[x]		1..1	Reference(CareConnect-DocumentReference-1)	Result of output
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Task.status	required	Interweave Social Care Assessment Status
Task.code	preferred	Interweave Social Care Assessment Type (a valid code from InterweaveSocialCareAssessmentType)
Task.output.type	required	Interweave Social Care Assessment output type (a valid code from InterweaveSocialCareAssessmentOutputType)

Name	Flags	Card.	Type	Description & Constraints
Task	C	0..*	CareConnect-Task-1	A task to be performed
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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (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://yhcr.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: Common Tags (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://yhcr.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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
outcome	S	0..*	CodeableConcept	The outcome of the assessment. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: Interweave Social Care Assessment outcome (required)
performer	S	0..1	Reference(CareConnect-Practitioner-1)	The practitioner performing the assessment. URL: https://fhir.yhcr.nhs.uk/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 (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.yhcr.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
basedOn	SΣ	0..1	Reference(Resource)	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: Interweave Social Care Assessment Status (required)
intent	SΣ	1..1	code	Not 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..1	CodeableConcept	The type of assessment. Binding: Interweave Social Care Assessment Type (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(CareConnectPatient1)	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
context	Σ	0..1	Reference(CareConnect-Encounter-1)	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(InterweaveOrganizationalTeam)	A reference to the Organizational team which is performing the assessment.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Task.meta.security	extensible	All Security Labels
Task.meta.tag	example	Common Tags
Task.meta.tag:Source	example	Common Tags
Task.meta.tag:Provenance	example	Common Tags
Task.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Task.identifier:localIdentifier.use	required	IdentifierUse
Task.status	required	Interweave Social Care Assessment Status
Task.intent	required	Fixed Value: plan
Task.code	preferred	Interweave Social Care Assessment Type (a valid code from InterweaveSocialCareAssessmentType)
Task.input.type	example

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Task	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
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..*	CareConnect-Task-1	A task to be performed
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	xml:id (or equivalent in JSON)
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.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
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://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
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://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: Interweave Social Care Assessment outcome (required)
performer	S	0..1	Reference(CareConnect-Practitioner-1)	The practitioner performing the assessment. URL: https://fhir.yhcr.nhs.uk/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	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (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.yhcr.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(Organization)	Organization that issued id (may be just text)
basedOn	SΣ	0..1	Reference(Resource)	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: Interweave Social Care Assessment Status (required)
intent	SΣ	1..1	code	Not 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..1	CodeableConcept	The type of assessment. Binding: Interweave Social Care Assessment Type (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
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	xml:id (or equivalent in JSON)
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(CareConnectPatient1)	The person which is subject of the assessment.
id		0..1	string	xml:id (or equivalent in JSON)
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)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
context	Σ	0..1	Reference(CareConnect-Encounter-1)	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	xml:id (or equivalent in JSON)
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(InterweaveOrganizationalTeam)	A reference to the Organizational team which is performing the assessment.
output		0..*	BackboneElement	Information produced as part of task
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
type		1..1	CodeableConcept	Label for output Binding: Interweave Social Care Assessment output type (required)
id		0..1	string	xml:id (or equivalent in JSON)
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	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: DOC
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
value[x]		1..1	Reference(CareConnect-DocumentReference-1)	Result of output
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Task.meta.security	extensible	All Security Labels
Task.meta.tag	example	Common Tags
Task.meta.tag:Source	example	Common Tags
Task.meta.tag:Provenance	example	Common Tags
Task.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Task.identifier:localIdentifier.use	required	IdentifierUse
Task.identifier:localIdentifier.type	extensible	Identifier Type Codes
Task.status	required	Interweave Social Care Assessment Status
Task.intent	required	Fixed Value: plan
Task.code	preferred	Interweave Social Care Assessment Type (a valid code from InterweaveSocialCareAssessmentType)
Task.input.type	example
Task.output.type	required	Interweave Social Care Assessment output type (a valid code from InterweaveSocialCareAssessmentOutputType)

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

Differential View

This structure is derived from CareConnect-Task-1

Name	Flags	Card.	Type	Description & Constraints
Task		0..*	CareConnect-Task-1	A task to be performed
id	S	0..1	id	Logical id of this artifact
meta
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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
extension:incrementNumber		0..0
extension:failsafeRuleVersion		0..0
outcome	S	0..*	CodeableConcept	The outcome of the assessment. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: Interweave Social Care Assessment outcome (required)
performer	S	0..1	Reference(CareConnect-Practitioner-1)	The practitioner performing the assessment. URL: https://fhir.yhcr.nhs.uk/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.yhcr.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
definition[x]		0..0
basedOn	S	0..1	Reference(Resource)	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: Interweave Social Care Assessment Status (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: Interweave Social Care Assessment Type (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(CareConnectPatient1)	The person which is subject of the assessment.
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
context		0..1	Reference(CareConnect-Encounter-1)	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(InterweaveOrganizationalTeam)	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..1	CodeableConcept	Label for output Binding: Interweave Social Care Assessment output type (required)
coding
code		0..1	code	Symbol in syntax defined by the system Fixed Value: DOC
value[x]		1..1	Reference(CareConnect-DocumentReference-1)	Result of output
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Task.status	required	Interweave Social Care Assessment Status
Task.code	preferred	Interweave Social Care Assessment Type (a valid code from InterweaveSocialCareAssessmentType)
Task.output.type	required	Interweave Social Care Assessment output type (a valid code from InterweaveSocialCareAssessmentOutputType)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Task	C	0..*	CareConnect-Task-1	A task to be performed
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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (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://yhcr.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: Common Tags (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://yhcr.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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
outcome	S	0..*	CodeableConcept	The outcome of the assessment. URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: Interweave Social Care Assessment outcome (required)
performer	S	0..1	Reference(CareConnect-Practitioner-1)	The practitioner performing the assessment. URL: https://fhir.yhcr.nhs.uk/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 (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.yhcr.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
basedOn	SΣ	0..1	Reference(Resource)	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: Interweave Social Care Assessment Status (required)
intent	SΣ	1..1	code	Not 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..1	CodeableConcept	The type of assessment. Binding: Interweave Social Care Assessment Type (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(CareConnectPatient1)	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
context	Σ	0..1	Reference(CareConnect-Encounter-1)	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(InterweaveOrganizationalTeam)	A reference to the Organizational team which is performing the assessment.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Task.meta.security	extensible	All Security Labels
Task.meta.tag	example	Common Tags
Task.meta.tag:Source	example	Common Tags
Task.meta.tag:Provenance	example	Common Tags
Task.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Task.identifier:localIdentifier.use	required	IdentifierUse
Task.status	required	Interweave Social Care Assessment Status
Task.intent	required	Fixed Value: plan
Task.code	preferred	Interweave Social Care Assessment Type (a valid code from InterweaveSocialCareAssessmentType)
Task.input.type	example

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Task	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
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..*	CareConnect-Task-1	A task to be performed
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	xml:id (or equivalent in JSON)
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.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
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://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
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://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
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: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
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.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome Binding: Interweave Social Care Assessment outcome (required)
performer	S	0..1	Reference(CareConnect-Practitioner-1)	The practitioner performing the assessment. URL: https://fhir.yhcr.nhs.uk/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	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (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.yhcr.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(Organization)	Organization that issued id (may be just text)
basedOn	SΣ	0..1	Reference(Resource)	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: Interweave Social Care Assessment Status (required)
intent	SΣ	1..1	code	Not 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..1	CodeableConcept	The type of assessment. Binding: Interweave Social Care Assessment Type (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
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	xml:id (or equivalent in JSON)
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(CareConnectPatient1)	The person which is subject of the assessment.
id		0..1	string	xml:id (or equivalent in JSON)
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)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
context	Σ	0..1	Reference(CareConnect-Encounter-1)	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	xml:id (or equivalent in JSON)
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(InterweaveOrganizationalTeam)	A reference to the Organizational team which is performing the assessment.
output		0..*	BackboneElement	Information produced as part of task
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
type		1..1	CodeableConcept	Label for output Binding: Interweave Social Care Assessment output type (required)
id		0..1	string	xml:id (or equivalent in JSON)
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	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: DOC
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
value[x]		1..1	Reference(CareConnect-DocumentReference-1)	Result of output
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Task.meta.security	extensible	All Security Labels
Task.meta.tag	example	Common Tags
Task.meta.tag:Source	example	Common Tags
Task.meta.tag:Provenance	example	Common Tags
Task.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
Task.identifier:localIdentifier.use	required	IdentifierUse
Task.identifier:localIdentifier.type	extensible	Identifier Type Codes
Task.status	required	Interweave Social Care Assessment Status
Task.intent	required	Fixed Value: plan
Task.code	preferred	Interweave Social Care Assessment Type (a valid code from InterweaveSocialCareAssessmentType)
Task.input.type	example
Task.output.type	required	Interweave Social Care Assessment output type (a valid code from InterweaveSocialCareAssessmentOutputType)

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

This structure is derived from CareConnect-Task-1

Summary

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

Structures

This structure refers to these other structures:

• CareConnectPatient1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1)
• CareConnect-Encounter-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1)
• InterweaveOrganizationalTeam (https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-OrganizationalTeam)
• CareConnect-DocumentReference-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-DocumentReference-1)

Extensions

This structure refers to these extensions:

• https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentOutcome
• https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareAssessmentPerformer

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