referral requests

Create Referral Request

post
/organizations/{organizationId}/fhir/3/ReferralRequest

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringReferralRequestThis is a ReferralRequest resource
identifierarray(Identifier)Business identifier that uniquely identifies the referral/care transfer request instance.
definitionarray(Reference)A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOnarray(Reference)Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
replacesarray(Reference)Completed or terminated request(s) whose function is taken by this new request.
groupIdentifierIdentifierThe business identifier of the logical "grouping" request/order that this referral is a part of.
statusstringThe status of the authorization/intention reflected by the referral request record.
intentstringDistinguishes the "level" of authorization/demand implicit in this request.
typeCodeableConceptAn indication of the type of referral (or where applicable the type of transfer of care) request.
prioritystringAn indication of the urgency of referral (or where applicable the type of transfer of care) request.
serviceRequestedarray(CodeableConcept)The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
subject*ReferenceThe patient who is the subject of a referral or transfer of care request.
contextReferenceThe encounter at which the request for referral or transfer of care is initiated.
occurrenceDateTimestringThe period of time within which the services identified in the referral/transfer of care is specified or required to occur.
occurrencePeriodPeriodThe period of time within which the services identified in the referral/transfer of care is specified or required to occur.
authoredOnstringDate/DateTime of creation for draft requests and date of activation for active requests.
requesterReferralRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
specialtyCodeableConceptIndication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
recipientarray(Reference)The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
reasonCodearray(CodeableConcept)Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request.
descriptionstringThe reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.
supportingInfoarray(Reference)Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.
notearray(Annotation)Comments made about the referral request by any of the participants.
relevantHistoryarray(Reference)Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Response

Patch Referral Request

patch
/organizations/{organizationId}/fhir/3/ReferralRequest/{resourceId}

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.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringReferralRequestThis is a ReferralRequest resource
identifierarray(Identifier)Business identifier that uniquely identifies the referral/care transfer request instance.
definitionarray(Reference)A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOnarray(Reference)Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
replacesarray(Reference)Completed or terminated request(s) whose function is taken by this new request.
groupIdentifierIdentifierThe business identifier of the logical "grouping" request/order that this referral is a part of.
statusstringThe status of the authorization/intention reflected by the referral request record.
intentstringDistinguishes the "level" of authorization/demand implicit in this request.
typeCodeableConceptAn indication of the type of referral (or where applicable the type of transfer of care) request.
prioritystringAn indication of the urgency of referral (or where applicable the type of transfer of care) request.
serviceRequestedarray(CodeableConcept)The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
subject*ReferenceThe patient who is the subject of a referral or transfer of care request.
contextReferenceThe encounter at which the request for referral or transfer of care is initiated.
occurrenceDateTimestringThe period of time within which the services identified in the referral/transfer of care is specified or required to occur.
occurrencePeriodPeriodThe period of time within which the services identified in the referral/transfer of care is specified or required to occur.
authoredOnstringDate/DateTime of creation for draft requests and date of activation for active requests.
requesterReferralRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
specialtyCodeableConceptIndication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
recipientarray(Reference)The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
reasonCodearray(CodeableConcept)Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request.
descriptionstringThe reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.
supportingInfoarray(Reference)Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.
notearray(Annotation)Comments made about the referral request by any of the participants.
relevantHistoryarray(Reference)Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Response

Read Referral Request

get
/organizations/{organizationId}/fhir/3/ReferralRequest/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Referral Request

get
/organizations/{organizationId}/fhir/3/ReferralRequest/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Referral Request

get
/organizations/{organizationId}/fhir/3/ReferralRequest/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Referral Request

delete
/organizations/{organizationId}/fhir/3/ReferralRequest/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Referral Request

get
/organizations/{organizationId}/fhir/3/ReferralRequest

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authored-onstring
based-onstring
contextstring
definitionstring
encounterstring
group-identifierstring
identifierstring
intentstring
occurrence-datestring
patientstring
prioritystring
recipientstring
replacesstring
requesterstring
servicestring
specialtystring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Referral Request

get
/organizations/{organizationId}/fhir/3/ReferralRequest/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Referral Request

post
/organizations/{organizationId}/fhir/3/ReferralRequest/_search

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.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authored-onstring
based-onstring
contextstring
definitionstring
encounterstring
group-identifierstring
identifierstring
intentstring
occurrence-datestring
patientstring
prioritystring
recipientstring
replacesstring
requesterstring
servicestring
specialtystring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringReferralRequestThis is a ReferralRequest resource
identifierarray(Identifier)Business identifier that uniquely identifies the referral/care transfer request instance.
definitionarray(Reference)A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOnarray(Reference)Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
replacesarray(Reference)Completed or terminated request(s) whose function is taken by this new request.
groupIdentifierIdentifierThe business identifier of the logical "grouping" request/order that this referral is a part of.
statusstringThe status of the authorization/intention reflected by the referral request record.
intentstringDistinguishes the "level" of authorization/demand implicit in this request.
typeCodeableConceptAn indication of the type of referral (or where applicable the type of transfer of care) request.
prioritystringAn indication of the urgency of referral (or where applicable the type of transfer of care) request.
serviceRequestedarray(CodeableConcept)The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
subject*ReferenceThe patient who is the subject of a referral or transfer of care request.
contextReferenceThe encounter at which the request for referral or transfer of care is initiated.
occurrenceDateTimestringThe period of time within which the services identified in the referral/transfer of care is specified or required to occur.
occurrencePeriodPeriodThe period of time within which the services identified in the referral/transfer of care is specified or required to occur.
authoredOnstringDate/DateTime of creation for draft requests and date of activation for active requests.
requesterReferralRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
specialtyCodeableConceptIndication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
recipientarray(Reference)The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
reasonCodearray(CodeableConcept)Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request.
descriptionstringThe reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.
supportingInfoarray(Reference)Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.
notearray(Annotation)Comments made about the referral request by any of the participants.
relevantHistoryarray(Reference)Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Response

Update Referral Request

put
/organizations/{organizationId}/fhir/3/ReferralRequest/{resourceId}

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringReferralRequestThis is a ReferralRequest resource
identifierarray(Identifier)Business identifier that uniquely identifies the referral/care transfer request instance.
definitionarray(Reference)A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOnarray(Reference)Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
replacesarray(Reference)Completed or terminated request(s) whose function is taken by this new request.
groupIdentifierIdentifierThe business identifier of the logical "grouping" request/order that this referral is a part of.
statusstringThe status of the authorization/intention reflected by the referral request record.
intentstringDistinguishes the "level" of authorization/demand implicit in this request.
typeCodeableConceptAn indication of the type of referral (or where applicable the type of transfer of care) request.
prioritystringAn indication of the urgency of referral (or where applicable the type of transfer of care) request.
serviceRequestedarray(CodeableConcept)The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
subject*ReferenceThe patient who is the subject of a referral or transfer of care request.
contextReferenceThe encounter at which the request for referral or transfer of care is initiated.
occurrenceDateTimestringThe period of time within which the services identified in the referral/transfer of care is specified or required to occur.
occurrencePeriodPeriodThe period of time within which the services identified in the referral/transfer of care is specified or required to occur.
authoredOnstringDate/DateTime of creation for draft requests and date of activation for active requests.
requesterReferralRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
specialtyCodeableConceptIndication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
recipientarray(Reference)The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
reasonCodearray(CodeableConcept)Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
reasonReferencearray(Reference)Indicates another resource whose existence justifies this request.
descriptionstringThe reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.
supportingInfoarray(Reference)Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.
notearray(Annotation)Comments made about the referral request by any of the participants.
relevantHistoryarray(Reference)Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

Response