ServiceRequestReferral

Introduction

The ServiceRequestReferral profile is used for retrieving data about a referral request. This profile is based on the FHIR resource ServiceRequest. It includes information like referral date, requester, receiver and also references a Composition resource with referral record data.

Intended Use

The intended use for this API is to get information about a patient's referral requests, both ongoing and completed. The referrals with accompanied data such as assessments and answers can be retrieved when the external system user is the patient to which record the data belongs.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Type Description
Rule The consumer of the API is responsible for making sure data retrieved is filtered in compliance with laws and regulations prior to presenting it to any end-users.
Rule For reading referral information, the external system needs to be able to evaluate PDL. This means whether the information can be displayed for a healthcare professional with a specific assignment. PDL data needed (HSA care unit and HSA care provider) is retrieved by including the organization referenced from ServiceRequest.performer.PractitionerRoleLiteSe (PractitionerRoleLiteSe.OrganizationSEVendorLite).

Profile Overview

ServiceRequestReferral

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ1..1canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
instantiatesCanonicalΣ0..0canonical(ActivityDefinition | PlanDefinition)
instantiatesUriΣ0..0uri
basedOnΣ I0..0Reference(CarePlan | ServiceRequest | MedicationRequest)
replacesΣ I0..0Reference(ServiceRequest)
requisitionΣ0..0Identifier
statusΣ ?!1..1codeBinding
intentΣ ?!1..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
priorityΣ0..0codeBinding
doNotPerformΣ ?!0..0boolean
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
orderDetailΣ I0..0CodeableConcept
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
authoredOnΣ1..1dateTime
requesterΣ I1..1Reference(PractitionerRole | Patient | Organization | Practitioner)
performerΣ I0..1Reference(PractitionerRoleLiteSe | Organization | Practitioner)
locationCodeΣ0..0CodeableConcept
locationReferenceΣ I0..0Reference(Location)
reasonCodeΣ0..1CodeableConcept
reasonReferenceΣ I0..0Reference(Condition | Observation | DiagnosticReport | DocumentReference)
insuranceI0..0Reference(Coverage | ClaimResponse)
supportingInfoI0..1Reference(CompositionReferralClinicalInformation)
specimenΣ I0..0Reference(Specimen)
bodySiteΣ0..0CodeableConcept
note0..0Annotation
patientInstructionΣ0..0string
relevantHistoryI0..0Reference(Provenance)

Versions

COS version Profile version Required COSMIC version Date Description
2.4.0 1.1.0 R8.3.04 Feb 2022 Enhanced support for PDL.
2.3.0 1.0.0 R8.3.03 Nov 2021 Initial version, support for GET.

Terminology Bindings

The profile Category element is bound to the Snomed CT concept |3457005 | Patient referral (procedure)| to indicate that this ServiceRequest is a type of referral.

ValueSet

The profile includes bindings to the following Cambio defined value set: ReferralRequestTypes

Code Display
306098008 Self-referral
44383000 Patient referral for consultation
3457005 Patient referral

This value set includes codes from Snomed CT.

Supported Operations

HTTP Methods

Method Description
GET Support for GET ServiceRequest by specific Id, and also to search by subject.

Query Operations

Search Parameters

Parameter Format Mandatory Comment
_profile string No
subject reference Yes The subject that the observation is about (if patient). The reference can be a literal reference ex: subject=1 or a Business identifier as well.ex: subject.identifier=urn:oid:1.2.752.129.2.1.3.1|20200109-6078

Supported Queries

  1. GET [baseURL]/ServiceRequest/[id] (Read)
  2. GET [baseURL]/ServiceRequest/subject= (Search)
  3. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;subject (Search)
  4. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;requester (Search)
  5. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;requester.practitioner (Search)
  6. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;requester.organization (Search)
  7. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;performer (Search)
  8. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;performer.practitioner (Search)
  9. GET [baseURL]/ServiceRequest/subject=[id]&_include=ServiceRequest;performer.organization (Search)
  10. GET [baseURL]/ServiceRequest/subject=[id]&_revinclude=Task;focus (Search)

Error codes

No specific error codes for ServiceRequest. For common codes, refer to Error handling section.