STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

F.23.1 StructureDefinition: QICore-MedicationDispense

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/qicore-medicationdispense

Profile of MedicationDispense for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile was published on Fri, Feb 27, 2015 00:00+1100 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

F.23.1.1 Formal Views of Profile Content

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

This structure is derived from MedicationDispense.

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*MedicationDispense
... status S0..1code
... medication[x] S1..1CodeableConcept, Reference(Medication)Binding: Medication Clinical Drug (RxNorm) (preferred)
... patient S0..1Reference(QICore-Patient)
... dispenser 0..1Reference(QICore-Practitioner)
... authorizingPrescription 0..*Reference(QICore-MedicationOrder)
... quantity S0..1SimpleQuantity
... daysSupply S0..1SimpleQuantity
... whenHandedOver S0..1dateTime
... destination 0..1Reference(QICore-Location)
... receiver 0..*Reference(QICore-Patient | QICore-Practitioner)
... dosageInstruction 0..*BackboneElement
.... timing S0..1Timing
.... site[x] 0..1CodeableConcept, Reference(BodySite)Binding: Vaccine Administered Body Site (preferred)
.... route S0..1CodeableConcept
.... dose[x] S0..1Range, SimpleQuantity
.... pharmacy-core-doseType 0..1CodeableConceptThe type of dose, e.g., loading.
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType
Binding: SNOMED CT Dosages Codes (preferred)
.... pharmacy-core-infuseOver 0..1DurationThe length of the infusion
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-infuseOver
.... pharmacy-core-rateIncrement 0..1RatioChange in dosing rate per interval
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrement
.... pharmacy-core-rateIncrementInterval 0..1DurationThe period of time between rate increments
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrementInterval
.... pharmacy-core-rateGoal 0..1RatioThe target rate for the infusion
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateGoal
.... pharmacy-core-minDosePerPeriod 0..1RatioThe minimum quantity of substance per period
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-minDosePerPeriod
.... pharmacy-core-maxDeliveryRate 0..1RatioThe maximum rate of substance administration
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryRate
.... pharmacy-core-maxDeliveryVolume 0..1QuantityThe maximum amount of fluid to infuse
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryVolume
... substitution 0..1BackboneElement
.... responsibleParty 0..*Reference(QICore-Practitioner)
... medicationdispense-validityPeriod 0..1PeriodTime interval for medication administration
URL: http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod
... pharmacy-core-refillsRemaining S0..1integerNumber of refills allowed
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-refillsRemaining

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense ∑ I0..*MedicationDispenseDispensing a medication to a named patient
mdd-1: whenHandedOver cannot be before whenPrepared
... 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... medicationdispense-validityPeriod 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod
... pharmacy-core-refillsRemaining S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-refillsRemaining
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..1IdentifierExternal identifier
... status ?! S∑0..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationDispenseStatus (required)
... medication[x] S ∑1..1CodeableConcept, Reference(Medication)What medication was supplied
Binding: Medication Clinical Drug (RxNorm) (preferred)
... patient S ∑0..1Reference(QICore-Patient)Who the dispense is for
... dispenser ∑0..1Reference(QICore-Practitioner)Practitioner responsible for dispensing medication
... authorizingPrescription ∑0..*Reference(QICore-MedicationOrder)Medication order that authorizes the dispense
... type ∑0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity S ∑0..1SimpleQuantityAmount dispensed
... daysSupply S ∑0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared ∑0..1dateTimeDispense processing time
... whenHandedOver S ∑0..1dateTimeWhen product was given out
... destination ∑0..1Reference(QICore-Location)Where the medication was sent
... receiver ∑0..*Reference(QICore-Patient | QICore-Practitioner)Who collected the medication
... note ∑0..*AnnotationInformation about the dispense
... dosageInstruction ∑0..*BackboneElementMedicine administration instructions to the patient/caregiver
.... pharmacy-core-doseType 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType
Binding: SNOMED CT Dosages Codes (preferred)
.... pharmacy-core-infuseOver 0..1DurationExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-infuseOver
.... pharmacy-core-rateIncrement 0..1RatioExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrement
.... pharmacy-core-rateIncrementInterval 0..1DurationExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrementInterval
.... pharmacy-core-rateGoal 0..1RatioExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateGoal
.... pharmacy-core-minDosePerPeriod 0..1RatioExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-minDosePerPeriod
.... pharmacy-core-maxDeliveryRate 0..1RatioExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryRate
.... pharmacy-core-maxDeliveryVolume 0..1QuantityExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryVolume
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... text ∑0..1stringFree text dosage instructions e.g. SIG
.... additionalInstructions ∑0..1CodeableConceptE.g. "Take with food"
Binding: (unbound) (example)
.... timing S ∑0..1TimingWhen medication should be administered
.... asNeeded[x] ∑0..1boolean, CodeableConceptTake "as needed" f(or x)
Binding: (unbound) (example)
.... site[x] ∑0..1CodeableConcept, Reference(BodySite)Body site to administer to
Binding: Vaccine Administered Body Site (preferred)
.... route S ∑0..1CodeableConceptHow drug should enter body
Binding: SNOMED CT Route Codes (example)
.... method ∑0..1CodeableConceptTechnique for administering medication
Binding: (unbound) (example)
.... dose[x] S ∑0..1Range, SimpleQuantityAmount of medication per dose
.... rate[x] ∑0..1Ratio, RangeAmount of medication per unit of time
.... maxDosePerPeriod ∑0..1RatioUpper limit on medication per unit of time
... substitution ∑0..1BackboneElementDeals with substitution of one medicine for another
.... 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(QICore-Practitioner)Who is responsible for the substitution

