CH EMED EPR
1.0.0 - trial-use Switzerland flag

This page is part of the FHIR eMedication exchange formats for the implementation effort of CARA within its EPR community (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: DIS MedicationDispense

Official URL: http://fhir.ch/ig/ch-emed-epr/StructureDefinition/ch-emed-epr-medicationdispense Version: 1.0.0
Draft as of 2024-01-26 Computable Name: CHEMEDEPRMedicationDispense

Copyright/Legal: CC0-1.0

Definition of the medication dispense for the medication dispense document

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CHEMEDMedicationDispense

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense CHEMEDMedicationDispense
... meta
.... extension D0..*Extension✕ This element is not supported
.... versionId D0..1id✕ This element is not supported
.... lastUpdated D0..1instant✕ This element is not supported
.... source D0..1uri✕ This element is not supported
.... security D0..*Coding✕ This element is not supported
.... tag D0..*Coding✕ This element is not supported
... implicitRules 0..0
... extension 1..*ExtensionExtension
... extension:prescription 0..1CHEMEDExtPrescriptionReference to te medication prescription. This item is mandantory if the treatment has already been prescribed.
... extension:pharmaceuticalAdvice D0..1CHEMEDExtPharmaceuticalAdvice✕ This element is not supported
... extension:treatmentPlan 1..1CHEMEDExtTreatmentPlanCH EMED Extension
... modifierExtension 0..0
... partOf D0..*Reference(Procedure)✕ This element is not supported
... statusReason[x] D0..1CodeableConcept, Reference(DetectedIssue)✕ This is only meaningful when the dispense was not performed
... category D0..1CodeableConcept✕ This element is not supported
... medication[x] 1..1Reference(Medication)What medication was supplied
... medication[x]:medicationReference 0..1Reference(CH EMED EPR Medication (DIS)) {c}Reference to the contained medication
... subject 0..1Reference(CH EMED EPR Patient) {r, b}Patient
... context D0..1Reference(Encounter | EpisodeOfCare)✕ This element is not supported
... supportingInformation D0..*Reference(Resource)✕ This element is not supported
... performer
.... modifierExtension 0..0
... location D0..1Reference(Location)✕ This element is not supported
... authorizingPrescription D0..*Reference(MedicationRequest)✕ This element is not supported
... type D0..1CodeableConcept✕ This element is not supported
... quantity 1..1CHEMEDEPRAmountQuantityA fixed quantity (no comparator)
... daysSupply D0..1CHEMEDEPRTimeQuantity✕ This element is not supported
... whenPrepared D0..1dateTime✕ This element is not supported
... destination D0..1Reference(Location)✕ This element is not supported
... receiver D0..*Reference(Patient | Practitioner)✕ This element is not supported
... note
.... id D0..1string✕ This element is not supported
.... extension D0..*Extension✕ This element is not supported
.... author[x] D0..1Reference(Practitioner | Patient | RelatedPerson | Organization), string✕ The note author is ignored, as it cannot be different than the document and/or entry's author
.... time D0..1dateTime✕ This element is not supported
.... text 1..1markdownThe annotation text content (as raw text, no markdown allowed).
... dosageInstruction:baseEntry 1..1CHEMEDEPRDosageCH EMED Dosage (MedicationStatement / MedicationDispense)
... dosageInstruction:additionalEntry 0..*CHEMEDEPRDosageSplitCH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest)
... substitution
.... modifierExtension 0..0
.... reason D0..*CodeableConcept✕ This element is not supported
.... responsibleParty D0..*Reference(Practitioner | PractitionerRole)✕ This element is not supported
... detectedIssue D0..*Reference(DetectedIssue)✕ This element is not supported
... eventHistory D0..*Reference(Provenance)✕ This element is not supported

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*CHEMEDMedicationDispenseCH EMED MedicationDispense (DIS)
... contained 1..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... treatmentReason 0..1stringTreatment reason
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentreason
... prescription 0..1(Complex)Reference to te medication prescription. This item is mandantory if the treatment has already been prescribed.
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-prescription
... pharmaceuticalAdvice 0..1(Complex)✕ This element is not supported
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-pharmaceuticaladvice
... treatmentPlan 1..1(Complex)CH EMED Extension
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentplan
... identifier 1..1IdentifierMedicationDispense Identifier
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value Σ1..1stringIdentifier value as UUID
Example General: 123456
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
... partOf 0..*Reference(Procedure)✕ This element is not supported
... status ?!Σ1..1codepreparation | 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.


