Left: | US Core MedicationDispense Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense) |
Right: | PDex MedicationDispense (http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense) |
Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense' vs 'http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense' |
Error | StructureDefinition.version | Values for version differ: '7.0.0-ballot' vs '2.0.0' |
Information | StructureDefinition.name | Values for name differ: 'USCoreMedicationDispenseProfile' vs 'PdexMedicationDispense' |
Information | StructureDefinition.title | Values for title differ: 'US Core MedicationDispense Profile' vs 'PDex MedicationDispense' |
Information | StructureDefinition.status | Values for status differ: 'active' vs 'draft' |
Information | StructureDefinition.date | Values for date differ: '2023-10-17' vs '2024-01-06T03:22:26+00:00' |
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Cross-Group Projects' vs 'HL7 International / Financial Management' |
Information | StructureDefinition.short | Values for short differ: 'Additional content defined by implementations' vs 'Extension' |
Information | StructureDefinition.definition | Values for definition differ: 'May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'An Extension' |
Information | StructureDefinition.short | Values for short differ: 'preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown' vs 'completed' |
Information | StructureDefinition.short | Values for short differ: 'Type of medication dispense' vs 'Type of dispense action' |
Warning | MedicationDispense.medication[x] | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | StructureDefinition.short | Values for short differ: 'Who the dispense is for' vs 'The patient who is prescribed the medication' |
Information | StructureDefinition.short | Values for short differ: 'Encounter associated with MedicationDispense' vs 'Encounter / Episode associated with event' |
Warning | MedicationDispense.context | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | StructureDefinition.short | Values for short differ: 'Information that supports the dispensing of the medication' vs 'Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile.' |
Information | StructureDefinition.short | Values for short differ: 'Who performed event' vs 'Who performed the dispense event' |
Warning | MedicationDispense.performer | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | StructureDefinition.short | Values for short differ: 'Individual who was performing' vs 'Individual or device performing the dispense' |
Warning | MedicationDispense.performer.actor | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | MedicationDispense.authorizingPrescription | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | MedicationDispense.type | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | StructureDefinition.short | Values for short differ: 'Amount dispensed' vs 'Billing, service, product, or drug code' |
Warning | MedicationDispense.quantity | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | StructureDefinition.short | Values for short differ: 'Amount of medication expressed as a timing amount' vs 'Medication expressed as a timing amount.' |
Information | StructureDefinition.short | Values for short differ: 'When product was given out or mailed' vs 'When product was given out' |
Information | StructureDefinition.definition | Values for definition differ: 'When the product was given out. For mailed prescriptions, when the label was printed' vs 'The time the dispensed product was provided to the patient or their representative.' |
Warning | MedicationDispense.whenHandedOver | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | MedicationDispense.dosageInstruction | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | MedicationDispense.substitution | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | MedicationDispense.substitution.wasSubstituted | Elements differ in definition for mustSupport: 'false' vs 'true' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/MedicationDispense | ||
copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
| |
date | 2023-10-17 | 2024-01-06T03:22:26+00:00 |
|
description | This profile sets minimum expectations for the MedicationDispense resource to record, search, and fetch the "state of a medication with regards to dispensing or other activity. (e.g., dispensed, partially dispensed, not dispensed)" associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases. | Prescription Medications dispensed by a pharmacy to a health plan member and paid for in full, or in part, by the health plan |
|
experimental | true |
| |
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | USCoreMedicationDispenseProfile | PdexMedicationDispense |
|
publisher | HL7 International / Cross-Group Projects | HL7 International / Financial Management |
|
purpose | |||
status | active | draft |
|
title | US Core MedicationDispense Profile | PDex MedicationDispense |
|
type | MedicationDispense | ||
url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense | http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense |
|
version | 7.0.0-ballot | 2.0.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient us-core-20: whenHandedOver SHALL be present if the status is "completed" | C | 0..* | MedicationDispense | Dispensing a medication to a named patient | |||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
identifier | 0..* | Identifier | External identifier | 0..* | Identifier | External identifier | |||||||||||
partOf | 0..* | Reference(Procedure) | Event that dispense is part of | 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: ?? (required): A coded concept specifying the state of the dispense event. | ?!SΣ | 1..1 | code | completed Binding: ?? (required) | |||||||||
statusReason[x] | 0..1 | CodeableConcept, Reference(DetectedIssue) | Why a dispense was not performed Binding: ?? (example): A code describing why a dispense was not performed. | 0..1 | CodeableConcept, Reference(DetectedIssue) | Why a dispense was not performed Binding: ?? (example): A code describing why a dispense was not performed. | |||||||||||
category | 0..1 | CodeableConcept | Type of medication dispense Binding: ?? (preferred): A code describing where the dispensed medication is expected to be consumed or administered. | 0..1 | CodeableConcept | Type of dispense action Binding: ?? (required) | |||||||||||
medication[x] | SΣ | 1..1 | CodeableConcept, Reference(US Core Medication Profile) | What medication was supplied Binding: ?? (extensible) | Σ | 1..1 | CodeableConcept | What medication was supplied Slice: Unordered, Closed by type:$this Binding: ?? (example): A coded concept identifying which substance or product can be dispensed. |
| ||||||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile S | Group) | Who the dispense is for | SΣ | 1..1 | Reference(US Core Patient Profile) | The patient who is prescribed the medication | |||||||||
context | S | 0..1 | Reference(US Core Encounter Profile S | EpisodeOfCare) | Encounter associated with MedicationDispense | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with event |
| |||||||||
supportingInformation | 0..* | Reference(Resource) | Information that supports the dispensing of the medication | 0..* | Reference(Resource) | Information that supports the dispensing of the medication. Reference any US Core, HRex or PDex profile. | |||||||||||
performer | S | 0..* | BackboneElement | Who performed event | 0..* | BackboneElement | Who performed the dispense event |
| |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
function | 0..1 | CodeableConcept | Who performed the dispense and what they did Binding: ?? (example): A code describing the role an individual played in dispensing a medication. | 0..1 | CodeableConcept | Who performed the dispense and what they did Binding: ?? (example): A code describing the role an individual played in dispensing a medication. | |||||||||||
actor | S | 1..1 | Reference(US Core Practitioner Profile S | US Core Patient Profile | US Core Organization Profile S | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device) | Individual who was performing | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Individual or device performing the dispense |
| |||||||||
location | 0..1 | Reference(Location) | Where the dispense occurred | 0..1 | Reference(US Core Location Profile) | Where the dispense occurred | |||||||||||
authorizingPrescription | S | 0..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense | 0..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense |
| |||||||||
type | S | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ?? (extensible) | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ?? (example) |
| |||||||||
quantity | S | 0..1 | Quantity | Amount dispensed Binding: ?? (preferred)
| 0..1 | ?? | Billing, service, product, or drug code |
| |||||||||
daysSupply | 0..1 | ?? | Amount of medication expressed as a timing amount | 0..1 | ?? | Medication expressed as a timing amount. | |||||||||||
whenPrepared | Σ | 0..1 | dateTime | When product was packaged and reviewed | Σ | 0..1 | dateTime | When product was packaged and reviewed | |||||||||
whenHandedOver | SC | 0..1 | dateTime | When product was given out or mailed | 0..1 | dateTime | When product was given out |
| |||||||||
destination | 0..1 | Reference(Location) | Where the medication was sent | 0..1 | Reference(Location) | Where the medication was sent | |||||||||||
receiver | 0..* | Reference(Patient | Practitioner) | Who collected the medication | 0..* | Reference(Patient | Practitioner) | Who collected the medication | |||||||||||
note | 0..* | Annotation | Information about the dispense | 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 | 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 |
| |||||||||||||
Slices for 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: ?? (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 | boolean, CodeableConcept | Take "as needed" (for x) Binding: ?? (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. |
| ||||||||||||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: ?? (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: ?? (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: ?? (example): A coded concept describing the technique by which the medicine is administered. |
| ||||||||||||
doseAndRate | SΣ | 0..* | Element | Amount of medication administered |
| ||||||||||||
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
| ||||||||||||
maxDosePerAdministration | Σ | 0..1 | ?? | Upper limit on medication per administration |
| ||||||||||||
maxDosePerLifetime | Σ | 0..1 | ?? | Upper limit on medication per lifetime of the patient |
| ||||||||||||
substitution | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | S | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
| |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 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 | S | 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: ?? (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription. | 0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ?? (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: ?? (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | 0..* | CodeableConcept | Why was substitution made Binding: ?? (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 | 0..* | Reference(Practitioner | PractitionerRole) | Who is responsible for the substitution | |||||||||||
detectedIssue | 0..* | Reference(DetectedIssue) | Clinical issue with action | 0..* | Reference(DetectedIssue) | Clinical issue with action | |||||||||||
eventHistory | 0..* | Reference(Provenance) | A list of relevant lifecycle events | 0..* | Reference(Provenance) | A list of relevant lifecycle events | |||||||||||
Documentation for this format |