Pharmacy FHIR Maturity Project CI Build

This page is part of the US-Medication FHIR IG (v0.0.1: STU 1 Ballot 1) based on FHIR v1.8.0. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-medicationdispense

The MedicationDispense resources can be used to record a medications that have been dispensed for a named person/patient. For more information about the context for their usages, refer to the medication domains’s boundaries section. This profile sets minimum expectations for the MedicationAdministration resource to record, search and fetch medications associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the DAF-MedicationDispense profile:

  • Query for medications that have been dispensed to a particular patient
Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and an example are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each MedicationDispense must have:

  1. a status
  2. a medication
  3. a patient
  4. a date or date range

In addition, the following data-elements must be supported.

If the data is present, MedicationDispense shall include:

  1. who dispensed
  2. dosage information

Profile specific implementation guidance:

  • The MedicationDispense and MedicationOrder resources can represent a medication, using either a code or refer to a Medication resource. The server application can choose one way or both methods, but the client application must support both methods. More specific guidance is provided in the conformance resource for this profile

example here

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/pharmacymaturity/StructureDefinition/medicationdispense

This profile builds on MedicationDispense.

This profile was published on Tue Nov 08 00:00:00 AEDT 2016 as a draft by Health Level Seven International (FHIR-Infrastructure).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*Dispensing a medication to a named patient
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..1IdentifierExternal identifier
... status ?!S1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: medication-Dispense-status (required)
... medication[x] S1..1CodeableConcept, Reference(US Core Medication Profile)What medication was supplied
Binding: Medication Clinical Drug (RxNorm) (extensible)
... patient S1..1Reference(US Core Patient Profile)Who the dispense is for
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication
... dispenser S0..1Reference(US Core Practitioner)Practitioner responsible for dispensing medication
... dispensingOrganization S0..1Reference(US Core Organization Profile)Organization responsible for the dispense of the medication
... authorizingPrescription 0..*Reference(MedicationRequest)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity 0..1SimpleQuantityAmount dispensed
... daysSupply 0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared ∑0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver S1..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the medication was sent
... receiver 0..*Reference(Patient), Reference(Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction S0..1DosageInstructionMedicine administration instructions to the patient/caregiver
... substitution I0..1BackboneElementDeals with substitution of one medicine for another
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type 1..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example)
.... reason 0..*CodeableConceptWhy was substitution made
Binding: SubstanceAdminSubstitutionReason (example)
.... responsibleParty 0..*Reference(Practitioner)Who is responsible for the substitution
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

summary

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense I0..*Dispensing a medication to a named patient
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..1IdentifierExternal identifier
... status ?!S1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: medication-Dispense-status (required)
... medication[x] S1..1CodeableConcept, Reference(US Core Medication Profile)What medication was supplied
Binding: Medication Clinical Drug (RxNorm) (extensible)
... patient S1..1Reference(US Core Patient Profile)Who the dispense is for
... supportingInformation 0..*Reference(Resource)Information that supports the dispensing of the medication
... dispenser S0..1Reference(US Core Practitioner)Practitioner responsible for dispensing medication
... dispensingOrganization S0..1Reference(US Core Organization Profile)Organization responsible for the dispense of the medication
... authorizingPrescription 0..*Reference(MedicationRequest)Medication order that authorizes the dispense
... type 0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity 0..1SimpleQuantityAmount dispensed
... daysSupply 0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared ∑0..1dateTimeWhen product was packaged and reviewed
... whenHandedOver S1..1dateTimeWhen product was given out
... destination 0..1Reference(Location)Where the medication was sent
... receiver 0..*Reference(Patient), Reference(Practitioner)Who collected the medication
... note 0..*AnnotationInformation about the dispense
... dosageInstruction S0..1DosageInstructionMedicine administration instructions to the patient/caregiver
... substitution I0..1BackboneElementDeals with substitution of one medicine for another
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type 1..1CodeableConceptCode signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example)
.... reason 0..*CodeableConceptWhy was substitution made
Binding: SubstanceAdminSubstitutionReason (example)
.... responsibleParty 0..*Reference(Practitioner)Who is responsible for the substitution
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

D.4.1.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Argonaut Search Criteria for StructureDefinition-medicationdispense

search