supply deliverys

Create Supply Delivery

post

/organizations/{organizationId}/fhir/4/SupplyDelivery

Record of delivery of what is supplied.

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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 SupplyDelivery 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)		Identifier for the supply delivery event that is used to identify it across multiple disparate systems.
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		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

201 400 401 404

Patch Supply Delivery

patch

/organizations/{organizationId}/fhir/4/SupplyDelivery/{resourceId}

Record of delivery of what is supplied.

Request

Headers

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*			This is a SupplyDelivery 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)		Identifier for the supply delivery event that is used to identify it across multiple disparate systems.
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		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

200 201 400 401 404 409

Read Supply Delivery

get

/organizations/{organizationId}/fhir/4/SupplyDelivery/{resourceId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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 Delivery

get

/organizations/{organizationId}/fhir/4/SupplyDelivery/{resourceId}/_history

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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 Delivery

get

/organizations/{organizationId}/fhir/4/SupplyDelivery/{resourceId}/_history/{versionId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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 Delivery

delete

/organizations/{organizationId}/fhir/4/SupplyDelivery/{resourceId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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 Delivery

get

/organizations/{organizationId}/fhir/4/SupplyDelivery

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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

200 401 404

Search History Supply Delivery

get

/organizations/{organizationId}/fhir/4/SupplyDelivery/_history

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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 Delivery

post

/organizations/{organizationId}/fhir/4/SupplyDelivery/_search

Record of delivery of what is supplied.

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml\|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*			This is a SupplyDelivery 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)		Identifier for the supply delivery event that is used to identify it across multiple disparate systems.
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		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

200 401 404

Update Supply Delivery

put

/organizations/{organizationId}/fhir/4/SupplyDelivery/{resourceId}

Record of delivery of what is supplied.

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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 SupplyDelivery 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)		Identifier for the supply delivery event that is used to identify it across multiple disparate systems.
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		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

200 201 400 401 404 409