supply deliverys

Create Supply Delivery

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

Record of delivery of what is supplied.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringSupplyDeliveryThis is a SupplyDelivery resource
identifierIdentifierIdentifier assigned by the dispensing facility when the item(s) is dispensed.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this event.
partOfarray(Reference)A larger event of which this particular event is a component or step.
statusstringin-progress|completed|abandoned|entered-in-errorA code specifying the state of the dispense event.
patientReferenceA link to a resource representing the person whom the delivered item is for.
typeCodeableConceptIndicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
suppliedItemSupplyDelivery_SuppliedItemThe item that is being delivered or has been supplied.
occurrenceDateTimestringThe date or time(s) the activity occurred.
occurrencePeriodPeriodThe date or time(s) the activity occurred.
occurrenceTimingTimingThe date or time(s) the activity occurred.
supplierReferenceThe individual responsible for dispensing the medication, supplier or device.
destinationReferenceIdentification of the facility/location where the Supply was shipped to, as part of the dispense event.
receiverarray(Reference)Identifies the person who picked up the Supply.

Response

Patch Supply Delivery

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

Record of delivery of what is supplied.

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*stringSupplyDeliveryThis is a SupplyDelivery resource
identifierIdentifierIdentifier assigned by the dispensing facility when the item(s) is dispensed.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this event.
partOfarray(Reference)A larger event of which this particular event is a component or step.
statusstringin-progress|completed|abandoned|entered-in-errorA code specifying the state of the dispense event.
patientReferenceA link to a resource representing the person whom the delivered item is for.
typeCodeableConceptIndicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
suppliedItemSupplyDelivery_SuppliedItemThe item that is being delivered or has been supplied.
occurrenceDateTimestringThe date or time(s) the activity occurred.
occurrencePeriodPeriodThe date or time(s) the activity occurred.
occurrenceTimingTimingThe date or time(s) the activity occurred.
supplierReferenceThe individual responsible for dispensing the medication, supplier or device.
destinationReferenceIdentification of the facility/location where the Supply was shipped to, as part of the dispense event.
receiverarray(Reference)Identifies the person who picked up the Supply.

Response

Read Supply Delivery

get
/organizations/{organizationId}/fhir/3/SupplyDelivery/{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 Delivery

get
/organizations/{organizationId}/fhir/3/SupplyDelivery/{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 Delivery

get
/organizations/{organizationId}/fhir/3/SupplyDelivery/{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 Delivery

delete
/organizations/{organizationId}/fhir/3/SupplyDelivery/{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 Delivery

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

Request

Headers

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

Query params

_idstring
_languagestring
identifierstring
patientstring
receiverstring
statusstring
supplierstring

Params

organizationId*string|stringid|slug

Response

Search History Supply Delivery

get
/organizations/{organizationId}/fhir/3/SupplyDelivery/_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 Delivery

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

Record of delivery of what is supplied.

Request

Headers

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

Query params

_idstring
_languagestring
identifierstring
patientstring
receiverstring
statusstring
supplierstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringSupplyDeliveryThis is a SupplyDelivery resource
identifierIdentifierIdentifier assigned by the dispensing facility when the item(s) is dispensed.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this event.
partOfarray(Reference)A larger event of which this particular event is a component or step.
statusstringin-progress|completed|abandoned|entered-in-errorA code specifying the state of the dispense event.
patientReferenceA link to a resource representing the person whom the delivered item is for.
typeCodeableConceptIndicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
suppliedItemSupplyDelivery_SuppliedItemThe item that is being delivered or has been supplied.
occurrenceDateTimestringThe date or time(s) the activity occurred.
occurrencePeriodPeriodThe date or time(s) the activity occurred.
occurrenceTimingTimingThe date or time(s) the activity occurred.
supplierReferenceThe individual responsible for dispensing the medication, supplier or device.
destinationReferenceIdentification of the facility/location where the Supply was shipped to, as part of the dispense event.
receiverarray(Reference)Identifies the person who picked up the Supply.

Response

Update Supply Delivery

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

Record of delivery of what is supplied.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringSupplyDeliveryThis is a SupplyDelivery resource
identifierIdentifierIdentifier assigned by the dispensing facility when the item(s) is dispensed.
basedOnarray(Reference)A plan, proposal or order that is fulfilled in whole or in part by this event.
partOfarray(Reference)A larger event of which this particular event is a component or step.
statusstringin-progress|completed|abandoned|entered-in-errorA code specifying the state of the dispense event.
patientReferenceA link to a resource representing the person whom the delivered item is for.
typeCodeableConceptIndicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
suppliedItemSupplyDelivery_SuppliedItemThe item that is being delivered or has been supplied.
occurrenceDateTimestringThe date or time(s) the activity occurred.
occurrencePeriodPeriodThe date or time(s) the activity occurred.
occurrenceTimingTimingThe date or time(s) the activity occurred.
supplierReferenceThe individual responsible for dispensing the medication, supplier or device.
destinationReferenceIdentification of the facility/location where the Supply was shipped to, as part of the dispense event.
receiverarray(Reference)Identifies the person who picked up the Supply.

Response