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. For a full list of available versions, see the Directory of published versions

Resource Profile: CHEMEDEPRMedicationDispenseList - Detailed Descriptions

Draft as of 2024-01-26

Definitions for the ch-emed-epr-medicationdispense-list resource profile.

Guidance on how to interpret the contents of this table can be found here

0. MedicationDispense
2. MedicationDispense.meta
4. MedicationDispense.meta.extension
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
6. MedicationDispense.meta.versionId
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
8. MedicationDispense.meta.lastUpdated
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
10. MedicationDispense.meta.source
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
12. MedicationDispense.meta.security
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
14. MedicationDispense.meta.tag
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
16. MedicationDispense.implicitRules
Comments

...All modifiers SHALL be documented in the profile, in order to be usable.

Control0..0
18. MedicationDispense.extension
Control2..?
20. MedicationDispense.extension:prescription
Slice Nameprescription
ShortReference to te medication prescription. This item is mandantory if the treatment has already been prescribed.
22. MedicationDispense.extension:pharmaceuticalAdvice
Slice NamepharmaceuticalAdvice
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
24. MedicationDispense.extension:treatmentPlan
Slice NametreatmentPlan
Control1..?
26. MedicationDispense.extension:parentDocument
Slice NameparentDocument
Control1..?
28. MedicationDispense.extension:authorDocument
Slice NameauthorDocument
30. MedicationDispense.extension:authorDocument.value[x]:valueReference
Slice NamevalueReference
TypeReference(CH EMED EPR PractitionerRole, CH EMED EPR Patient, CH EMED EPR RelatedPerson)
[x] NoteSee Choice of Data Types for further information about how to use [x]
32. MedicationDispense.modifierExtension
Comments

...All modifiers SHALL be documented in the profile, in order to be usable.

Control0..0
34. MedicationDispense.partOf
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
36. MedicationDispense.statusReason[x]
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This is only meaningful when the dispense was not performed
[x] NoteSee Choice of Data Types for further information about how to use [x]
Standards StatusDraft (from Trial Use)
38. MedicationDispense.category
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
40. MedicationDispense.medication[x]
TypeReference(Medication), CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
42. MedicationDispense.medication[x]:medicationReference
Slice NamemedicationReference
TypeReference(CH EMED EPR Medication (DIS))contained
[x] NoteSee Choice of Data Types for further information about how to use [x]
44. MedicationDispense.subject
TypeReference(CH EMED EPR Patient)referenced, bundled
46. MedicationDispense.context
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
48. MedicationDispense.supportingInformation
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
50. MedicationDispense.performer
52. MedicationDispense.performer.modifierExtension
Comments

...All modifiers SHALL be documented in the profile, in order to be usable.

Control0..0
54. MedicationDispense.location
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
56. MedicationDispense.authorizingPrescription
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
58. MedicationDispense.type
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
60. MedicationDispense.quantity
TypeQuantity(Amount Quantity)
62. MedicationDispense.daysSupply
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
TypeQuantity(Time Quantity)
Standards StatusDraft (from Trial Use)
64. MedicationDispense.whenPrepared
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
66. MedicationDispense.destination
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
68. MedicationDispense.receiver
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
70. MedicationDispense.note
72. MedicationDispense.note.id
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
74. MedicationDispense.note.extension
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
76. MedicationDispense.note.author[x]
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ The note author is ignored, as it cannot be different than the document and/or entry's author
[x] NoteSee Choice of Data Types for further information about how to use [x]
Standards StatusDraft (from Trial Use)
78. MedicationDispense.note.time
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
80. MedicationDispense.note.text
ShortThe annotation text content (as raw text, no markdown allowed).
82. MedicationDispense.dosageInstruction:baseEntry
Slice NamebaseEntry
TypeDosage(Dosage (MedicationStatement / MedicationDispense))
84. MedicationDispense.dosageInstruction:additionalEntry
Slice NameadditionalEntry
TypeDosage(Dosage Split)
86. MedicationDispense.substitution
88. MedicationDispense.substitution.modifierExtension
Comments

...All modifiers SHALL be documented in the profile, in order to be usable.

Control0..0
90. MedicationDispense.substitution.reason
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
92. MedicationDispense.substitution.responsibleParty
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
94. MedicationDispense.detectedIssue
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
96. MedicationDispense.eventHistory
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)

Guidance on how to interpret the contents of this table can be found here

0. MedicationDispense
Definition

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.

