ReferralRequest - FHIR Resource (stu3)


This ReferralRequest Resource uses the FHIR API standard for access and structure.

Resource Attributes

AttributeField is listTypeDescription
authoredOnfalsedateTime Date of creation/activation
basedOntrueReference Request fulfilled by this request
contextfalseReference Originating encounter
definitiontrueReference Instantiates protocol or definition
descriptionfalsestring A textual description of the referral
groupIdentifierfalseIdentifier Composite request this is part of
identifiertrueIdentifier Business identifier
intentfalsecode proposal | plan | order
notetrueAnnotation Comments made about referral request
occurrenceDateTimefalsedateTime "occurrenceDateTime" : "<dateTime>",
occurrencePeriodfalsePeriod "occurrencePeriod" : { Period },
priorityfalsecode Urgency of referral / transfer of care request
reasonCodetrueCodeableConcept Reason for referral / transfer of care request
reasonReferencetrueReference Why is service needed?
recipienttrueReference Receiver of referral / transfer of care request
relevantHistorytrueReference Key events in history of request
replacestrueReference Request(s) replaced by this request
requesterfalseData Type Who/what is requesting service
serviceRequestedtrueCodeableConcept Actions requested as part of the referral
specialtyfalseCodeableConcept The clinical specialty (discipline) that the referral is requested for
statusfalsecode draft | active | suspended | cancelled | completed | entered-in-error | unknown
subjectfalseReference Patient referred to care or transfer
supportingInfotrueReference Additonal information to support referral or transfer of care request
typefalseCodeableConcept Referral/Transition of care request type

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 the like so:

https://api.1up.health/fhir/stu3/ReferralRequest?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
authored-ondateauthoredOn
based-onreferencebasedOn
contextreferencecontext
definitionreferencedefinition
encounterreferencecontext
group-identifiertextgroupIdentifier
identifiertextidentifier
intenttextintent
occurrence-datedateoccurrence
patientreferencesubject
prioritytextpriority
recipientreferencerecipient
replacesreferencereplaces
requesterreferencerequester.agent
servicetextserviceRequested
specialtytextspecialty
statustextstatus
subjectreferencesubject
typetexttype