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 - Detailed Descriptions

Active as of 2024-04-19

Definitions for the Interweave-SocialCareContact resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. ReferralRequest
2. ReferralRequest.id
Must Supporttrue
3. ReferralRequest.meta
Control0..?
4. ReferralRequest.meta.versionId
Control0..?
Must Supporttrue
5. ReferralRequest.meta.lastUpdated
Control0..?
Must Supporttrue
6. ReferralRequest.meta.profile
Control0..?
Must Supporttrue
7. ReferralRequest.meta.security
Control0..?
8. ReferralRequest.meta.tag
Control0..?
SlicingThis element introduces a set of slices on ReferralRequest.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
9. ReferralRequest.meta.tag:Source
SliceNameSource
Control0..1
Must Supporttrue
10. ReferralRequest.meta.tag:Source.system
Control1..?
Fixed Valuehttps://yhcr.nhs.uk/Source
11. ReferralRequest.meta.tag:Source.code
Control1..?
Must Supporttrue
12. ReferralRequest.meta.tag:Source.display
Control1..?
Must Supporttrue
13. ReferralRequest.meta.tag:Provenance
SliceNameProvenance
Control0..1
Must Supporttrue
14. ReferralRequest.meta.tag:Provenance.system
Control1..?
Fixed Valuehttps://yhcr.nhs.uk/Provenance
15. ReferralRequest.meta.tag:Provenance.code
Control1..?
Must Supporttrue
16. ReferralRequest.meta.tag:Provenance.display
Control1..?
Must Supporttrue
17. ReferralRequest.implicitRules
18. ReferralRequest.language
19. ReferralRequest.text
20. ReferralRequest.extension
Control10..*
21. ReferralRequest.extension:requesterType
SliceNamerequesterType
Control1..1
TypeExtension(ExtensionInterweaveSocialCareRequesterType) (Extension Type: CodeableConcept)
Must Supporttrue
22. ReferralRequest.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
SlicingThis element introduces a set of slices on ReferralRequest.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
23. ReferralRequest.identifier:localIdentifier
SliceNamelocalIdentifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
24. ReferralRequest.identifier:localIdentifier.system
Control0..?
Must Supporttrue
Fixed Valuehttps://fhir.yhcr.nhs.uk/Id/local-socialcarecontact-identifier
25. ReferralRequest.identifier:localIdentifier.value
Control0..?
Must Supporttrue
26. ReferralRequest.identifier:localIdentifier.period
Control0..0
27. ReferralRequest.definition
Control0..0*
28. ReferralRequest.basedOn
Control0..0*
29. ReferralRequest.replaces
Control0..0*
30. ReferralRequest.groupIdentifier
Control0..01
31. ReferralRequest.status
BindingThe codes SHALL be taken from Interweave Social Care Contact StatusThe codes SHALL be taken from RequestStatus
Must Supporttrue
32. ReferralRequest.intent
Must Supporttrue
Fixed Valueplan
33. ReferralRequest.priority
34. ReferralRequest.subject
TypeReference(CareConnectPatient1|Group)
Must Supporttrue
35. ReferralRequest.subject.reference
Control1..?
36. ReferralRequest.subject.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..?
37. ReferralRequest.subject.display
Control1..?
38. ReferralRequest.context
TypeReference(CareConnect-Encounter-1|CareConnect-EpisodeOfCare-1)
39. ReferralRequest.occurrence[x]
Control10..1
TypeChoice of: , Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
40. ReferralRequest.authoredOn
Control10..1
Must Supporttrue
41. ReferralRequest.requester
Control0..?
42. ReferralRequest.requester.agent
43. ReferralRequest.specialty
Control0..01
44. ReferralRequest.recipient
Control0..0*
45. ReferralRequest.reasonCode
Control10..1*
BindingThe codes SHALL be taken from Interweave Social Care Contact ReasonFor example codes, see SNOMED CT Clinical Findings
Must Supporttrue
46. ReferralRequest.reasonReference
Control0..0*
47. ReferralRequest.description
Must Supporttrue
48. ReferralRequest.supportingInfo
Control0..0*
49. ReferralRequest.note
Control0..0*
50. ReferralRequest.relevantHistory
Control0..0*

