supply deliverys
Create Supply Delivery
post
/organizations/{organizationId}/fhir/3/SupplyDelivery
Record of delivery of what is supplied.
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 | SupplyDelivery | This is a SupplyDelivery resource |
| identifier | Identifier | Identifier assigned by the dispensing facility when the item(s) is dispensed. | |
| basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this event. | |
| partOf | array(Reference) | A larger event of which this particular event is a component or step. | |
| status | string | in-progress|completed|abandoned|entered-in-error | A code specifying the state of the dispense event. |
| patient | Reference | A link to a resource representing the person whom the delivered item is for. | |
| type | CodeableConcept | Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. | |
| suppliedItem | SupplyDelivery_SuppliedItem | The item that is being delivered or has been supplied. | |
| occurrenceDateTime | string | The date or time(s) the activity occurred. | |
| occurrencePeriod | Period | The date or time(s) the activity occurred. | |
| occurrenceTiming | Timing | The date or time(s) the activity occurred. | |
| supplier | Reference | The individual responsible for dispensing the medication, supplier or device. | |
| destination | Reference | Identification of the facility/location where the Supply was shipped to, as part of the dispense event. | |
| receiver | array(Reference) | Identifies the person who picked up the Supply. |
Response
keyboard_arrow_down
Patch Supply Delivery
patch
/organizations/{organizationId}/fhir/3/SupplyDelivery/{resourceId}
Record of delivery of what is supplied.
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 | SupplyDelivery | This is a SupplyDelivery resource |
| identifier | Identifier | Identifier assigned by the dispensing facility when the item(s) is dispensed. | |
| basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this event. | |
| partOf | array(Reference) | A larger event of which this particular event is a component or step. | |
| status | string | in-progress|completed|abandoned|entered-in-error | A code specifying the state of the dispense event. |
| patient | Reference | A link to a resource representing the person whom the delivered item is for. | |
| type | CodeableConcept | Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. | |
| suppliedItem | SupplyDelivery_SuppliedItem | The item that is being delivered or has been supplied. | |
| occurrenceDateTime | string | The date or time(s) the activity occurred. | |
| occurrencePeriod | Period | The date or time(s) the activity occurred. | |
| occurrenceTiming | Timing | The date or time(s) the activity occurred. | |
| supplier | Reference | The individual responsible for dispensing the medication, supplier or device. | |
| destination | Reference | Identification of the facility/location where the Supply was shipped to, as part of the dispense event. | |
| receiver | array(Reference) | Identifies the person who picked up the Supply. |
Response
keyboard_arrow_down
Read Supply Delivery
get
/organizations/{organizationId}/fhir/3/SupplyDelivery/{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
keyboard_arrow_down
Read History Supply Delivery
get
/organizations/{organizationId}/fhir/3/SupplyDelivery/{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
keyboard_arrow_down
Read Version Supply Delivery
get
/organizations/{organizationId}/fhir/3/SupplyDelivery/{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
keyboard_arrow_down
Remove Supply Delivery
delete
/organizations/{organizationId}/fhir/3/SupplyDelivery/{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
keyboard_arrow_down
Search Get Supply Delivery
get
/organizations/{organizationId}/fhir/3/SupplyDelivery
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 | ||
| identifier | string | ||
| patient | string | ||
| receiver | string | ||
| status | string | ||
| supplier | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Supply Delivery
get
/organizations/{organizationId}/fhir/3/SupplyDelivery/_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
keyboard_arrow_down
Search Post Supply Delivery
post
/organizations/{organizationId}/fhir/3/SupplyDelivery/_search
Record of delivery of what is supplied.
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 | ||
| identifier | string | ||
| patient | string | ||
| receiver | string | ||
| status | string | ||
| supplier | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | SupplyDelivery | This is a SupplyDelivery resource |
| identifier | Identifier | Identifier assigned by the dispensing facility when the item(s) is dispensed. | |
| basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this event. | |
| partOf | array(Reference) | A larger event of which this particular event is a component or step. | |
| status | string | in-progress|completed|abandoned|entered-in-error | A code specifying the state of the dispense event. |
| patient | Reference | A link to a resource representing the person whom the delivered item is for. | |
| type | CodeableConcept | Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. | |
| suppliedItem | SupplyDelivery_SuppliedItem | The item that is being delivered or has been supplied. | |
| occurrenceDateTime | string | The date or time(s) the activity occurred. | |
| occurrencePeriod | Period | The date or time(s) the activity occurred. | |
| occurrenceTiming | Timing | The date or time(s) the activity occurred. | |
| supplier | Reference | The individual responsible for dispensing the medication, supplier or device. | |
| destination | Reference | Identification of the facility/location where the Supply was shipped to, as part of the dispense event. | |
| receiver | array(Reference) | Identifies the person who picked up the Supply. |
Response
keyboard_arrow_down
Update Supply Delivery
put
/organizations/{organizationId}/fhir/3/SupplyDelivery/{resourceId}
Record of delivery of what is supplied.
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 | SupplyDelivery | This is a SupplyDelivery resource |
| identifier | Identifier | Identifier assigned by the dispensing facility when the item(s) is dispensed. | |
| basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this event. | |
| partOf | array(Reference) | A larger event of which this particular event is a component or step. | |
| status | string | in-progress|completed|abandoned|entered-in-error | A code specifying the state of the dispense event. |
| patient | Reference | A link to a resource representing the person whom the delivered item is for. | |
| type | CodeableConcept | Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. | |
| suppliedItem | SupplyDelivery_SuppliedItem | The item that is being delivered or has been supplied. | |
| occurrenceDateTime | string | The date or time(s) the activity occurred. | |
| occurrencePeriod | Period | The date or time(s) the activity occurred. | |
| occurrenceTiming | Timing | The date or time(s) the activity occurred. | |
| supplier | Reference | The individual responsible for dispensing the medication, supplier or device. | |
| destination | Reference | Identification of the facility/location where the Supply was shipped to, as part of the dispense event. | |
| receiver | array(Reference) | Identifies the person who picked up the Supply. |
Response
keyboard_arrow_down