Fixed Value: completed
... statusReason[x] 0..1✕ This is only meaningful when the dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
... category 0..1CodeableConcept✕ This element is not supported
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.

... Slices for medication[x] Σ1..1Reference(Medication)What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ0..1Reference(CH EMED EPR Medication (DIS)) {c}Reference to the contained medication
... subject Σ0..1Reference(CH EMED EPR Patient) {r, b}Patient
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... context 0..1Reference(Encounter | EpisodeOfCare)✕ This element is not supported
... supportingInformation 0..*Reference(Resource)✕ This element is not supported
... performer 1..1BackboneElementWho performed event
.... actor 1..1Reference(CH EMED PractitionerRole)The author of the medical decision, see also 'Guidance - Authorship'
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... location 0..1Reference(Location)✕ This element is not supported
... authorizingPrescription 0..*Reference(MedicationRequest)✕ This element is not supported
... type 0..1CodeableConcept✕ This element is not supported
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 C1..1CHEMEDEPRAmountQuantityA fixed quantity (no comparator)
... daysSupply C0..1CHEMEDEPRTimeQuantity✕ This element is not supported
... whenPrepared Σ0..1dateTime✕ This element is not supported
... whenHandedOver 1..1dateTimeWhen product was given out
... destination 0..1Reference(Location)✕ This element is not supported
... receiver 0..*Reference(Patient | Practitioner)✕ This element is not supported
... Slices for dosageInstruction 1..*DosageHow the medication should be taken
Slice: Unordered, Closed by profile:$this
.... dosageInstruction:baseEntry C1..1CHEMEDEPRDosageCH EMED Dosage (MedicationStatement / MedicationDispense)
.... dosageInstruction:additionalEntry 0..*CHEMEDEPRDosageSplitCH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest)
... detectedIssue 0..*Reference(DetectedIssue)✕ This element is not supported
... eventHistory 0..*Reference(Provenance)✕ This element is not supported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationDispense.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationDispense.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
from the FHIR Standard
MedicationDispense.categorypreferredMedicationDispense Category Codes
http://hl7.org/fhir/ValueSet/medicationdispense-category
from the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType

Constraints

IdGradePath(s)DetailsRequirements
ch-dosage-4errorMedicationDispense.dosageInstruction:baseEntryFor split dosage timing event and dose/rate are required
: sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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-4errorMedicationDispenseIf 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-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
qty-3errorMedicationDispense.quantity, MedicationDispense.daysSupplyIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorMedicationDispense.quantity, MedicationDispense.daysSupplyThe comparator is not used on a SimpleQuantity
: comparator.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*CHEMEDMedicationDispenseCH EMED MedicationDispense (DIS)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*Extension✕ This element is not supported
Slice: Unordered, Open by value:url
.... versionId Σ0..1id✕ This element is not supported
.... lastUpdated Σ0..1instant✕ This element is not supported
.... source Σ0..1uri✕ This element is not supported
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*Coding✕ This element is not supported
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*Coding✕ This element is not supported
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 1..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... treatmentReason 0..1stringTreatment reason
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentreason
... prescription 0..1(Complex)Reference to te medication prescription. This item is mandantory if the treatment has already been prescribed.
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-prescription
... pharmaceuticalAdvice 0..1(Complex)✕ This element is not supported
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-pharmaceuticaladvice
... treatmentPlan 1..1(Complex)CH EMED Extension
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentplan
... identifier 1..1IdentifierMedicationDispense Identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value Σ1..1stringIdentifier value as UUID
Example General: 123456
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... partOf 0..*Reference(Procedure)✕ This element is not supported
... status ?!Σ1..1codepreparation | 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.