ShortCH EMED MedicationDispense (LIST)Dispensing a medication to a named patient
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
mdd-1: whenHandedOver cannot be before whenPrepared (whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared)
mdd-1: whenHandedOver cannot be before whenPrepared (whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared)
2. MedicationDispense.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. All modifiers SHALL be documented in the profile, in order to be usable.


Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..01
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. MedicationDispense.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control10..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. MedicationDispense.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control20..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationDispense.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
8. MedicationDispense.extension:treatmentReason
Slice NametreatmentReason
Definition

An Extension

ShortTreatment reason
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(CH EMED Extension Treatment Reason) (Extension Type: string)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. MedicationDispense.extension:prescription
Slice Nameprescription
Definition

An Extension

ShortReference to te medication prescription. This item is mandantory if the treatment has already been prescribed.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(CH EMED Extension Prescription) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. MedicationDispense.extension:pharmaceuticalAdvice
Slice NamepharmaceuticalAdvice
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(CH EMED Extension Pharmaceutical Advice) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. MedicationDispense.extension:treatmentPlan
Slice NametreatmentPlan
Definition

An Extension

ShortCH EMED Extension
Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(CH EMED Extension Treatment Plan) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. MedicationDispense.extension:parentDocument
Slice NameparentDocument
Definition

An Extension

ShortCH EMED Extension
Control1..1
TypeExtension(CH EMED Extension Dispense) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. MedicationDispense.extension:authorDocument
Slice NameauthorDocument
Definition

An Extension

ShortExtension
Control0..1
TypeExtension(Author of the content) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. MedicationDispense.extension:authorDocument.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationDispense.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
22. MedicationDispense.extension:authorDocument.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
24. MedicationDispense.extension:authorDocument.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control10..1
TypeReference, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on MedicationDispense.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
26. MedicationDispense.extension:authorDocument.value[x]:valueReference
Slice NamevalueReference
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortAuthor of the contentValue of extension
Control10..1
TypeReference(CH EMED EPR PractitionerRole, CH EMED EPR Patient, CH EMED EPR RelatedPerson), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. MedicationDispense.extension:authorDocument.value[x]:valueReference.extension:time
Slice Nametime
Definition

Extension to define the timestamp of the authorship/data input

ShortTimestamp of the authorship/data input
Control0..1
TypeExtension(EPR Time) (Extension Type: dateTime)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. MedicationDispense.extension:authorDocument.value[x]:valueReference.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

ShortLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control10..1
This element is affected by the following invariants: ref-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. MedicationDispense.modifierExtension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensionExtensions that cannot be ignored
Comments

All modifiers SHALL be documented in the profile, in order to be usable.


There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. MedicationDispense.identifier
Definition

Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

ShortMedicationDispense IdentifierExternal identifier
Comments

This is a business identifier, not a resource identifier.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..1*
TypeIdentifier
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. MedicationDispense.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. MedicationDispense.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valueurn:ietf:rfc:3986
Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. MedicationDispense.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortIdentifier value as UUIDThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456 <br/><b>CH EMED</b>:urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. MedicationDispense.partOf
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


The procedure that trigger the dispense.

Short✕ This element is not supportedEvent that dispense is part of
Control0..*
TypeReference(Procedure)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. MedicationDispense.status
Definition

A code specifying the state of the set of dispense events.

Shortpreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from MedicationDispense Status Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valuecompleted
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. MedicationDispense.statusReason[x]
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


Indicates the reason why a dispense was not performed.

Short✕ This is only meaningful when the dispense was not performedWhy a dispense was not performed
Control0..1
BindingFor example codes, see MedicationDispense Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reason
(example to http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
TypeChoice of: CodeableConcept, Reference(DetectedIssue)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. MedicationDispense.category
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).

Short✕ This element is not supportedType of medication dispense
Comments

The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.

