Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_MedicationDispense_R4B

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-MedicationDispense Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_MedicationDispense_R4B

This cross-version profile allows R5 MedicationDispense content to be represented via FHIR R4B MedicationDispense resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense(4.3.0) Dispensing a medication to a named patient
Constraints: mdd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B(0.1.0) | CarePlan) R5: Plan that is fulfilled by this dispense (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.basedOn
Constraints: ext-1
.... extension:statusChanged 0..1 dateTime R5: When the status changed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.statusChanged
Constraints: ext-1
.... extension:recorded 0..1 dateTime R5: When the recording of the dispense started (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.recorded
Constraints: ext-1
.... extension:renderedDosageInstruction 0..1 markdown R5: Full representation of the dosage instructions (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.renderedDosageInstruction
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... medication[x] Σ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required MedicationDispense Status Codes 📍4.3.0 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error MedicationDispense.implicitRules, MedicationDispense.extension, MedicationDispense.extension:basedOn, MedicationDispense.extension:statusChanged, MedicationDispense.extension:recorded, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.modifierExtension, MedicationDispense.status, MedicationDispense.medication[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MedicationDispense.extension, MedicationDispense.extension:basedOn, MedicationDispense.extension:statusChanged, MedicationDispense.extension:recorded, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense(4.3.0) Dispensing a medication to a named patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B(0.1.0) | CarePlan) R5: Plan that is fulfilled by this dispense (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.basedOn
.... extension:statusChanged 0..1 dateTime R5: When the status changed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.statusChanged
.... extension:recorded 0..1 dateTime R5: When the recording of the dispense started (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.recorded
.... extension:renderedDosageInstruction 0..1 markdown R5: Full representation of the dosage instructions (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.renderedDosageInstruction
... partOf
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..* Reference(Resource) R5: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... performer
.... actor
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:actor 0..1 Reference(Resource) R5: actor
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 Reference(Location) R5: location
URL: http://hl7.org/fhir/StructureDefinition/event-location
... receiver
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:receiver 0..* Reference(Resource) R5: Who collected the medication or where the medication was delivered
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... substitution
.... responsibleParty
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:responsibleParty 0..1 Reference(Resource) R5: responsibleParty
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense(4.3.0) Dispensing a medication to a named patient
Constraints: mdd-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B(0.1.0) | CarePlan) R5: Plan that is fulfilled by this dispense (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.basedOn
Constraints: ext-1
.... extension:statusChanged 0..1 dateTime R5: When the status changed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.statusChanged
Constraints: ext-1
.... extension:recorded 0..1 dateTime R5: When the recording of the dispense started (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.recorded
Constraints: ext-1
.... extension:renderedDosageInstruction 0..1 markdown R5: Full representation of the dosage instructions (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.renderedDosageInstruction
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:partOf 0..1 Reference(Resource) R5: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... status ?!Σ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): Describes the lifecycle of the dispense.
... statusReason[x] 0..1 Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
.... statusReasonCodeableConcept CodeableConcept
.... statusReasonReference Reference(DetectedIssue)
... category 0..1 CodeableConcept Type of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
... medication[x] Σ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject Σ 0..1 Reference(Patient | Group) Who the dispense is for
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... function 0..1 CodeableConcept Who performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.
.... actor 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was performing
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:actor 0..1 Reference(Resource) R5: actor
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... location 0..1 Reference(Location) Where the dispense occurred
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:location 0..1 Reference(Location) R5: location
URL: http://hl7.org/fhir/StructureDefinition/event-location
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... authorizingPrescription 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (3.0.0) (example): ActPharmacySupplyType
... quantity 0..1 SimpleQuantity(4.3.0) Amount dispensed
... daysSupply 0..1 SimpleQuantity(4.3.0) Amount of medication expressed as a timing amount
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver 0..1 dateTime When product was given out
... destination 0..1 Reference(Location) Where the medication was sent
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:receiver 0..1 Reference(Resource) R5: Who collected the medication or where the medication was delivered
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note 0..* Annotation Information about the dispense
... dosageInstruction 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (3.0.0) (example): ActSubstanceAdminSubstitutionCode
.... reason 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (3.0.0) (example): SubstanceAdminSubstitutionReason
.... responsibleParty 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:responsibleParty 0..1 Reference(Resource) R5: responsibleParty
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.language Base preferred Common Languages 📍4.3.0 FHIR Std.
MedicationDispense.partOf.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
MedicationDispense.status Base required MedicationDispense Status Codes 📍4.3.0 FHIR Std.
MedicationDispense.statusReason[x] Base example MedicationDispense Status Reason Codes 📍4.3.0 FHIR Std.
MedicationDispense.category Base preferred MedicationDispense Category Codes 📍4.3.0 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.3.0 FHIR Std.
MedicationDispense.performer.​function Base example MedicationDispense Performer Function Codes 📍4.3.0 FHIR Std.
MedicationDispense.performer.​actor.type Base extensible ResourceType 📍4.3.0 FHIR Std.
MedicationDispense.location.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📍3.0.0 THO v7.1
MedicationDispense.receiver.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📍3.0.0 THO v7.1
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📍3.0.0 THO v7.1
MedicationDispense.substitution.​responsibleParty.type Base extensible ResourceType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning MedicationDispense.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error MedicationDispense.meta, MedicationDispense.implicitRules, MedicationDispense.language, MedicationDispense.text, MedicationDispense.extension, MedicationDispense.extension:basedOn, MedicationDispense.extension:statusChanged, MedicationDispense.extension:recorded, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.modifierExtension, MedicationDispense.identifier, MedicationDispense.partOf, MedicationDispense.partOf.extension, MedicationDispense.partOf.extension:partOf, MedicationDispense.partOf.reference, MedicationDispense.partOf.type, MedicationDispense.partOf.identifier, MedicationDispense.partOf.display, MedicationDispense.status, MedicationDispense.statusReason[x], MedicationDispense.category, MedicationDispense.medication[x], MedicationDispense.subject, MedicationDispense.context, MedicationDispense.supportingInformation, MedicationDispense.performer, MedicationDispense.performer.extension, MedicationDispense.performer.modifierExtension, MedicationDispense.performer.function, MedicationDispense.performer.actor, MedicationDispense.performer.actor.extension, MedicationDispense.performer.actor.extension:actor, MedicationDispense.performer.actor.reference, MedicationDispense.performer.actor.type, MedicationDispense.performer.actor.identifier, MedicationDispense.performer.actor.display, MedicationDispense.location, MedicationDispense.location.extension, MedicationDispense.location.extension:location, MedicationDispense.location.reference, MedicationDispense.location.type, MedicationDispense.location.identifier, MedicationDispense.location.display, MedicationDispense.authorizingPrescription, MedicationDispense.type, MedicationDispense.quantity, MedicationDispense.daysSupply, MedicationDispense.whenPrepared, MedicationDispense.whenHandedOver, MedicationDispense.destination, MedicationDispense.receiver, MedicationDispense.receiver.extension, MedicationDispense.receiver.extension:receiver, MedicationDispense.receiver.reference, MedicationDispense.receiver.type, MedicationDispense.receiver.identifier, MedicationDispense.receiver.display, MedicationDispense.note, MedicationDispense.dosageInstruction, MedicationDispense.substitution, MedicationDispense.substitution.extension, MedicationDispense.substitution.modifierExtension, MedicationDispense.substitution.wasSubstituted, MedicationDispense.substitution.type, MedicationDispense.substitution.reason, MedicationDispense.substitution.responsibleParty, MedicationDispense.substitution.responsibleParty.extension, MedicationDispense.substitution.responsibleParty.extension:responsibleParty, MedicationDispense.substitution.responsibleParty.reference, MedicationDispense.substitution.responsibleParty.type, MedicationDispense.substitution.responsibleParty.identifier, MedicationDispense.substitution.responsibleParty.display, MedicationDispense.detectedIssue, MedicationDispense.eventHistory All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MedicationDispense.extension, MedicationDispense.extension:basedOn, MedicationDispense.extension:statusChanged, MedicationDispense.extension:recorded, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.modifierExtension, MedicationDispense.partOf.extension, MedicationDispense.partOf.extension:partOf, MedicationDispense.performer.extension, MedicationDispense.performer.modifierExtension, MedicationDispense.performer.actor.extension, MedicationDispense.performer.actor.extension:actor, MedicationDispense.location.extension, MedicationDispense.location.extension:location, MedicationDispense.receiver.extension, MedicationDispense.receiver.extension:receiver, MedicationDispense.substitution.extension, MedicationDispense.substitution.modifierExtension, MedicationDispense.substitution.responsibleParty.extension, MedicationDispense.substitution.responsibleParty.extension:responsibleParty Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense(4.3.0) Dispensing a medication to a named patient
Constraints: mdd-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B(0.1.0) | CarePlan) R5: Plan that is fulfilled by this dispense (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.basedOn
Constraints: ext-1
.... extension:statusChanged 0..1 dateTime R5: When the status changed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.statusChanged
Constraints: ext-1
.... extension:recorded 0..1 dateTime R5: When the recording of the dispense started (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.recorded
Constraints: ext-1
.... extension:renderedDosageInstruction 0..1 markdown R5: Full representation of the dosage instructions (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.renderedDosageInstruction
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... medication[x] Σ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.status Base required MedicationDispense Status Codes 📍4.3.0 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
ele-1 error MedicationDispense.implicitRules, MedicationDispense.extension, MedicationDispense.extension:basedOn, MedicationDispense.extension:statusChanged, MedicationDispense.extension:recorded, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.modifierExtension, MedicationDispense.status, MedicationDispense.medication[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MedicationDispense.extension, MedicationDispense.extension:basedOn, MedicationDispense.extension:statusChanged, MedicationDispense.extension:recorded, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

Differential View

This structure is derived from MedicationDispense

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense 0..* MedicationDispense(4.3.0) Dispensing a medication to a named patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B(0.1.0) | CarePlan) R5: Plan that is fulfilled by this dispense (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.basedOn
.... extension:statusChanged 0..1 dateTime R5: When the status changed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.statusChanged
.... extension:recorded 0..1 dateTime R5: When the recording of the dispense started (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.recorded
.... extension:renderedDosageInstruction 0..1 markdown R5: Full representation of the dosage instructions (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.renderedDosageInstruction
... partOf
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..* Reference(Resource) R5: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... performer
.... actor
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:actor 0..1 Reference(Resource) R5: actor
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:location 0..1 Reference(Location) R5: location
URL: http://hl7.org/fhir/StructureDefinition/event-location
... receiver
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:receiver 0..* Reference(Resource) R5: Who collected the medication or where the medication was delivered
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... substitution
.... responsibleParty
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:responsibleParty 0..1 Reference(Resource) R5: responsibleParty
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationDispense C 0..* MedicationDispense(4.3.0) Dispensing a medication to a named patient
Constraints: mdd-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B(0.1.0) | CarePlan) R5: Plan that is fulfilled by this dispense (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.basedOn
Constraints: ext-1
.... extension:statusChanged 0..1 dateTime R5: When the status changed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.statusChanged
Constraints: ext-1
.... extension:recorded 0..1 dateTime R5: When the recording of the dispense started (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.recorded
Constraints: ext-1
.... extension:renderedDosageInstruction 0..1 markdown R5: Full representation of the dosage instructions (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationDispense.renderedDosageInstruction
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier 0..* Identifier External identifier
... partOf 0..* Reference(Procedure) Event that dispense is part of
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:partOf 0..1 Reference(Resource) R5: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... status ?!Σ 1..1 code preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Binding: MedicationDispense Status Codes (required): Describes the lifecycle of the dispense.
... statusReason[x] 0..1 Why a dispense was not performed
Binding: MedicationDispense Status Reason Codes (example): A code describing why a dispense was not performed.
.... statusReasonCodeableConcept CodeableConcept
.... statusReasonReference Reference(DetectedIssue)
... category 0..1 CodeableConcept Type of medication dispense
Binding: MedicationDispense Category Codes (preferred): A code describing where the dispensed medication is expected to be consumed or administered.
... medication[x] Σ 1..1 What medication was supplied
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject Σ 0..1 Reference(Patient | Group) Who the dispense is for
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... supportingInformation 0..* Reference(Resource) Information that supports the dispensing of the medication
... performer 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... function 0..1 CodeableConcept Who performed the dispense and what they did
Binding: MedicationDispense Performer Function Codes (example): A code describing the role an individual played in dispensing a medication.
.... actor 1..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was performing
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:actor 0..1 Reference(Resource) R5: actor
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... location 0..1 Reference(Location) Where the dispense occurred
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:location 0..1 Reference(Location) R5: location
URL: http://hl7.org/fhir/StructureDefinition/event-location
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... authorizingPrescription 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
... type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
Binding: ActPharmacySupplyType (3.0.0) (example): ActPharmacySupplyType
... quantity 0..1 SimpleQuantity(4.3.0) Amount dispensed
... daysSupply 0..1 SimpleQuantity(4.3.0) Amount of medication expressed as a timing amount
... whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
... whenHandedOver 0..1 dateTime When product was given out
... destination 0..1 Reference(Location) Where the medication was sent
... receiver 0..* Reference(Patient | Practitioner) Who collected the medication
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:receiver 0..1 Reference(Resource) R5: Who collected the medication or where the medication was delivered
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note 0..* Annotation Information about the dispense
... dosageInstruction 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
... substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
.... type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
Binding: ActSubstanceAdminSubstitutionCode (3.0.0) (example): ActSubstanceAdminSubstitutionCode
.... reason 0..* CodeableConcept Why was substitution made
Binding: SubstanceAdminSubstitutionReason (3.0.0) (example): SubstanceAdminSubstitutionReason
.... responsibleParty 0..* Reference(Practitioner | PractitionerRole) Who is responsible for the substitution
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:responsibleParty 0..1 Reference(Resource) R5: responsibleParty
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
... eventHistory 0..* Reference(Provenance) A list of relevant lifecycle events

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationDispense.language Base preferred Common Languages 📍4.3.0 FHIR Std.
MedicationDispense.partOf.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
MedicationDispense.status Base required MedicationDispense Status Codes 📍4.3.0 FHIR Std.
MedicationDispense.statusReason[x] Base example MedicationDispense Status Reason Codes 📍4.3.0 FHIR Std.
MedicationDispense.category Base preferred MedicationDispense Category Codes 📍4.3.0 FHIR Std.
MedicationDispense.medication[x] Base example SNOMED CT Medication Codes 📍4.3.0 FHIR Std.
MedicationDispense.performer.​function Base example MedicationDispense Performer Function Codes 📍4.3.0 FHIR Std.
MedicationDispense.performer.​actor.type Base extensible ResourceType 📍4.3.0 FHIR Std.
MedicationDispense.location.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
MedicationDispense.type Base example ActPharmacySupplyType 📍3.0.0 THO v7.1
MedicationDispense.receiver.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
MedicationDispense.substitution.​type Base example ActSubstanceAdminSubstitutionCode 📍3.0.0 THO v7.1
MedicationDispense.substitution.​reason Base example SubstanceAdminSubstitutionReason 📍3.0.0 THO v7.1
MedicationDispense.substitution.​responsibleParty.type Base extensible ResourceType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationDispense If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationDispense If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationDispense If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationDispense A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning MedicationDispense.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error MedicationDispense.meta, MedicationDispense.implicitRules, MedicationDispense.language, MedicationDispense.text, MedicationDispense.extension, MedicationDispense.extension:basedOn, MedicationDispense.extension:statusChanged, MedicationDispense.extension:recorded, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.modifierExtension, MedicationDispense.identifier, MedicationDispense.partOf, MedicationDispense.partOf.extension, MedicationDispense.partOf.extension:partOf, MedicationDispense.partOf.reference, MedicationDispense.partOf.type, MedicationDispense.partOf.identifier, MedicationDispense.partOf.display, MedicationDispense.status, MedicationDispense.statusReason[x], MedicationDispense.category, MedicationDispense.medication[x], MedicationDispense.subject, MedicationDispense.context, MedicationDispense.supportingInformation, MedicationDispense.performer, MedicationDispense.performer.extension, MedicationDispense.performer.modifierExtension, MedicationDispense.performer.function, MedicationDispense.performer.actor, MedicationDispense.performer.actor.extension, MedicationDispense.performer.actor.extension:actor, MedicationDispense.performer.actor.reference, MedicationDispense.performer.actor.type, MedicationDispense.performer.actor.identifier, MedicationDispense.performer.actor.display, MedicationDispense.location, MedicationDispense.location.extension, MedicationDispense.location.extension:location, MedicationDispense.location.reference, MedicationDispense.location.type, MedicationDispense.location.identifier, MedicationDispense.location.display, MedicationDispense.authorizingPrescription, MedicationDispense.type, MedicationDispense.quantity, MedicationDispense.daysSupply, MedicationDispense.whenPrepared, MedicationDispense.whenHandedOver, MedicationDispense.destination, MedicationDispense.receiver, MedicationDispense.receiver.extension, MedicationDispense.receiver.extension:receiver, MedicationDispense.receiver.reference, MedicationDispense.receiver.type, MedicationDispense.receiver.identifier, MedicationDispense.receiver.display, MedicationDispense.note, MedicationDispense.dosageInstruction, MedicationDispense.substitution, MedicationDispense.substitution.extension, MedicationDispense.substitution.modifierExtension, MedicationDispense.substitution.wasSubstituted, MedicationDispense.substitution.type, MedicationDispense.substitution.reason, MedicationDispense.substitution.responsibleParty, MedicationDispense.substitution.responsibleParty.extension, MedicationDispense.substitution.responsibleParty.extension:responsibleParty, MedicationDispense.substitution.responsibleParty.reference, MedicationDispense.substitution.responsibleParty.type, MedicationDispense.substitution.responsibleParty.identifier, MedicationDispense.substitution.responsibleParty.display, MedicationDispense.detectedIssue, MedicationDispense.eventHistory All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MedicationDispense.extension, MedicationDispense.extension:basedOn, MedicationDispense.extension:statusChanged, MedicationDispense.extension:recorded, MedicationDispense.extension:renderedDosageInstruction, MedicationDispense.modifierExtension, MedicationDispense.partOf.extension, MedicationDispense.partOf.extension:partOf, MedicationDispense.performer.extension, MedicationDispense.performer.modifierExtension, MedicationDispense.performer.actor.extension, MedicationDispense.performer.actor.extension:actor, MedicationDispense.location.extension, MedicationDispense.location.extension:location, MedicationDispense.receiver.extension, MedicationDispense.receiver.extension:receiver, MedicationDispense.substitution.extension, MedicationDispense.substitution.modifierExtension, MedicationDispense.substitution.responsibleParty.extension, MedicationDispense.substitution.responsibleParty.extension:responsibleParty Must have either extensions or value[x], not both extension.exists() != value.exists()
mdd-1 error MedicationDispense whenHandedOver cannot be before whenPrepared whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared

 

Other representations of profile: CSV, Excel, Schematron