doco Documentation for this format

todo

Differential View

This structure is derived from MedicationDispense.

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense 0..*MedicationDispense
... status S0..1code
... medication[x] S1..1CodeableConcept, Reference(Medication)Binding: Medication Clinical Drug (RxNorm) (preferred)
... patient S0..1Reference(QICore-Patient)
... dispenser 0..1Reference(QICore-Practitioner)
... authorizingPrescription 0..*Reference(QICore-MedicationOrder)
... quantity S0..1SimpleQuantity
... daysSupply S0..1SimpleQuantity
... whenHandedOver S0..1dateTime
... destination 0..1Reference(QICore-Location)
... receiver 0..*Reference(QICore-Patient | QICore-Practitioner)
... dosageInstruction 0..*BackboneElement
.... timing S0..1Timing
.... site[x] 0..1CodeableConcept, Reference(BodySite)Binding: Vaccine Administered Body Site (preferred)
.... route S0..1CodeableConcept
.... dose[x] S0..1Range, SimpleQuantity
.... pharmacy-core-doseType 0..1CodeableConceptThe type of dose, e.g., loading.
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType
Binding: SNOMED CT Dosages Codes (preferred)
.... pharmacy-core-infuseOver 0..1DurationThe length of the infusion
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-infuseOver
.... pharmacy-core-rateIncrement 0..1RatioChange in dosing rate per interval
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrement
.... pharmacy-core-rateIncrementInterval 0..1DurationThe period of time between rate increments
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrementInterval
.... pharmacy-core-rateGoal 0..1RatioThe target rate for the infusion
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateGoal
.... pharmacy-core-minDosePerPeriod 0..1RatioThe minimum quantity of substance per period
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-minDosePerPeriod
.... pharmacy-core-maxDeliveryRate 0..1RatioThe maximum rate of substance administration
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryRate
.... pharmacy-core-maxDeliveryVolume 0..1QuantityThe maximum amount of fluid to infuse
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryVolume
... substitution 0..1BackboneElement
.... responsibleParty 0..*Reference(QICore-Practitioner)
... medicationdispense-validityPeriod 0..1PeriodTime interval for medication administration
URL: http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod
... pharmacy-core-refillsRemaining S0..1integerNumber of refills allowed
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-refillsRemaining

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense ∑ I0..*MedicationDispenseDispensing a medication to a named patient
mdd-1: whenHandedOver cannot be before whenPrepared
... 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... medicationdispense-validityPeriod 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/medicationdispense-validityPeriod
... pharmacy-core-refillsRemaining S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-refillsRemaining
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..1IdentifierExternal identifier
... status ?! S∑0..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationDispenseStatus (required)
... medication[x] S ∑1..1CodeableConcept, Reference(Medication)What medication was supplied
Binding: Medication Clinical Drug (RxNorm) (preferred)
... patient S ∑0..1Reference(QICore-Patient)Who the dispense is for
... dispenser ∑0..1Reference(QICore-Practitioner)Practitioner responsible for dispensing medication
... authorizingPrescription ∑0..*Reference(QICore-MedicationOrder)Medication order that authorizes the dispense
... type ∑0..1CodeableConceptTrial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (example)
... quantity S ∑0..1SimpleQuantityAmount dispensed
... daysSupply S ∑0..1SimpleQuantityAmount of medication expressed as a timing amount
... whenPrepared ∑0..1dateTimeDispense processing time
... whenHandedOver S ∑0..1dateTimeWhen product was given out
... destination ∑0..1Reference(QICore-Location)Where the medication was sent
... receiver ∑0..*Reference(QICore-Patient | QICore-Practitioner)Who collected the medication
... note ∑0..*AnnotationInformation about the dispense
... dosageInstruction ∑0..*BackboneElementMedicine administration instructions to the patient/caregiver
.... pharmacy-core-doseType 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType
Binding: SNOMED CT Dosages Codes (preferred)
.... pharmacy-core-infuseOver 0..1DurationExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-infuseOver
.... pharmacy-core-rateIncrement 0..1RatioExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrement
.... pharmacy-core-rateIncrementInterval 0..1DurationExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrementInterval
.... pharmacy-core-rateGoal 0..1RatioExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateGoal
.... pharmacy-core-minDosePerPeriod 0..1RatioExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-minDosePerPeriod
.... pharmacy-core-maxDeliveryRate 0..1RatioExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryRate
.... pharmacy-core-maxDeliveryVolume 0..1QuantityExtension
URL: http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryVolume
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... text ∑0..1stringFree text dosage instructions e.g. SIG
.... additionalInstructions ∑0..1CodeableConceptE.g. "Take with food"
Binding: (unbound) (example)
.... timing S ∑0..1TimingWhen medication should be administered
.... asNeeded[x] ∑0..1boolean, CodeableConceptTake "as needed" f(or x)
Binding: (unbound) (example)
.... site[x] ∑0..1CodeableConcept, Reference(BodySite)Body site to administer to
Binding: Vaccine Administered Body Site (preferred)
.... route S ∑0..1CodeableConceptHow drug should enter body
Binding: SNOMED CT Route Codes (example)
.... method ∑0..1CodeableConceptTechnique for administering medication
Binding: (unbound) (example)
.... dose[x] S ∑0..1Range, SimpleQuantityAmount of medication per dose
.... rate[x] ∑0..1Ratio, RangeAmount of medication per unit of time
.... maxDosePerPeriod ∑0..1RatioUpper limit on medication per unit of time
... substitution ∑0..1BackboneElementDeals with substitution of one medicine for another
.... 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(QICore-Practitioner)Who is responsible for the substitution

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

