Status: Active: Approved (STU)

Definition A notification to social services that a person may need their support – a contact can be made by the person themselves, a relative, health professional or any concerned member of the public.

Introduction

This profile sets minimum expectations for the Social Care Contact resource which is modelled using the FHIR ReferralRequest resource. The FHIR ReferralRequest resource was chosen to model a Contact 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 a Contact throughout the remainder of the notes section.

Coverage and references

• A Data Provider MUST offer FHIR resources to represent its own Contacts.

• When referencing a Contact from another resource, the provider must populate the reference.display with the value held in ‘reasonCode.display’ field of the Contact.

Mandatory fields

The following fields are mandatory:

• status Used to indicate the status of the contact. Here we use the mandated FHIR code system request-status but limit it to the following values, a description of their use is placed in brackets:

active (The Contact becomes active as soon as it is created) completed (The Contact has been actioned/acted upon) cancelled (The Contact was rejected e.g. The contact was made with the wrong organisation) entered-in-error (The Contact was recorded in error)

It is envisaged that most contacts will not use the ‘active’ status as most contacts are recorded and acted upon straight away.

• intent Although this field is not relevant to Social Care, it is mandatory within FHIR, therefore we default its value to ‘plan’.

• subject.patient The person who is the subject of the contact.

• occurrence The date that the contact was made with the organisation.

• authoredOn The date that the contact was recorded on the administration system.

• requesterType This is an Interweave extension created to record the type of person making the contact E.g. relative, person themselves, health professional etc. We have created an extensible Valueset to use here. Please get in touch if there are any requirements for further values to be added.

• reasonCode The reason why the person first made the contact. e.g. Concern for welfare

Must Support fields

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

• type The type of contact being made e.g. Referral to Social Care

• description Narrative around the reason for contact. Please ensure any detail included is appropriate for regional sharing.

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.

• Extension-CareConnect-ReferralRequestMethod-1 The form in which the contact is made e.g. Phone, Letter, Self Referral etc

• Extension-CareConnect-SourceOfReferral-1 The source of the referral request.

• priority Can be used to record the priority for the contact to be acted upon.

• serviceRequested Can be used to record which service was requested.

• context Optional link to an encounter resource. A use case has been identified where it would be useful to link the contact back to a Hospital Encounter record for when a discharge assessment is requested.

• requester Optionally provide the Organization, Organisational Team or Practitioner making the contact. The data provider will need to consider the usefulness of sharing this information and any condider and confidentiality implications.

Discouraged or Removed fields

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

• definition
• basedOn
• replaces
• groupIdentfier
• specialty
• receipient
• reasonReference - Removed to not over complicate the resource, the reasonCode field provides enough information.
• supportingInfo
• note
• relevantHistory

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

This structure is derived from CareConnect-ReferralRequest-1

Name	Flags	Card.	Type	Description & Constraints
ReferralRequest		0..*	CareConnect-ReferralRequest-1	A request for referral or transfer of care
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		1..*	Extension	Extension
requesterType	S	1..1	CodeableConcept	Social Care Requester Type URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareRequesterType Binding: InterweaveSocialCareRequesterType (extensible)
Slices for identifier		0..*	Identifier	Business identifier Slice: Unordered, Open by value:system
identifier:localIdentifier		0..1	Identifier	Business identifier
system	S	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcarecontact-identifier
value	S	1..1	string	The Local socialcarecontact Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
period		0..0
definition		0..0
basedOn		0..0
replaces		0..0
groupIdentifier		0..0
status	S	1..1	code	A mandatory flag to indicate the status of the contact. Binding: Interweave Social Care Contact Status (required)
intent	S	1..1	code	proposal | plan | order Fixed Value: plan
priority		0..1	code	The priority for the contact being acted upon/followed up.
subject	S	1..1	Reference(CareConnectPatient1)	The person which is subject of the contact.
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. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
occurrence[x]	S	1..1	dateTime	The date/time that the contact was made.
authoredOn	S	1..1	dateTime	The date/time that the contact was recorded.
requester
agent		1..1	Reference(Device | CareConnect-Organization-1 | CareConnectPatient1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)	Use agent to provide a reference to the organisation, organisational team or practitioner making the contact.
specialty		0..0
recipient		0..0
reasonCode	S	1..1	CodeableConcept	Reason for referral / transfer of care request Binding: Interweave Social Care Contact Reason (required)
reasonReference		0..0
description	S	0..1	string	Additional narrative around the reason for contact
supportingInfo		0..0
note		0..0
relevantHistory		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
ReferralRequest.status	required	Interweave Social Care Contact Status
ReferralRequest.reasonCode	required	Interweave Social Care Contact Reason (a valid code from InterweaveSocialCareContactReason)

