Interweave Implementation Guide
0.1.0 - ci-build

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

Resource Profile: InterweaveReferralRequest

Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-ReferralRequest Version: 0.1.0
Active as of 2024-06-10 Computable Name: InterweaveReferralRequest

Interweave Referral Request resource profile.

 Status: Active: Approved (STU)

Introduction

This profile sets out the expectations for the interweave referral request resource.

Mandatory fields

The following fields are mandatory:

  • status – This is a mandatory field which describes the status of the referral. It has a required binding to STU3 valueset-request-status however we remove the values ‘draft’, ‘suspended’ and ‘unknown’ from this list as referrals with these statuses are not appropriate to share.

  • intent – This is a mandatory field in FHIR, however, it does not add much value in the shared care record context. As we have to provide a value from the required binding STU3 valueset-request-intent we default its value to ‘order’.

  • type – A comprehensive list of snomed codes Valueset-referral-type - FHIR v3.0.2 (hl7.org) is provided as an example binding on this field by care connect. We enforce this binding further to ‘preferred’.

  • subject – every referral request must be linked to a patient resource which is the subject of the referral

  • authoredOn – This is the date when the referral became active.

  • recipient – the organisation or practitioner who is the receiver of the referral.

Must Support fields

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

  • referralRequestMethod – This is a care connect extension which was introduced to capture the method used to communicate the referral such as e-referral, secure email etc.

  • sourceOfReferral – Another useful care connect extension which is used to specify the source of the referral e.g SCT 309013001 Referred by person OR
    SCT 306098008 Self-referral.
  • Identifier – A Local Id should be provided, such that could be quoted if manually getting in touch to find out more.

  • priority – this is a mandatory field with a required binding inherited from the care connect specification and as such we are unable to add or amend the codes held in the valueset. We intend to build up a library of the codes usage within this guide as data provision of this resource matures.

  • serviceRequested – We keep this field inline with the encounter resource and pre-adopt the UKCore value set (based on SNOMED refset 1127531000000102: Services Simple Reference Set), which is more relevant than the default FHIR example and also covers social care.

  • context – If known, a reference to the encounter which initiated the referral request should be populated here. This field is renamed to ‘encounter’ in R4.

  • requester – This field currently has two sub fields ‘agent’ and ‘onBehalfOf’. IN R4 this is consolidated into one field which replicates the agent field, we therefore remove ‘onBehalfOf’ and ask for ‘agent’ to be populated. We have also restricted the resources which can be referenced here to ‘Organisation’, ‘Patient’ and ‘Practitioner’.

  • reasonCode - A long list of SNOMED codes to describe different reasons which may have led to the Referral. We pre-adopt the value set used in R4. This builds on the existing STU3 list covering SNOMED codes for “Clinical Finding” and “Procedure”, and adds codes for “Context-dependent categories” (Social Care) and “Events” (A&E).

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Optional fields to note include:

  • basedOn – Gives the option of providing a link to another procedure or referral request.
  • specialty – The clinical specialty (discipline) that the referral is requested for. We pre-adopt the UKCore value set (ukcore-practicesettingcode), which is based on the values in the NHS Data Dictionary MAIN SPECIALTY CODE.
  • locationReference – This field is pre-adopted from R4 and supports the supply of the patient preference as to where they are seen.
  • reasonReference – optionally provide a link to a condition and/or an observation resource(s) which add further context as to why the referral has been requested.
  • notes – Optionally provide additional information about the referral. Please be cautious when populating this field and ensure notes which are provided are relevant to the shared care record.

Discouraged or Removed fields

  • definition – Removed.
  • replaces – Removed.
  • groupIdentifier – Removed to avoid any complexity for the data consumer.
  • description – This field is REMOVED in R4 and here we do the same.
  • supportingInfo – We DISCOURAGE this field do to the complexities placed on the consumer. If this field is used, then we only allow reference to the Questionnaire resource.
  • relevantHistory – Removed to avoid any complexity for the data consumer.
  • occurrence[x] – Removed, detail here is more relevant to the scheduling of the services requested in the referral and not currently deemed relevant to the shared care record.

Usage:

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

Formal Views of Profile Content

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

