ReferralRequest - FHIR Resource (stu3)
This ReferralRequest Resource uses the FHIR API standard for access and structure.
Validate an ReferralRequest FHIR Resource (stu3)
ReferralRequest Attributes
AttributeField is listTypeDescription
Description: Key events in history of request
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relevantHistory": Learn more about the (ReferralRequest) relevantHistory FHIR attribute
Description: Reason for referral / transfer of care request
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCode": [
{
"text": "For consideration of Grommets"
}
]Learn more about the (ReferralRequest) reasonCode FHIR attribute
Description: Patient referred to care or transfer
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"display": "Beverly Weaver",
"reference": "https://fhir.orionhealth.com/blaze/fhir/Patient/77662"
}Learn more about the (ReferralRequest) subject FHIR attribute
Description: Comments made about referral request
FHIR Version: stu3
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (ReferralRequest) note FHIR attribute
Description: Request fulfilled by this request
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"basedOn": [
{
"display": "ProcedureRequest for Myringotomy and insertion of tympanic ventilation tube"
}
]Learn more about the (ReferralRequest) basedOn FHIR attribute
Description: Actions requested as part of the referral
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"serviceRequested": [
{
"text": "Insertion of grommets",
"coding": [
{
"code": "172676009",
"system": "http://snomed.info/sct",
"display": "Myringotomy and insertion of tympanic ventilation tube"
}
]
}
]Learn more about the (ReferralRequest) serviceRequested FHIR attribute
Description: Urgency of referral / transfer of care request
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priority": "routine"Learn more about the (ReferralRequest) priority FHIR attribute
Description: "occurrencePeriod" : { Period },
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrencePeriod": {
"end": "2014-03-14"
}Learn more about the (ReferralRequest) occurrencePeriod FHIR attribute
Description: Referral/Transition of care request type
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": {
"coding": [
{
"code": "103696004",
"system": "http://snomed.info/sct",
"display": "Patient referral to specialist"
}
]
}Learn more about the (ReferralRequest) type FHIR attribute
Description: draft | active | suspended | cancelled | completed | entered-in-error | unknown
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (ReferralRequest) status FHIR attribute
Description: A textual description of the referral
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "In the past 2 years Beverly has had 6 instances of r) sided Otitis media. She is falling behind her peers at school, and displaying some learning difficulties."Learn more about the (ReferralRequest) description FHIR attribute
Description: Composite request this is part of
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"groupIdentifier": {
"value": "1234"
}Learn more about the (ReferralRequest) groupIdentifier FHIR attribute
Description: The clinical specialty (discipline) that the referral is requested for
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"specialty": {
"coding": [
{
"code": "ent",
"system": "http://orionhealth.com/fhir/apps/specialties",
"display": "ENT"
}
]
}Learn more about the (ReferralRequest) specialty FHIR attribute
Description: Additonal information to support referral or transfer of care request
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supportingInfo": Learn more about the (ReferralRequest) supportingInfo FHIR attribute
Description: Request(s) replaced by this request
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"replaces": [
{
"display": "prior ReferralRequest"
}
]Learn more about the (ReferralRequest) replaces FHIR attribute
Description: proposal | plan | order
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"intent": "order"Learn more about the (ReferralRequest) intent FHIR attribute
Description: Who/what is requesting service
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requester": {
"agent": {
"display": "Serena Shrink",
"reference": "https://fhir.orionhealth.com/blaze/fhir/Practitioner/77272"
}
}Learn more about the (ReferralRequest) requester FHIR attribute
Description: "occurrenceDateTime" : "<dateTime>",
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrenceDateTime": Learn more about the (ReferralRequest) occurrenceDateTime FHIR attribute
Description: Receiver of referral / transfer of care request
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"recipient": [
{
"display": "Dr Dave",
"reference": "https://fhir.orionhealth.com/blaze/fhir/Practitioner/76597"
}
]Learn more about the (ReferralRequest) recipient FHIR attribute
Description: Instantiates protocol or definition
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"definition": [
{
"display": "Protocol for insertion of tympanic ventilation tube"
}
]Learn more about the (ReferralRequest) definition FHIR attribute
Description: Date of creation/activation
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"authoredOn": "2014-02-14"Learn more about the (ReferralRequest) authoredOn FHIR attribute
Description: Why is service needed?
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonReference": Learn more about the (ReferralRequest) reasonReference FHIR attribute
Description: Originating encounter
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"context": {
"display": "Beverly Waver's encounter on 2014-02-14"
}Learn more about the (ReferralRequest) context FHIR attribute
Description: Business identifier
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://orionhealth.com/fhir/apps/referralids",
"value": "ret4421"
}
]Learn more about the (ReferralRequest) identifier FHIR attribute
ReferralRequest Example
{
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Referral to Dr Dave for Beverly weaver to have grommets inserted in her r) ear</div>"
},
"reasonCode": [
{
"text": "For consideration of Grommets"
}
],
"id": "example",
"subject": {
"display": "Beverly Weaver",
"reference": "https://fhir.orionhealth.com/blaze/fhir/Patient/77662"
},
"basedOn": [
{
"display": "ProcedureRequest for Myringotomy and insertion of tympanic ventilation tube"
}
],
"serviceRequested": [
{
"text": "Insertion of grommets",
"coding": [
{
"code": "172676009",
"system": "http://snomed.info/sct",
"display": "Myringotomy and insertion of tympanic ventilation tube"
}
]
}
],
"priority": "routine",
"occurrencePeriod": {
"end": "2014-03-14"
},
"type": {
"coding": [
{
"code": "103696004",
"system": "http://snomed.info/sct",
"display": "Patient referral to specialist"
}
]
},
"status": "active",
"description": "In the past 2 years Beverly has had 6 instances of r) sided Otitis media. She is falling behind her peers at school, and displaying some learning difficulties.",
"groupIdentifier": {
"value": "1234"
},
"specialty": {
"coding": [
{
"code": "ent",
"system": "http://orionhealth.com/fhir/apps/specialties",
"display": "ENT"
}
]
},
"authoredOn": "2014-02-14",
"intent": "order",
"requester": {
"agent": {
"display": "Serena Shrink",
"reference": "https://fhir.orionhealth.com/blaze/fhir/Practitioner/77272"
}
},
"recipient": [
{
"display": "Dr Dave",
"reference": "https://fhir.orionhealth.com/blaze/fhir/Practitioner/76597"
}
],
"definition": [
{
"display": "Protocol for insertion of tympanic ventilation tube"
}
],
"replaces": [
{
"display": "prior ReferralRequest"
}
],
"resourceType": "ReferralRequest",
"context": {
"display": "Beverly Waver's encounter on 2014-02-14"
},
"identifier": [
{
"system": "http://orionhealth.com/fhir/apps/referralids",
"value": "ret4421"
}
]
}ReferralRequest Structure
{
"resourceType" : "ReferralRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier
"definition" : [{ Reference(ActivityDefinition|PlanDefinition) }], // Instantiates protocol or definition
"basedOn" : [{ Reference(ReferralRequest|CarePlan|ProcedureRequest) }], // Request fulfilled by this request
"replaces" : [{ Reference(ReferralRequest) }], // Request(s) replaced by this request
"groupIdentifier" : { Identifier }, // Composite request this is part of
"status" : "<code>", // R! draft | active | suspended | cancelled | completed | entered-in-error | unknown
"intent" : "<code>", // R! proposal | plan | order
"type" : { CodeableConcept }, // Referral/Transition of care request type
"priority" : "<code>", // Urgency of referral / transfer of care request
"serviceRequested" : [{ CodeableConcept }], // Actions requested as part of the referral
"subject" : { Reference(Patient|Group) }, // R! Patient referred to care or transfer
"context" : { Reference(Encounter|EpisodeOfCare) }, // Originating encounter
// occurrence[x]: When the service(s) requested in the referral should occur. One of these 2:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"authoredOn" : "<dateTime>", // Date of creation/activation
"requester" : { // Who/what is requesting service
"agent" : { Reference(Practitioner|Organization|Patient|RelatedPerson|
Device) }, // R! Individual making the request
"onBehalfOf" : { Reference(Organization) } // C? Organization agent is acting for
},
"specialty" : { CodeableConcept }, // The clinical specialty (discipline) that the referral is requested for
"recipient" : [{ Reference(Practitioner|Organization|HealthcareService) }], // Receiver of referral / transfer of care request
"reasonCode" : [{ CodeableConcept }], // Reason for referral / transfer of care request
"reasonReference" : [{ Reference(Condition|Observation) }], // Why is service needed?
"description" : "<string>", // A textual description of the referral
"supportingInfo" : [{ Reference(Any) }], // Additonal information to support referral or transfer of care request
"note" : [{ Annotation }], // Comments made about referral request
"relevantHistory" : [{ Reference(Provenance) }] // Key events in history of request
}
ReferralRequest Search Parameters
The following search parameters can be used to query ReferralRequest resources. Just submit them like so:
https://api.1up.health/fhir/stu3/ReferralRequest?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
authored-on | date | authoredOn |
based-on | reference | basedOn |
context | reference | context |
definition | reference | definition |
encounter | reference | context |
group-identifier | text | groupIdentifier |
identifier | text | identifier |
intent | text | intent |
occurrence-date | date | occurrence |
patient | reference | subject |
priority | text | priority |
recipient | reference | recipient |
replaces | reference | replaces |
requester | reference | requester.agent |
service | text | serviceRequested |
specialty | text | specialty |
status | text | status |
subject | reference | subject |
type | text | type |