Fixed Value: completed
... statusReason[x] 0..1✕ This is only meaningful when the dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
... category 0..1CodeableConcept✕ This element is not supported
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.

... Slices for medication[x] Σ1..1Reference(Medication)What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ0..1Reference(CH EMED EPR Medication (DIS)) {c}Reference to the contained medication
... subject Σ0..1Reference(CH EMED EPR Patient) {r, b}Patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... context 0..1Reference(Encounter | EpisodeOfCare)✕ This element is not supported
... supportingInformation 0..*Reference(Resource)✕ This element is not supported
... performer 1..1BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... function 0..1CodeableConceptWho 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..1Reference(CH EMED PractitionerRole)The author of the medical decision, see also 'Guidance - Authorship'
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... location 0..1Reference(Location)✕ This element is not supported
... authorizingPrescription 0..*Reference(MedicationRequest)✕ This element is not supported
... type 0..1CodeableConcept✕ This element is not supported
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 C1..1CHEMEDEPRAmountQuantityA fixed quantity (no comparator)
... daysSupply C0..1CHEMEDEPRTimeQuantity✕ This element is not supported
... whenPrepared Σ0..1dateTime✕ This element is not supported
... whenHandedOver 1..1dateTimeWhen product was given out
... destination 0..1Reference(Location)✕ This element is not supported
... receiver 0..*Reference(Patient | Practitioner)✕ This element is not supported
... note 0..*AnnotationInformation about the dispense
.... id 0..1string✕ This element is not supported
.... extension 0..*Extension✕ This element is not supported
Slice: Unordered, Open by value:url
.... author[x] Σ0..1✕ The note author is ignored, as it cannot be different than the document and/or entry's author
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTime✕ This element is not supported
.... text Σ1..1markdownThe annotation text content (as raw text, no markdown allowed).
... Slices for dosageInstruction 1..*DosageHow the medication should be taken
Slice: Unordered, Closed by profile:$this
.... dosageInstruction:baseEntry C1..1CHEMEDEPRDosageCH EMED Dosage (MedicationStatement / MedicationDispense)
.... dosageInstruction:additionalEntry 0..*CHEMEDEPRDosageSplitCH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest)
... substitution C0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... wasSubstituted 1..1booleanWhether a substitution was (true) or was not (false) performed on the dispense
.... type 0..1CodeableConceptIf 'wasSubstituted = true', the type can be defined in addition (optional). If 'wasSubstituted = false', no type is expected.
Binding: ActSubstanceAdminSubstitutionCode (required)
.... reason 0..*CodeableConcept✕ This element is not supported
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)✕ This element is not supported
... detectedIssue 0..*Reference(DetectedIssue)✕ This element is not supported
... eventHistory 0..*Reference(Provenance)✕ This element is not supported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationDispense.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
MedicationDispense.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationDispense.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationDispense.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
MedicationDispense.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
from the FHIR Standard
MedicationDispense.categorypreferredMedicationDispense Category Codes
http://hl7.org/fhir/ValueSet/medicationdispense-category
from the FHIR Standard
MedicationDispense.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
MedicationDispense.performer.functionexampleMedicationDispense Performer Function Codes
http://hl7.org/fhir/ValueSet/medicationdispense-performer-function
from the FHIR Standard
MedicationDispense.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
MedicationDispense.substitution.typerequiredActSubstanceAdminSubstitutionCode
http://fhir.ch/ig/ch-emed/ValueSet/ActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
ch-dosage-4errorMedicationDispense.dosageInstruction:baseEntryFor split dosage timing event and dose/rate are required
: sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
ch-emed-dis-1errorMedicationDispense.substitutionIf no substitution was performed, no type is expected.
: wasSubstituted = true or (wasSubstituted = false and type.exists().not())
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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-4errorMedicationDispenseIf 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-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
qty-3errorMedicationDispense.quantity, MedicationDispense.daysSupplyIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorMedicationDispense.quantity, MedicationDispense.daysSupplyThe comparator is not used on a SimpleQuantity
: comparator.empty()

Differential View