Guidance on how to interpret the contents of this table can be found here.

1. ReferralRequest
Definition

Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.

Control0..*
Alternate NamesReferralRequest TransferOfCare Request
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: 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: 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())
2. ReferralRequest.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Must Supporttrue
Summarytrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. ReferralRequest.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Summarytrue
4. ReferralRequest.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Must Supporttrue
Summarytrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

5. ReferralRequest.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Must Supporttrue
Summarytrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

6. ReferralRequest.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control0..*
Typeuri
Must Supporttrue
Summarytrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

7. ReferralRequest.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable

Security Labels from the Healthcare Privacy and Security Classification System.

TypeCoding
Summarytrue
Comments

The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

8. ReferralRequest.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
BindingFor example codes, see Common Tags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

SlicingThis element introduces a set of slices on ReferralRequest.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
9. ReferralRequest.meta.tag:Source
SliceNameSource
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1*
BindingFor example codes, see Common Tags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

10. ReferralRequest.meta.tag:Source.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttps://yhcr.nhs.uk/Source
11. ReferralRequest.meta.tag:Source.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control10..1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

12. ReferralRequest.meta.tag:Source.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control10..1
Typestring
Must Supporttrue
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

13. ReferralRequest.meta.tag:Provenance
SliceNameProvenance
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1*
BindingFor example codes, see Common Tags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

14. ReferralRequest.meta.tag:Provenance.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttps://yhcr.nhs.uk/Provenance
15. ReferralRequest.meta.tag:Provenance.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control10..1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

16. ReferralRequest.meta.tag:Provenance.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control10..1
Typestring
Must Supporttrue
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

17. ReferralRequest.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

18. ReferralRequest.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

19. ReferralRequest.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

20. ReferralRequest.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control10..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on ReferralRequest.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
21. ReferralRequest.extension:referralRequestMethod
SliceNamereferralRequestMethod
Definition

The method used to send or receive a Referral Request.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-ReferralRequestMethod-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
22. ReferralRequest.extension:sourceOfReferral
SliceNamesourceOfReferral
Definition

The source of referral for a Referral Request.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-SourceOfReferral-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
23. ReferralRequest.extension:requesterType
SliceNamerequesterType
Definition

Social Care Support Requester: The type of person who has either placed a request or made contact with social care

Control1..1
TypeExtension(ExtensionInterweaveSocialCareRequesterType) (Extension Type: CodeableConcept)
Must Supporttrue
24. ReferralRequest.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

25. ReferralRequest.identifier
Definition

Business identifier that uniquely identifies the referral/care transfer request instance.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
SlicingThis element introduces a set of slices on ReferralRequest.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
26. ReferralRequest.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

27. ReferralRequest.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control10..1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example
General:http://www.acme.com/identifiers/patient
28. ReferralRequest.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control10..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
29. ReferralRequest.identifier:localIdentifier
SliceNamelocalIdentifier
Definition

Business identifier that uniquely identifies the referral/care transfer request instance.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier
Summarytrue
30. ReferralRequest.identifier:localIdentifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

31. ReferralRequest.identifier:localIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control10..1
Typeuri
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttps://fhir.yhcr.nhs.uk/Id/local-socialcarecontact-identifier
Example
General:http://www.acme.com/identifiers/patient
32. ReferralRequest.identifier:localIdentifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control10..1
Typestring
Must Supporttrue
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
33. ReferralRequest.identifier:localIdentifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..01
TypePeriod
Summarytrue
34. ReferralRequest.definition
Definition

A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

