Implementation Guide
23.0.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena MedicationDispense

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-meddispense-profile.html Version: 23.0.0
Active as of 2023-09-25 Computable Name: AthenaMedicationDispense

Defines constraints and extensions on the medicationdispense resource as supported by Athena Products.

This MedicationDispense profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

This resource covers the supply of medications to a patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access MedicationDispense resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The MedicationDispense resource includes description of the medication product (supply) supported by the athenaPractice and athenaFlow products. It derives from the RcopiaPrescriptionFillStatus, RcopiaMapPrescription and RcopiaFillStatusReasoncode tables in athenaPractice and athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
mdd-1: whenHandedOver cannot be before whenPrepared
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:us-core-medicationdispense Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense
..... profile:athena-medicaiondispense-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medicationdispense-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!Σ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.

... statusReason[x] 0..1 CodeableConcept Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

... medication[x] SΣ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationReference Reference(Medication)
.... medicationCodeableConcept CodeableConcept
... subject Σ 1..1 Reference(Patient) Who the dispense is for
... performer S 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... authorizingPrescription 0..* Reference(MedicationRequest) Additional supporting information
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

... quantity 0..1 Quantity Amount dispensed
... whenHandedOver 0..1 dateTime When product was given out
... dosageInstruction 0..* Dosage How medication should be taken
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... doseAndRate Σ 0..* Element Amount of medication administered
..... dose[x] Σ 0..1 Quantity Amount administered in one dose

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
from the FHIR Standard
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... id 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:us-core-medicationdispense 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense
..... profile:athena-medicaiondispense-profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medicationdispense-profile
.... Slices for security 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
..... security:CONFABBR 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
... status 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
... medication[x] S 1..1 What medication was supplied
.... medicationReference Reference(Medication)
.... medicationCodeableConcept CodeableConcept
... subject 1..1 Reference(Patient) Who the dispense is for
... performer S 0..* BackboneElement Who performed event
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... authorizingPrescription 0..* Reference(MedicationRequest) Additional supporting information
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
... quantity 0..1 Quantity Amount dispensed
... whenHandedOver 0..1 dateTime When product was given out
... dosageInstruction 0..* Dosage How medication should be taken
.... text 0..1 string Free text dosage instructions e.g. SIG
.... doseAndRate 0..* Element Amount of medication administered
..... dose[x] 0..1 Quantity Amount administered in one dose

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
mdd-1: whenHandedOver cannot be before whenPrepared
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:us-core-medicationdispense Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense
..... profile:athena-medicaiondispense-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medicationdispense-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!Σ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.

... statusReason[x] 0..1 CodeableConcept Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

... category 0..1 CodeableConcept Type of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.

... medication[x] SΣ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationReference Reference(Medication)
.... medicationCodeableConcept CodeableConcept
... subject Σ 1..1 Reference(Patient) Who the dispense is for
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer S 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function 0..1 CodeableConcept Who performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.

.... actor S 1..1 Reference(Practitioner) Individual who was performing
... location 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription 0..* Reference(MedicationRequest) Additional supporting information
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

... quantity 0..1 Quantity Amount dispensed
... daysSupply 0..1 SimpleQuantity Amount of medication expressed as a timing amount
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver 0..1 dateTime When product was given out
... destination 0..1 Reference(Location) Where the medication was sent
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Information about the dispense
... dosageInstruction 0..* Dosage How medication should be taken
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".


.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing Σ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.

..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

..... dose[x] Σ 0..1 Quantity Amount administered in one dose
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.


.... responsibleParty 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
MedicationDispense.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
from the FHIR Standard
MedicationDispense.categorypreferredMedicationDispense Category Codes
http://hl7.org/fhir/ValueSet/medicationdispense-category
from the FHIR Standard
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.performer.functionexampleMedicationDispense Performer Function Codes
http://hl7.org/fhir/ValueSet/medicationdispense-performer-function
from the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
MedicationDispense.dosageInstruction.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
MedicationDispense.dosageInstruction.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
MedicationDispense.dosageInstruction.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationDispense.dosageInstruction.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationDispense.dosageInstruction.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
MedicationDispense.dosageInstruction.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

This structure is derived from MedicationDispense

Summary

Mandatory: 4 elements(5 nested mandatory elements)
Must-Support: 3 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationDispense.meta.profile
  • The element 1 is sliced based on the value of MedicationDispense.meta.security

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
mdd-1: whenHandedOver cannot be before whenPrepared
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:us-core-medicationdispense Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense
..... profile:athena-medicaiondispense-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medicationdispense-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!Σ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.

... statusReason[x] 0..1 CodeableConcept Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