Control0..1
BindingThe codes SHOULD be taken from MedicationDispense Category Codeshttp://hl7.org/fhir/ValueSet/medicationdispense-category
(preferred to http://hl7.org/fhir/ValueSet/medicationdispense-category
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. MedicationDispense.medication[x]
Definition

Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

ShortWhat medication was supplied
Comments

If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.

Control1..1
TypeReference(Medication), CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on MedicationDispense.medication[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
52. MedicationDispense.medication[x]:medicationReference
Slice NamemedicationReference
Definition

Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

ShortReference to the contained medicationWhat medication was supplied
Comments

If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.

Control01..1
TypeReference(CH EMED EPR Medication (DIS), Medication)contained, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. MedicationDispense.subject
Definition

A link to a resource representing the person or the group to whom the medication will be given.

ShortPatientWho the dispense is for
Comments

SubstanceAdministration->subject->Patient.

Control0..1
TypeReference(CH EMED EPR Patient, Patient, Group)referenced, bundled
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. MedicationDispense.subject.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

ShortLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control10..1
This element is affected by the following invariants: ref-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. MedicationDispense.context
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


The encounter or episode of care that establishes the context for this event.

Short✕ This element is not supportedEncounter / Episode associated with event
Control0..1
TypeReference(Encounter, EpisodeOfCare)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. MedicationDispense.supportingInformation
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


Additional information that supports the medication being dispensed.

Short✕ This element is not supportedInformation that supports the dispensing of the medication
Control0..*
TypeReference(Resource)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. MedicationDispense.performer
Definition

Indicates who or what performed the event.

ShortWho performed event
Control10..1*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. MedicationDispense.performer.modifierExtension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensionExtensions that cannot be ignored even if unrecognized
Comments

All modifiers SHALL be documented in the profile, in order to be usable.


There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
66. MedicationDispense.performer.actor
Definition

The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.

ShortThe author of the medical decision, see also 'Guidance - Authorship'Individual who was performing
Control1..1
TypeReference(CH EMED PractitionerRole, Practitioner, PractitionerRole, Organization, Patient, Device, RelatedPerson)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. MedicationDispense.performer.actor.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

ShortLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control10..1
This element is affected by the following invariants: ref-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. MedicationDispense.location
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


The principal physical location where the dispense was performed.

Short✕ This element is not supportedWhere the dispense occurred
Control0..1
TypeReference(Location)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. MedicationDispense.authorizingPrescription
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


Indicates the medication order that is being dispensed against.

Short✕ This element is not supportedMedication order that authorizes the dispense
Comments

Maps to basedOn in Event logical model.

Control0..*
TypeReference(MedicationRequest)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. MedicationDispense.type
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

Short✕ This element is not supportedTrial fill, partial fill, emergency fill, etc.
Control0..1
BindingFor example codes, see ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
(example to http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. MedicationDispense.quantity
Definition

The comparator is not used on a SimpleQuantity


The amount of medication that has been dispensed. Includes unit of measure.

ShortA fixed quantity (no comparator)Amount dispensed
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Control10..1
This element is affected by the following invariants: ele-1
TypeQuantity(Amount Quantity, SimpleQuantity)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
78. MedicationDispense.daysSupply
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


The amount of medication expressed as a timing amount.

Short✕ This element is not supportedAmount of medication expressed as a timing amount
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Control0..1
This element is affected by the following invariants: ele-1
TypeQuantity(Time Quantity, SimpleQuantity)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
80. MedicationDispense.whenPrepared
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


The time when the dispensed product was packaged and reviewed.

Short✕ This element is not supportedWhen product was packaged and reviewed
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. MedicationDispense.whenHandedOver
Definition

The time the dispensed product was provided to the patient or their representative.

ShortWhen product was given out
Control10..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. MedicationDispense.destination
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


Identification of the facility/location where the medication was shipped to, as part of the dispense event.

Short✕ This element is not supportedWhere the medication was sent
Control0..1
TypeReference(Location)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. MedicationDispense.receiver
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.

Short✕ This element is not supportedWho collected the medication
Control0..*
TypeReference(Patient, Practitioner)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. MedicationDispense.dosageInstruction
Definition

Indicates how the medication is to be used by the patient.

ShortHow the medication should be takenHow the medication is to be used by the patient or administered by the caregiver
Comments

When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

Control10..*
TypeDosage
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • profile @ $this
90. MedicationDispense.dosageInstruction:baseEntry
Slice NamebaseEntry
Definition

Indicates how the medication is/was taken or should be taken by the patient.


Indicates how the medication is to be used by the patient.

ShortCH EMED Dosage (MedicationStatement / MedicationDispense)How the medication is to be used by the patient or administered by the caregiver
Comments

When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

Control10..1*
TypeDosage(Dosage (MedicationStatement / MedicationDispense))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ch-dosage-4: For split dosage timing event and dose/rate are required (sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists()))
92. MedicationDispense.dosageInstruction:additionalEntry
Slice NameadditionalEntry
Definition

Indicates how the medication is/was taken or should be taken by the patient.


Indicates how the medication is to be used by the patient.

ShortCH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest)How the medication is to be used by the patient or administered by the caregiver
Comments

When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

Control0..*
TypeDosage(Dosage Split)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. MedicationDispense.detectedIssue
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.

Short✕ This element is not supportedClinical issue with action
Comments

This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.

Control0..*
TypeReference(DetectedIssue)
Is Modifierfalse
Summaryfalse
Alternate NamesContraindication, Drug Utilization Review (DUR), Alert
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. MedicationDispense.eventHistory
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


A summary of the events of interest that have occurred, such as when the dispense was verified.

Short✕ This element is not supportedA list of relevant lifecycle events
Comments

This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).

