OpenMRS Core FHIR Implementation Guide
0.1.0 - ci-build
OpenMRS Core FHIR Implementation Guide
0.1.0 - ci-build
OpenMRS Core FHIR Implementation Guide, published by . This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/abertnamanya/openmrs-contrib-fhir2-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.openmrs.org/core/StructureDefinition/omrsmedication-dispense | Version: 0.1.0 | |||
| Active as of 2024-12-11 | Computable Name: OMRSMedicationDispense | |||
Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
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 |
0..* | MedicationDispense | Dispensing a medication to a named patient | |
  id |
0..1 | id | Logical id of this artifact | |
| identifier |
0..0 | |||
| partOf |
0..0 | |||
| status |
1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown | |
  Slices for statusReason[x] |
0..1 | CodeableConcept, Reference(DetectedIssue) | Why a dispense was not performed Slice: Unordered, Open by type:$this | |
   statusReason[x]:statusReasonCodeableConcept |
0..1 | CodeableConcept | Why a dispense was not performed | |
| category |
0..0 | |||
| medication[x] |
1..1 | CodeableConcept, Reference(Medication) | What medication was supplied | |
| subject |
0..1 | Reference(Patient | Group) | Who the dispense is for | |
 context |
0..1 | Reference(Openmrs Encounter) | Encounter / Episode associated with event | |
| supportingInformation |
0..0 | |||
| performer |
||||
 actor |
1..1 | Reference(Openmrs Practitioner) | Individual who was performing | |
| location |
0..1 | Reference(OpenMRS Location) | Where the dispense occurred | |
| authorizingPrescription |
0..* | Reference(OpenMRS Medication Request) | Medication order that authorizes the dispense | |
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. | |
| quantity |
0..1 | SimpleQuantity | Amount dispensed | |
| daysSupply |
0..0 | |||
| whenPrepared |
0..1 | dateTime | When product was packaged and reviewed | |
| whenHandedOver |
0..1 | dateTime | When product was given out | |
| destination |
0..0 | |||
| receiver |
0..0 | |||
| note |
0..0 | |||
| dosageInstruction |
0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |
| substitution |
||||
| 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 | |
| reason |
0..1 | CodeableConcept | Why was substitution made | |
| responsibleParty |
0..0 | |||
| detectedIssue |
0..0 | |||
| eventHistory |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management mdd-1: whenHandedOver cannot be before whenPrepared |
 id |
Σ | 0..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!Σ | 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. ele-1: All FHIR elements must have a @value or children |
| Slices for statusReason[x] |
0..1 | Why a dispense was not performed Slice: Unordered, Open by type:$this Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. ele-1: All FHIR elements must have a @value or children | ||
  statusReasonCodeableConcept |
CodeableConcept | |||
| statusReasonReference |
Reference(DetectedIssue) | |||
| statusReason[x]:statusReasonCodeableConcept |
0..1 | CodeableConcept | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. ele-1: All FHIR elements must have a @value or children | |
 medication[x] |