F.23.1.2 Terminology Bindings

PathNameConformanceValueSet
MedicationDispense.language?extrequiredhttp://tools.ietf.org/html/bcp47
MedicationDispense.statusMedicationDispenseStatusrequiredMedicationDispenseStatus
MedicationDispense.medication[x]Medication Clinical Drug (RxNorm)preferredMedication Clinical Drug (RxNorm)
MedicationDispense.typeActPharmacySupplyTypeexampleActPharmacySupplyType
MedicationDispense.dosageInstruction.extension
[UriType[http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType]]		SNOMED CT Dosages CodespreferredSNOMED CT Dosages Codes
MedicationDispense.dosageInstruction.additionalInstructions?extexample
MedicationDispense.dosageInstruction.asNeeded[x]?extexample
MedicationDispense.dosageInstruction.site[x]Vaccine Administered Body SitepreferredVaccine Administered Body Site
MedicationDispense.dosageInstruction.routeSNOMED CT Route CodesexampleSNOMED CT Route Codes
MedicationDispense.dosageInstruction.method?extexample
MedicationDispense.substitution.typeActSubstanceAdminSubstitutionCodeexampleActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonSubstanceAdminSubstitutionReasonexampleSubstanceAdminSubstitutionReason

F.23.1.3 Constraints

IdPathDetailsRequirements
mdd-1MedicationDispensewhenHandedOver cannot be before whenPrepared
XPath: not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)
.