This structure is derived from CareConnect-ReferralRequest-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest 0..*CareConnect-ReferralRequest-1A request for referral or transfer of care
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... language 0..1codeEnglish is assumed (not currently a multi-lingual implementation)
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension:referralRequestMethod S0..1Extension-CareConnect-ReferralRequestMethod-1The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc...
... extension:sourceOfReferral S0..1Extension-CareConnect-SourceOfReferral-1This represents the source of referral
.... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Care Connect Source of Referral (required)
... locationReferenceR4 0..1Reference(CareConnect-Location-1)Reference to the patient’s requested location.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4LocationReference
... identifier S0..*IdentifierBusiness identifier
... definition 0..0
... basedOn 0..*Reference(CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1)Request fulfilled by this request
... replaces 0..0
... groupIdentifier 0..0
... status S1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
... intent S1..1codeproposal | plan | order
Fixed Value: order
... type S1..1CodeableConceptReferral/Transition of care request type.
Binding: SNOMED CT Patient Referral (preferred)
... priority S1..1codeUrgency of referral / transfer of care request
... serviceRequested S0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: Interweave UkCore Care Service Type (preferred)
... subject S1..1Reference(CareConnectPatient1)Patient referred to care or transfer
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... context S0..1Reference(CareConnect-Encounter-1)Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] 0..0
... authoredOn S1..1dateTimeDate of creation/activation
... requester
.... agent S1..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1 | CareConnect-Organization-1)Individual making the request
.... onBehalfOf 0..0
... specialty 0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: InterweaveUKCorePracticeSettingCode (preferred)
... reasonCode S0..*CodeableConceptReason for referral / transfer of care request
Binding: Interweave R4 Encounter Reason (preferred)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... description 0..0
... supportingInfo 0..*Reference(Questionnaire)Additonal information to support referral or transfer of care request
... relevantHistory 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConceptrequiredCare Connect Source of Referral
ReferralRequest.typepreferredSNOMED CT Patient Referral
ReferralRequest.serviceRequestedpreferredInterweave UkCore Care Service Type
ReferralRequest.specialtypreferredInterweaveUKCorePracticeSettingCode
ReferralRequest.reasonCodepreferredInterweave R4 Encounter Reason
NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest 0..*CareConnect-ReferralRequest-1A request for referral or transfer of care
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


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


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


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


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... referralRequestMethod S0..1CodeableConceptThe method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc...
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1
Binding: Care Connect Referral Request Method (required): The form in which a referral is sent and received


... sourceOfReferral S0..1CodeableConceptThis represents the source of referral
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1
Binding: Care Connect Source of Referral (extensible): A classification which identifies the source of referral


.... url 1..1uri"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Care Connect Source of Referral (required)
...... coding Σ0..1CodingCode defined by a terminology system
... locationReferenceR4 0..1Reference(CareConnect-Location-1)Reference to the patient’s requested location.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4LocationReference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... basedOn Σ0..*Reference(CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1)Request fulfilled by this request
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the referral.

... intent ?!SΣ1..1codeproposal | plan | order
Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request


Fixed Value: order
... type SΣ1..1CodeableConceptReferral/Transition of care request type.
Binding: SNOMED CT Patient Referral (preferred)
... priority SΣ1..1codeUrgency of referral / transfer of care request
Binding: RequestPriority (required): Codes indicating the relative priority of the referral.

