This page is part of the Pharmacist Care Plan FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.1.0. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
This is a pre-release of a future version of the Pharmacist Care Plan FHIR IG (expected to be STU 1). There is no current official version.
For a full list of available versions, see the Directory of published versions .
The official URL for this profile is:
http://hl7.org/fhir/STU3/us/phcp/StructureDefinition/PhCP-MedicationDispense
This profile builds on MedicationDispense.
This profile was published on Fri Jul 21 05:29:09 AEST 2017 as a draft by null.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from MedicationDispense
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | 1..* | |||
status | 1..1 | code | ||
medication[x] | 1..1 | CodeableConcept, Reference(US Core Medication Profile) | Binding: Medication Clinical Drug (RxNorm) (preferred) | |
performer | 1..* | BackboneElement | ||
actor | 1..1 | Reference(US Core Practitioner Profile) | ||
onBehalfOf | 0..1 | Reference(US Core Organization Core Profile) | ||
authorizingPrescription | 1..* | Reference(US Core MedicationRequest Profile) | ||
quantity | 1..1 | SimpleQuantity | ||
daysSupply | 1..1 | SimpleQuantity | ||
whenHandedOver | 1..1 | dateTime | ||
Documentation for this format |
This structure is derived from MedicationDispense
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | I | 1..* | Dispensing a medication to a named patient | |
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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | External identifier | |
partOf | 0..* | Reference(Procedure) | Event that dispense is part of | |
status | ?!Σ | 1..1 | code | preparation | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationDispenseStatus (required) |
category | 0..1 | CodeableConcept | Type of medication dispense Binding: MedicationDispenseCategory (preferred) | |
medication[x] | Σ | 1..1 | CodeableConcept, Reference(US Core Medication Profile) | What medication was supplied Binding: Medication Clinical Drug (RxNorm) (preferred) |
subject | Σ | 0..1 | Reference(Patient), Reference(Group) | Who the dispense is for |
context | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Encounter / Episode associated with event | |
supportingInformation | 0..* | Reference(Resource) | Information that supports the dispensing of the medication | |
performer | I | 1..* | BackboneElement | Who performed event |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
actor | 1..1 | Reference(US Core Practitioner Profile) | Individual who was performing | |
onBehalfOf | 0..1 | Reference(US Core Organization Core Profile) | Organization was acting for | |
authorizingPrescription | 1..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense | |
type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
quantity | 1..1 | SimpleQuantity | Amount dispensed | |
daysSupply | 1..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |
whenPrepared | Σ | 0..1 | dateTime | When product was packaged and reviewed |
whenHandedOver | 1..1 | dateTime | When product was given out | |
destination | 0..1 | Reference(Location) | Where the medication was sent | |
receiver | 0..* | Reference(Patient), Reference(Practitioner) | Who collected the medication | |
note | 0..* | Annotation | Information about the dispense | |
dosageInstruction | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |
substitution | I | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
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) | |
reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example) | |
responsibleParty | 0..* | Reference(Practitioner) | Who is responsible for the substitution | |
detectedIssue | 0..* | Reference(DetectedIssue) | Clinical issue with action | |
notDone | 0..1 | boolean | Whether the dispense was or was not performed | |
notDoneReason[x] | 0..1 | CodeableConcept, Reference(DetectedIssue) | Why a dispense was not performed | |
eventHistory | 0..* | Reference(Provenance) | A list of releveant lifecycle events | |
Documentation for this format |
This structure is derived from MedicationDispense
This structure is derived from MedicationDispense
Differential View
This structure is derived from MedicationDispense
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | 1..* | |||
status | 1..1 | code | ||
medication[x] | 1..1 | CodeableConcept, Reference(US Core Medication Profile) | Binding: Medication Clinical Drug (RxNorm) (preferred) | |
performer | 1..* | BackboneElement | ||
actor | 1..1 | Reference(US Core Practitioner Profile) | ||
onBehalfOf | 0..1 | Reference(US Core Organization Core Profile) | ||
authorizingPrescription | 1..* | Reference(US Core MedicationRequest Profile) | ||
quantity | 1..1 | SimpleQuantity | ||
daysSupply | 1..1 | SimpleQuantity | ||
whenHandedOver | 1..1 | dateTime | ||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | I | 1..* | Dispensing a medication to a named patient | |
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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | External identifier | |
partOf | 0..* | Reference(Procedure) | Event that dispense is part of | |
status | ?!Σ | 1..1 | code | preparation | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationDispenseStatus (required) |
category | 0..1 | CodeableConcept | Type of medication dispense Binding: MedicationDispenseCategory (preferred) | |
medication[x] | Σ | 1..1 | CodeableConcept, Reference(US Core Medication Profile) | What medication was supplied Binding: Medication Clinical Drug (RxNorm) (preferred) |
subject | Σ | 0..1 | Reference(Patient), Reference(Group) | Who the dispense is for |
context | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Encounter / Episode associated with event | |
supportingInformation | 0..* | Reference(Resource) | Information that supports the dispensing of the medication | |
performer | I | 1..* | BackboneElement | Who performed event |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
actor | 1..1 | Reference(US Core Practitioner Profile) | Individual who was performing | |
onBehalfOf | 0..1 | Reference(US Core Organization Core Profile) | Organization was acting for | |
authorizingPrescription | 1..* | Reference(US Core MedicationRequest Profile) | Medication order that authorizes the dispense | |
type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example) | |
quantity | 1..1 | SimpleQuantity | Amount dispensed | |
daysSupply | 1..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |
whenPrepared | Σ | 0..1 | dateTime | When product was packaged and reviewed |
whenHandedOver | 1..1 | dateTime | When product was given out | |
destination | 0..1 | Reference(Location) | Where the medication was sent | |
receiver | 0..* | Reference(Patient), Reference(Practitioner) | Who collected the medication | |
note | 0..* | Annotation | Information about the dispense | |
dosageInstruction | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |
substitution | I | 0..1 | BackboneElement | Whether a substitution was performed on the dispense |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
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) | |
reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example) | |
responsibleParty | 0..* | Reference(Practitioner) | Who is responsible for the substitution | |
detectedIssue | 0..* | Reference(DetectedIssue) | Clinical issue with action | |
notDone | 0..1 | boolean | Whether the dispense was or was not performed | |
notDoneReason[x] | 0..1 | CodeableConcept, Reference(DetectedIssue) | Why a dispense was not performed | |
eventHistory | 0..* | Reference(Provenance) | A list of releveant lifecycle events | |
Documentation for this format |
Path | Name | Conformance | ValueSet |
MedicationDispense.language | Common Languages | extensible | Common Languages |
MedicationDispense.status | MedicationDispenseStatus | required | MedicationDispenseStatus |
MedicationDispense.category | MedicationDispenseCategory | preferred | MedicationDispenseCategory |
MedicationDispense.medication[x] | Medication Clinical Drug (RxNorm) | preferred | Medication Clinical Drug (RxNorm) |
MedicationDispense.type | ActPharmacySupplyType | example | ActPharmacySupplyType |
MedicationDispense.substitution.type | ActSubstanceAdminSubstitutionCode | example | ActSubstanceAdminSubstitutionCode |
MedicationDispense.substitution.reason | SubstanceAdminSubstitutionReason | example | SubstanceAdminSubstitutionReason |
Id | Path | Details | Requirements |
dom-2 | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
mdd-1 | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared | |
ele-1 | MedicationDispense.performer | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | MedicationDispense.substitution | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |