IE (Ireland) Core Implementation Guide
1.0.0-ballot - Ballot
Publication Build: This will be filled in by the publication tooling
Official URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-medicationdispense | Version: 1.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 3 | Computable Name: IECoreMedicationDispenseProfile | ||
Other Identifiers: OID:1.3.6.1.4.1.54392.5.2690.42.35 | ||||
Copyright/Legal: iEHR.ai, all rights reserved Creative Commons License |
The IE Core MedicationDispense Profile inherits from the FHIR MedicationDispense resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the MedicationDispense resource to record, search, and fetch the state of a patients medication with regards to dispensing or other activity. (e.g., dispensed, partially dispensed, not dispensed) It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.
Example Usage Scenarios:
The following are example usage scenarios for the IE Core-MedicationDispense profile:
The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.
Each MedicationDispense Must Have:
* see guidance below
Each MedicationDispense Must Support:
Profile Specific Implementation Guidance:
.medicationCodeableConcept
. They can be supplied as an additional coding element..medicationReference
, the resource may be contained or an external resource._include
parameter for searching this element.Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationDispense
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient ie-core-20: whenHandedOver SHALL be present if the status is "completed" | ||||
status | SC | 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 | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(IE Core Medication Profile) | |||||||
subject | S | 1..1 | Reference(IE Core Patient Profile S | Group) | Who the dispense is for | ||||
context | S | 0..1 | Reference(IE Core Encounter Profile S | EpisodeOfCare) | Encounter associated with MedicationDispense | ||||
performer | S | 0..* | BackboneElement | Who performed event | ||||
actor | S | 1..1 | Reference(IE Core Practitioner Profile S | IE Core Patient Profile | IE Core Organization Profile S | IE Core PractitionerRole Profile | IE Core RelatedPerson Profile | Device) | Individual who was performing | ||||
authorizingPrescription | S | 0..* | Reference(IE Core MedicationRequest Profile) | Medication order that authorizes the dispense | ||||
type | S | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (extensible) | ||||
quantity | S | 0..1 | SimpleQuantity | Amount dispensed Binding: Common UCUM units (preferred)
| ||||
whenHandedOver | SC | 0..1 | dateTime | When product was given out or mailed | ||||
dosageInstruction | S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | ||||
text | S | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
timing | S | 0..1 | Timing | When medication should be administered | ||||
route | S | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration of Therapeutic Agents (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes | ||||
doseAndRate | S | 0..* | Element | Amount of medication administered | ||||
dose[x] | S | 0..1 | Amount of medication per dose Binding: Common UCUM units (preferred)
| |||||
doseRange | Range S | |||||||
doseQuantity | Quantity(SimpleQuantity) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.type | extensible | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.quantity | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.route | extensible | RouteOfAdministrationOfTherapeuticAgents http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.22 | ||||
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ie-core-20 | error | MedicationDispense | whenHandedOver SHALL be present if the status is "completed" : status='completed' implies whenHandedOver.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared ie-core-20: whenHandedOver SHALL be present if the status is "completed" | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
status | ?!SΣC | 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. | ||||
medication[x] | SΣ | 1..1 | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(IE Core Medication Profile) | |||||||
subject | SΣ | 1..1 | Reference(IE Core Patient Profile) | Who the dispense is for | ||||
context | S | 0..1 | Reference(IE Core Encounter Profile) | Encounter associated with MedicationDispense | ||||
performer | S | 0..* | BackboneElement | Who performed event | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
actor | S | 1..1 | Reference(IE Core Practitioner Profile | IE Core Organization Profile) | Individual who was performing | ||||
authorizingPrescription | S | 0..* | Reference(IE Core MedicationRequest Profile) | Medication order that authorizes the dispense | ||||
type | S | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (extensible) | ||||
quantity | S | 0..1 | SimpleQuantity | Amount dispensed Binding: Common UCUM units (preferred)
| ||||
whenHandedOver | SC | 0..1 | dateTime | When product was given out or mailed | ||||
dosageInstruction | S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
text | SΣ | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
timing | SΣ | 0..1 | Timing | When medication should be administered | ||||
route | SΣ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration of Therapeutic Agents (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes | ||||
doseAndRate | SΣ | 0..* | Element | Amount of medication administered | ||||
dose[x] | SΣ | 0..1 | Amount of medication per dose Binding: Common UCUM units (preferred)
| |||||
doseRange | Range | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1 from the FHIR Standard | ||||
MedicationDispense.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationDispense.type | extensible | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.quantity | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.route | extensible | RouteOfAdministrationOfTherapeuticAgents http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.22 | ||||
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ie-core-20 | error | MedicationDispense | whenHandedOver SHALL be present if the status is "completed" : status='completed' implies whenHandedOver.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared ie-core-20: whenHandedOver SHALL be present if the status is "completed" | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
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.
| |||||
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 | ?!SΣC | 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 | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||
statusReasonCodeableConcept | CodeableConcept | |||||||
statusReasonReference | Reference(DetectedIssue) | |||||||
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. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(IE Core Medication Profile) | |||||||
subject | SΣ | 1..1 | Reference(IE Core Patient Profile S | Group) | Who the dispense is for | ||||
context | S | 0..1 | Reference(IE Core Encounter Profile S | EpisodeOfCare) | Encounter associated with MedicationDispense | ||||
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(IE Core Practitioner Profile S | IE Core Patient Profile | IE Core Organization Profile S | IE Core PractitionerRole Profile | IE Core RelatedPerson Profile | Device) | Individual who was performing | ||||
location | 0..1 | Reference(Location) | Where the dispense occurred | |||||
authorizingPrescription | S | 0..* | Reference(IE Core MedicationRequest Profile) | Medication order that authorizes the dispense | ||||
type | S | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (extensible) | ||||
quantity | S | 0..1 | SimpleQuantity | Amount dispensed Binding: Common UCUM units (preferred)
| ||||
daysSupply | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |||||
whenPrepared | Σ | 0..1 | dateTime | When product was packaged and reviewed | ||||
whenHandedOver | SC | 0..1 | dateTime | When product was given out or mailed | ||||
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 | S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | ||||
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 | SΣ | 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 | SΣ | 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 | SΣ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration of Therapeutic Agents (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes | ||||
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
doseAndRate | SΣ | 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] | SΣ | 0..1 | Amount of medication per dose Binding: Common UCUM units (preferred)
| |||||
doseRange | Range S | |||||||
doseQuantity | Quantity(SimpleQuantity) | |||||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1 from the FHIR Standard | ||||
MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reason from the FHIR Standard | ||||
MedicationDispense.category | preferred | MedicationDispense Category Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-category from the FHIR Standard | ||||
MedicationDispense.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationDispense.performer.function | example | MedicationDispense Performer Function Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-function from the FHIR Standard | ||||
MedicationDispense.type | extensible | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.quantity | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.route | extensible | RouteOfAdministrationOfTherapeuticAgents http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.22 | ||||
MedicationDispense.dosageInstruction.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Id | Grade | Path(s) | Details | Requirements |
ie-core-20 | error | MedicationDispense | whenHandedOver SHALL be present if the status is "completed" : status='completed' implies whenHandedOver.exists() |
This structure is derived from MedicationDispense
Summary
Mandatory: 1 element
Must-Support: 16 elements
Structures
This structure refers to these other structures:
Maturity: 3
Differential View
This structure is derived from MedicationDispense
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient ie-core-20: whenHandedOver SHALL be present if the status is "completed" | ||||
status | SC | 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 | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(IE Core Medication Profile) | |||||||
subject | S | 1..1 | Reference(IE Core Patient Profile S | Group) | Who the dispense is for | ||||
context | S | 0..1 | Reference(IE Core Encounter Profile S | EpisodeOfCare) | Encounter associated with MedicationDispense | ||||
performer | S | 0..* | BackboneElement | Who performed event | ||||
actor | S | 1..1 | Reference(IE Core Practitioner Profile S | IE Core Patient Profile | IE Core Organization Profile S | IE Core PractitionerRole Profile | IE Core RelatedPerson Profile | Device) | Individual who was performing | ||||
authorizingPrescription | S | 0..* | Reference(IE Core MedicationRequest Profile) | Medication order that authorizes the dispense | ||||
type | S | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (extensible) | ||||
quantity | S | 0..1 | SimpleQuantity | Amount dispensed Binding: Common UCUM units (preferred)
| ||||
whenHandedOver | SC | 0..1 | dateTime | When product was given out or mailed | ||||
dosageInstruction | S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | ||||
text | S | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
timing | S | 0..1 | Timing | When medication should be administered | ||||
route | S | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration of Therapeutic Agents (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes | ||||
doseAndRate | S | 0..* | Element | Amount of medication administered | ||||
dose[x] | S | 0..1 | Amount of medication per dose Binding: Common UCUM units (preferred)
| |||||
doseRange | Range S | |||||||
doseQuantity | Quantity(SimpleQuantity) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.type | extensible | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.quantity | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.route | extensible | RouteOfAdministrationOfTherapeuticAgents http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.22 | ||||
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ie-core-20 | error | MedicationDispense | whenHandedOver SHALL be present if the status is "completed" : status='completed' implies whenHandedOver.exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared ie-core-20: whenHandedOver SHALL be present if the status is "completed" | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
status | ?!SΣC | 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. | ||||
medication[x] | SΣ | 1..1 | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(IE Core Medication Profile) | |||||||
subject | SΣ | 1..1 | Reference(IE Core Patient Profile) | Who the dispense is for | ||||
context | S | 0..1 | Reference(IE Core Encounter Profile) | Encounter associated with MedicationDispense | ||||
performer | S | 0..* | BackboneElement | Who performed event | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
actor | S | 1..1 | Reference(IE Core Practitioner Profile | IE Core Organization Profile) | Individual who was performing | ||||
authorizingPrescription | S | 0..* | Reference(IE Core MedicationRequest Profile) | Medication order that authorizes the dispense | ||||
type | S | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (extensible) | ||||
quantity | S | 0..1 | SimpleQuantity | Amount dispensed Binding: Common UCUM units (preferred)
| ||||
whenHandedOver | SC | 0..1 | dateTime | When product was given out or mailed | ||||
dosageInstruction | S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
text | SΣ | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
timing | SΣ | 0..1 | Timing | When medication should be administered | ||||
route | SΣ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration of Therapeutic Agents (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes | ||||
doseAndRate | SΣ | 0..* | Element | Amount of medication administered | ||||
dose[x] | SΣ | 0..1 | Amount of medication per dose Binding: Common UCUM units (preferred)
| |||||
doseRange | Range | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1 from the FHIR Standard | ||||
MedicationDispense.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationDispense.type | extensible | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.quantity | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.route | extensible | RouteOfAdministrationOfTherapeuticAgents http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.22 | ||||
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ie-core-20 | error | MedicationDispense | whenHandedOver SHALL be present if the status is "completed" : status='completed' implies whenHandedOver.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared ie-core-20: whenHandedOver SHALL be present if the status is "completed" | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
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.
| |||||
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 | ?!SΣC | 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 | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||
statusReasonCodeableConcept | CodeableConcept | |||||||
statusReasonReference | Reference(DetectedIssue) | |||||||
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. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(IE Core Medication Profile) | |||||||
subject | SΣ | 1..1 | Reference(IE Core Patient Profile S | Group) | Who the dispense is for | ||||
context | S | 0..1 | Reference(IE Core Encounter Profile S | EpisodeOfCare) | Encounter associated with MedicationDispense | ||||
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(IE Core Practitioner Profile S | IE Core Patient Profile | IE Core Organization Profile S | IE Core PractitionerRole Profile | IE Core RelatedPerson Profile | Device) | Individual who was performing | ||||
location | 0..1 | Reference(Location) | Where the dispense occurred | |||||
authorizingPrescription | S | 0..* | Reference(IE Core MedicationRequest Profile) | Medication order that authorizes the dispense | ||||
type | S | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (extensible) | ||||
quantity | S | 0..1 | SimpleQuantity | Amount dispensed Binding: Common UCUM units (preferred)
| ||||
daysSupply | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |||||
whenPrepared | Σ | 0..1 | dateTime | When product was packaged and reviewed | ||||
whenHandedOver | SC | 0..1 | dateTime | When product was given out or mailed | ||||
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 | S | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | ||||
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 | SΣ | 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 | SΣ | 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 | SΣ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration of Therapeutic Agents (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes | ||||
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
doseAndRate | SΣ | 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] | SΣ | 0..1 | Amount of medication per dose Binding: Common UCUM units (preferred)
| |||||
doseRange | Range S | |||||||
doseQuantity | Quantity(SimpleQuantity) | |||||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationDispense.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1 from the FHIR Standard | ||||
MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reason from the FHIR Standard | ||||
MedicationDispense.category | preferred | MedicationDispense Category Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-category from the FHIR Standard | ||||
MedicationDispense.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationDispense.performer.function | example | MedicationDispense Performer Function Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-function from the FHIR Standard | ||||
MedicationDispense.type | extensible | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
MedicationDispense.quantity | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.route | extensible | RouteOfAdministrationOfTherapeuticAgents http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.22 | ||||
MedicationDispense.dosageInstruction.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard | ||||
MedicationDispense.dosageInstruction.doseAndRate.dose[x] | preferred | Common UCUM units
http://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Id | Grade | Path(s) | Details | Requirements |
ie-core-20 | error | MedicationDispense | whenHandedOver SHALL be present if the status is "completed" : status='completed' implies whenHandedOver.exists() |
This structure is derived from MedicationDispense
Summary
Mandatory: 1 element
Must-Support: 16 elements
Structures
This structure refers to these other structures:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the IE Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only IE Core Profiles (Profile Only Support) are not required to support these interactions. See the IE Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.
Servers providing access to dispensed medication data SHALL support these IE Core SMART Scopes:
<patient|user|system>/MedicationDispense.rs
SHALL support searching using the patient
search parameter:
_include
parameters: MedicationDispense:medication
GET [base]/MedicationDispense?patient={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all MedicationDispense resources for the specified patient. (how to search by reference)
The following search parameter combinations SHOULD be supported:
patient
and status
search parameters:
_include
parameters: MedicationDispense:medication
status
(e.g.status={system|}[code],{system|}[code],...
)GET [base]/MedicationDispense?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all MedicationDispense resources for the specified patient that have a given dispense status (e.g., dispensed, not dispensed)). (how to search by reference and how to search by token)
patient
and status
and type
search parameters:
_include
parameters: MedicationDispense:medication
status
(e.g.status={system|}[code],{system|}[code],...
)type
(e.g.type={system|}[code],{system|}[code],...
)GET [base]/MedicationDispense?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}&type={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all MedicationDispense resources for the specified patient that have a given dispense status (e.g., dispensed, not dispensed) and type of dispense (e.g., partially dispensed). (how to search by reference and how to search by token)