Control0..*
TypeReference(Provenance)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. MedicationDispense
Definition

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.

ShortCH EMED MedicationDispense (LIST)
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
mdd-1: whenHandedOver cannot be before whenPrepared (whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared)
2. MedicationDispense.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. MedicationDispense.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. MedicationDispense.meta.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
8. MedicationDispense.meta.extension
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationDispense.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. MedicationDispense.meta.versionId
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. MedicationDispense.meta.lastUpdated
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Control0..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. MedicationDispense.meta.source
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. MedicationDispense.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

ShortProfiles this resource claims to conform to
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. MedicationDispense.meta.security
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Control0..*
BindingUnless not suitable, these codes SHALL be taken from All Security Labels
(extensible to http://hl7.org/fhir/ValueSet/security-labels
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. MedicationDispense.meta.tag
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Control0..*
BindingFor example codes, see CommonTags
(example to http://hl7.org/fhir/ValueSet/common-tags
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. MedicationDispense.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. All modifiers SHALL be documented in the profile, in order to be usable.

Control0..0
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. MedicationDispense.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. MedicationDispense.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. MedicationDispense.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control1..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
30. MedicationDispense.extension
Definition

An Extension

ShortExtension
Control2..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationDispense.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
32. MedicationDispense.extension:treatmentReason
Slice NametreatmentReason
Definition

An Extension

ShortTreatment reason
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(CH EMED Extension Treatment Reason) (Extension Type: string)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. MedicationDispense.extension:prescription
Slice Nameprescription
Definition

An Extension

ShortReference to te medication prescription. This item is mandantory if the treatment has already been prescribed.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(CH EMED Extension Prescription) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. MedicationDispense.extension:pharmaceuticalAdvice
Slice NamepharmaceuticalAdvice
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(CH EMED Extension Pharmaceutical Advice) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. MedicationDispense.extension:treatmentPlan
Slice NametreatmentPlan
Definition

An Extension

ShortCH EMED Extension
Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(CH EMED Extension Treatment Plan) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
40. MedicationDispense.extension:parentDocument
Slice NameparentDocument
Definition

An Extension

ShortCH EMED Extension
Control1..1
TypeExtension(CH EMED Extension Dispense) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
42. MedicationDispense.extension:authorDocument
Slice NameauthorDocument
Definition

An Extension

ShortExtension
Control0..1
TypeExtension(Author of the content) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
44. MedicationDispense.extension:authorDocument.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
46. MedicationDispense.extension:authorDocument.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationDispense.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
48. MedicationDispense.extension:authorDocument.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuehttp://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
50. MedicationDispense.extension:authorDocument.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control1..1
TypeReference
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on MedicationDispense.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
52. MedicationDispense.extension:authorDocument.value[x]:valueReference
Slice NamevalueReference
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortAuthor of the content
Control1..1
TypeReference(CH EMED EPR PractitionerRole, CH EMED EPR Patient, CH EMED EPR RelatedPerson)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. MedicationDispense.extension:authorDocument.value[x]:valueReference.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
56. MedicationDispense.extension:authorDocument.value[x]:valueReference.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationDispense.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
58. MedicationDispense.extension:authorDocument.value[x]:valueReference.extension:time
Slice Nametime
Definition

Extension to define the timestamp of the authorship/data input

ShortTimestamp of the authorship/data input
Control0..1
TypeExtension(EPR Time) (Extension Type: dateTime)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
60. MedicationDispense.extension:authorDocument.value[x]:valueReference.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

ShortLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control1..1
This element is affected by the following invariants: ref-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. MedicationDispense.extension:authorDocument.value[x]:valueReference.type
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

ShortType the reference refers to (e.g. "Patient")
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. MedicationDispense.extension:authorDocument.value[x]:valueReference.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

ShortLogical reference, when literal reference is not known
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. MedicationDispense.extension:authorDocument.value[x]:valueReference.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

ShortText alternative for the resource
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. MedicationDispense.modifierExtension
Definition

An Extension

ShortExtension
Comments

All modifiers SHALL be documented in the profile, in order to be usable.

Control0..0
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
70. MedicationDispense.identifier
Definition

Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

ShortMedicationDispense Identifier
Comments

This is a business identifier, not a resource identifier.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. MedicationDispense.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
74. MedicationDispense.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationDispense.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
76. MedicationDispense.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. MedicationDispense.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type
TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. MedicationDispense.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valueurn:ietf:rfc:3986
Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. MedicationDispense.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortIdentifier value as UUID
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456 <br/><b>CH EMED</b>:urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. MedicationDispense.identifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. MedicationDispense.identifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. MedicationDispense.partOf
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..*
TypeReference(Procedure)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. MedicationDispense.status
Definition

A code specifying the state of the set of dispense events.

Shortpreparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from MedicationDispense Status Codes
(required to http://hl7.org/fhir/ValueSet/medicationdispense-status|4.0.1
Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Valuecompleted
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. MedicationDispense.statusReason[x]
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This is only meaningful when the dispense was not performed
Control0..1
BindingFor example codes, see MedicationDispense Status Reason Codes
(example to http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
TypeChoice of: CodeableConcept, Reference(DetectedIssue)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. MedicationDispense.category
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Comments

The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.

Control0..1
BindingThe codes SHOULD be taken from MedicationDispense Category Codes
(preferred to http://hl7.org/fhir/ValueSet/medicationdispense-category
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. MedicationDispense.medication[x]
Definition

Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

ShortWhat medication was supplied
Comments

If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.

Control1..1
TypeReference(Medication)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on MedicationDispense.medication[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
98. MedicationDispense.medication[x]:medicationReference
Slice NamemedicationReference
Definition

Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

ShortReference to the contained medication
Comments

If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.

Control0..1
TypeReference(CH EMED EPR Medication (DIS))contained
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. MedicationDispense.subject
Definition

A link to a resource representing the person or the group to whom the medication will be given.

ShortPatient
Comments

SubstanceAdministration->subject->Patient.

Control0..1
TypeReference(CH EMED EPR Patient)referenced, bundled
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. MedicationDispense.subject.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
104. MedicationDispense.subject.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationDispense.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
106. MedicationDispense.subject.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

ShortLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control1..1
This element is affected by the following invariants: ref-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. MedicationDispense.subject.type
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

ShortType the reference refers to (e.g. "Patient")
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. MedicationDispense.subject.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

ShortLogical reference, when literal reference is not known
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. MedicationDispense.subject.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

ShortText alternative for the resource
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. MedicationDispense.context
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..1
TypeReference(Encounter, EpisodeOfCare)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. MedicationDispense.supportingInformation
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..*
TypeReference(Resource)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. MedicationDispense.performer
Definition

Indicates who or what performed the event.

ShortWho performed event
Control1..1
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. MedicationDispense.performer.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
122. MedicationDispense.performer.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
124. MedicationDispense.performer.modifierExtension
Definition

An Extension

ShortExtension
Comments

All modifiers SHALL be documented in the profile, in order to be usable.

Control0..0
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
126. MedicationDispense.performer.function
Definition

Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

ShortWho performed the dispense and what they did
Control0..1
BindingFor example codes, see MedicationDispense Performer Function Codes
(example to http://hl7.org/fhir/ValueSet/medicationdispense-performer-function
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

Allows disambiguation of the types of involvement of different performers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. MedicationDispense.performer.actor
Definition

The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.

ShortThe author of the medical decision, see also 'Guidance - Authorship'
Control1..1
TypeReference(CH EMED PractitionerRole)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. MedicationDispense.performer.actor.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
132. MedicationDispense.performer.actor.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationDispense.performer.actor.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
134. MedicationDispense.performer.actor.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

ShortLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control1..1
This element is affected by the following invariants: ref-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. MedicationDispense.performer.actor.type
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

ShortType the reference refers to (e.g. "Patient")
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. MedicationDispense.performer.actor.identifier
Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

ShortLogical reference, when literal reference is not known
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. MedicationDispense.performer.actor.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

ShortText alternative for the resource
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
142. MedicationDispense.location
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..1
TypeReference(Location)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. MedicationDispense.authorizingPrescription
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Comments

Maps to basedOn in Event logical model.

Control0..*
TypeReference(MedicationRequest)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. MedicationDispense.type
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..1
BindingFor example codes, see ActPharmacySupplyType
(example to http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. MedicationDispense.quantity
Definition

The comparator is not used on a SimpleQuantity

ShortA fixed quantity (no comparator)
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Control1..1
This element is affected by the following invariants: ele-1
TypeQuantity(Amount Quantity)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
150. MedicationDispense.daysSupply
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Control0..1
This element is affected by the following invariants: ele-1
TypeQuantity(Time Quantity)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
152. MedicationDispense.whenPrepared
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
154. MedicationDispense.whenHandedOver
Definition

The time the dispensed product was provided to the patient or their representative.

ShortWhen product was given out
Control1..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. MedicationDispense.destination
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..1
TypeReference(Location)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. MedicationDispense.receiver
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..*
TypeReference(Patient, Practitioner)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
160. MedicationDispense.note
Definition

Extra information about the dispense that could not be conveyed in the other attributes.

ShortInformation about the dispense
Control0..*
TypeAnnotation
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. MedicationDispense.note.id
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
164. MedicationDispense.note.extension
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationDispense.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
166. MedicationDispense.note.author[x]
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ The note author is ignored, as it cannot be different than the document and/or entry's author
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Control0..1
TypeChoice of: Reference(Practitioner, Patient, RelatedPerson, Organization), string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
168. MedicationDispense.note.time
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. MedicationDispense.note.text
Definition

The text of the annotation in markdown format.

ShortThe annotation text content (as raw text, no markdown allowed).
Control1..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. MedicationDispense.dosageInstruction
Definition

Indicates how the medication is to be used by the patient.

ShortHow the medication should be taken
Comments

When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

Control1..*
TypeDosage
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on MedicationDispense.dosageInstruction. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • profile @ $this
174. MedicationDispense.dosageInstruction:baseEntry
Slice NamebaseEntry
Definition

Indicates how the medication is/was taken or should be taken by the patient.

ShortCH EMED Dosage (MedicationStatement / MedicationDispense)
Comments

When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

Control1..1
TypeDosage(Dosage (MedicationStatement / MedicationDispense))
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ch-dosage-4: For split dosage timing event and dose/rate are required (sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists()))
176. MedicationDispense.dosageInstruction:additionalEntry
Slice NameadditionalEntry
Definition

Indicates how the medication is/was taken or should be taken by the patient.

ShortCH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest)
Comments

When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.

Control0..*
TypeDosage(Dosage Split)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. MedicationDispense.substitution
Definition

Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.

ShortWhether a substitution was performed on the dispense
Control0..1
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ch-emed-dis-1: If no substitution was performed, no type is expected. (wasSubstituted = true or (wasSubstituted = false and type.exists().not()))
180. MedicationDispense.substitution.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
182. MedicationDispense.substitution.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
184. MedicationDispense.substitution.modifierExtension
Definition

An Extension

ShortExtension
Comments

All modifiers SHALL be documented in the profile, in order to be usable.

Control0..0
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
186. MedicationDispense.substitution.wasSubstituted
Definition

True if the dispenser dispensed a different drug or product from what was prescribed.

ShortWhether a substitution was (true) or was not (false) performed on the dispense
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. MedicationDispense.substitution.type
Definition

A code signifying whether a different drug was dispensed from what was prescribed.

ShortIf 'wasSubstituted = true', the type can be defined in addition (optional). If 'wasSubstituted = false', no type is expected.
Control0..1
BindingThe codes SHALL be taken from ActSubstanceAdminSubstitutionCode
(required to http://fhir.ch/ig/ch-emed/ValueSet/ActSubstanceAdminSubstitutionCode
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. MedicationDispense.substitution.reason
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..*
BindingFor example codes, see SubstanceAdminSubstitutionReason
(example to http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
192. MedicationDispense.substitution.responsibleParty
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..*
TypeReference(Practitioner, PractitionerRole)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
194. MedicationDispense.detectedIssue
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Comments

This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.

Control0..*
TypeReference(DetectedIssue)
Is Modifierfalse
Summaryfalse
Alternate NamesContraindication, Drug Utilization Review (DUR), Alert
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
196. MedicationDispense.eventHistory
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Comments

This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).

Control0..*
TypeReference(Provenance)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))