Control0..0*
TypeReference(ActivityDefinition|PlanDefinition)
Summarytrue
35. ReferralRequest.basedOn
Definition

Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.

Control0..0*
TypeReference(CareConnect-CarePlan-1|CareConnect-ProcedureRequest-1|CareConnect-ReferralRequest-1|ReferralRequest|CarePlan|ProcedureRequest)
Summarytrue
Alternate Namesfulfills
36. ReferralRequest.replaces
Definition

Completed or terminated request(s) whose function is taken by this new request.

Control0..0*
TypeReference(CareConnect-ReferralRequest-1|ReferralRequest)
Summarytrue
Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.

Alternate Namessupersedes, prior, renewed order
Comments

The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.

37. ReferralRequest.groupIdentifier
Definition

The business identifier of the logical "grouping" request/order that this referral is a part of.

Control0..01
TypeIdentifier
Summarytrue
Requirements

Allows multiple orders to be collected as part of a single requisition.

Alternate NamesgrouperId, requisition
38. ReferralRequest.status
Definition

The status of the authorization/intention reflected by the referral request record.

Control1..1
BindingThe codes SHALL be taken from Interweave Social Care Contact StatusThe codes SHALL be taken from RequestStatus
Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
Requirements

Workflow status is handled by the Task resource.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

39. ReferralRequest.intent
Definition

Distinguishes the "level" of authorization/demand implicit in this request.

Control1..1
BindingThe codes SHALL be taken from RequestIntent

Codes identifying the stage lifecycle stage of a request

Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
Requirements

The same resource structure is used when capturing proposals/recommendations, plans and actual requests.

Alternate Namescategory
Fixed Valueplan
40. ReferralRequest.priority
Definition

An indication of the urgency of referral (or where applicable the type of transfer of care) request.

Control0..1
BindingThe codes SHALL be taken from RequestPriority

Codes indicating the relative priority of the referral.

Typecode
Summarytrue
41. ReferralRequest.subject
Definition

The patient who is the subject of a referral or transfer of care request.

Control1..1
TypeReference(CareConnectPatient1|Patient|Group)
Must Supporttrue
Summarytrue
Comments

Referral of family, group or community is to be catered for by profiles.

42. ReferralRequest.subject.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control10..1 This element is affected by the following invariants: ref-1
Typestring
Summarytrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

43. ReferralRequest.subject.identifier
Definition

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

44. ReferralRequest.subject.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control10..1
Typestring
Summarytrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

45. ReferralRequest.context
Definition

The encounter at which the request for referral or transfer of care is initiated.

Control0..1
TypeReference(CareConnect-Encounter-1|Encounter|EpisodeOfCare)
Summarytrue
Alternate Namesencounter
46. ReferralRequest.occurrence[x]
Definition

The period of time within which the services identified in the referral/transfer of care is specified or required to occur.

Control10..1
TypeChoice of: dateTime, Period
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Summarytrue
Requirements

Use cases: (1) to indicate that the requested service is not to happen before a specified date, and saving the start date in Period.start; (2) to indicate that the requested service must happen before a specified date, and saving the end date in Period.end; (3) to indicate that the requested service must happen during the specified dates ("start" and "end" values).

Alternate Namestiming
Comments

When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date.

47. ReferralRequest.authoredOn
Definition

Date/DateTime of creation for draft requests and date of activation for active requests.

Control10..1
TypedateTime
Must Supporttrue
Summarytrue
Alternate NamescreatedOn
48. ReferralRequest.specialty
Definition

Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.

Control0..01
BindingFor example codes, see PractitionerSpecialty

Codes indicating the types of capability the referred to service provider must have.

TypeCodeableConcept
49. ReferralRequest.recipient
Definition

The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.

Control0..0*
TypeReference(CareConnect-Organization-1|CareConnect-Practitioner-1|CareConnect-HealthcareService-1|Practitioner|Organization|HealthcareService)
Summarytrue
Comments