Name	Flags	Card.	Type	Description & Constraints
ReferralRequest		0..*	CareConnect-ReferralRequest-1	A request for referral or transfer of care
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
referralRequestMethod		0..1	CodeableConcept	The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc... URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1 Binding: Care Connect Referral Request Method (required): The form in which a referral is sent and received
sourceOfReferral		0..1	CodeableConcept	This represents the source of referral URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1 Binding: Care Connect Source of Referral (extensible): A classification which identifies the source of referral
requesterType	S	1..1	CodeableConcept	Social Care Requester Type URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareRequesterType Binding: InterweaveSocialCareRequesterType (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Business identifier Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:localIdentifier	Σ	0..1	Identifier	Business 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-socialcarecontact-identifier
value	SΣ	1..1	string	The Local socialcarecontact Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
status	?!SΣ	1..1	code	A mandatory flag to indicate the status of the contact. Binding: Interweave Social Care Contact Status (required)
intent	?!SΣ	1..1	code	proposal | plan | order Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request Fixed Value: plan
priority	Σ	0..1	code	The priority for the contact being acted upon/followed up. Binding: RequestPriority (required): Codes indicating the relative priority of the referral.
subject	SΣ	1..1	Reference(CareConnectPatient1)	The person which is subject of the contact.
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. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
occurrence[x]	SΣ	1..1	dateTime	The date/time that the contact was made.
authoredOn	SΣ	1..1	dateTime	The date/time that the contact was recorded.
reasonCode	SΣ	1..1	CodeableConcept	Reason for referral / transfer of care request Binding: Interweave Social Care Contact Reason (required)
description	S	0..1	string	Additional narrative around the reason for contact
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
ReferralRequest.meta.security	extensible	All Security Labels
ReferralRequest.meta.tag	example	Common Tags
ReferralRequest.meta.tag:Source	example	Common Tags
ReferralRequest.meta.tag:Provenance	example	Common Tags
ReferralRequest.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
ReferralRequest.identifier.use	required	IdentifierUse
ReferralRequest.identifier:localIdentifier.use	required	IdentifierUse
ReferralRequest.groupIdentifier.use	required	IdentifierUse
ReferralRequest.status	required	Interweave Social Care Contact Status
ReferralRequest.intent	required	Fixed Value: plan
ReferralRequest.priority	required	RequestPriority
ReferralRequest.reasonCode	required	Interweave Social Care Contact Reason (a valid code from InterweaveSocialCareContactReason)

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	ReferralRequest	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	ReferralRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ReferralRequest	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	ReferralRequest	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()
ele-1	error	ReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferral	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	ReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferral	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
ReferralRequest		0..*	CareConnect-ReferralRequest-1	A request for referral or transfer of care
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
referralRequestMethod		0..1	CodeableConcept	The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc... URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1 Binding: Care Connect Referral Request Method (required): The form in which a referral is sent and received
sourceOfReferral		0..1	CodeableConcept	This represents the source of referral URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1 Binding: Care Connect Source of Referral (extensible): A classification which identifies the source of referral
requesterType	S	1..1	CodeableConcept	Social Care Requester Type URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareRequesterType Binding: InterweaveSocialCareRequesterType (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Business identifier Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
identifier:localIdentifier	Σ	0..1	Identifier	Business 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-socialcarecontact-identifier
value	SΣ	1..1	string	The Local socialcarecontact Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	A mandatory flag to indicate the status of the contact. Binding: Interweave Social Care Contact Status (required)
intent	?!SΣ	1..1	code	proposal | plan | order Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request Fixed Value: plan
type	Σ	0..1	CodeableConcept	Referral/Transition of care request type Binding: SNOMED CT Patient Referral (example): Codes for types of referral; e.g. consult, transfer, temporary transfer.
priority	Σ	0..1	code	The priority for the contact being acted upon/followed up. Binding: RequestPriority (required): Codes indicating the relative priority of the referral.
serviceRequested	Σ	0..*	CodeableConcept	Actions requested as part of the referral Binding: Practice Setting Code Value Set (example): Codes indicating the types of services that might be requested as part of a referral.
subject	SΣ	1..1	Reference(CareConnectPatient1)	The person which is subject of the contact.
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. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
occurrence[x]	SΣ	1..1	dateTime	The date/time that the contact was made.
authoredOn	SΣ	1..1	dateTime	The date/time that the contact was recorded.
requester	ΣC	0..1	BackboneElement	Who/what is requesting service
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
agent	Σ	1..1	Reference(Device | CareConnect-Organization-1 | CareConnectPatient1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)	Use agent to provide a reference to the organisation, organisational team or practitioner making the contact.
onBehalfOf	ΣC	0..1	Reference(CareConnect-Organization-1)	Organization agent is acting for
reasonCode	SΣ	1..1	CodeableConcept	Reason for referral / transfer of care request Binding: Interweave Social Care Contact Reason (required)
description	S	0..1	string	Additional narrative around the reason for contact
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
ReferralRequest.meta.security	extensible	All Security Labels
ReferralRequest.meta.tag	example	Common Tags
ReferralRequest.meta.tag:Source	example	Common Tags
ReferralRequest.meta.tag:Provenance	example	Common Tags
ReferralRequest.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
ReferralRequest.identifier.use	required	IdentifierUse
ReferralRequest.identifier.type	extensible	Identifier Type Codes
ReferralRequest.identifier:localIdentifier.use	required	IdentifierUse
ReferralRequest.identifier:localIdentifier.type	extensible	Identifier Type Codes
ReferralRequest.groupIdentifier.use	required	IdentifierUse
ReferralRequest.groupIdentifier.type	extensible	Identifier Type Codes
ReferralRequest.status	required	Interweave Social Care Contact Status
ReferralRequest.intent	required	Fixed Value: plan
ReferralRequest.type	example	SNOMED CT Patient Referral
ReferralRequest.priority	required	RequestPriority
ReferralRequest.serviceRequested	example	Practice Setting Code Value Set
ReferralRequest.reasonCode	required	Interweave Social Care Contact Reason (a valid code from InterweaveSocialCareContactReason)

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferral, ReferralRequest.requester	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	ReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferral	Must have either extensions or value[x], not both : extension.exists() != value.exists()
rfr-1	error	ReferralRequest.requester	onBehalfOf can only be specified if agent is practitioner or device : (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()

Differential View

This structure is derived from CareConnect-ReferralRequest-1

Name	Flags	Card.	Type	Description & Constraints
ReferralRequest		0..*	CareConnect-ReferralRequest-1	A request for referral or transfer of care
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		1..*	Extension	Extension
requesterType	S	1..1	CodeableConcept	Social Care Requester Type URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareRequesterType Binding: InterweaveSocialCareRequesterType (extensible)
Slices for identifier		0..*	Identifier	Business identifier Slice: Unordered, Open by value:system
identifier:localIdentifier		0..1	Identifier	Business identifier
system	S	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcarecontact-identifier
value	S	1..1	string	The Local socialcarecontact Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
period		0..0
definition		0..0
basedOn		0..0
replaces		0..0
groupIdentifier		0..0
status	S	1..1	code	A mandatory flag to indicate the status of the contact. Binding: Interweave Social Care Contact Status (required)
intent	S	1..1	code	proposal | plan | order Fixed Value: plan
priority		0..1	code	The priority for the contact being acted upon/followed up.
subject	S	1..1	Reference(CareConnectPatient1)	The person which is subject of the contact.
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. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
occurrence[x]	S	1..1	dateTime	The date/time that the contact was made.
authoredOn	S	1..1	dateTime	The date/time that the contact was recorded.
requester
agent		1..1	Reference(Device | CareConnect-Organization-1 | CareConnectPatient1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)	Use agent to provide a reference to the organisation, organisational team or practitioner making the contact.
specialty		0..0
recipient		0..0
reasonCode	S	1..1	CodeableConcept	Reason for referral / transfer of care request Binding: Interweave Social Care Contact Reason (required)
reasonReference		0..0
description	S	0..1	string	Additional narrative around the reason for contact
supportingInfo		0..0
note		0..0
relevantHistory		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
ReferralRequest.status	required	Interweave Social Care Contact Status
ReferralRequest.reasonCode	required	Interweave Social Care Contact Reason (a valid code from InterweaveSocialCareContactReason)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ReferralRequest		0..*	CareConnect-ReferralRequest-1	A request for referral or transfer of care
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
referralRequestMethod		0..1	CodeableConcept	The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc... URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1 Binding: Care Connect Referral Request Method (required): The form in which a referral is sent and received
sourceOfReferral		0..1	CodeableConcept	This represents the source of referral URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1 Binding: Care Connect Source of Referral (extensible): A classification which identifies the source of referral
requesterType	S	1..1	CodeableConcept	Social Care Requester Type URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareRequesterType Binding: InterweaveSocialCareRequesterType (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Business identifier Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:localIdentifier	Σ	0..1	Identifier	Business 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-socialcarecontact-identifier
value	SΣ	1..1	string	The Local socialcarecontact Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
status	?!SΣ	1..1	code	A mandatory flag to indicate the status of the contact. Binding: Interweave Social Care Contact Status (required)
intent	?!SΣ	1..1	code	proposal | plan | order Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request Fixed Value: plan
priority	Σ	0..1	code	The priority for the contact being acted upon/followed up. Binding: RequestPriority (required): Codes indicating the relative priority of the referral.
subject	SΣ	1..1	Reference(CareConnectPatient1)	The person which is subject of the contact.
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. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
occurrence[x]	SΣ	1..1	dateTime	The date/time that the contact was made.
authoredOn	SΣ	1..1	dateTime	The date/time that the contact was recorded.
reasonCode	SΣ	1..1	CodeableConcept	Reason for referral / transfer of care request Binding: Interweave Social Care Contact Reason (required)
description	S	0..1	string	Additional narrative around the reason for contact
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
ReferralRequest.meta.security	extensible	All Security Labels
ReferralRequest.meta.tag	example	Common Tags
ReferralRequest.meta.tag:Source	example	Common Tags
ReferralRequest.meta.tag:Provenance	example	Common Tags
ReferralRequest.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
ReferralRequest.identifier.use	required	IdentifierUse
ReferralRequest.identifier:localIdentifier.use	required	IdentifierUse
ReferralRequest.groupIdentifier.use	required	IdentifierUse
ReferralRequest.status	required	Interweave Social Care Contact Status
ReferralRequest.intent	required	Fixed Value: plan
ReferralRequest.priority	required	RequestPriority
ReferralRequest.reasonCode	required	Interweave Social Care Contact Reason (a valid code from InterweaveSocialCareContactReason)

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	ReferralRequest	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	ReferralRequest	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ReferralRequest	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	ReferralRequest	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()
ele-1	error	ReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferral	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	ReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferral	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ReferralRequest		0..*	CareConnect-ReferralRequest-1	A request for referral or transfer of care
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
referralRequestMethod		0..1	CodeableConcept	The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc... URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1 Binding: Care Connect Referral Request Method (required): The form in which a referral is sent and received
sourceOfReferral		0..1	CodeableConcept	This represents the source of referral URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1 Binding: Care Connect Source of Referral (extensible): A classification which identifies the source of referral
requesterType	S	1..1	CodeableConcept	Social Care Requester Type URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareRequesterType Binding: InterweaveSocialCareRequesterType (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Business identifier Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
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	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
identifier:localIdentifier	Σ	0..1	Identifier	Business 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-socialcarecontact-identifier
value	SΣ	1..1	string	The Local socialcarecontact Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	A mandatory flag to indicate the status of the contact. Binding: Interweave Social Care Contact Status (required)
intent	?!SΣ	1..1	code	proposal | plan | order Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request Fixed Value: plan
type	Σ	0..1	CodeableConcept	Referral/Transition of care request type Binding: SNOMED CT Patient Referral (example): Codes for types of referral; e.g. consult, transfer, temporary transfer.
priority	Σ	0..1	code	The priority for the contact being acted upon/followed up. Binding: RequestPriority (required): Codes indicating the relative priority of the referral.
serviceRequested	Σ	0..*	CodeableConcept	Actions requested as part of the referral Binding: Practice Setting Code Value Set (example): Codes indicating the types of services that might be requested as part of a referral.
subject	SΣ	1..1	Reference(CareConnectPatient1)	The person which is subject of the contact.
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. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
occurrence[x]	SΣ	1..1	dateTime	The date/time that the contact was made.
authoredOn	SΣ	1..1	dateTime	The date/time that the contact was recorded.
requester	ΣC	0..1	BackboneElement	Who/what is requesting service
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
agent	Σ	1..1	Reference(Device | CareConnect-Organization-1 | CareConnectPatient1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)	Use agent to provide a reference to the organisation, organisational team or practitioner making the contact.
onBehalfOf	ΣC	0..1	Reference(CareConnect-Organization-1)	Organization agent is acting for
reasonCode	SΣ	1..1	CodeableConcept	Reason for referral / transfer of care request Binding: Interweave Social Care Contact Reason (required)
description	S	0..1	string	Additional narrative around the reason for contact
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
ReferralRequest.meta.security	extensible	All Security Labels
ReferralRequest.meta.tag	example	Common Tags
ReferralRequest.meta.tag:Source	example	Common Tags
ReferralRequest.meta.tag:Provenance	example	Common Tags
ReferralRequest.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
ReferralRequest.identifier.use	required	IdentifierUse
ReferralRequest.identifier.type	extensible	Identifier Type Codes
ReferralRequest.identifier:localIdentifier.use	required	IdentifierUse
ReferralRequest.identifier:localIdentifier.type	extensible	Identifier Type Codes
ReferralRequest.groupIdentifier.use	required	IdentifierUse
ReferralRequest.groupIdentifier.type	extensible	Identifier Type Codes
ReferralRequest.status	required	Interweave Social Care Contact Status
ReferralRequest.intent	required	Fixed Value: plan
ReferralRequest.type	example	SNOMED CT Patient Referral
ReferralRequest.priority	required	RequestPriority
ReferralRequest.serviceRequested	example	Practice Setting Code Value Set
ReferralRequest.reasonCode	required	Interweave Social Care Contact Reason (a valid code from InterweaveSocialCareContactReason)

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferral, ReferralRequest.requester	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	ReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferral	Must have either extensions or value[x], not both : extension.exists() != value.exists()
rfr-1	error	ReferralRequest.requester	onBehalfOf can only be specified if agent is practitioner or device : (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()

This structure is derived from CareConnect-ReferralRequest-1

Summary

Mandatory: 7 elements (6 nested mandatory elements)
Must-Support: 20 elements
Fixed Value: 4 elements
Prohibited: 11 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)

Extensions

This structure refers to these extensions:

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

Slices

This structure defines the following Slices:

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