Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
Active as of 2024-07-17 |
Definitions for the Interweave-ReferralRequest resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. ReferralRequest | |
2. ReferralRequest.id | |
Must Support | true |
3. ReferralRequest.meta | |
Control | 0..? |
4. ReferralRequest.meta.versionId | |
Control | 0..? |
Must Support | true |
5. ReferralRequest.meta.lastUpdated | |
Control | 0..? |
Must Support | true |
6. ReferralRequest.meta.profile | |
Control | 0..? |
Must Support | true |
7. ReferralRequest.meta.security | |
Control | 0..? |
8. ReferralRequest.meta.tag | |
Control | 0..? |
Slicing | This element introduces a set of slices on ReferralRequest.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
9. ReferralRequest.meta.tag:Source | |
SliceName | Source |
Control | 0..1 |
Must Support | true |
10. ReferralRequest.meta.tag:Source.system | |
Control | 1..? |
Fixed Value | https://yhcr.nhs.uk/Source |
11. ReferralRequest.meta.tag:Source.code | |
Control | 1..? |
Must Support | true |
12. ReferralRequest.meta.tag:Source.display | |
Control | 1..? |
Must Support | true |
13. ReferralRequest.meta.tag:Provenance | |
SliceName | Provenance |
Control | 0..1 |
Must Support | true |
14. ReferralRequest.meta.tag:Provenance.system | |
Control | 1..? |
Fixed Value | https://yhcr.nhs.uk/Provenance |
15. ReferralRequest.meta.tag:Provenance.code | |
Control | 1..? |
Must Support | true |
16. ReferralRequest.meta.tag:Provenance.display | |
Control | 1..? |
Must Support | true |
17. ReferralRequest.implicitRules | |
18. ReferralRequest.language | |
19. ReferralRequest.text | |
20. ReferralRequest.extension:referralRequestMethod | |
SliceName | referralRequestMethod |
Must Support | true |
21. ReferralRequest.extension:sourceOfReferral | |
SliceName | sourceOfReferral |
Must Support | true |
22. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept | |
SliceName | valueCodeableConcept |
Control | 0..? |
Binding | The codes SHALL be taken from Care Connect Source of Referral |
Type | CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
23. ReferralRequest.extension:locationReferenceR4 | |
SliceName | locationReferenceR4 |
Control | 0..1 |
Type | Extension(ExtensionInterweaveR4LocationReference) (Extension Type: Reference) |
24. ReferralRequest.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Must Support | true |
25. ReferralRequest.definition | |
Control | 0..0* |
26. ReferralRequest.basedOn | |
Type | Reference(CareConnect-ProcedureRequest-1|CareConnect-ReferralRequest-1|CareConnect-CarePlan-1) |
27. ReferralRequest.replaces | |
Control | 0..0* |
28. ReferralRequest.groupIdentifier | |
Control | 0..01 |
29. ReferralRequest.status | |
Must Support | true |
30. ReferralRequest.intent | |
Must Support | true |
Fixed Value | order |
31. ReferralRequest.type | |
Control | 10..1 |
Binding | The codes SHOULD be taken from SNOMED CT Patient ReferralFor example codes, see SNOMED CT Patient Referral |
Must Support | true |
32. ReferralRequest.priority | |
Control | 10..1 |
Must Support | true |
33. ReferralRequest.serviceRequested | |
Control | 0..1* |
Binding | The codes SHOULD be taken from Interweave UkCore Care Service TypeFor example codes, see Practice Setting Code Value Set |
Must Support | true |
34. ReferralRequest.subject | |
Type | Reference(CareConnectPatient1|Group) |
Must Support | true |
35. ReferralRequest.subject.reference | |
Control | 1..? |
36. ReferralRequest.subject.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..? |
37. ReferralRequest.subject.display | |
Control | 1..? |
38. ReferralRequest.context | |
Type | Reference(CareConnect-Encounter-1|CareConnect-EpisodeOfCare-1) |
Must Support | true |
39. ReferralRequest.occurrence[x] | |
Control | 0..01 |
[x] Note | See Choice of Data Types for further information about how to use [x] |
40. ReferralRequest.authoredOn | |
Control | 10..1 |
Must Support | true |
41. ReferralRequest.requester | |
Control | 0..? |
42. ReferralRequest.requester.agent | |
Type | Reference(CareConnectPatient1|CareConnect-Practitioner-1|CareConnect-Organization-1|Device|CareConnect-RelatedPerson-1) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
43. ReferralRequest.requester.onBehalfOf | |
Control | 0..01 |
44. ReferralRequest.specialty | |
Binding | The codes SHOULD be taken from InterweaveUKCorePracticeSettingCodeFor example codes, see PractitionerSpecialty |
45. ReferralRequest.reasonCode | |
Binding | The codes SHOULD be taken from Interweave R4 Encounter ReasonFor example codes, see SNOMED CT Clinical Findings |
Must Support | true |
46. ReferralRequest.reasonCode.coding | |
Control | 0..? |
47. ReferralRequest.reasonCode.coding.system | |
Control | 1..? |
48. ReferralRequest.reasonCode.coding.code | |
Control | 1..? |
49. ReferralRequest.reasonCode.coding.display | |
Control | 1..? |
50. ReferralRequest.description | |
Control | 0..01 |
51. ReferralRequest.supportingInfo | |
Type | Reference(Questionnaire|Resource) |
52. ReferralRequest.relevantHistory | |
Control | 0..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. | ||||
Control | 0..* | ||||
Alternate Names | ReferralRequest TransferOfCare Request | ||||
Invariants | Defined 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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..* | ||||
Type | uri | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..* | ||||
Binding | The 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. | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Control | 0..* | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Slicing | This element introduces a set of slices on ReferralRequest.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
9. ReferralRequest.meta.tag:Source | |||||
SliceName | Source | ||||
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. | ||||
Control | 0..1* | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
Type | Coding | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 10..1 | ||||
Type | uri | ||||
Summary | true | ||||
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 Value | https://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). | ||||
Control | 10..1 | ||||
Type | code | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 10..1 | ||||
Type | string | ||||
Must Support | true | ||||
Summary | true | ||||
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 | |||||
SliceName | Provenance | ||||
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. | ||||
Control | 0..1* | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
Type | Coding | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 10..1 | ||||
Type | uri | ||||
Summary | true | ||||
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 Value | https://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). | ||||
Control | 10..1 | ||||
Type | code | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 10..1 | ||||
Type | string | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language.
| ||||
Type | code | ||||
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. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, 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:referralRequestMethod | |||||
SliceName | referralRequestMethod | ||||
Definition | The method used to send or receive a Referral Request. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension-CareConnect-ReferralRequestMethod-1) (Extension Type: CodeableConcept) | ||||
Must Support | true | ||||
Invariants | Defined 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()) | ||||
21. ReferralRequest.extension:sourceOfReferral | |||||
SliceName | sourceOfReferral | ||||
Definition | The source of referral for a Referral Request. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension-CareConnect-SourceOfReferral-1) (Extension Type: CodeableConcept) | ||||
Must Support | true | ||||
Invariants | Defined 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.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Control | 1..1 | ||||
Type | uri | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Fixed Value | https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1 | ||||
23. ReferralRequest.extension:sourceOfReferral.value[x] | |||||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||||
Control | 10..1 | ||||
Type | Choice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Slicing | This element introduces a set of slices on ReferralRequest.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
24. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept | |||||
SliceName | valueCodeableConcept | ||||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||||
Control | 10..1 | ||||
Binding | The codes SHALL be taken from Care Connect Source of ReferralFor codes, see (unbound) | ||||
Type | Choice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
25. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..1* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
26. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.coding.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..01 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
27. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..01 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
28. ReferralRequest.extension:locationReferenceR4 | |||||
SliceName | locationReferenceR4 | ||||
Definition | Reference to the patient’s requested location. | ||||
Control | 0..1 | ||||
Type | Extension(ExtensionInterweaveR4LocationReference) (Extension Type: Reference) | ||||
29. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Alternate Names | extensions, 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. | ||||
30. ReferralRequest.identifier | |||||
Definition | Business identifier that uniquely identifies the referral/care transfer request instance. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Must Support | true | ||||
Summary | true | ||||
31. ReferralRequest.identifier.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
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. | ||||
32. ReferralRequest.identifier.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 10..1 | ||||
Type | uri | ||||
Summary | true | ||||
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 | ||||
33. ReferralRequest.identifier.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 10..1 | ||||
Type | string | ||||
Summary | true | ||||
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 | ||||
34. ReferralRequest.definition | |||||
Definition | A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | ||||
Control | 0..0* | ||||
Type | Reference(ActivityDefinition|PlanDefinition) | ||||
Summary | true | ||||
35. ReferralRequest.basedOn | |||||
Definition | Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part. | ||||
Control | 0..* | ||||
Type | Reference(CareConnect-ProcedureRequest-1|CareConnect-ReferralRequest-1|ReferralRequest|CarePlan|ProcedureRequest) | ||||
Summary | true | ||||
Alternate Names | fulfills | ||||
36. ReferralRequest.replaces | |||||
Definition | Completed or terminated request(s) whose function is taken by this new request. | ||||
Control | 0..0* | ||||
Type | Reference(CareConnect-ReferralRequest-1|ReferralRequest) | ||||
Summary | true | ||||
Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. | ||||
Alternate Names | supersedes, 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. | ||||
Control | 0..01 | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Allows multiple orders to be collected as part of a single requisition. | ||||
Alternate Names | grouperId, requisition | ||||
38. ReferralRequest.status | |||||
Definition | The status of the authorization/intention reflected by the referral request record. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from RequestStatus The status of the referral. | ||||
Type | code | ||||
Is Modifier | true | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from RequestIntent Codes identifying the stage lifecycle stage of a request | ||||
Type | code | ||||
Is Modifier | true | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | The same resource structure is used when capturing proposals/recommendations, plans and actual requests. | ||||
Alternate Names | category | ||||
Fixed Value | order | ||||
40. ReferralRequest.type | |||||
Definition | An indication of the type of referral (or where applicable the type of transfer of care) request. | ||||
Control | 10..1 | ||||
Binding | The codes SHOULD be taken from SNOMED CT Patient ReferralFor example codes, see SNOMED CT Patient Referral | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
41. ReferralRequest.priority | |||||
Definition | An indication of the urgency of referral (or where applicable the type of transfer of care) request. | ||||
Control | 10..1 | ||||
Binding | The codes SHALL be taken from RequestPriority Codes indicating the relative priority of the referral. | ||||
Type | code | ||||
Must Support | true | ||||
Summary | true | ||||
42. ReferralRequest.serviceRequested | |||||
Definition | The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion. | ||||
Control | 0..1* | ||||
Binding | The codes SHOULD be taken from Interweave UkCore Care Service TypeFor example codes, see Practice Setting Code Value Set | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
43. ReferralRequest.subject | |||||
Definition | The patient who is the subject of a referral or transfer of care request. | ||||
Control | 1..1 | ||||
Type | Reference(CareConnectPatient1|Patient|Group) | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | Referral of family, group or community is to be catered for by profiles. | ||||
44. 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. | ||||
Control | 10..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
45. 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. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
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. | ||||
46. ReferralRequest.subject.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 10..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
47. ReferralRequest.context | |||||
Definition | The encounter at which the request for referral or transfer of care is initiated. | ||||
Control | 0..1 | ||||
Type | Reference(CareConnect-Encounter-1|Encounter|EpisodeOfCare) | ||||
Must Support | true | ||||
Summary | true | ||||
Alternate Names | encounter | ||||
48. 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. | ||||
Control | 0..01 | ||||
Type | Choice of: dateTime, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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 Names | timing | ||||
Comments | When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date. | ||||
49. ReferralRequest.authoredOn | |||||
Definition | Date/DateTime of creation for draft requests and date of activation for active requests. | ||||
Control | 10..1 | ||||
Type | dateTime | ||||
Must Support | true | ||||
Summary | true | ||||
Alternate Names | createdOn | ||||
50. ReferralRequest.requester | |||||
Definition | The individual who initiated the request and has responsibility for its activation. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Alternate Names | author | ||||
Invariants | Defined 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()) | ||||
51. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, 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. | ||||
52. ReferralRequest.requester.agent | |||||
Definition | The device, practitioner, etc. who initiated the request. | ||||
Control | 1..1 | ||||
Type | Reference(CareConnectPatient1|CareConnect-Practitioner-1|CareConnect-Organization-1|Practitioner|Organization|Patient|RelatedPerson|Device) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
53. ReferralRequest.requester.onBehalfOf | |||||
Definition | The organization the device or practitioner was acting on behalf of. | ||||
Control | 0..01 This element is affected by the following invariants: rfr-1 | ||||
Type | Reference(CareConnect-Organization-1|Organization) | ||||
Summary | true | ||||
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. | ||||
54. 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. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from InterweaveUKCorePracticeSettingCodeFor example codes, see PractitionerSpecialty | ||||
Type | CodeableConcept | ||||
55. 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. | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from Interweave R4 Encounter ReasonFor example codes, see SNOMED CT Clinical Findings | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
56. 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. | ||||
Control | 0..01 | ||||
Type | string | ||||
57. 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. | ||||
Control | 0..* | ||||
Type | Reference(Questionnaire|Resource) | ||||
58. 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. | ||||
Control | 0..0* | ||||
Type | Reference(Provenance) | ||||
Alternate Names | eventHistory | ||||
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. | ||||
Control | 0..* | ||||
Alternate Names | ReferralRequest 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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
Slicing | This element introduces a set of slices on ReferralRequest.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..* | ||||
Type | uri | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..* | ||||
Binding | The 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 | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Control | 0..* | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones | ||||
Type | Coding | ||||
Summary | true | ||||
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. | ||||
Slicing | This element introduces a set of slices on ReferralRequest.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
11. ReferralRequest.meta.tag:Source | |||||
SliceName | Source | ||||
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. | ||||
Control | 0..1 | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones | ||||
Type | Coding | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
Slicing | This 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:
| ||||
14. ReferralRequest.meta.tag:Source.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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 Value | https://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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 1..1 | ||||
Type | string | ||||
Must Support | true | ||||
Summary | true | ||||
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). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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 | |||||
SliceName | Provenance | ||||
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. | ||||
Control | 0..1 | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones | ||||
Type | Coding | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
Slicing | This 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:
| ||||
22. ReferralRequest.meta.tag:Provenance.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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 Value | https://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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Control | 1..1 | ||||
Type | string | ||||
Must Support | true | ||||
Summary | true | ||||
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). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Summary | true | ||||
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. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
A human language
| ||||
Type | code | ||||
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. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline 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 | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on ReferralRequest.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
32. ReferralRequest.extension:referralRequestMethod | |||||
SliceName | referralRequestMethod | ||||
Definition | The method used to send or receive a Referral Request. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension-CareConnect-ReferralRequestMethod-1) (Extension Type: CodeableConcept) | ||||
Must Support | true | ||||
Invariants | Defined 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 | |||||
SliceName | sourceOfReferral | ||||
Definition | The source of referral for a Referral Request. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension-CareConnect-SourceOfReferral-1) (Extension Type: CodeableConcept) | ||||
Must Support | true | ||||
Invariants | Defined 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:sourceOfReferral.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
35. ReferralRequest.extension:sourceOfReferral.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
Slicing | This element introduces a set of slices on ReferralRequest.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
36. ReferralRequest.extension:sourceOfReferral.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Control | 1..1 | ||||
Type | uri | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Fixed Value | https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1 | ||||
37. ReferralRequest.extension:sourceOfReferral.value[x] | |||||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||||
Control | 1..1 | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Slicing | This element introduces a set of slices on ReferralRequest.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
38. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept | |||||
SliceName | valueCodeableConcept | ||||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Care Connect Source of Referral | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
39. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
40. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
Slicing | This element introduces a set of slices on ReferralRequest.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
41. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..1 | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
42. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.coding.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
43. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.coding.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
Slicing | This element introduces a set of slices on ReferralRequest.extension.value[x].coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
44. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
45. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.coding.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..0 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
46. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.coding.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). | ||||
Control | 0..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
47. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
48. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..0 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
49. ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConcept.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
50. ReferralRequest.extension:locationReferenceR4 | |||||
SliceName | locationReferenceR4 | ||||
Definition | Reference to the patient’s requested location. | ||||
Control | 0..1 | ||||
Type | Extension(ExtensionInterweaveR4LocationReference) (Extension Type: Reference) | ||||
51. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Alternate Names | extensions, 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. | ||||
52. ReferralRequest.identifier | |||||
Definition | Business identifier that uniquely identifies the referral/care transfer request instance. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Must Support | true | ||||
Summary | true | ||||
53. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
54. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
Slicing | This element introduces a set of slices on ReferralRequest.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
55. ReferralRequest.identifier.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
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. | ||||
56. ReferralRequest.identifier.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 0..1 | ||||
Binding | The 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 | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
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. | ||||
57. ReferralRequest.identifier.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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 | ||||
58. ReferralRequest.identifier.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
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 | ||||
59. ReferralRequest.identifier.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
60. ReferralRequest.identifier.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(CareConnect-Organization-1) | ||||
Summary | true | ||||
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. | ||||
61. ReferralRequest.definition | |||||
Definition | A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | ||||
Control | 0..0 | ||||
Type | Reference(ActivityDefinition|PlanDefinition) | ||||
Summary | true | ||||
62. ReferralRequest.basedOn | |||||
Definition | Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part. | ||||
Control | 0..* | ||||
Type | Reference(CareConnect-ProcedureRequest-1|CareConnect-ReferralRequest-1) | ||||
Summary | true | ||||
Alternate Names | fulfills | ||||
63. ReferralRequest.replaces | |||||
Definition | Completed or terminated request(s) whose function is taken by this new request. | ||||
Control | 0..0 | ||||
Type | Reference(CareConnect-ReferralRequest-1) | ||||
Summary | true | ||||
Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. | ||||
Alternate Names | supersedes, 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. | ||||
64. ReferralRequest.groupIdentifier | |||||
Definition | The business identifier of the logical "grouping" request/order that this referral is a part of. | ||||
Control | 0..0 | ||||
Type | Identifier | ||||
Summary | true | ||||
Requirements | Allows multiple orders to be collected as part of a single requisition. | ||||
Alternate Names | grouperId, requisition | ||||
65. ReferralRequest.status | |||||
Definition | The status of the authorization/intention reflected by the referral request record. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from RequestStatus The status of the referral | ||||
Type | code | ||||
Is Modifier | true | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
66. ReferralRequest.intent | |||||
Definition | Distinguishes the "level" of authorization/demand implicit in this request. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from RequestIntent Codes identifying the stage lifecycle stage of a reques | ||||
Type | code | ||||
Is Modifier | true | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | The same resource structure is used when capturing proposals/recommendations, plans and actual requests. | ||||
Alternate Names | category | ||||
Fixed Value | order | ||||
67. ReferralRequest.type | |||||
Definition | An indication of the type of referral (or where applicable the type of transfer of care) request. | ||||
Control | 1..1 | ||||
Binding | The codes SHOULD be taken from SNOMED CT Patient Referral | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
68. ReferralRequest.priority | |||||
Definition | An indication of the urgency of referral (or where applicable the type of transfer of care) request. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from RequestPriority Codes indicating the relative priority of the referral | ||||
Type | code | ||||
Must Support | true | ||||
Summary | true | ||||
69. ReferralRequest.serviceRequested | |||||
Definition | The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from Interweave UkCore Care Service Type | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
70. ReferralRequest.subject | |||||
Definition | The patient who is the subject of a referral or transfer of care request. | ||||
Control | 1..1 | ||||
Type | Reference(CareConnectPatient1) | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | Referral of family, group or community is to be catered for by profiles. | ||||
71. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
72. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
Slicing | This element introduces a set of slices on ReferralRequest.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
73. 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. | ||||
Control | 1..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
74. 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. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
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. | ||||
75. ReferralRequest.subject.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
76. ReferralRequest.context | |||||
Definition | The encounter at which the request for referral or transfer of care is initiated. | ||||
Control | 0..1 | ||||
Type | Reference(CareConnect-Encounter-1) | ||||
Must Support | true | ||||
Summary | true | ||||
Alternate Names | encounter | ||||
77. 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. | ||||
Control | 0..0 | ||||
Type | Choice of: dateTime, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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 Names | timing | ||||
Comments | When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date. | ||||
78. ReferralRequest.authoredOn | |||||
Definition | Date/DateTime of creation for draft requests and date of activation for active requests. | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Must Support | true | ||||
Summary | true | ||||
Alternate Names | createdOn | ||||
79. ReferralRequest.requester | |||||
Definition | The individual who initiated the request and has responsibility for its activation. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Alternate Names | author | ||||
80. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
81. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
82. 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, 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. | ||||
83. ReferralRequest.requester.agent | |||||
Definition | The device, practitioner, etc. who initiated the request. | ||||
Control | 1..1 | ||||
Type | Reference(CareConnectPatient1|CareConnect-Practitioner-1|CareConnect-Organization-1) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
84. ReferralRequest.requester.onBehalfOf | |||||
Definition | The organization the device or practitioner was acting on behalf of. | ||||
Control | 0..0 This element is affected by the following invariants: rfr-1 | ||||
Type | Reference(CareConnect-Organization-1) | ||||
Summary | true | ||||
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. | ||||
85. 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. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from InterweaveUKCorePracticeSettingCode | ||||
Type | CodeableConcept | ||||
86. ReferralRequest.recipient | |||||
Definition | The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request. | ||||
Control | 0..* | ||||
Type | Reference(CareConnect-Organization-1|CareConnect-Practitioner-1|CareConnect-HealthcareService-1) | ||||
Summary | true | ||||
Comments | There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations. | ||||
87. 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. | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from Interweave R4 Encounter Reason | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
88. ReferralRequest.reasonCode.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
89. ReferralRequest.reasonCode.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
Slicing | This element introduces a set of slices on ReferralRequest.reasonCode.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
90. ReferralRequest.reasonCode.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
91. ReferralRequest.reasonCode.coding.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
92. ReferralRequest.reasonCode.coding.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
Slicing | This element introduces a set of slices on ReferralRequest.reasonCode.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
93. ReferralRequest.reasonCode.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
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. | ||||
94. ReferralRequest.reasonCode.coding.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. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
95. ReferralRequest.reasonCode.coding.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). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
96. ReferralRequest.reasonCode.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
97. ReferralRequest.reasonCode.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
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. | ||||
98. ReferralRequest.reasonCode.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
99. ReferralRequest.reasonReference | |||||
Definition | Indicates another resource whose existence justifies this request. | ||||
Control | 0..* | ||||
Type | Reference(CareConnect-Condition-1|CareConnect-Observation-1) | ||||
Summary | true | ||||
100. 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. | ||||
Control | 0..0 | ||||
Type | string | ||||
101. 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. | ||||
Control | 0..* | ||||
Type | Reference(Questionnaire) | ||||
102. ReferralRequest.note | |||||
Definition | Comments made about the referral request by any of the participants. | ||||
Control | 0..* | ||||
Type | Annotation | ||||
103. ReferralRequest.note.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
104. ReferralRequest.note.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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, 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. | ||||
Slicing | This element introduces a set of slices on ReferralRequest.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
105. ReferralRequest.note.author[x] | |||||
Definition | The individual responsible for making the annotation. | ||||
Control | 0..1 | ||||
Type | Choice of: string, Reference(CareConnectPatient1|CareConnect-RelatedPerson-1|CareConnect-Practitioner-1) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
106. ReferralRequest.note.time | |||||
Definition | Indicates when this particular annotation was made. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Summary | true | ||||
107. ReferralRequest.note.text | |||||
Definition | The text of the annotation. | ||||
Control | 1..1 | ||||
Type | string | ||||
108. 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. | ||||
Control | 0..0 | ||||
Type | Reference(Provenance) | ||||
Alternate Names | eventHistory | ||||
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. |