medication dispenses

Create Medication Dispense

post
/organizations/{organizationId}/fhir/4/MedicationDispense

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a MedicationDispense resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
partOfarray(Reference)The procedure that trigger the dispense.
statuscodeA code specifying the state of the set of dispense events.
statusReasonCodeableConceptCodeableConceptIndicates the reason why a dispense was not performed.
statusReasonReferenceReferenceIndicates the reason why a dispense was not performed.
categoryCodeableConceptIndicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
medicationCodeableConceptCodeableConceptIdentifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
subjectReferenceA link to a resource representing the person or the group to whom the medication will be given.
contextReferenceThe encounter or episode of care that establishes the context for this event.
supportingInformationarray(Reference)Additional information that supports the medication being dispensed.
performerarray(MedicationDispense_Performer)Indicates who or what performed the event.
locationReferenceThe principal physical location where the dispense was performed.
authorizingPrescriptionarray(Reference)Indicates the medication order that is being dispensed against.
typeCodeableConceptIndicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
quantityQuantityThe amount of medication that has been dispensed. Includes unit of measure.
daysSupplyQuantityThe amount of medication expressed as a timing amount.
whenPrepareddateTimeThe time when the dispensed product was packaged and reviewed.
whenHandedOverdateTimeThe time the dispensed product was provided to the patient or their representative.
destinationReferenceIdentification of the facility/location where the medication was shipped to, as part of the dispense event.
receiverarray(Reference)Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
notearray(Annotation)Extra information about the dispense that could not be conveyed in the other attributes.
dosageInstructionarray(Dosage)Indicates how the medication is to be used by the patient.
substitutionMedicationDispense_SubstitutionIndicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
detectedIssuearray(Reference)Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.
eventHistoryarray(Reference)A summary of the events of interest that have occurred, such as when the dispense was verified.

Response

Patch Medication Dispense

patch
/organizations/{organizationId}/fhir/4/MedicationDispense/{resourceId}

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

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*This is a MedicationDispense resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
partOfarray(Reference)The procedure that trigger the dispense.
statuscodeA code specifying the state of the set of dispense events.
statusReasonCodeableConceptCodeableConceptIndicates the reason why a dispense was not performed.
statusReasonReferenceReferenceIndicates the reason why a dispense was not performed.
categoryCodeableConceptIndicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
medicationCodeableConceptCodeableConceptIdentifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
subjectReferenceA link to a resource representing the person or the group to whom the medication will be given.
contextReferenceThe encounter or episode of care that establishes the context for this event.
supportingInformationarray(Reference)Additional information that supports the medication being dispensed.
performerarray(MedicationDispense_Performer)Indicates who or what performed the event.
locationReferenceThe principal physical location where the dispense was performed.
authorizingPrescriptionarray(Reference)Indicates the medication order that is being dispensed against.
typeCodeableConceptIndicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
quantityQuantityThe amount of medication that has been dispensed. Includes unit of measure.
daysSupplyQuantityThe amount of medication expressed as a timing amount.
whenPrepareddateTimeThe time when the dispensed product was packaged and reviewed.
whenHandedOverdateTimeThe time the dispensed product was provided to the patient or their representative.
destinationReferenceIdentification of the facility/location where the medication was shipped to, as part of the dispense event.
receiverarray(Reference)Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
notearray(Annotation)Extra information about the dispense that could not be conveyed in the other attributes.
dosageInstructionarray(Dosage)Indicates how the medication is to be used by the patient.
substitutionMedicationDispense_SubstitutionIndicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
detectedIssuearray(Reference)Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.
eventHistoryarray(Reference)A summary of the events of interest that have occurred, such as when the dispense was verified.

Response

Read Medication Dispense

get
/organizations/{organizationId}/fhir/4/MedicationDispense/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Medication Dispense

get
/organizations/{organizationId}/fhir/4/MedicationDispense/{resourceId}/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Medication Dispense

get
/organizations/{organizationId}/fhir/4/MedicationDispense/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Medication Dispense

delete
/organizations/{organizationId}/fhir/4/MedicationDispense/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Medication Dispense

get
/organizations/{organizationId}/fhir/4/MedicationDispense

Request

Headers

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

Query params

_idstring
_languagestring
codestring
contextstring
destinationstring
identifierstring
medicationstring
patientstring
performerstring
prescriptionstring
receiverstring
responsiblepartystring
statusstring
subjectstring
typestring
whenhandedoverstring
whenpreparedstring

Params

organizationId*string|stringid|slug

Response

Search History Medication Dispense

get
/organizations/{organizationId}/fhir/4/MedicationDispense/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Medication Dispense

post
/organizations/{organizationId}/fhir/4/MedicationDispense/_search

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

Request

Headers

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

Query params

_idstring
_languagestring
codestring
contextstring
destinationstring
identifierstring
medicationstring
patientstring
performerstring
prescriptionstring
receiverstring
responsiblepartystring
statusstring
subjectstring
typestring
whenhandedoverstring
whenpreparedstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a MedicationDispense resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
partOfarray(Reference)The procedure that trigger the dispense.
statuscodeA code specifying the state of the set of dispense events.
statusReasonCodeableConceptCodeableConceptIndicates the reason why a dispense was not performed.
statusReasonReferenceReferenceIndicates the reason why a dispense was not performed.
categoryCodeableConceptIndicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
medicationCodeableConceptCodeableConceptIdentifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
subjectReferenceA link to a resource representing the person or the group to whom the medication will be given.
contextReferenceThe encounter or episode of care that establishes the context for this event.
supportingInformationarray(Reference)Additional information that supports the medication being dispensed.
performerarray(MedicationDispense_Performer)Indicates who or what performed the event.
locationReferenceThe principal physical location where the dispense was performed.
authorizingPrescriptionarray(Reference)Indicates the medication order that is being dispensed against.
typeCodeableConceptIndicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
quantityQuantityThe amount of medication that has been dispensed. Includes unit of measure.
daysSupplyQuantityThe amount of medication expressed as a timing amount.
whenPrepareddateTimeThe time when the dispensed product was packaged and reviewed.
whenHandedOverdateTimeThe time the dispensed product was provided to the patient or their representative.
destinationReferenceIdentification of the facility/location where the medication was shipped to, as part of the dispense event.
receiverarray(Reference)Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
notearray(Annotation)Extra information about the dispense that could not be conveyed in the other attributes.
dosageInstructionarray(Dosage)Indicates how the medication is to be used by the patient.
substitutionMedicationDispense_SubstitutionIndicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
detectedIssuearray(Reference)Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.
eventHistoryarray(Reference)A summary of the events of interest that have occurred, such as when the dispense was verified.

Response

Update Medication Dispense

put
/organizations/{organizationId}/fhir/4/MedicationDispense/{resourceId}

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a MedicationDispense resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
partOfarray(Reference)The procedure that trigger the dispense.
statuscodeA code specifying the state of the set of dispense events.
statusReasonCodeableConceptCodeableConceptIndicates the reason why a dispense was not performed.
statusReasonReferenceReferenceIndicates the reason why a dispense was not performed.
categoryCodeableConceptIndicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
medicationCodeableConceptCodeableConceptIdentifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
medicationReferenceReferenceIdentifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
subjectReferenceA link to a resource representing the person or the group to whom the medication will be given.
contextReferenceThe encounter or episode of care that establishes the context for this event.
supportingInformationarray(Reference)Additional information that supports the medication being dispensed.
performerarray(MedicationDispense_Performer)Indicates who or what performed the event.
locationReferenceThe principal physical location where the dispense was performed.
authorizingPrescriptionarray(Reference)Indicates the medication order that is being dispensed against.
typeCodeableConceptIndicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
quantityQuantityThe amount of medication that has been dispensed. Includes unit of measure.
daysSupplyQuantityThe amount of medication expressed as a timing amount.
whenPrepareddateTimeThe time when the dispensed product was packaged and reviewed.
whenHandedOverdateTimeThe time the dispensed product was provided to the patient or their representative.
destinationReferenceIdentification of the facility/location where the medication was shipped to, as part of the dispense event.
receiverarray(Reference)Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
notearray(Annotation)Extra information about the dispense that could not be conveyed in the other attributes.
dosageInstructionarray(Dosage)Indicates how the medication is to be used by the patient.
substitutionMedicationDispense_SubstitutionIndicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
detectedIssuearray(Reference)Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.
eventHistoryarray(Reference)A summary of the events of interest that have occurred, such as when the dispense was verified.

Response