Σ | 1..1 | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. ele-1: All FHIR elements must have a @value or children | |
| medicationCodeableConcept |
CodeableConcept | |||
| medicationReference |
Reference(Medication) | |||
| subject |
Σ | 0..1 | Reference(Patient | Group) | Who the dispense is for ele-1: All FHIR elements must have a @value or children |
| context |
0..1 | Reference(Openmrs Encounter) | Encounter / Episode associated with event ele-1: All FHIR elements must have a @value or children | |
| location |
0..1 | Reference(OpenMRS Location) | Where the dispense occurred ele-1: All FHIR elements must have a @value or children | |
| authorizingPrescription |
0..* | Reference(OpenMRS Medication Request) | Medication order that authorizes the dispense ele-1: All FHIR elements must have a @value or children | |
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. ele-1: All FHIR elements must have a @value or children | |
| quantity |
0..1 | SimpleQuantity | Amount dispensed ele-1: All FHIR elements must have a @value or children | |
| whenPrepared |
Σ | 0..1 | dateTime | When product was packaged and reviewed ele-1: All FHIR elements must have a @value or children |
| whenHandedOver |
0..1 | dateTime | When product was given out ele-1: All FHIR elements must have a @value or children | |
| dosageInstruction |
0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1from the FHIR Standard | |
| MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reasonfrom the FHIR Standard | |
| MedicationDispense.statusReason[x]:statusReasonCodeableConcept | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reasonfrom the FHIR Standard | |
| MedicationDispense.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationDispense |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared | ||||
| 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 | ||||
| status |
?!Σ | 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. | ||||
| Slices for statusReason[x] |
0..1 | Why a dispense was not performed Slice: Unordered, Open by type:$this Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||
| statusReasonCodeableConcept |
CodeableConcept | |||||||
| statusReasonReference |
Reference(DetectedIssue) | |||||||
| statusReason[x]:statusReasonCodeableConcept |
0..1 | CodeableConcept | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | |||||
| medication[x] |
Σ | 1..1 | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | |||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| subject |
Σ | 0..1 | Reference(Patient | Group) | Who the dispense is for | ||||
| context |
0..1 | Reference(Openmrs Encounter) | Encounter / Episode associated with event | |||||
| performer |
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 |
1..1 | Reference(Openmrs Practitioner) | Individual who was performing | |||||
| location |
0..1 | Reference(OpenMRS Location) | Where the dispense occurred | |||||
| authorizingPrescription |
0..* | Reference(OpenMRS Medication Request) | Medication order that authorizes the dispense | |||||
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. | |||||
| quantity |
0..1 | SimpleQuantity | Amount dispensed | |||||
| whenPrepared |
Σ | 0..1 | dateTime | When product was packaged and reviewed | ||||
| whenHandedOver |
0..1 | dateTime | When product was given out | |||||
| dosageInstruction |
0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |||||
 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..1 | 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. | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| MedicationDispense.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1from the FHIR Standard | ||||
| MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reasonfrom the FHIR Standard | ||||
| MedicationDispense.statusReason[x]:statusReasonCodeableConcept | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reasonfrom the FHIR Standard | ||||
| MedicationDispense.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationDispense.performer.function | example | MedicationDispense Performer Function Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-functionfrom the FHIR Standard | ||||
| MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
| 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 |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
This structure is derived from MedicationDispense
Summary
Prohibited: 11 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MedicationDispense
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense |
0..* | MedicationDispense | Dispensing a medication to a named patient | |
| id |
0..1 | id | Logical id of this artifact | |
| identifier |
0..0 | |||
| partOf |
0..0 | |||
| status |
1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown | |
| Slices for statusReason[x] |
0..1 | CodeableConcept, Reference(DetectedIssue) | Why a dispense was not performed Slice: Unordered, Open by type:$this | |
| statusReason[x]:statusReasonCodeableConcept |
0..1 | CodeableConcept | Why a dispense was not performed | |
| category |
0..0 | |||
| medication[x] |
1..1 | CodeableConcept, Reference(Medication) | What medication was supplied | |
| subject |
0..1 | Reference(Patient | Group) | Who the dispense is for | |
| context |
0..1 | Reference(Openmrs Encounter) | Encounter / Episode associated with event | |
| supportingInformation |
0..0 | |||
| performer |
||||
| actor |
1..1 | Reference(Openmrs Practitioner) | Individual who was performing | |
| location |
0..1 | Reference(OpenMRS Location) | Where the dispense occurred | |
| authorizingPrescription |
0..* | Reference(OpenMRS Medication Request) | Medication order that authorizes the dispense | |
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. | |
| quantity |
0..1 | SimpleQuantity | Amount dispensed | |
| daysSupply |
0..0 | |||
| whenPrepared |
0..1 | dateTime | When product was packaged and reviewed | |
| whenHandedOver |
0..1 | dateTime | When product was given out | |
| destination |
0..0 | |||
| receiver |
0..0 | |||
| note |
0..0 | |||
| dosageInstruction |
0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |
| substitution |
||||
| 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 | |
| reason |
0..1 | CodeableConcept | Why was substitution made | |
| responsibleParty |
0..0 | |||
| detectedIssue |
0..0 | |||
| eventHistory |
0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense |
C | 0..* | MedicationDispense | Dispensing a medication to a named patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management mdd-1: whenHandedOver cannot be before whenPrepared |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!Σ | 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. ele-1: All FHIR elements must have a @value or children |
| Slices for statusReason[x] |
0..1 | Why a dispense was not performed Slice: Unordered, Open by type:$this Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. ele-1: All FHIR elements must have a @value or children | ||
| statusReasonCodeableConcept |
CodeableConcept | |||
| statusReasonReference |
Reference(DetectedIssue) | |||
| statusReason[x]:statusReasonCodeableConcept |
0..1 | CodeableConcept | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. ele-1: All FHIR elements must have a @value or children | |
| medication[x] |
Σ | 1..1 | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. ele-1: All FHIR elements must have a @value or children | |
| medicationCodeableConcept |
CodeableConcept | |||
| medicationReference |
Reference(Medication) | |||
| subject |
Σ | 0..1 | Reference(Patient | Group) | Who the dispense is for ele-1: All FHIR elements must have a @value or children |
| context |
0..1 | Reference(Openmrs Encounter) | Encounter / Episode associated with event ele-1: All FHIR elements must have a @value or children | |
| location |
0..1 | Reference(OpenMRS Location) | Where the dispense occurred ele-1: All FHIR elements must have a @value or children | |
| authorizingPrescription |
0..* | Reference(OpenMRS Medication Request) | Medication order that authorizes the dispense ele-1: All FHIR elements must have a @value or children | |
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. ele-1: All FHIR elements must have a @value or children | |
| quantity |
0..1 | SimpleQuantity | Amount dispensed ele-1: All FHIR elements must have a @value or children | |
| whenPrepared |
Σ | 0..1 | dateTime | When product was packaged and reviewed ele-1: All FHIR elements must have a @value or children |
| whenHandedOver |
0..1 | dateTime | When product was given out ele-1: All FHIR elements must have a @value or children | |
| dosageInstruction |
0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1from the FHIR Standard | |
| MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reasonfrom the FHIR Standard | |
| MedicationDispense.statusReason[x]:statusReasonCodeableConcept | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reasonfrom the FHIR Standard | |
| MedicationDispense.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
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 | ||||
| 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 | ||||
| status |
?!Σ | 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. | ||||
| Slices for statusReason[x] |
0..1 | Why a dispense was not performed Slice: Unordered, Open by type:$this Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | ||||||
| statusReasonCodeableConcept |
CodeableConcept | |||||||
| statusReasonReference |
Reference(DetectedIssue) | |||||||
| statusReason[x]:statusReasonCodeableConcept |
0..1 | CodeableConcept | Why a dispense was not performed Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed. | |||||
| medication[x] |
Σ | 1..1 | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. | |||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| subject |
Σ | 0..1 | Reference(Patient | Group) | Who the dispense is for | ||||
| context |
0..1 | Reference(Openmrs Encounter) | Encounter / Episode associated with event | |||||
| performer |
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 |
1..1 | Reference(Openmrs Practitioner) | Individual who was performing | |||||
| location |
0..1 | Reference(OpenMRS Location) | Where the dispense occurred | |||||
| authorizingPrescription |
0..* | Reference(OpenMRS Medication Request) | Medication order that authorizes the dispense | |||||
| type |
0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc. Binding: ActPharmacySupplyType (example): Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. | |||||
| quantity |
0..1 | SimpleQuantity | Amount dispensed | |||||
| whenPrepared |
Σ | 0..1 | dateTime | When product was packaged and reviewed | ||||
| whenHandedOver |
0..1 | dateTime | When product was given out | |||||
| dosageInstruction |
0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |||||
| 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..1 | 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. | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| MedicationDispense.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MedicationDispense.status | required | MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1from the FHIR Standard | ||||
| MedicationDispense.statusReason[x] | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reasonfrom the FHIR Standard | ||||
| MedicationDispense.statusReason[x]:statusReasonCodeableConcept | example | MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reasonfrom the FHIR Standard | ||||
| MedicationDispense.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationDispense.performer.function | example | MedicationDispense Performer Function Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-functionfrom the FHIR Standard | ||||
| MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | ||||
| 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 |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
This structure is derived from MedicationDispense
Summary
Prohibited: 11 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron