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.

FHIR Resource: ReferralRequest http://hl7.org/fhir/stu3/referralrequest.html

Required Profile

https://healthgorilla.com/fhir/StructureDefinition/hg-referral

https://api.healthgorilla.com/fhir/ReferralRequest

Supported Attributes

Name	Comment
identifier
status
intent	order
subject	Patient
authoredOn
requester
recipient	Single recipient only. Practitioner or Organization
https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-recipient	Recipient Practitioner and Organization.
note
reasonCode	ICD10
supportingInfo	DiagnosticReport, DocumentReference, Binary
https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-deliveryOptions
https://www.healthgorilla.com/fhir/StructureDefinition/referralrequest-reply

FHIR Operations

The following operations are currently supported:

1.Read

HTTP Request	Method	Action
/ReferralRequest/{ID}	GET	Retrieve ReferralRequest resource by ID

2.Search

HTTP Request	Method	Action
/ReferralRequest?[parameter={value}]	GET	Retrieve ReferralRequest resources by the specified search criteria

Parameters:

Name	Type	Description
patient	Reference	Patient Identifier
identifier	Token	External Identifier
status	Token
_lastUpdated	Date	gt, ge, eq
_offset	Number	Default is 0
_count	Number	Default is 100
_include		Use to include linked Patient and related Observations into result Bundle. https://www.hl7.org/fhir/STU3/search.html#include

Available values for include directive:

Include	Criteria	Resource
_include	ReferralRequest:subject	Patient
_include	ReferralRequest:requester.agent	Practitioner
_include	ReferralRequest:requester.onBehalfOf	Organization
_include	ReferralRequest:recipient	Practitioner and(or) Organization
_include	ReferralRequest:supportingInfo	DiagnosticReport, DocumentReference

Examples

2.1 Get referral with Health Gorilla identifier '0cb02b5bb9e7f9318af8dd67', include recipient and supported documents.

https://api.healthgorilla.com/fhir/Referralrequest
?identifier=https://www.healthgorilla.com|0cb02b5bb9e7f9318af8dd67
&_include=ReferralRequest:recipient
&_include=ReferralRequest:supportingInfo

2.2 Retrieve Referrals by patient updated in March 2020

https://api.healthgorilla.com/fhir/ReferralRequest
?patient=8063965523692105bfc35def
&_lastUpdated=eq2020-03

3. Download PDF

You can generate a PDF copy of the record using the following request:

HTTP Request	Method	Action
/ReferralRequest/{ID}/$pdf	GET	Generate PDF

The result contains a link to a Binary resource (PDF) that can be downloaded.

Example

https://api.healthgorilla.com/fhir/ReferralRequest/8063965523692105bfc35def/$pdf

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "url",
            "valueString": "http://api.healthgorilla.com/fhir/Binary/bf5e745ba2f573534d447686"
        },
        {
            "name": "contentType",
            "valueString": "application/pdf"
        },
        {
            "name": "size",
            "valuePositiveInt": 13081
        }
    ]
}

4. Create

You can send a new referral request to the specified practitioner or organization.

HTTP Request	Method	Action
/ReferralRequest	POST	Submit new referral

You can send a referral to

an existing HealthGorilla practitioner
any practitioner by fax or email
an existing HealthGorilla organization