This structure is derived from CHEMEDMedicationDispense

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense CHEMEDMedicationDispense
... meta
.... extension D0..*Extension✕ This element is not supported
.... versionId D0..1id✕ This element is not supported
.... lastUpdated D0..1instant✕ This element is not supported
.... source D0..1uri✕ This element is not supported
.... security D0..*Coding✕ This element is not supported
.... tag D0..*Coding✕ This element is not supported
... implicitRules 0..0
... extension 1..*ExtensionExtension
... extension:prescription 0..1CHEMEDExtPrescriptionReference to te medication prescription. This item is mandantory if the treatment has already been prescribed.
... extension:pharmaceuticalAdvice D0..1CHEMEDExtPharmaceuticalAdvice✕ This element is not supported
... extension:treatmentPlan 1..1CHEMEDExtTreatmentPlanCH EMED Extension
... modifierExtension 0..0
... partOf D0..*Reference(Procedure)✕ This element is not supported
... statusReason[x] D0..1CodeableConcept, Reference(DetectedIssue)✕ This is only meaningful when the dispense was not performed
... category D0..1CodeableConcept✕ This element is not supported
... medication[x] 1..1Reference(Medication)What medication was supplied
... medication[x]:medicationReference 0..1Reference(CH EMED EPR Medication (DIS)) {c}Reference to the contained medication
... subject 0..1Reference(CH EMED EPR Patient) {r, b}Patient
... context D0..1Reference(Encounter | EpisodeOfCare)✕ This element is not supported
... supportingInformation D0..*Reference(Resource)✕ This element is not supported
... performer
.... modifierExtension 0..0
... location D0..1Reference(Location)✕ This element is not supported
... authorizingPrescription D0..*Reference(MedicationRequest)✕ This element is not supported
... type D0..1CodeableConcept✕ This element is not supported
... quantity 1..1CHEMEDEPRAmountQuantityA fixed quantity (no comparator)
... daysSupply D0..1CHEMEDEPRTimeQuantity✕ This element is not supported
... whenPrepared D0..1dateTime✕ This element is not supported
... destination D0..1Reference(Location)✕ This element is not supported
... receiver D0..*Reference(Patient | Practitioner)✕ This element is not supported
... note
.... id D0..1string✕ This element is not supported
.... extension D0..*Extension✕ This element is not supported
.... author[x] D0..1Reference(Practitioner | Patient | RelatedPerson | Organization), string✕ The note author is ignored, as it cannot be different than the document and/or entry's author
.... time D0..1dateTime✕ This element is not supported
.... text 1..1markdownThe annotation text content (as raw text, no markdown allowed).
... dosageInstruction:baseEntry 1..1CHEMEDEPRDosageCH EMED Dosage (MedicationStatement / MedicationDispense)
... dosageInstruction:additionalEntry 0..*CHEMEDEPRDosageSplitCH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest)
... substitution
.... modifierExtension 0..0
.... reason D0..*CodeableConcept✕ This element is not supported
.... responsibleParty D0..*Reference(Practitioner | PractitionerRole)✕ This element is not supported
... detectedIssue D0..*Reference(DetectedIssue)✕ This element is not supported
... eventHistory D0..*Reference(Provenance)✕ This element is not supported

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*CHEMEDMedicationDispenseCH EMED MedicationDispense (DIS)
... contained 1..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... treatmentReason 0..1stringTreatment reason
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentreason
... prescription 0..1(Complex)Reference to te medication prescription. This item is mandantory if the treatment has already been prescribed.
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-prescription
... pharmaceuticalAdvice 0..1(Complex)✕ This element is not supported
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-pharmaceuticaladvice
... treatmentPlan 1..1(Complex)CH EMED Extension
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentplan
... identifier 1..1IdentifierMedicationDispense Identifier
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value Σ1..1stringIdentifier value as UUID
Example General: 123456
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
... partOf 0..*Reference(Procedure)✕ This element is not supported
... status ?!Σ1..1codepreparation | 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.


Fixed Value: completed
... statusReason[x] 0..1✕ This is only meaningful when the dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
... category 0..1CodeableConcept✕ This element is not supported
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.

