Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

ReferralRequest Implementation Guidance

ReferralRequest resource implementation guidance

ReferralRequest: Implementation Guidance

Usage

Within the Clinical Decision Support API implementation, the CareConnect-ReferralRequest-1 profile will be used to carry the triage outcome of recommendation to another service for a patient.

A reference to the relevant ReferralRequest will be carried in the action.resource element of the RequestGroup resource in the form of the logical id of the ReferralRequest.

RequestGroup.action.resource MAY also carry a reference to one or more CarePlans to carry accompanying care advice for the patient.
Detailed implementation guidance for a ReferralRequest resource in the context of a CDS $evaluate interaction is given below:

Name Cardinality Type FHIR Documentation CDS Implementation Guidance
id 0..1 id Logical id of this artifact Note that this will always be populated except when the resource is being created (initial creation call)
meta 0..1 Meta Metadata about the resource
implicitRules 0..1 uri A set of rules under which this content was created
language 0..1 code Language of the resource content.
Common Languages (Extensible but limited to All Languages)
text 0..1 Narrative Text summary of the resource, for human interpretation
contained 0..* Resource Contained, inline Resources This SHOULD NOT be populated
extension 0..* Extension Additional Content defined by implementations
modifierExtension 0..* Extension Extensions that cannot be ignored
identifier 0..* Identifier Business identifier
definition 0..* Reference
(ActivityDefinition |
PlanDefinition)
Instantiates protocol or definition This MAY be populated with an ActivityDefinition, if a standard template for the ReferralRequest has been defined in the local implementation.
basedOn 0..* Reference
(ReferralRequest |
Careplan |
ProcedureRequest)
Request fulfilled by this request This MUST NOT be populated.
replaces 0..* Reference
(ReferralRequest)
Request(s) replaced by this request
groupIdentifier 0..1 Identifier Composite request this is part of This SHOULD be populated.
Where populated it MUST be with the RequestGroup.id
status 1..1 code draft | active | suspended | completed | entered-in-error | cancelled RequestStatus (Required) This MUST be populated with 'draft', 'active' or cancelled'.
intent 1..1 code proposal | plan | order RequestIntent (Required) This MUST be populated with 'plan'
type 0..1 CodeableConcept Referral/Transition of care request type SNOMED CT Patient Referral (Example) This MUST NOT be populated.
priority 0..1 code Urgency of referral/transfer of care request. RequestPriority (Required) This MUST be 'routine'.
serviceRequested 0..* CodeableConcept Actions requested as part of the referral Practice Setting Code Value Set (Example) This MUST NOT be populated.
subject 1..1 Reference
(Patient |
Group)
Patient referred to care or transfer This MUST be populated with a reference to the Patient resource.
context 0..1 Reference
(Encounter |
EpisodeOfCare)
Originating encounter This MUST be populated with a reference to the Encounter supplied in the ServiceDefinition.$evaluate operation.
occurrence[x] 0..1 dateTime
| Period
When the service(s) requested in the referral should occur This MUST be populated.
This MUST use the datatype 'Period'
The start of the period must be 'now'.
authoredOn 0..1 dateTime Date of creation/activation This SHOULD be populated
requester 0..1 BackboneElement Who/what is requesting service - onBehalfOf can only be specified if agent is practitioner or device
requester.agent 1..1 Reference
(Practitioner |
Organization |
Patient |
RelatedPerson |
Device)
Individual making the request This SHOULD be populated with the CDS (Device)
requester.onBehalfOf 0..1 Reference
(Organization)
Organization agent is acting for This SHOULD be populated with the Organisation in the `ServiceDefinition$evaluate`
specialty 0..1 CodeableConcept The clinical specialty (discipline) that the referral is requested for PractitionerSpecialty (Example) This MUST NOT be populated.
recipient 0..* Reference
(Practitioner |
Organization |
HealthcareService)
Receiver of referral/transfer of care request This MUST NOT be populated.
reasonCode 0..* CodeableConcept Reason for referral/transfer of care request SNOMED CT Clinical Findings (Example) This MUST NOT be populated.
reasonReference 0..* Reference
(Condition |
Observation)
Why is service needed? This MUST be populated with the chief concern which MUST be a Condition
description 0..1 string A textual description of the referral This SHOULD be populated by the CDSS.
supportingInfo 0..* Reference
(Any)
Additional information to support referral or transfer of care request This MUST be populated with a ProcedureRequest as the next activity.
Where present, Secondary Concerns MUST be carried in this element.
note 0..* Annotation Comments made about referral request This MUST NOT be populated
relevantHistory 0..* Reference
(Provenance)
Key events in history of request This SHOULD be populated by the CDSS.
Tags: rest fhir api

All content is available under the Open Government Licence v3.0, except where otherwise stated