supply requests
Create Supply Request
post
/organizations/{organizationId}/fhir/4/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+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* | This is a SupplyRequest resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. | |
status | 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 | code | Indicates how quickly this SupplyRequest should be addressed with respect to other requests. | |
itemCodeableConcept | CodeableConcept | The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. | |
itemReference | Reference | The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. | |
quantity* | Quantity | The amount that is being ordered of the indicated item. | |
parameter | array(SupplyRequest_Parameter) | Specific parameters for the ordered item. For example, the size of the indicated item. | |
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 | dateTime | When the request was made. | |
requester | Reference | The device, practitioner, etc. who initiated the request. | |
supplier | array(Reference) | Who is intended to fulfill the request. | |
reasonCode | array(CodeableConcept) | The reason why the supply item was requested. | |
reasonReference | array(Reference) | The reason 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
keyboard_arrow_down
Patch Supply Request
patch
/organizations/{organizationId}/fhir/4/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* | This is a SupplyRequest resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. | |
status | 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 | code | Indicates how quickly this SupplyRequest should be addressed with respect to other requests. | |
itemCodeableConcept | CodeableConcept | The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. | |
itemReference | Reference | The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. | |
quantity* | Quantity | The amount that is being ordered of the indicated item. | |
parameter | array(SupplyRequest_Parameter) | Specific parameters for the ordered item. For example, the size of the indicated item. | |
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 | dateTime | When the request was made. | |
requester | Reference | The device, practitioner, etc. who initiated the request. | |
supplier | array(Reference) | Who is intended to fulfill the request. | |
reasonCode | array(CodeableConcept) | The reason why the supply item was requested. | |
reasonReference | array(Reference) | The reason 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
keyboard_arrow_down
Read Supply Request
get
/organizations/{organizationId}/fhir/4/SupplyRequest/{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 Request
get
/organizations/{organizationId}/fhir/4/SupplyRequest/{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 Request
get
/organizations/{organizationId}/fhir/4/SupplyRequest/{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 Request
delete
/organizations/{organizationId}/fhir/4/SupplyRequest/{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 Request
get
/organizations/{organizationId}/fhir/4/SupplyRequest
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 | ||
category | string | ||
date | |||
identifier | string | ||
requester | string | ||
status | string | ||
subject | string | ||
supplier | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Supply Request
get
/organizations/{organizationId}/fhir/4/SupplyRequest/_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 Request
post
/organizations/{organizationId}/fhir/4/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 | |||
identifier | string | ||
requester | string | ||
status | string | ||
subject | string | ||
supplier | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a SupplyRequest resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. | |
status | 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 | code | Indicates how quickly this SupplyRequest should be addressed with respect to other requests. | |
itemCodeableConcept | CodeableConcept | The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. | |
itemReference | Reference | The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. | |
quantity* | Quantity | The amount that is being ordered of the indicated item. | |
parameter | array(SupplyRequest_Parameter) | Specific parameters for the ordered item. For example, the size of the indicated item. | |
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 | dateTime | When the request was made. | |
requester | Reference | The device, practitioner, etc. who initiated the request. | |
supplier | array(Reference) | Who is intended to fulfill the request. | |
reasonCode | array(CodeableConcept) | The reason why the supply item was requested. | |
reasonReference | array(Reference) | The reason 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
keyboard_arrow_down
Update Supply Request
put
/organizations/{organizationId}/fhir/4/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+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* | This is a SupplyRequest resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. | |
status | 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 | code | Indicates how quickly this SupplyRequest should be addressed with respect to other requests. | |
itemCodeableConcept | CodeableConcept | The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. | |
itemReference | Reference | The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list. | |
quantity* | Quantity | The amount that is being ordered of the indicated item. | |
parameter | array(SupplyRequest_Parameter) | Specific parameters for the ordered item. For example, the size of the indicated item. | |
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 | dateTime | When the request was made. | |
requester | Reference | The device, practitioner, etc. who initiated the request. | |
supplier | array(Reference) | Who is intended to fulfill the request. | |
reasonCode | array(CodeableConcept) | The reason why the supply item was requested. | |
reasonReference | array(Reference) | The reason 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
keyboard_arrow_down