abstractbaseDefinitioncopyrightdescriptionexperimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisherpurposestatustitletypeurl| Left: | US Core MedicationDispense Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense) |
| Right: | US Core MedicationDispense Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense) |
| Name | Value | Comments | |
|---|---|---|---|
| abstract | false | ||
| baseDefinition | http://hl7.org/fhir/StructureDefinition/MedicationDispense | ||
| copyright | |||
| description | The US Core MedicationDispense Profile inherits from the FHIR [MedicationDispense](https://hl7.org/fhir/R4/medicationdispense.html) 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. | ||
| experimental | |||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
| jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | USCoreMedicationDispenseProfile | ||
| publisher | HL7 International / Cross-Group Projects | ||
| purpose | |||
| status | active | ||
| title | US Core MedicationDispense Profile | ||
| type | MedicationDispense | ||
| url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense | ||
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient Constraints: us-core-20 | C | 0..* | MedicationDispense | Dispensing a medication to a named patient Constraints: us-core-20 | |||||||||
 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||
| contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
 extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
 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 | 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. | 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. | |||||||||
| 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 medication dispense Binding: ?? (preferred): A code describing where the dispensed medication is expected to be consumed or administered. | |||||||||||
| medication[x] | 1..1 | CodeableConcept, Reference(US Core Medication Profile) | What medication was supplied Binding: ?? (extensible) | 1..1 | CodeableConcept, Reference(US Core Medication Profile) | What medication was supplied Binding: ?? (extensible) | |||||||||||
| subject | 1..1 | Reference(US Core Patient Profile | Group) | Who the dispense is for | 1..1 | Reference(US Core Patient Profile | Group) | Who the dispense is for | |||||||||||
| context | 0..1 | Reference(US Core Encounter Profile | EpisodeOfCare) | Encounter associated with MedicationDispense | 0..1 | Reference(US Core Encounter Profile | EpisodeOfCare) | Encounter associated with MedicationDispense | |||||||||||
| supportingInformation | 0..* | Reference(Resource) | Information that supports the dispensing of the medication | 0..* | Reference(Resource) | Information that supports the dispensing of the medication | |||||||||||
| performer | 0..* | BackboneElement | Who performed event | 0..* | BackboneElement | Who performed 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 | 1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) | Individual who was performing | 1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) | Individual who was performing | |||||||||||
| location | 0..1 | Reference(Location) | Where the dispense occurred | 0..1 | Reference(Location) | Where the dispense occurred | |||||||||||
| authorizingPrescription | 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 | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ?? (extensible) | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ?? (extensible) | |||||||||||
| quantity | 0..1 | ??  | Amount dispensed Binding: ?? (preferred)
| C | 0..1 | ?? | Amount dispensed Binding: ?? (preferred)
| ||||||||||
| daysSupply | 0..1 | ?? | Amount of medication expressed as a timing amount | C | 0..1 | ?? | Amount of 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 | C | 0..1 | dateTime | When product was given out or mailed | C | 0..1 | dateTime | When product was given out or mailed | |||||||||
| 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 | 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 | 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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| sequence | 0..1 | integer | The order of the dosage instructions | 0..1 | integer | The order of the dosage instructions | |||||||||||
| text | 0..1 | string | Free text dosage instructions e.g. SIG | 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". | 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 | 0..1 | string | Patient or consumer oriented instructions | |||||||||||
| timing | 0..1 | Timing | When medication should be administered | 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. | 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. | 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: ?? (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes | 0..1 | CodeableConcept | How drug should enter body Binding: ?? (extensible): SNOMED CT and NCI Thesaurus SPL route of administration codes | |||||||||||
| method | 0..1 | CodeableConcept | Technique for administering medication Binding: ?? (example): A coded concept describing the technique by which the medicine is administered. | 0..1 | CodeableConcept | Technique for administering medication Binding: ?? (example): A coded concept describing the technique by which the medicine is administered. | |||||||||||
| doseAndRate | 0..* | Element | Amount of medication administered | 0..* | Element | Amount of medication administered | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 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 | 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: ?? (example): The kind of dose or rate specified. | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: ?? (example): The kind of dose or rate specified. | |||||||||||
| dose[x] | 0..1 | ?? , Range | Amount of medication per dose Binding: ?? (preferred)
| 0..1 | ?? , Range | Amount of medication per dose Binding: ?? (preferred)
| |||||||||||
| rate[x] | 0..1 | Ratio, Range, ?? | Amount of medication per unit of time | 0..1 | Ratio, Range, ?? | Amount of medication per unit of time | |||||||||||
| maxDosePerPeriod | 0..1 | Ratio | Upper limit on medication per unit of time | 0..1 | Ratio | Upper limit on medication per unit of time | |||||||||||
| maxDosePerAdministration | 0..1 | ?? | Upper limit on medication per administration | C | 0..1 | ?? | Upper limit on medication per administration | ||||||||||
| maxDosePerLifetime | 0..1 | ?? | Upper limit on medication per lifetime of the patient | C | 0..1 | ?? | Upper limit on medication per lifetime of the patient | ||||||||||
| substitution | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | 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 | 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 | |||||||||||||||||