... Slices for medication[x] Σ1..1Reference(Medication)What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ0..1Reference(CH EMED EPR Medication (DIS)) {c}Reference to the contained medication
... subject Σ0..1Reference(CH EMED EPR Patient) {r, b}Patient
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... context 0..1Reference(Encounter | EpisodeOfCare)✕ This element is not supported
... supportingInformation 0..*Reference(Resource)✕ This element is not supported
... performer 1..1BackboneElementWho performed event
.... actor 1..1Reference(CH EMED PractitionerRole)The author of the medical decision, see also 'Guidance - Authorship'
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... location 0..1Reference(Location)✕ This element is not supported
... authorizingPrescription 0..*Reference(MedicationRequest)✕ This element is not supported
... type 0..1CodeableConcept✕ This element is not supported
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 C1..1CHEMEDEPRAmountQuantityA fixed quantity (no comparator)
... daysSupply C0..1CHEMEDEPRTimeQuantity✕ This element is not supported
... whenPrepared Σ0..1dateTime✕ This element is not supported
... whenHandedOver 1..1dateTimeWhen product was given out
... destination 0..1Reference(Location)✕ This element is not supported
... receiver 0..*Reference(Patient | Practitioner)✕ This element is not supported
... Slices for dosageInstruction 1..*DosageHow the medication should be taken
Slice: Unordered, Closed by profile:$this
.... dosageInstruction:baseEntry C1..1CHEMEDEPRDosageCH EMED Dosage (MedicationStatement / MedicationDispense)
.... dosageInstruction:additionalEntry 0..*CHEMEDEPRDosageSplitCH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest)
... detectedIssue 0..*Reference(DetectedIssue)✕ This element is not supported
... eventHistory 0..*Reference(Provenance)✕ This element is not supported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationDispense.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationDispense.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
from the FHIR Standard
MedicationDispense.categorypreferredMedicationDispense Category Codes
http://hl7.org/fhir/ValueSet/medicationdispense-category
from the FHIR Standard
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType

Constraints

IdGradePath(s)DetailsRequirements
ch-dosage-4errorMedicationDispense.dosageInstruction:baseEntryFor split dosage timing event and dose/rate are required
: sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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-4errorMedicationDispenseIf 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-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
qty-3errorMedicationDispense.quantity, MedicationDispense.daysSupplyIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorMedicationDispense.quantity, MedicationDispense.daysSupplyThe comparator is not used on a SimpleQuantity
: comparator.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationDispense C0..*CHEMEDMedicationDispenseCH EMED MedicationDispense (DIS)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*Extension✕ This element is not supported
Slice: Unordered, Open by value:url
.... versionId Σ0..1id✕ This element is not supported
.... lastUpdated Σ0..1instant✕ This element is not supported
.... source Σ0..1uri✕ This element is not supported
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*Coding✕ This element is not supported
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*Coding✕ This element is not supported
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 1..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... treatmentReason 0..1stringTreatment reason
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentreason
... prescription 0..1(Complex)Reference to te medication prescription. This item is mandantory if the treatment has already been prescribed.
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-prescription
... pharmaceuticalAdvice 0..1(Complex)✕ This element is not supported
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-pharmaceuticaladvice
... treatmentPlan 1..1(Complex)CH EMED Extension
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentplan
... identifier 1..1IdentifierMedicationDispense Identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value Σ1..1stringIdentifier value as UUID
Example General: 123456
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... partOf 0..*Reference(Procedure)✕ This element is not supported
... status ?!Σ1..1codepreparation | 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.


Fixed Value: completed
... statusReason[x] 0..1✕ This is only meaningful when the dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.

.... statusReasonCodeableConceptCodeableConcept
.... statusReasonReferenceReference(DetectedIssue)
... category 0..1CodeableConcept✕ This element is not supported
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.

