MedicationDispense read

get/MedicationDispense/{id}

Page View

Show Required Fields Only

Show Translation Fields

This resource records when a medication is dispensed to a patient, typically by a pharmacy. Each dispense entry contains the medication details, quantity, refills, pharmacy information, and dispense date.

You can review or retrieve dispensed medication information with FHIR® passthrough.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

read

Review a specific MedicationDispense resource with medication, quantity, and dispense details for a given patient.

FHIR read

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/MedicationDispense/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
MedicationDispense identifier

Response fields and example

Example Medication Dispense

json

1
{}

A profile on the MedicationDispense resource that conforms to Redox requirements. Represents the provision of a supply of a medication with the intention that it is subsequently consumed by a patient.

resourceType
required, string
Identifies the type of the resource
Value: MedicationDispense
status
required, string
A code specifying the state of the set of dispense events.
Possible Values: preparation, in-progress, cancelled, on-hold, completed, entered-in-error, stopped, declined, unknown
medicationCodeableConcept
required, object
Identifies 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.
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
id
string
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
Array of object
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.
- extension
  Array of Boolean, String, CodeableConcept, Coding
  May be used to represent additional information that is not part of the basic definition of the element. 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.
  One of:
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  valueBoolean
  boolean
  A single value for the extension.
- use
  string
  The purpose of this identifier.
  Possible Values: usual, official, temp, secondary, old (If known)
- system
  string
  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- value
  string
  The portion of the identifier typically relevant to the user and which is unique within the context of the system.
subject
object
A link to a resource representing the person or the group to whom the medication will be given.

Must be a resource of type Patient.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
context
object
The encounter or episode of care that establishes the context for this event.

Must be a resource of type Encounter.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
performer
Array of object
Indicates who or what performed the event.
- actor
  required, object
  The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.
  
  Must reference one of the following types of resources:
  
  Practitioner
  
  Organization
  
  reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
authorizingPrescription
Array of object
Indicates the medication order that is being dispensed against.

Must be a resource of type MedicationRequest.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
type
object
Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
quantity
object
The amount of medication that has been dispensed. Includes unit of measure.
- value
  number
  The value of the measured amount. The value includes an implicit precision in the presentation of the value.
- system
  string
  The identification of the system that provides the coded form of the unit.
- code
  string
  A computer processable form of the unit in some unit representation system.
daysSupply
object
The amount of medication expressed as a timing amount.
- value
  number
  The value of the measured amount. The value includes an implicit precision in the presentation of the value.
- system
  string
  The identification of the system that provides the coded form of the unit.
- code
  string
  A computer processable form of the unit in some unit representation system.
whenPrepared
string
The time when the dispensed product was packaged and reviewed.
whenHandedOver
string
The time the dispensed product was provided to the patient or their representative.
dosageInstruction
Array of object
Indicates how the medication is to be used by the patient.
- text
  string
  Free text dosage instructions e.g. SIG.
- timing
  object
  When medication should be administered.
  repeat
  object
  A set of rules that describe when the event is scheduled.
  frequency
  number
  The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
  frequencyMax
  number
  If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
  period
  number
  Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
  _period
  object
  This element contains extensions for period. Depending on the extensions present it could be used in place of period or contain additional information about period. See the extension element for more details on the possible extensions being sent.
  extension
  Array of OriginalText or Other
  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.
  Any of:
  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.
  
  See http://hl7.org/fhir/StructureDefinition/originalText for more information
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  Value: http://hl7.org/fhir/StructureDefinition/originalText
  valueString
  required, string
  The original text
  
  Only one of valueString, valueUrl may be present.
  valueUrl
  required, string
  The original text
  
  Only one of valueString, valueUrl may be present.
  periodMax
  number
  If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
  _periodMax
  object
  This element contains extensions for periodMax. Depending on the extensions present it could be used in place of periodMax or contain additional information about periodMax. See the extension element for more details on the possible extensions being sent.
  extension
  Array of OriginalText or Other
  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.
  Any of:
  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.
  
  See http://hl7.org/fhir/StructureDefinition/originalText for more information
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  Value: http://hl7.org/fhir/StructureDefinition/originalText
  valueString
  required, string
  The original text
  
  Only one of valueString, valueUrl may be present.
  valueUrl
  required, string
  The original text
  
  Only one of valueString, valueUrl may be present.
  periodUnit
  string
  The units of time for the period in UCUM units.
  Possible Values: s, min, h, d, wk, mo, a - unit of time (UCUM)
  _periodUnit
  object
  This element contains extensions for periodUnit. Depending on the extensions present it could be used in place of periodUnit or contain additional information about periodUnit. See the extension element for more details on the possible extensions being sent.
  extension
  Array of OriginalText or Other
  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.
  Any of:
  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.
  
  See http://hl7.org/fhir/StructureDefinition/originalText for more information
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  Value: http://hl7.org/fhir/StructureDefinition/originalText
  valueString
  required, string
  The original text
  
  Only one of valueString, valueUrl may be present.
  valueUrl
  required, string
  The original text
  
  Only one of valueString, valueUrl may be present.
  when
  Array of string
  An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
  _when
  object
  This element contains extensions for when. Depending on the extensions present it could be used in place of when or contain additional information about when. See the extension element for more details on the possible extensions being sent.
  extension
  Array of OriginalText or Other
  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.
  Any of:
  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.
  
  See http://hl7.org/fhir/StructureDefinition/originalText for more information
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  Value: http://hl7.org/fhir/StructureDefinition/originalText
  valueString
  required, string
  The original text
  
  Only one of valueString, valueUrl may be present.
  valueUrl
  required, string
  The original text
  
  Only one of valueString, valueUrl may be present.
  boundsPeriod
  object
  Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
  start
  string
  The start of the period. The boundary is inclusive.
  end
  string
  The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
- route
  object
  How drug should enter body.
  coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
  text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.