ReferralRequest_GET
GET {{baseUrl}}/ReferralRequest?patient=<string>&based-on=<string>&context=<string>&definition=<string>&encounter=<string>&recipient=<string>&replaces=<string>&requester=<string>&subject=<string>&_id=<string>&_lastUpdated=<date>&_profile=<string>&_security=<string>&_tag=<string>&type=<string>&authored-on=<date>&group-identifier=<string>&identifier=<string>&intent=<string>&occurrence-date=<date>&priority=<string>&service=<string>&specialty=<string>&status=<string>&_format=<string>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
patient | string | Multiple Resources: |
-
ReferralRequest: Who the referral is about
-
DocumentManifest: The subject of the set of documents
-
Goal: Who this goal is intended for
-
Consent: Who the consent applies to
-
DocumentReference: Who/what is the subject of the document
-
ImagingManifest: Subject of the ImagingManifest (or a DICOM Key Object Selection which it represents)
-
RiskAssessment: Who/what does assessment apply to?
-
CareTeam: Who care team is for
-
ImagingStudy: Who the study is about
-
FamilyMemberHistory: The identity of a subject to list family member history items for
-
Encounter: The patient ro group present at the encounter
-
DeviceUseStatement: Search by subject - a patient
-
DeviceRequest: Individual the service is ordered for
-
AllergyIntolerance: Who the sensitivity is for
-
CarePlan: Who care plan is for
-
EpisodeOfCare: The patient who is the focus of this episode of care
-
Procedure: Search by subject - a patient
-
List: If all resources have the same subject
-
Immunization: The patient for the vaccination record
-
VisionPrescription: The identity of a patient to list dispenses for
-
ProcedureRequest: Search by subject - a patient
-
Flag: The identity of a subject to list flags for
-
Observation: The subject that the observation is about (if patient)
-
DiagnosticReport: The subject of the report if a patient
-
NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement
-
Condition: Who has the condition?
-
Composition: Who and/or what the composition is about
-
DetectedIssue: Associated patient
-
SupplyDelivery: Patient for whom the item is supplied
-
ClinicalImpression: Patient or group assessed | |
based-on
| string | | Request being fulfilled | |context
| string | | Part of encounter or episode of care | |definition
| string | | Instantiates protocol or definition | |encounter
| string | | Originating encounter | |recipient
| string | | The person that the referral was sent to | |replaces
| string | | Request(s) replaced by this request | |requester
| string | | Individual making the request | |subject
| string | | Patient referred to care or transfer | |_id
| string | | Logical id of this artifact | |_lastUpdated
| string | | When the resource version last changed | |_profile
| string | | Profiles this resource claims to conform to | |_security
| string | | Security Labels applied to this resource | |_tag
| string | | Tags applied to this resource | |type
| string | | Multiple Resources: -
ReferralRequest: The type of the referral
-
DocumentManifest: Kind of document set
-
DocumentReference: Kind of document (LOINC if possible)
-
Encounter: Specific type of encounter
-
AllergyIntolerance: allergy | intolerance - Underlying mechanism (if known)
-
EpisodeOfCare: Type/class - e.g. specialist referral, disease management
-
Composition: Kind of composition (LOINC if possible) | |
authored-on
| string | | Creation or activation date | |group-identifier
| string | | Part of common request | |identifier
| string | | Business identifier | |intent
| string | | Proposal, plan or order | |occurrence-date
| string | | When the service(s) requested in the referral should occur | |priority
| string | | The priority assigned to the referral | |service
| string | | Actions requested as part of the referral | |specialty
| string | | The specialty that the referral is for | |status
| string | | The status of the referral | |_format
| string | | |
RESPONSES
status: OK
[{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"status":"\u003cstring\u003e","category":"\u003cstring\u003e","type":{"fhir_comments":["\u003cobject\u003e","\u003cobject\u003e"],"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"priority":{"fhir_comments":["\u003cobject\u003e","\u003cobject\u003e"],"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"patient":{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"},"authored":"\u003cstring\u003e","requester":{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"},"specialty":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"recipient":[{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"reason":{"text":"\u003cstring\u003e"},"description":"\u003cstring\u003e","serviceRequested":[{"text":"\u003cstring\u003e","coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}]},{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"status":"\u003cstring\u003e","category":"\u003cstring\u003e","type":{"fhir_comments":["\u003cobject\u003e","\u003cobject\u003e"],"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"priority":{"fhir_comments":["\u003cobject\u003e","\u003cobject\u003e"],"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"patient":{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"},"authored":"\u003cstring\u003e","requester":{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"},"specialty":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"recipient":[{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}],"reason":{"text":"\u003cstring\u003e"},"description":"\u003cstring\u003e","serviceRequested":[{"text":"\u003cstring\u003e","coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}]}]