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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringSupplyRequestThis is a SupplyRequest resource
identifierIdentifierUnique identifier for this supply request.
statusstringdraft|active|suspended|cancelled|completed|entered-in-error|unknownStatus of the supply request.
categoryCodeableConceptCategory of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
prioritystringIndicates how quickly this SupplyRequest should be addressed with respect to other requests.
orderedItemSupplyRequest_OrderedItemThe item being requested.
occurrenceDateTimestringWhen the request should be fulfilled.
occurrencePeriodPeriodWhen the request should be fulfilled.
occurrenceTimingTimingWhen the request should be fulfilled.
authoredOnstringWhen the request was made.
requesterSupplyRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
supplierarray(Reference)Who is intended to fulfill the request.
reasonCodeableConceptCodeableConceptWhy the supply item was requested.
reasonReferenceReferenceWhy the supply item was requested.
deliverFromReferenceWhere the supply is expected to come from.
deliverToReferenceWhere the supply is destined to go.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringSupplyRequestThis is a SupplyRequest resource
identifierIdentifierUnique identifier for this supply request.
statusstringdraft|active|suspended|cancelled|completed|entered-in-error|unknownStatus of the supply request.
categoryCodeableConceptCategory of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
prioritystringIndicates how quickly this SupplyRequest should be addressed with respect to other requests.
orderedItemSupplyRequest_OrderedItemThe item being requested.
occurrenceDateTimestringWhen the request should be fulfilled.
occurrencePeriodPeriodWhen the request should be fulfilled.
occurrenceTimingTimingWhen the request should be fulfilled.
authoredOnstringWhen the request was made.
requesterSupplyRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
supplierarray(Reference)Who is intended to fulfill the request.
reasonCodeableConceptCodeableConceptWhy the supply item was requested.
reasonReferenceReferenceWhy the supply item was requested.
deliverFromReferenceWhere the supply is expected to come from.
deliverToReferenceWhere the supply is destined to go.

Response

Read Supply Request

get
/organizations/{organizationId}/fhir/3/SupplyRequest/{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 Supply Request

get
/organizations/{organizationId}/fhir/3/SupplyRequest/{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 Supply Request

get
/organizations/{organizationId}/fhir/3/SupplyRequest/{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 Supply Request

delete
/organizations/{organizationId}/fhir/3/SupplyRequest/{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 Supply Request

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

Request

Headers

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

Query params

_idstring
_languagestring
categorystring
datestring
identifierstring
requesterstring
statusstring
supplierstring

Params

organizationId*string|stringid|slug

Response

Search History Supply Request

get
/organizations/{organizationId}/fhir/3/SupplyRequest/_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 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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
categorystring
datestring
identifierstring
requesterstring
statusstring
supplierstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringSupplyRequestThis is a SupplyRequest resource
identifierIdentifierUnique identifier for this supply request.
statusstringdraft|active|suspended|cancelled|completed|entered-in-error|unknownStatus of the supply request.
categoryCodeableConceptCategory of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
prioritystringIndicates how quickly this SupplyRequest should be addressed with respect to other requests.
orderedItemSupplyRequest_OrderedItemThe item being requested.
occurrenceDateTimestringWhen the request should be fulfilled.
occurrencePeriodPeriodWhen the request should be fulfilled.
occurrenceTimingTimingWhen the request should be fulfilled.
authoredOnstringWhen the request was made.
requesterSupplyRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
supplierarray(Reference)Who is intended to fulfill the request.
reasonCodeableConceptCodeableConceptWhy the supply item was requested.
reasonReferenceReferenceWhy the supply item was requested.
deliverFromReferenceWhere the supply is expected to come from.
deliverToReferenceWhere the supply is destined to go.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringSupplyRequestThis is a SupplyRequest resource
identifierIdentifierUnique identifier for this supply request.
statusstringdraft|active|suspended|cancelled|completed|entered-in-error|unknownStatus of the supply request.
categoryCodeableConceptCategory of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
prioritystringIndicates how quickly this SupplyRequest should be addressed with respect to other requests.
orderedItemSupplyRequest_OrderedItemThe item being requested.
occurrenceDateTimestringWhen the request should be fulfilled.
occurrencePeriodPeriodWhen the request should be fulfilled.
occurrenceTimingTimingWhen the request should be fulfilled.
authoredOnstringWhen the request was made.
requesterSupplyRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
supplierarray(Reference)Who is intended to fulfill the request.
reasonCodeableConceptCodeableConceptWhy the supply item was requested.
reasonReferenceReferenceWhy the supply item was requested.
deliverFromReferenceWhere the supply is expected to come from.
deliverToReferenceWhere the supply is destined to go.

Response