... serviceRequested SΣ0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: Interweave UkCore Care Service Type (preferred)
... subject SΣ1..1Reference(CareConnectPatient1)Patient referred to care or transfer
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... context SΣ0..1Reference(CareConnect-Encounter-1)Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... authoredOn SΣ1..1dateTimeDate of creation/activation
... requester ΣC0..1BackboneElementWho/what is requesting service
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent SΣ1..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1 | CareConnect-Organization-1)Individual making the request
... specialty 0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: InterweaveUKCorePracticeSettingCode (preferred)
... reasonCode SΣ0..*CodeableConceptReason for referral / transfer of care request
Binding: Interweave R4 Encounter Reason (preferred)
... supportingInfo 0..*Reference(Questionnaire)Additonal information to support referral or transfer of care request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ReferralRequest.meta.securityextensibleAll Security Labels
ReferralRequest.meta.tagexampleCommon Tags
ReferralRequest.meta.tag:SourceexampleCommon Tags
ReferralRequest.meta.tag:ProvenanceexampleCommon Tags
ReferralRequest.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConceptrequiredCare Connect Source of Referral
ReferralRequest.identifier.userequiredIdentifierUse
ReferralRequest.groupIdentifier.userequiredIdentifierUse
ReferralRequest.statusrequiredRequestStatus
ReferralRequest.intentrequiredFixed Value: order
ReferralRequest.typepreferredSNOMED CT Patient Referral
ReferralRequest.priorityrequiredRequestPriority
ReferralRequest.serviceRequestedpreferredInterweave UkCore Care Service Type
ReferralRequest.specialtypreferredInterweaveUKCorePracticeSettingCode
ReferralRequest.reasonCodepreferredInterweave R4 Encounter Reason

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorReferralRequestIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorReferralRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorReferralRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorReferralRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1errorReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferral, ReferralRequest.requesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferralMust have either extensions or value[x], not both
: extension.exists() != value.exists()
rfr-1errorReferralRequest.requesteronBehalfOf can only be specified if agent is practitioner or device
: (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest 0..*CareConnect-ReferralRequest-1A request for referral or transfer of care
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


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


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


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


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... language 0..1codeEnglish is assumed (not currently a multi-lingual implementation)
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... referralRequestMethod S0..1CodeableConceptThe method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc...
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1
Binding: Care Connect Referral Request Method (required): The form in which a referral is sent and received


... sourceOfReferral S0..1CodeableConceptThis represents the source of referral
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1
Binding: Care Connect Source of Referral (extensible): A classification which identifies the source of referral


.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Care Connect Source of Referral (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
...... text Σ0..1stringPlain text representation of the concept
... locationReferenceR4 0..1Reference(CareConnect-Location-1)Reference to the patient’s requested location.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4LocationReference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... basedOn Σ0..*Reference(CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1)Request fulfilled by this request
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the referral.

... intent ?!SΣ1..1codeproposal | plan | order
Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request


Fixed Value: order
... type SΣ1..1CodeableConceptReferral/Transition of care request type.
Binding: SNOMED CT Patient Referral (preferred)
... priority SΣ1..1codeUrgency of referral / transfer of care request
Binding: RequestPriority (required): Codes indicating the relative priority of the referral.

... serviceRequested SΣ0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: Interweave UkCore Care Service Type (preferred)
... subject SΣ1..1Reference(CareConnectPatient1)Patient referred to care or transfer
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... context SΣ0..1Reference(CareConnect-Encounter-1)Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... authoredOn SΣ1..1dateTimeDate of creation/activation
... requester ΣC0..1BackboneElementWho/what is requesting service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent SΣ1..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1 | CareConnect-Organization-1)Individual making the request
... specialty 0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: InterweaveUKCorePracticeSettingCode (preferred)
... recipient Σ0..*Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1)Receiver of referral / transfer of care request
... reasonCode SΣ0..*CodeableConceptReason for referral / transfer of care request
Binding: Interweave R4 Encounter Reason (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... reasonReference Σ0..*Reference(CareConnect-Condition-1 | CareConnect-Observation-1)Why is service needed?
... supportingInfo 0..*Reference(Questionnaire)Additonal information to support referral or transfer of care request
... note 0..*AnnotationComments made about referral request
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorStringstring
..... authorReferenceReference(CareConnectPatient1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ReferralRequest.meta.securityextensibleAll Security Labels
ReferralRequest.meta.tagexampleCommon Tags
ReferralRequest.meta.tag:SourceexampleCommon Tags
ReferralRequest.meta.tag:ProvenanceexampleCommon Tags
ReferralRequest.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConceptrequiredCare Connect Source of Referral
ReferralRequest.identifier.userequiredIdentifierUse
ReferralRequest.identifier.typeextensibleIdentifier Type Codes
ReferralRequest.groupIdentifier.userequiredIdentifierUse
ReferralRequest.groupIdentifier.typeextensibleIdentifier Type Codes
ReferralRequest.statusrequiredRequestStatus
ReferralRequest.intentrequiredFixed Value: order
ReferralRequest.typepreferredSNOMED CT Patient Referral
ReferralRequest.priorityrequiredRequestPriority
ReferralRequest.serviceRequestedpreferredInterweave UkCore Care Service Type
ReferralRequest.specialtypreferredInterweaveUKCorePracticeSettingCode
ReferralRequest.reasonCodepreferredInterweave R4 Encounter Reason

Constraints

IdGradePath(s)DetailsRequirements
ele-1errorReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferralAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferralMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from CareConnect-ReferralRequest-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest 0..*CareConnect-ReferralRequest-1A request for referral or transfer of care
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... language 0..1codeEnglish is assumed (not currently a multi-lingual implementation)
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension:referralRequestMethod S0..1Extension-CareConnect-ReferralRequestMethod-1The method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc...
... extension:sourceOfReferral S0..1Extension-CareConnect-SourceOfReferral-1This represents the source of referral
.... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Care Connect Source of Referral (required)
... locationReferenceR4 0..1Reference(CareConnect-Location-1)Reference to the patient’s requested location.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4LocationReference
... identifier S0..*IdentifierBusiness identifier
... definition 0..0
... basedOn 0..*Reference(CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1)Request fulfilled by this request
... replaces 0..0
... groupIdentifier 0..0
... status S1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
... intent S1..1codeproposal | plan | order
Fixed Value: order
... type S1..1CodeableConceptReferral/Transition of care request type.
Binding: SNOMED CT Patient Referral (preferred)
... priority S1..1codeUrgency of referral / transfer of care request
... serviceRequested S0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: Interweave UkCore Care Service Type (preferred)
... subject S1..1Reference(CareConnectPatient1)Patient referred to care or transfer
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... context S0..1Reference(CareConnect-Encounter-1)Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... occurrence[x] 0..0
... authoredOn S1..1dateTimeDate of creation/activation
... requester
.... agent S1..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1 | CareConnect-Organization-1)Individual making the request
.... onBehalfOf 0..0
... specialty 0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: InterweaveUKCorePracticeSettingCode (preferred)
... reasonCode S0..*CodeableConceptReason for referral / transfer of care request
Binding: Interweave R4 Encounter Reason (preferred)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... description 0..0
... supportingInfo 0..*Reference(Questionnaire)Additonal information to support referral or transfer of care request
... relevantHistory 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConceptrequiredCare Connect Source of Referral
ReferralRequest.typepreferredSNOMED CT Patient Referral
ReferralRequest.serviceRequestedpreferredInterweave UkCore Care Service Type
ReferralRequest.specialtypreferredInterweaveUKCorePracticeSettingCode
ReferralRequest.reasonCodepreferredInterweave R4 Encounter Reason

Key Elements View

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


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


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


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


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... referralRequestMethod S0..1CodeableConceptThe method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc...
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1
Binding: Care Connect Referral Request Method (required): The form in which a referral is sent and received


... sourceOfReferral S0..1CodeableConceptThis represents the source of referral
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1
Binding: Care Connect Source of Referral (extensible): A classification which identifies the source of referral


.... url 1..1uri"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Care Connect Source of Referral (required)
...... coding Σ0..1CodingCode defined by a terminology system
... locationReferenceR4 0..1Reference(CareConnect-Location-1)Reference to the patient’s requested location.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4LocationReference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... basedOn Σ0..*Reference(CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1)Request fulfilled by this request
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the referral.

... intent ?!SΣ1..1codeproposal | plan | order
Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request


Fixed Value: order
... type SΣ1..1CodeableConceptReferral/Transition of care request type.
Binding: SNOMED CT Patient Referral (preferred)
... priority SΣ1..1codeUrgency of referral / transfer of care request
Binding: RequestPriority (required): Codes indicating the relative priority of the referral.

... serviceRequested SΣ0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: Interweave UkCore Care Service Type (preferred)
... subject SΣ1..1Reference(CareConnectPatient1)Patient referred to care or transfer
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... context SΣ0..1Reference(CareConnect-Encounter-1)Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... authoredOn SΣ1..1dateTimeDate of creation/activation
... requester ΣC0..1BackboneElementWho/what is requesting service
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent SΣ1..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1 | CareConnect-Organization-1)Individual making the request
... specialty 0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: InterweaveUKCorePracticeSettingCode (preferred)
... reasonCode SΣ0..*CodeableConceptReason for referral / transfer of care request
Binding: Interweave R4 Encounter Reason (preferred)
... supportingInfo 0..*Reference(Questionnaire)Additonal information to support referral or transfer of care request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ReferralRequest.meta.securityextensibleAll Security Labels
ReferralRequest.meta.tagexampleCommon Tags
ReferralRequest.meta.tag:SourceexampleCommon Tags
ReferralRequest.meta.tag:ProvenanceexampleCommon Tags
ReferralRequest.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConceptrequiredCare Connect Source of Referral
ReferralRequest.identifier.userequiredIdentifierUse
ReferralRequest.groupIdentifier.userequiredIdentifierUse
ReferralRequest.statusrequiredRequestStatus
ReferralRequest.intentrequiredFixed Value: order
ReferralRequest.typepreferredSNOMED CT Patient Referral
ReferralRequest.priorityrequiredRequestPriority
ReferralRequest.serviceRequestedpreferredInterweave UkCore Care Service Type
ReferralRequest.specialtypreferredInterweaveUKCorePracticeSettingCode
ReferralRequest.reasonCodepreferredInterweave R4 Encounter Reason

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorReferralRequestIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorReferralRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorReferralRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorReferralRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1errorReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferral, ReferralRequest.requesterAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferralMust have either extensions or value[x], not both
: extension.exists() != value.exists()
rfr-1errorReferralRequest.requesteronBehalfOf can only be specified if agent is practitioner or device
: (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()

Snapshot View

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


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


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


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


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... language 0..1codeEnglish is assumed (not currently a multi-lingual implementation)
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... referralRequestMethod S0..1CodeableConceptThe method used to communicate the referral such as fax, NHS e-Referral Service, secure email, etc...
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReferralRequestMethod-1
Binding: Care Connect Referral Request Method (required): The form in which a referral is sent and received


... sourceOfReferral S0..1CodeableConceptThis represents the source of referral
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1
Binding: Care Connect Source of Referral (extensible): A classification which identifies the source of referral


.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-SourceOfReferral-1"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Care Connect Source of Referral (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
...... text Σ0..1stringPlain text representation of the concept
... locationReferenceR4 0..1Reference(CareConnect-Location-1)Reference to the patient’s requested location.
URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4LocationReference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... basedOn Σ0..*Reference(CareConnect-ProcedureRequest-1 | CareConnect-ReferralRequest-1)Request fulfilled by this request
... status ?!SΣ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the referral.

... intent ?!SΣ1..1codeproposal | plan | order
Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request


Fixed Value: order
... type SΣ1..1CodeableConceptReferral/Transition of care request type.
Binding: SNOMED CT Patient Referral (preferred)
... priority SΣ1..1codeUrgency of referral / transfer of care request
Binding: RequestPriority (required): Codes indicating the relative priority of the referral.

... serviceRequested SΣ0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: Interweave UkCore Care Service Type (preferred)
... subject SΣ1..1Reference(CareConnectPatient1)Patient referred to care or transfer
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... context SΣ0..1Reference(CareConnect-Encounter-1)Optional link to an encounter resource. e.g. contact for hospital discharge assessments linked back to a hospital encounter.
... authoredOn SΣ1..1dateTimeDate of creation/activation
... requester ΣC0..1BackboneElementWho/what is requesting service
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... agent SΣ1..1Reference(CareConnectPatient1 | CareConnect-Practitioner-1 | CareConnect-Organization-1)Individual making the request
... specialty 0..1CodeableConceptThe service(s) that is/are requested to be provided to the patient.
Binding: InterweaveUKCorePracticeSettingCode (preferred)
... recipient Σ0..*Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-HealthcareService-1)Receiver of referral / transfer of care request
... reasonCode SΣ0..*CodeableConceptReason for referral / transfer of care request
Binding: Interweave R4 Encounter Reason (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... reasonReference Σ0..*Reference(CareConnect-Condition-1 | CareConnect-Observation-1)Why is service needed?
... supportingInfo 0..*Reference(Questionnaire)Additonal information to support referral or transfer of care request
... note 0..*AnnotationComments made about referral request
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorStringstring
..... authorReferenceReference(CareConnectPatient1 | CareConnect-RelatedPerson-1 | CareConnect-Practitioner-1)
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ReferralRequest.meta.securityextensibleAll Security Labels
ReferralRequest.meta.tagexampleCommon Tags
ReferralRequest.meta.tag:SourceexampleCommon Tags
ReferralRequest.meta.tag:ProvenanceexampleCommon Tags
ReferralRequest.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
ReferralRequest.extension:sourceOfReferral.value[x]:valueCodeableConceptrequiredCare Connect Source of Referral
ReferralRequest.identifier.userequiredIdentifierUse
ReferralRequest.identifier.typeextensibleIdentifier Type Codes
ReferralRequest.groupIdentifier.userequiredIdentifierUse
ReferralRequest.groupIdentifier.typeextensibleIdentifier Type Codes
ReferralRequest.statusrequiredRequestStatus
ReferralRequest.intentrequiredFixed Value: order
ReferralRequest.typepreferredSNOMED CT Patient Referral
ReferralRequest.priorityrequiredRequestPriority
ReferralRequest.serviceRequestedpreferredInterweave UkCore Care Service Type
ReferralRequest.specialtypreferredInterweaveUKCorePracticeSettingCode
ReferralRequest.reasonCodepreferredInterweave R4 Encounter Reason

Constraints

IdGradePath(s)DetailsRequirements
ele-1errorReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferralAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorReferralRequest.extension:referralRequestMethod, ReferralRequest.extension:sourceOfReferralMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron