MedicationDispense - FHIR Resource (r4)


This MedicationDispense Resource uses the FHIR API standard for access and structure.

Validate an MedicationDispense FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
authorizingPrescriptiontrueReference# Medication order that authorizes the dispense
categoryfalseCodeableConcept# Type of medication dispense
contextfalseReference# Encounter / Episode associated with event
daysSupplyfalseSimpleQuantity# Amount of medication expressed as a timing amount
destinationfalseReference# Where the medication was sent
detectedIssuetrueReference# Clinical issue with action
dosageInstructiontrueDosage# How the medication is to be used by the patient or administered by the caregiver
eventHistorytrueReference# A list of relevant lifecycle events
identifiertrueIdentifier# External identifier
locationfalseReference# Where the dispense occurred
medication[x]falseReference#undefined
notetrueAnnotation# Information about the dispense
partOftrueReference# Event that dispense is part of
performertrueData Type# Who performed event
quantityfalseSimpleQuantity# Amount dispensed
receivertrueReference# Who collected the medication
statusfalsecode# preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
statusReason[x]falseReference#undefined
subjectfalseReference# Who the dispense is for
substitutionfalseData Type# Whether a substitution was performed on the dispense
supportingInformationtrueReference# Information that supports the dispensing of the medication
typefalseCodeableConcept# Trial fill, partial fill, emergency fill, etc.
whenHandedOverfalsedateTime# When product was given out
whenPreparedfalsedateTime# When product was packaged and reviewed

MedicationDispense Example

{
  "resourceType": "MedicationDispense",
  "id": "meddisp008",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: meddisp008</p><p><b>contained</b>: </p><p><b>status</b>: completed</p><p><b>medication</b>: id: medexample015; Capecitabine 500mg oral tablet (Xeloda) <span>(Details : {RxNorm code '213293' = 'Xeloda 500 MG Oral Tablet', given as 'Capecitabine 500mg oral tablet (Xeloda)'})</span></p><p><b>subject</b>: <a>Donald Duck</a></p><h3>Performers</h3><table><tr><td>-</td><td><b>Actor</b></td></tr><tr><td>*</td><td><a>Practitioner/f006</a></td></tr></table><p><b>authorizingPrescription</b>: <a>MedicationRequest/medrx0309</a></p><p><b>dosageInstruction</b>: </p></div>"
  },
  "contained": [
    {
      "resourceType": "Medication",
      "id": "medexample015",
      "code": {
        "coding": [
          {
            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
            "code": "213293",
            "display": "Capecitabine 500mg oral tablet (Xeloda)"
          }
        ]
      }
    }
  ],
  "status": "completed",
  "medicationReference": {
    "reference": "#medexample015"
  },
  "subject": {
    "reference": "Patient/pat1",
    "display": "Donald Duck"
  },
  "performer": [
    {
      "actor": {
        "reference": "Practitioner/f006"
      }
    }
  ],
  "authorizingPrescription": [
    {
      "reference": "MedicationRequest/medrx0309"
    }
  ],
  "dosageInstruction": [
    {
      "sequence": 1,
      "timing": {
        "repeat": {
          "frequency": 2,
          "period": 21,
          "periodUnit": "d"
        }
      },
      "route": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "394899003",
            "display": "oral administration of treatment"
          }
        ]
      },
      "doseAndRate": [
        {
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/dose-rate-type",
                "code": "ordered",
                "display": "Ordered"
              }
            ]
          },
          "doseQuantity": {
            "value": 500,
            "unit": "mg",
            "system": "http://unitsofmeasure.org",
            "code": "mg"
          }
        }
      ]
    }
  ]
}

MedicationDispense Structure

{
  "resourceType" : "MedicationDispense",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External identifier
  "partOf" : [{ Reference(Procedure) }], // Event that dispense is part of
  "status" : "<code>", // R!  preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
  // statusReason[x]: Why a dispense was not performed. One of these 2:
  "statusReasonCodeableConcept" : { CodeableConcept },
  "statusReasonReference" : { Reference(DetectedIssue) },
  "category" : { CodeableConcept }, // Type of medication dispense
  // medication[x]: What medication was supplied. One of these 2:
  "medicationCodeableConcept" : { CodeableConcept },
  "medicationReference" : { Reference(Medication) },
  "subject" : { Reference(Patient|Group) }, // Who the dispense is for
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter / Episode associated with event
  "supportingInformation" : [{ Reference(Any) }], // Information that supports the dispensing of the medication
  "performer" : [{ // Who performed event
    "function" : { CodeableConcept }, // Who performed the dispense and what they did
    "actor" : { Reference(Practitioner|PractitionerRole|Organization|Patient|
    Device|RelatedPerson) } // R!  Individual who was performing
  }],
  "location" : { Reference(Location) }, // Where the dispense occurred
  "authorizingPrescription" : [{ Reference(MedicationRequest) }], // Medication order that authorizes the dispense
  "type" : { CodeableConcept }, // Trial fill, partial fill, emergency fill, etc.
  "quantity" : { Quantity(SimpleQuantity) }, // Amount dispensed
  "daysSupply" : { Quantity(SimpleQuantity) }, // Amount of medication expressed as a timing amount
  "whenPrepared" : "<dateTime>", // When product was packaged and reviewed
  "whenHandedOver" : "<dateTime>", // When product was given out
  "destination" : { Reference(Location) }, // Where the medication was sent
  "receiver" : [{ Reference(Patient|Practitioner) }], // Who collected the medication
  "note" : [{ Annotation }], // Information about the dispense
  "dosageInstruction" : [{ Dosage }], // How the medication is to be used by the patient or administered by the caregiver
  "substitution" : { // Whether a substitution was performed on the dispense
    "wasSubstituted" : <boolean>, // R!  Whether a substitution was or was not performed on the dispense
    "type" : { CodeableConcept }, // Code signifying whether a different drug was dispensed from what was prescribed
    "reason" : [{ CodeableConcept }], // Why was substitution made
    "responsibleParty" : [{ Reference(Practitioner|PractitionerRole) }] // Who is responsible for the substitution
  },
  "detectedIssue" : [{ Reference(DetectedIssue) }], // Clinical issue with action
  "eventHistory" : [{ Reference(Provenance) }] // A list of relevant lifecycle events
}

MedicationDispense Search Parameters

The following search parameters can be used to query MedicationDispense resources. Just submit them like so:

https://api.1up.health/fhir/r4/MedicationDispense?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
codetextmedication
contextreferencecontext
destinationreferencedestination
identifiertextidentifier
medicationreferencemedication
patientreferencesubject.where
performerreferenceperformer.actor
prescriptionreferenceauthorizingPrescription
receiverreferencereceiver
responsiblepartyreferencesubstitution.responsibleParty
statustextstatus
subjectreferencesubject
typetexttype
whenhandedoverdatewhenHandedOver
whenprepareddatewhenPrepared