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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ReferralRequest	This is a ReferralRequest resource
identifier	array(Identifier)		Business identifier that uniquely identifies the referral/care transfer request instance.
definition	array(Reference)		A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOn	array(Reference)		Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
replaces	array(Reference)		Completed or terminated request(s) whose function is taken by this new request.
groupIdentifier	Identifier		The business identifier of the logical "grouping" request/order that this referral is a part of.
status	string		The status of the authorization/intention reflected by the referral request record.
intent	string		Distinguishes the "level" of authorization/demand implicit in this request.
type	CodeableConcept		An indication of the type of referral (or where applicable the type of transfer of care) request.
priority	string		An indication of the urgency of referral (or where applicable the type of transfer of care) request.
serviceRequested	array(CodeableConcept)		The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
subject*	Reference		The patient who is the subject of a referral or transfer of care request.
context	Reference		The encounter at which the request for referral or transfer of care is initiated.
occurrenceDateTime	string		The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
occurrencePeriod	Period		The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
authoredOn	string		Date/DateTime of creation for draft requests and date of activation for active requests.
requester	ReferralRequest_Requester		The individual who initiated the request and has responsibility for its activation.
specialty	CodeableConcept		Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
recipient	array(Reference)		The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
reasonCode	array(CodeableConcept)		Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
reasonReference	array(Reference)		Indicates another resource whose existence justifies this request.
description	string		The 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.
supportingInfo	array(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.
note	array(Annotation)		Comments made about the referral request by any of the participants.
relevantHistory	array(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

201 400 401 404

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*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	ReferralRequest	This is a ReferralRequest resource
identifier	array(Identifier)		Business identifier that uniquely identifies the referral/care transfer request instance.
definition	array(Reference)		A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOn	array(Reference)		Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
replaces	array(Reference)		Completed or terminated request(s) whose function is taken by this new request.
groupIdentifier	Identifier		The business identifier of the logical "grouping" request/order that this referral is a part of.
status	string		The status of the authorization/intention reflected by the referral request record.
intent	string		Distinguishes the "level" of authorization/demand implicit in this request.
type	CodeableConcept		An indication of the type of referral (or where applicable the type of transfer of care) request.
priority	string		An indication of the urgency of referral (or where applicable the type of transfer of care) request.
serviceRequested	array(CodeableConcept)		The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
subject*	Reference		The patient who is the subject of a referral or transfer of care request.
context	Reference		The encounter at which the request for referral or transfer of care is initiated.
occurrenceDateTime	string		The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
occurrencePeriod	Period		The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
authoredOn	string		Date/DateTime of creation for draft requests and date of activation for active requests.
requester	ReferralRequest_Requester		The individual who initiated the request and has responsibility for its activation.
specialty	CodeableConcept		Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
recipient	array(Reference)		The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
reasonCode	array(CodeableConcept)		Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
reasonReference	array(Reference)		Indicates another resource whose existence justifies this request.
description	string		The 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.
supportingInfo	array(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.
note	array(Annotation)		Comments made about the referral request by any of the participants.
relevantHistory	array(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

200 201 400 401 404 409

Read Referral Request

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Referral Request

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Referral Request

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Referral Request

delete

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Referral Request

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
authored-on	string
based-on	string
context	string
definition	string
encounter	string
group-identifier	string
identifier	string
intent	string
occurrence-date	string
patient	string
priority	string
recipient	string
replaces	string
requester	string
service	string
specialty	string
status	string
subject	string
type	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Referral Request

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

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*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
authored-on	string
based-on	string
context	string
definition	string
encounter	string
group-identifier	string
identifier	string
intent	string
occurrence-date	string
patient	string
priority	string
recipient	string
replaces	string
requester	string
service	string
specialty	string
status	string
subject	string
type	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ReferralRequest	This is a ReferralRequest resource
identifier	array(Identifier)		Business identifier that uniquely identifies the referral/care transfer request instance.
definition	array(Reference)		A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOn	array(Reference)		Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
replaces	array(Reference)		Completed or terminated request(s) whose function is taken by this new request.
groupIdentifier	Identifier		The business identifier of the logical "grouping" request/order that this referral is a part of.
status	string		The status of the authorization/intention reflected by the referral request record.
intent	string		Distinguishes the "level" of authorization/demand implicit in this request.
type	CodeableConcept		An indication of the type of referral (or where applicable the type of transfer of care) request.
priority	string		An indication of the urgency of referral (or where applicable the type of transfer of care) request.
serviceRequested	array(CodeableConcept)		The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
subject*	Reference		The patient who is the subject of a referral or transfer of care request.
context	Reference		The encounter at which the request for referral or transfer of care is initiated.
occurrenceDateTime	string		The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
occurrencePeriod	Period		The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
authoredOn	string		Date/DateTime of creation for draft requests and date of activation for active requests.
requester	ReferralRequest_Requester		The individual who initiated the request and has responsibility for its activation.
specialty	CodeableConcept		Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
recipient	array(Reference)		The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
reasonCode	array(CodeableConcept)		Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
reasonReference	array(Reference)		Indicates another resource whose existence justifies this request.
description	string		The 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.
supportingInfo	array(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.
note	array(Annotation)		Comments made about the referral request by any of the participants.
relevantHistory	array(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

200 401 404

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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	ReferralRequest	This is a ReferralRequest resource
identifier	array(Identifier)		Business identifier that uniquely identifies the referral/care transfer request instance.
definition	array(Reference)		A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOn	array(Reference)		Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
replaces	array(Reference)		Completed or terminated request(s) whose function is taken by this new request.
groupIdentifier	Identifier		The business identifier of the logical "grouping" request/order that this referral is a part of.
status	string		The status of the authorization/intention reflected by the referral request record.
intent	string		Distinguishes the "level" of authorization/demand implicit in this request.
type	CodeableConcept		An indication of the type of referral (or where applicable the type of transfer of care) request.
priority	string		An indication of the urgency of referral (or where applicable the type of transfer of care) request.
serviceRequested	array(CodeableConcept)		The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
subject*	Reference		The patient who is the subject of a referral or transfer of care request.
context	Reference		The encounter at which the request for referral or transfer of care is initiated.
occurrenceDateTime	string		The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
occurrencePeriod	Period		The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
authoredOn	string		Date/DateTime of creation for draft requests and date of activation for active requests.
requester	ReferralRequest_Requester		The individual who initiated the request and has responsibility for its activation.
specialty	CodeableConcept		Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
recipient	array(Reference)		The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
reasonCode	array(CodeableConcept)		Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
reasonReference	array(Reference)		Indicates another resource whose existence justifies this request.
description	string		The 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.
supportingInfo	array(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.
note	array(Annotation)		Comments made about the referral request by any of the participants.
relevantHistory	array(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

200 201 400 401 404 409