... Slices for medication[x] Σ1..1Reference(Medication)What medication was supplied
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference Σ0..1Reference(CH EMED EPR Medication (DIS)) {c}Reference to the contained medication
... subject Σ0..1Reference(CH EMED EPR Patient) {r, b}Patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... context 0..1Reference(Encounter | EpisodeOfCare)✕ This element is not supported
... supportingInformation 0..*Reference(Resource)✕ This element is not supported
... performer 1..1BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... function 0..1CodeableConceptWho 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..1Reference(CH EMED PractitionerRole)The author of the medical decision, see also 'Guidance - Authorship'
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... location 0..1Reference(Location)✕ This element is not supported
... authorizingPrescription 0..*Reference(MedicationRequest)✕ This element is not supported
... type 0..1CodeableConcept✕ This element is not supported
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 C1..1CHEMEDEPRAmountQuantityA fixed quantity (no comparator)
... daysSupply C0..1CHEMEDEPRTimeQuantity✕ This element is not supported
... whenPrepared Σ0..1dateTime✕ This element is not supported
... whenHandedOver 1..1dateTimeWhen product was given out
... destination 0..1Reference(Location)✕ This element is not supported
... receiver 0..*Reference(Patient | Practitioner)✕ This element is not supported
... note 0..*AnnotationInformation about the dispense
.... id 0..1string✕ This element is not supported
.... extension 0..*Extension✕ This element is not supported
Slice: Unordered, Open by value:url
.... author[x] Σ0..1✕ The note author is ignored, as it cannot be different than the document and/or entry's author
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTime✕ This element is not supported
.... text Σ1..1markdownThe annotation text content (as raw text, no markdown allowed).
... Slices for dosageInstruction 1..*DosageHow the medication should be taken
Slice: Unordered, Closed by profile:$this
.... dosageInstruction:baseEntry C1..1CHEMEDEPRDosageCH EMED Dosage (MedicationStatement / MedicationDispense)
.... dosageInstruction:additionalEntry 0..*CHEMEDEPRDosageSplitCH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest)
... substitution C0..1BackboneElementWhether a substitution was performed on the dispense
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... wasSubstituted 1..1booleanWhether a substitution was (true) or was not (false) performed on the dispense
.... type 0..1CodeableConceptIf 'wasSubstituted = true', the type can be defined in addition (optional). If 'wasSubstituted = false', no type is expected.
Binding: ActSubstanceAdminSubstitutionCode (required)
.... reason 0..*CodeableConcept✕ This element is not supported
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)✕ This element is not supported
... detectedIssue 0..*Reference(DetectedIssue)✕ This element is not supported
... eventHistory 0..*Reference(Provenance)✕ This element is not supported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationDispense.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationDispense.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
MedicationDispense.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationDispense.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationDispense.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
MedicationDispense.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
from the FHIR Standard
MedicationDispense.statusReason[x]exampleMedicationDispense Status Reason Codes
http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
from the FHIR Standard
MedicationDispense.categorypreferredMedicationDispense Category Codes
http://hl7.org/fhir/ValueSet/medicationdispense-category
from the FHIR Standard
MedicationDispense.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
MedicationDispense.performer.functionexampleMedicationDispense Performer Function Codes
http://hl7.org/fhir/ValueSet/medicationdispense-performer-function
from the FHIR Standard
MedicationDispense.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
MedicationDispense.typeexampleActPharmacySupplyType
http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
MedicationDispense.substitution.typerequiredActSubstanceAdminSubstitutionCode
http://fhir.ch/ig/ch-emed/ValueSet/ActSubstanceAdminSubstitutionCode
MedicationDispense.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
ch-dosage-4errorMedicationDispense.dosageInstruction:baseEntryFor split dosage timing event and dose/rate are required
: sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists())
ch-emed-dis-1errorMedicationDispense.substitutionIf no substitution was performed, no type is expected.
: wasSubstituted = true or (wasSubstituted = false and type.exists().not())
dom-2errorMedicationDispenseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationDispenseIf 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-4errorMedicationDispenseIf 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-5errorMedicationDispenseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationDispenseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mdd-1errorMedicationDispensewhenHandedOver cannot be before whenPrepared
: whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared
qty-3errorMedicationDispense.quantity, MedicationDispense.daysSupplyIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorMedicationDispense.quantity, MedicationDispense.daysSupplyThe comparator is not used on a SimpleQuantity
: comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron