medication dispenses

Create Medication Dispense

post
/organizations/{organizationId}/fhir/3/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/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringMedicationDispenseThis is a MedicationDispense resource
identifierarray(Identifier)Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
partOfarray(Reference)The procedure that the dispense is done because of.
statusstringpreparation|in-progress|on-hold|completed|entered-in-error|stoppedA code specifying the state of the set of dispense events.
categoryCodeableConceptIndicates type of medication dispense and where the medication is expected to be consumed or administered.
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. It should be assumed that the performer is the dispenser of the medication.
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.
whenPreparedstringThe time when the dispensed product was packaged and reviewed.
whenHandedOverstringThe 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.
notDonebooleanTrue if the dispense was not performed for some reason.
notDoneReasonCodeableConceptCodeableConceptIndicates the reason why a dispense was not performed.
notDoneReasonReferenceReferenceIndicates the reason why a dispense was not performed.
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/3/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*stringMedicationDispenseThis is a MedicationDispense resource
identifierarray(Identifier)Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
partOfarray(Reference)The procedure that the dispense is done because of.
statusstringpreparation|in-progress|on-hold|completed|entered-in-error|stoppedA code specifying the state of the set of dispense events.
categoryCodeableConceptIndicates type of medication dispense and where the medication is expected to be consumed or administered.
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. It should be assumed that the performer is the dispenser of the medication.
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.
whenPreparedstringThe time when the dispensed product was packaged and reviewed.
whenHandedOverstringThe 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.
notDonebooleanTrue if the dispense was not performed for some reason.
notDoneReasonCodeableConceptCodeableConceptIndicates the reason why a dispense was not performed.
notDoneReasonReferenceReferenceIndicates the reason why a dispense was not performed.
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/3/MedicationDispense/{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 Medication Dispense

get
/organizations/{organizationId}/fhir/3/MedicationDispense/{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 Medication Dispense

get
/organizations/{organizationId}/fhir/3/MedicationDispense/{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 Medication Dispense

delete
/organizations/{organizationId}/fhir/3/MedicationDispense/{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 Medication Dispense

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

Request

Headers

content-type*stringapplication/jsonapplication/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/3/MedicationDispense/_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 Medication Dispense

post
/organizations/{organizationId}/fhir/3/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*stringMedicationDispenseThis is a MedicationDispense resource
identifierarray(Identifier)Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
partOfarray(Reference)The procedure that the dispense is done because of.
statusstringpreparation|in-progress|on-hold|completed|entered-in-error|stoppedA code specifying the state of the set of dispense events.
categoryCodeableConceptIndicates type of medication dispense and where the medication is expected to be consumed or administered.
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. It should be assumed that the performer is the dispenser of the medication.
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.
whenPreparedstringThe time when the dispensed product was packaged and reviewed.
whenHandedOverstringThe 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.
notDonebooleanTrue if the dispense was not performed for some reason.
notDoneReasonCodeableConceptCodeableConceptIndicates the reason why a dispense was not performed.
notDoneReasonReferenceReferenceIndicates the reason why a dispense was not performed.
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/3/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/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringMedicationDispenseThis is a MedicationDispense resource
identifierarray(Identifier)Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
partOfarray(Reference)The procedure that the dispense is done because of.
statusstringpreparation|in-progress|on-hold|completed|entered-in-error|stoppedA code specifying the state of the set of dispense events.
categoryCodeableConceptIndicates type of medication dispense and where the medication is expected to be consumed or administered.
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. It should be assumed that the performer is the dispenser of the medication.
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.
whenPreparedstringThe time when the dispensed product was packaged and reviewed.
whenHandedOverstringThe 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.
notDonebooleanTrue if the dispense was not performed for some reason.
notDoneReasonCodeableConceptCodeableConceptIndicates the reason why a dispense was not performed.
notDoneReasonReferenceReferenceIndicates the reason why a dispense was not performed.
eventHistoryarray(Reference)A summary of the events of interest that have occurred, such as when the dispense was verified.

Response