Interweave Implementation Guide
0.1.0 - ci-build

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

Resource Profile: InterweaveSocialCareContact

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

Interweave Social Care Contact resource profile (modelled using FHIR ReferralRequest) - DRAFT

  Status: DRAFT: Work in Progress

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

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

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:

Extensions

This structure refers to these extensions:

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

This structure is derived from CareConnect-ReferralRequest-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest 0..*CareConnect-ReferralRequest-1A request for referral or transfer of care
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... language 0..1codeEnglish is assumed (not currently a multi-lingual implementation)
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension 1..*ExtensionExtension
... Extension-Interweave-SocialCareRequesterType S1..1CodeableConceptSocial Care Requester Type
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareRequesterType
Binding: InterweaveSocialCareRequesterType (extensible)
... Slices for identifier 0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierBusiness identifier
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcarecontact-identifier
..... value S1..1stringThe 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 S1..1codeA mandatory flag to indicate the status of the contact.
Binding: Interweave Social Care Contact Status (required)
... intent S1..1codeproposal | plan | order
Fixed Value: plan
... priority 0..1codeThe priority for the contact being acted upon/followed up.
... subject S1..1Reference(CareConnect-Patient-1)The person which is subject of the contact.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... context 0..1Reference(CareConnect-Encounter-1)Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] S1..1dateTimeThe date/time that the contact was made.
... authoredOn S1..1dateTimeThe date/time that the contact was recorded.
... requester
.... agent 1..1Reference(Device | CareConnect-Organization-1 | CareConnect-Patient-1 | 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 S1..1CodeableConceptReason for referral / transfer of care request
Binding: Interweave Social Care Contact Reason (required)
... reasonReference 0..0
... description S0..1stringAdditional narrative around the reason for contact
... supportingInfo 0..0
... note 0..0
... relevantHistory 0..0

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


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


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


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


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... Extension-CareConnect-ReferralRequestMethod-1 0..1CodeableConceptThe 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


... Extension-CareConnect-SourceOfReferral-1 0..1CodeableConceptThis 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


... Extension-Interweave-SocialCareRequesterType S1..1CodeableConceptSocial Care Requester Type
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareRequesterType
Binding: InterweaveSocialCareRequesterType (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

..... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:localIdentifier Σ0..1IdentifierBusiness identifier
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcarecontact-identifier
..... value SΣ1..1stringThe Local socialcarecontact Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!SΣ1..1codeA mandatory flag to indicate the status of the contact.
Binding: Interweave Social Care Contact Status (required)
... intent ?!SΣ1..1codeproposal | plan | order
Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request


Fixed Value: plan
... type Σ0..1CodeableConceptReferral/Transition of care request type
Binding: SNOMED CT Patient Referral (example): Codes for types of referral; e.g. consult, transfer, temporary transfer.

... priority Σ0..1codeThe priority for the contact being acted upon/followed up.
Binding: RequestPriority (required): Codes indicating the relative priority of the referral.

... serviceRequested Σ0..*CodeableConceptActions 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..1Reference(CareConnect-Patient-1)The person which is subject of the contact.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... context Σ0..1Reference(CareConnect-Encounter-1)Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] SΣ1..1dateTimeThe date/time that the contact was made.
... authoredOn SΣ1..1dateTimeThe date/time that the contact was recorded.
... requester ΣI0..1BackboneElementWho/what is requesting service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent Σ1..1Reference(Device | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)Use agent to provide a reference to the organisation, organisational team or practitioner making the contact.
.... onBehalfOf ΣI0..1Reference(CareConnect-Organization-1)Organization agent is acting for
... reasonCode SΣ1..1CodeableConceptReason for referral / transfer of care request
Binding: Interweave Social Care Contact Reason (required)
... description S0..1stringAdditional narrative around the reason for contact

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


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


..... code Σ1..1codeThe ODS Code of the organisation responsible for the data
..... display Σ1..1stringName of the organisation supplying the data
... Extension-Interweave-SocialCareRequesterType 1..1CodeableConceptSocial Care Requester Type
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareRequesterType
Binding: InterweaveSocialCareRequesterType (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcarecontact-identifier
.... value Σ1..1stringThe Local socialcarecontact Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
... status ?!Σ1..1codeA mandatory flag to indicate the status of the contact.
Binding: Interweave Social Care Contact Status (required)
... intent ?!Σ1..1codeproposal | plan | order
Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request


Fixed Value: plan
... subject Σ1..1Reference(CareConnect-Patient-1)The person which is subject of the contact.
... occurrence[x] Σ1..1dateTimeThe date/time that the contact was made.
... authoredOn Σ1..1dateTimeThe date/time that the contact was recorded.
... reasonCode Σ1..1CodeableConceptReason for referral / transfer of care request
Binding: Interweave Social Care Contact Reason (required)
... description 0..1stringAdditional narrative around the reason for contact

doco Documentation for this format

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:

Extensions

This structure refers to these extensions:

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

Differential View

This structure is derived from CareConnect-ReferralRequest-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest 0..*CareConnect-ReferralRequest-1A request for referral or transfer of care
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... language 0..1codeEnglish is assumed (not currently a multi-lingual implementation)
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension 1..*ExtensionExtension
... Extension-Interweave-SocialCareRequesterType S1..1CodeableConceptSocial Care Requester Type
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareRequesterType
Binding: InterweaveSocialCareRequesterType (extensible)
... Slices for identifier 0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierBusiness identifier
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcarecontact-identifier
..... value S1..1stringThe 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 S1..1codeA mandatory flag to indicate the status of the contact.
Binding: Interweave Social Care Contact Status (required)
... intent S1..1codeproposal | plan | order
Fixed Value: plan
... priority 0..1codeThe priority for the contact being acted upon/followed up.
... subject S1..1Reference(CareConnect-Patient-1)The person which is subject of the contact.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... context 0..1Reference(CareConnect-Encounter-1)Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] S1..1dateTimeThe date/time that the contact was made.
... authoredOn S1..1dateTimeThe date/time that the contact was recorded.
... requester
.... agent 1..1Reference(Device | CareConnect-Organization-1 | CareConnect-Patient-1 | 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 S1..1CodeableConceptReason for referral / transfer of care request
Binding: Interweave Social Care Contact Reason (required)
... reasonReference 0..0
... description S0..1stringAdditional narrative around the reason for contact
... supportingInfo 0..0
... note 0..0
... relevantHistory 0..0

doco Documentation for this format

Snapshot View

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


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


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


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


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... Extension-CareConnect-ReferralRequestMethod-1 0..1CodeableConceptThe 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


... Extension-CareConnect-SourceOfReferral-1 0..1CodeableConceptThis 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


... Extension-Interweave-SocialCareRequesterType S1..1CodeableConceptSocial Care Requester Type
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareRequesterType
Binding: InterweaveSocialCareRequesterType (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

..... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:localIdentifier Σ0..1IdentifierBusiness identifier
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-socialcarecontact-identifier
..... value SΣ1..1stringThe Local socialcarecontact Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!SΣ1..1codeA mandatory flag to indicate the status of the contact.
Binding: Interweave Social Care Contact Status (required)
... intent ?!SΣ1..1codeproposal | plan | order
Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request


Fixed Value: plan
... type Σ0..1CodeableConceptReferral/Transition of care request type
Binding: SNOMED CT Patient Referral (example): Codes for types of referral; e.g. consult, transfer, temporary transfer.

... priority Σ0..1codeThe priority for the contact being acted upon/followed up.
Binding: RequestPriority (required): Codes indicating the relative priority of the referral.

... serviceRequested Σ0..*CodeableConceptActions 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..1Reference(CareConnect-Patient-1)The person which is subject of the contact.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... context Σ0..1Reference(CareConnect-Encounter-1)Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] SΣ1..1dateTimeThe date/time that the contact was made.
... authoredOn SΣ1..1dateTimeThe date/time that the contact was recorded.
... requester ΣI0..1BackboneElementWho/what is requesting service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent Σ1..1Reference(Device | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)Use agent to provide a reference to the organisation, organisational team or practitioner making the contact.
.... onBehalfOf ΣI0..1Reference(CareConnect-Organization-1)Organization agent is acting for
... reasonCode SΣ1..1CodeableConceptReason for referral / transfer of care request
Binding: Interweave Social Care Contact Reason (required)
... description S0..1stringAdditional narrative around the reason for contact

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
ReferralRequest.meta.securityextensibleAll Security Labels
ReferralRequest.meta.tagexampleCommon Tags
ReferralRequest.meta.tag:SourceexampleCommon Tags
ReferralRequest.meta.tag:ProvenanceexampleCommon Tags
ReferralRequest.languageextensibleCommon Languages
Max Binding: All Languages
ReferralRequest.identifier.userequiredIdentifierUse
ReferralRequest.identifier.typeextensibleIdentifier Type Codes
ReferralRequest.identifier:localIdentifier.userequiredIdentifierUse
ReferralRequest.identifier:localIdentifier.typeextensibleIdentifier Type Codes
ReferralRequest.groupIdentifier.userequiredIdentifierUse
ReferralRequest.groupIdentifier.typeextensibleIdentifier Type Codes
ReferralRequest.statusrequiredInterweave Social Care Contact Status
ReferralRequest.intentrequiredFixed Value: plan
ReferralRequest.typeexampleSNOMED CT Patient Referral
ReferralRequest.priorityrequiredRequestPriority
ReferralRequest.serviceRequestedexamplePractice Setting Code Value Set
ReferralRequest.reasonCoderequiredInterweave Social Care Contact Reason

Constraints

IdGradePathDetailsRequirements
dom-2errorReferralRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1errorReferralRequestIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4errorReferralRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3errorReferralRequestIf 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()
ele-1errorReferralRequest.extension:referralRequestMethodAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorReferralRequest.extension:referralRequestMethodMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorReferralRequest.extension:sourceOfReferralAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorReferralRequest.extension:sourceOfReferralMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorReferralRequest.requesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
rfr-1errorReferralRequest.requesteronBehalfOf can only be specified if agent is practitioner or device
: (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()