supply requests

Create Supply Request

post

/organizations/{organizationId}/fhir/3/SupplyRequest

A record of a request for a medication, substance or device used in the healthcare setting.

Request

Headers


content-type*	string	application/json	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	SupplyRequest	This is a SupplyRequest resource
identifier	Identifier		Unique identifier for this supply request.
status	string	draft\|active\|suspended\|cancelled\|completed\|entered-in-error\|unknown	Status of the supply request.
category	CodeableConcept		Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
priority	string		Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
orderedItem	SupplyRequest_OrderedItem		The item being requested.
occurrenceDateTime	string		When the request should be fulfilled.
occurrencePeriod	Period		When the request should be fulfilled.
occurrenceTiming	Timing		When the request should be fulfilled.
authoredOn	string		When the request was made.
requester	SupplyRequest_Requester		The individual who initiated the request and has responsibility for its activation.
supplier	array(Reference)		Who is intended to fulfill the request.
reasonCodeableConcept	CodeableConcept		Why the supply item was requested.
reasonReference	Reference		Why the supply item was requested.
deliverFrom	Reference		Where the supply is expected to come from.
deliverTo	Reference		Where the supply is destined to go.

Response

201 400 401 404

Patch Supply Request

patch

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

A record of a request for a medication, substance or device used in the healthcare setting.

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	SupplyRequest	This is a SupplyRequest resource
identifier	Identifier		Unique identifier for this supply request.
status	string	draft\|active\|suspended\|cancelled\|completed\|entered-in-error\|unknown	Status of the supply request.
category	CodeableConcept		Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
priority	string		Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
orderedItem	SupplyRequest_OrderedItem		The item being requested.
occurrenceDateTime	string		When the request should be fulfilled.
occurrencePeriod	Period		When the request should be fulfilled.
occurrenceTiming	Timing		When the request should be fulfilled.
authoredOn	string		When the request was made.
requester	SupplyRequest_Requester		The individual who initiated the request and has responsibility for its activation.
supplier	array(Reference)		Who is intended to fulfill the request.
reasonCodeableConcept	CodeableConcept		Why the supply item was requested.
reasonReference	Reference		Why the supply item was requested.
deliverFrom	Reference		Where the supply is expected to come from.
deliverTo	Reference		Where the supply is destined to go.

Response

200 201 400 401 404 409

Read Supply Request

get

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

Request

Headers


content-type*	string	application/json	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 Supply Request

get

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

Request

Headers


content-type*	string	application/json	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 Supply Request

get

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

Request

Headers


content-type*	string	application/json	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 Supply Request

delete

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

Request

Headers


content-type*	string	application/json	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 Supply Request

get

/organizations/{organizationId}/fhir/3/SupplyRequest

Request

Headers


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

Query params


_id	string
_language	string
category	string
date	string
identifier	string
requester	string
status	string
supplier	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Supply Request

get

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

Request

Headers


content-type*	string	application/json	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 Supply Request

post

/organizations/{organizationId}/fhir/3/SupplyRequest/_search

A record of a request for a medication, substance or device used in the healthcare setting.

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
category	string
date	string
identifier	string
requester	string
status	string
supplier	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	SupplyRequest	This is a SupplyRequest resource
identifier	Identifier		Unique identifier for this supply request.
status	string	draft\|active\|suspended\|cancelled\|completed\|entered-in-error\|unknown	Status of the supply request.
category	CodeableConcept		Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
priority	string		Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
orderedItem	SupplyRequest_OrderedItem		The item being requested.
occurrenceDateTime	string		When the request should be fulfilled.
occurrencePeriod	Period		When the request should be fulfilled.
occurrenceTiming	Timing		When the request should be fulfilled.
authoredOn	string		When the request was made.
requester	SupplyRequest_Requester		The individual who initiated the request and has responsibility for its activation.
supplier	array(Reference)		Who is intended to fulfill the request.
reasonCodeableConcept	CodeableConcept		Why the supply item was requested.
reasonReference	Reference		Why the supply item was requested.
deliverFrom	Reference		Where the supply is expected to come from.
deliverTo	Reference		Where the supply is destined to go.

Response

200 401 404

Update Supply Request

put

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

A record of a request for a medication, substance or device used in the healthcare setting.

Request

Headers


content-type*	string	application/json	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	SupplyRequest	This is a SupplyRequest resource
identifier	Identifier		Unique identifier for this supply request.
status	string	draft\|active\|suspended\|cancelled\|completed\|entered-in-error\|unknown	Status of the supply request.
category	CodeableConcept		Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
priority	string		Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
orderedItem	SupplyRequest_OrderedItem		The item being requested.
occurrenceDateTime	string		When the request should be fulfilled.
occurrencePeriod	Period		When the request should be fulfilled.
occurrenceTiming	Timing		When the request should be fulfilled.
authoredOn	string		When the request was made.
requester	SupplyRequest_Requester		The individual who initiated the request and has responsibility for its activation.
supplier	array(Reference)		Who is intended to fulfill the request.
reasonCodeableConcept	CodeableConcept		Why the supply item was requested.
reasonReference	Reference		Why the supply item was requested.
deliverFrom	Reference		Where the supply is expected to come from.
deliverTo	Reference		Where the supply is destined to go.

Response

200 201 400 401 404 409