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 outcome of triage recommendation to another service for a patient.

Detailed implementation guidance for a ReferralRequest resource in the context of a CDS Encounter Report 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 be populated with the 'generic' ReferralRequest received from the CDSS during triage.
replaces 0..* Reference
(ReferralRequest)
Request(s) replaced by this request If this Encounter Report is replacing a previously sent Encounter Report with a different ReferralRequest , this MUST be populated with the previous ReferralRequest .
groupIdentifier 0..1 Identifier Composite request this is part of This MUST NOT be populated
status 1..1 code draft | active | suspended | completed | entered-in-error | cancelled RequestStatus (Required)
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 theEncounter.
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'
This MUST match the occurrence returned in the $evaluate.referralrequest.
authoredOn 0..1 dateTime Date of creation/activation This MUST be populated
requester 0..1 BackboneElement Who/what is requesting service - onBehalfOf can only be specified if agent is practitioner or device This MUST be populated with the EMS User
agent 1..1 Reference
(Practitioner |
Organization |
Patient |
RelatedPerS e
Individual making the request
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 MAY be populated by the EMS
recipient 0..* Reference
(Practitioner |
Organization |
HealthcareService)
Receiver of referral/transfer of care request This MUST be populated with the HealthcareService selected from the $check-services response (or other appropriate override).
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 MAY be populated with additional notes entered by the EMS user. If populated this SHOULD be displayed.
relevantHistory 0..* Reference
(Provenance)
Key events in history of request Where populated in the $evaluate.referralrequest this must be populated with a reference to the same.
Tags: rest fhir api

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