There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations.

50. ReferralRequest.reasonCode
Definition

Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.

Control10..1*
BindingThe codes SHALL be taken from Interweave Social Care Contact ReasonFor example codes, see SNOMED CT Clinical Findings
TypeCodeableConcept
Must Supporttrue
Summarytrue
51. ReferralRequest.reasonReference
Definition

Indicates another resource whose existence justifies this request.

Control0..0*
TypeReference(CareConnect-Condition-1|CareConnect-Observation-1|Condition|Observation)
Summarytrue
52. ReferralRequest.description
Definition

The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.

Control0..1
Typestring
Must Supporttrue
53. ReferralRequest.supportingInfo
Definition

Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.

Control0..0*
TypeReference(Resource)
54. ReferralRequest.note
Definition

Comments made about the referral request by any of the participants.

Control0..0*
TypeAnnotation
55. ReferralRequest.relevantHistory
Definition

Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Control0..0*
TypeReference(Provenance)
Alternate NameseventHistory
Comments

This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.

Guidance on how to interpret the contents of this table can be found here.

1. ReferralRequest
Definition

Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.

Control0..*
Alternate NamesReferralRequest TransferOfCare Request
2. ReferralRequest.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Must Supporttrue
Summarytrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. ReferralRequest.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Summarytrue
4. ReferralRequest.meta.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
5. ReferralRequest.meta.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on ReferralRequest.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. ReferralRequest.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Must Supporttrue
Summarytrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

7. ReferralRequest.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Must Supporttrue
Summarytrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

8. ReferralRequest.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control0..*
Typeuri
Must Supporttrue
Summarytrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

9. ReferralRequest.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System
TypeCoding
Summarytrue
Comments

The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

10. ReferralRequest.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
BindingFor example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones
TypeCoding
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

SlicingThis element introduces a set of slices on ReferralRequest.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
11. ReferralRequest.meta.tag:Source
SliceNameSource
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1
BindingFor example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones
TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

12. ReferralRequest.meta.tag:Source.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. ReferralRequest.meta.tag:Source.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on ReferralRequest.meta.tag.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
14. ReferralRequest.meta.tag:Source.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttps://yhcr.nhs.uk/Source
15. ReferralRequest.meta.tag:Source.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

16. ReferralRequest.meta.tag:Source.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

17. ReferralRequest.meta.tag:Source.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
Typestring
Must Supporttrue
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

18. ReferralRequest.meta.tag:Source.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

19. ReferralRequest.meta.tag:Provenance
SliceNameProvenance
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1
BindingFor example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones
TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

20. ReferralRequest.meta.tag:Provenance.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
21. ReferralRequest.meta.tag:Provenance.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on ReferralRequest.meta.tag.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
22. ReferralRequest.meta.tag:Provenance.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttps://yhcr.nhs.uk/Provenance
23. ReferralRequest.meta.tag:Provenance.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

24. ReferralRequest.meta.tag:Provenance.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

25. ReferralRequest.meta.tag:Provenance.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
Typestring
Must Supporttrue
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

26. ReferralRequest.meta.tag:Provenance.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

27. ReferralRequest.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

28. ReferralRequest.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

29. ReferralRequest.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

30. ReferralRequest.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

31. ReferralRequest.extension
Definition

An Extension

Control1..*
TypeExtension
SlicingThis element introduces a set of slices on ReferralRequest.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
32. ReferralRequest.extension:referralRequestMethod
SliceNamereferralRequestMethod
Definition

The method used to send or receive a Referral Request.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-ReferralRequestMethod-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
33. ReferralRequest.extension:sourceOfReferral
SliceNamesourceOfReferral
Definition

The source of referral for a Referral Request.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-SourceOfReferral-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
34. ReferralRequest.extension:requesterType
SliceNamerequesterType
Definition

Social Care Support Requester: The type of person who has either placed a request or made contact with social care

Control1..1
TypeExtension(ExtensionInterweaveSocialCareRequesterType) (Extension Type: CodeableConcept)
Must Supporttrue
35. ReferralRequest.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

36. ReferralRequest.identifier
Definition

Business identifier that uniquely identifies the referral/care transfer request instance.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
SlicingThis element introduces a set of slices on ReferralRequest.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
37. ReferralRequest.identifier.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
38. ReferralRequest.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on ReferralRequest.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
39. ReferralRequest.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

40. ReferralRequest.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

41. ReferralRequest.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example
General:http://www.acme.com/identifiers/patient
42. ReferralRequest.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
43. ReferralRequest.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Summarytrue
44. ReferralRequest.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

45. ReferralRequest.identifier:localIdentifier
SliceNamelocalIdentifier
Definition

Business identifier that uniquely identifies the referral/care transfer request instance.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
46. ReferralRequest.identifier:localIdentifier.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
47. ReferralRequest.identifier:localIdentifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on ReferralRequest.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
48. ReferralRequest.identifier:localIdentifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

49. ReferralRequest.identifier:localIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

50. ReferralRequest.identifier:localIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Must Supporttrue
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttps://fhir.yhcr.nhs.uk/Id/local-socialcarecontact-identifier
Example
General:http://www.acme.com/identifiers/patient
51. ReferralRequest.identifier:localIdentifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Must Supporttrue
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
52. ReferralRequest.identifier:localIdentifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..0
TypePeriod
Summarytrue
53. ReferralRequest.identifier:localIdentifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

54. ReferralRequest.definition
Definition

A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

Control0..0
TypeReference(ActivityDefinition|PlanDefinition)
Summarytrue
55. ReferralRequest.basedOn
Definition

Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.

Control0..0
TypeReference(CareConnect-CarePlan-1|CareConnect-ProcedureRequest-1|CareConnect-ReferralRequest-1)
Summarytrue
Alternate Namesfulfills
56. ReferralRequest.replaces
Definition

Completed or terminated request(s) whose function is taken by this new request.

Control0..0
TypeReference(CareConnect-ReferralRequest-1)
Summarytrue
Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.

Alternate Namessupersedes, prior, renewed order
Comments

The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.

57. ReferralRequest.groupIdentifier
Definition

The business identifier of the logical "grouping" request/order that this referral is a part of.

Control0..0
TypeIdentifier
Summarytrue
Requirements

Allows multiple orders to be collected as part of a single requisition.

Alternate NamesgrouperId, requisition
58. ReferralRequest.status
Definition

The status of the authorization/intention reflected by the referral request record.

Control1..1
BindingThe codes SHALL be taken from Interweave Social Care Contact Status
Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
Requirements

Workflow status is handled by the Task resource.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

59. ReferralRequest.intent
Definition

Distinguishes the "level" of authorization/demand implicit in this request.

Control1..1
BindingThe codes SHALL be taken from RequestIntent Codes identifying the stage lifecycle stage of a reques
Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
Requirements

The same resource structure is used when capturing proposals/recommendations, plans and actual requests.

Alternate Namescategory
Fixed Valueplan
60. ReferralRequest.type
Definition

An indication of the type of referral (or where applicable the type of transfer of care) request.

Control0..1
BindingFor example codes, see SNOMED CT Patient Referral Codes for types of referral; e.g. consult, transfer, temporary transfer
TypeCodeableConcept
Summarytrue
61. ReferralRequest.priority
Definition

An indication of the urgency of referral (or where applicable the type of transfer of care) request.

Control0..1
BindingThe codes SHALL be taken from RequestPriority Codes indicating the relative priority of the referral
Typecode
Summarytrue
62. ReferralRequest.serviceRequested
Definition

The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.

Control0..*
BindingFor example codes, see Practice Setting Code Value Set Codes indicating the types of services that might be requested as part of a referral
TypeCodeableConcept
Summarytrue
63. ReferralRequest.subject
Definition

The patient who is the subject of a referral or transfer of care request.

Control1..1
TypeReference(CareConnectPatient1)
Must Supporttrue
Summarytrue
Comments

Referral of family, group or community is to be catered for by profiles.

64. ReferralRequest.subject.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
65. ReferralRequest.subject.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on ReferralRequest.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
66. ReferralRequest.subject.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 This element is affected by the following invariants: ref-1
Typestring
Summarytrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

67. ReferralRequest.subject.identifier
Definition

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

68. ReferralRequest.subject.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control1..1
Typestring
Summarytrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

69. ReferralRequest.context
Definition

The encounter at which the request for referral or transfer of care is initiated.

Control0..1
TypeReference(CareConnect-Encounter-1)
Summarytrue
Alternate Namesencounter
70. ReferralRequest.occurrence[x]
Definition

The period of time within which the services identified in the referral/transfer of care is specified or required to occur.

Control1..1
TypedateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Summarytrue
Requirements

Use cases: (1) to indicate that the requested service is not to happen before a specified date, and saving the start date in Period.start; (2) to indicate that the requested service must happen before a specified date, and saving the end date in Period.end; (3) to indicate that the requested service must happen during the specified dates ("start" and "end" values).

Alternate Namestiming
Comments

When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date.

71. ReferralRequest.authoredOn
Definition

Date/DateTime of creation for draft requests and date of activation for active requests.

Control1..1
TypedateTime
Must Supporttrue
Summarytrue
Alternate NamescreatedOn
72. ReferralRequest.requester
Definition

The individual who initiated the request and has responsibility for its activation.

Control0..1
TypeBackboneElement
Summarytrue
Alternate Namesauthor
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
rfr-1: onBehalfOf can only be specified if agent is practitioner or device (: (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not())
73. ReferralRequest.requester.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
74. ReferralRequest.requester.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

75. ReferralRequest.requester.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

76. ReferralRequest.requester.agent
Definition

The device, practitioner, etc. who initiated the request.

Control1..1
TypeReference(Device|CareConnect-Organization-1|CareConnectPatient1|CareConnect-RelatedPerson-1|CareConnect-Practitioner-1)
Summarytrue
77. ReferralRequest.requester.onBehalfOf
Definition

The organization the device or practitioner was acting on behalf of.

Control0..1 This element is affected by the following invariants: rfr-1
TypeReference(CareConnect-Organization-1)
Summarytrue
Requirements

Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.

78. ReferralRequest.specialty
Definition

Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.

Control0..0
BindingFor example codes, see PractitionerSpecialty Codes indicating the types of capability the referred to service provider must have
TypeCodeableConcept
79. ReferralRequest.recipient
Definition

The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.

Control0..0
TypeReference(CareConnect-Organization-1|CareConnect-Practitioner-1|CareConnect-HealthcareService-1)
Summarytrue
Comments

There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations.

80. ReferralRequest.reasonCode
Definition

Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.

Control1..1
BindingThe codes SHALL be taken from Interweave Social Care Contact Reason
TypeCodeableConcept
Must Supporttrue
Summarytrue
81. ReferralRequest.reasonReference
Definition

Indicates another resource whose existence justifies this request.

Control0..0
TypeReference(CareConnect-Condition-1|CareConnect-Observation-1)
Summarytrue
82. ReferralRequest.description
Definition

The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.

Control0..1
Typestring
Must Supporttrue
83. ReferralRequest.supportingInfo
Definition

Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.

Control0..0
TypeReference(Resource)
84. ReferralRequest.note
Definition

Comments made about the referral request by any of the participants.

Control0..0
TypeAnnotation
85. ReferralRequest.relevantHistory
Definition

Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Control0..0
TypeReference(Provenance)
Alternate NameseventHistory
Comments

This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.