... medication[x] SΣ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationReference Reference(Medication)
.... medicationCodeableConcept CodeableConcept
... subject Σ 1..1 Reference(Patient) Who the dispense is for
... performer S 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... authorizingPrescription 0..* Reference(MedicationRequest) Additional supporting information
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

... quantity 0..1 Quantity Amount dispensed
... whenHandedOver 0..1 dateTime When product was given out
... dosageInstruction 0..* Dosage How medication should be taken
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... doseAndRate Σ 0..* Element Amount of medication administered
..... dose[x] Σ 0..1 Quantity Amount administered in one dose

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
from the FHIR Standard
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType

Differential View

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..* MedicationDispense Dispensing a medication to a named patient
... id 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:us-core-medicationdispense 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense
..... profile:athena-medicaiondispense-profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medicationdispense-profile
.... Slices for security 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
..... security:CONFABBR 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
... status 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
... medication[x] S 1..1 What medication was supplied
.... medicationReference Reference(Medication)
.... medicationCodeableConcept CodeableConcept
... subject 1..1 Reference(Patient) Who the dispense is for
... performer S 0..* BackboneElement Who performed event
.... actor S 1..1 Reference(Practitioner) Individual who was performing
... authorizingPrescription 0..* Reference(MedicationRequest) Additional supporting information
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
... quantity 0..1 Quantity Amount dispensed
... whenHandedOver 0..1 dateTime When product was given out
... dosageInstruction 0..* Dosage How medication should be taken
.... text 0..1 string Free text dosage instructions e.g. SIG
.... doseAndRate 0..* Element Amount of medication administered
..... dose[x] 0..1 Quantity Amount administered in one dose

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C 0..* MedicationDispense Dispensing a medication to a named patient
mdd-1: whenHandedOver cannot be before whenPrepared
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:us-core-medicationdispense Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense
..... profile:athena-medicaiondispense-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medicationdispense-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
... status ?!Σ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): A coded concept specifying the state of the dispense event.

... statusReason[x] 0..1 CodeableConcept Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

... category 0..1 CodeableConcept Type of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.

... medication[x] SΣ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.

.... medicationReference Reference(Medication)
.... medicationCodeableConcept CodeableConcept
... subject Σ 1..1 Reference(Patient) Who the dispense is for
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer S 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function 0..1 CodeableConcept Who performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.

.... actor S 1..1 Reference(Practitioner) Individual who was performing
... location 0..1 Reference(Location) Where the dispense occurred
... authorizingPrescription 0..* Reference(MedicationRequest) Additional supporting information
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

... quantity 0..1 Quantity Amount dispensed
... daysSupply 0..1 SimpleQuantity Amount of medication expressed as a timing amount
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver 0..1 dateTime When product was given out
... destination 0..1 Reference(Location) Where the medication was sent
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
... note 0..* Annotation Information about the dispense
... dosageInstruction 0..* Dosage How medication should be taken
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".


.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing Σ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.

..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

..... dose[x] Σ 0..1 Quantity Amount administered in one dose
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.


.... responsibleParty 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationDispense.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
MedicationDispense.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationDispense.statusrequiredMedicationDispense Status Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
from the FHIR Standard
MedicationDispense.categorypreferredMedicationDispense Category Codes
http://hl7.org/fhir/ValueSet/medicationdispense-category
from the FHIR Standard
MedicationDispense.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationDispense.performer.functionexampleMedicationDispense Performer Function Codes
http://hl7.org/fhir/ValueSet/medicationdispense-performer-function
from the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
MedicationDispense.dosageInstruction.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
MedicationDispense.dosageInstruction.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
MedicationDispense.dosageInstruction.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationDispense.dosageInstruction.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationDispense.dosageInstruction.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
MedicationDispense.dosageInstruction.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard
MedicationDispense.substitution.typeexampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

This structure is derived from MedicationDispense

Summary

Mandatory: 4 elements(5 nested mandatory elements)
Must-Support: 3 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationDispense.meta.profile
  • The element 1 is sliced based on the value of MedicationDispense.meta.security

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for MedicationDispense resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/r4/MedicationDispense?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results MedicationDispense resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
_lastUpdated (date)
_lastUpdated-fromnow (quantity) Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
_security (token)
code (token) Returns dispenses of this medicine code
medication (reference) Returns dispenses of this medicine resource
subject (reference) The identity of a patient to list dispenses for.
patient (reference) The identity of a patient to list dispenses for.
performer (reference) Returns dispenses performed by a specific individual
prescription (reference) The identity of a prescription to list dispenses from
status (token) Returns dispenses with a specified dispense status
type (token) Returns dispenses of a specific type
whenhandedover (date) Returns dispenses handed over on this date
whenhandedover-fromnow (quantity) Returns dispenses handed over as of today
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.