ELGA e-Medikation FHIR R5 Implementierungsleitfaden
0.0.0 - ci-build
Publish Box goes here
Official URL: http://fhir.hl7.at/elga-e-medikation-R5/StructureDefinition/linca-dipsense-documentation | Version: 0.0.0 | |||
Draft as of 2024-06-26 | Responsible: ELGA GmbH | Computable Name: LINCAMedicationDispense |
Linked Care Profile for dispense documentation. The dispense must be documented by the dispensing pharmacist and specify if an order was fulfilled completly or partially. The LINCA Dispense must have an LINCA Prescription as authorizingPrescription.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationDispense
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | 0..* | MedicationDispense | Dispensing a medication to a named patient | |
status | 1..1 | code | A dispense ends the chain of the workflow. Therefore the status is fixed to 'completed' Required Pattern: completed | |
medication | 1..1 | CodeableReference(Medication) | Medication in conformance with the ELGA e-Medication used PZN (i.e. ASP-Liste). | Arzneimittel entsprechend der ELGA e-Medikation verwendet PZN (d.h. ASP-Liste). Binding: https://termgit.elga.gv.at/CodeSystem/asp-liste (required) | |
concept | 1..1 | CodeableConcept | Reference to a concept (by class) | |
reference | 0..0 | |||
subject | 1..1 | Reference(HL7® AT Core Patient Profile) | Patient conform HL7 AT. Make sure the patient is identifiable somehow | |
performer | ||||
actor | 1..1 | Reference(Organization) | Reference to dispensing pharmacy (GDA index) | |
authorizingPrescription | 1..1 | Reference(2 ELGA e-Medication MedicationRequest (eMedRequest)) | Prescription that authorized dispense of this medication | |
type | 0..1 | CodeableConcept | Possible values: FFC (First-fill complete for completly fulfilled orders), FFP (first-fill part fill, for pratially fulfilled orders) | |
dosageInstruction | ||||
doseAndRate | ||||
Slices for dose[x] | 0..1 | Range, SimpleQuantity | Amount of medication per dose Slice: Unordered, Open by type:$this | |
dose[x]:doseQuantity | 0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
code | 0..1 | code | Coded form of the unit Binding: https://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsform (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationDispense.medication | required | https://termgit.elga.gv.at/CodeSystem/asp-listehttps://termgit.elga.gv.at/CodeSystem/asp-liste | |
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.code | required | https://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsformhttps://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsform |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | A dispense ends the chain of the workflow. Therefore the status is fixed to 'completed' Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. Required Pattern: completed |
medication | Σ | 1..1 | CodeableReference(Medication) | Medication in conformance with the ELGA e-Medication used PZN (i.e. ASP-Liste). | Arzneimittel entsprechend der ELGA e-Medikation verwendet PZN (d.h. ASP-Liste). Binding: https://termgit.elga.gv.at/CodeSystem/asp-liste (required) |
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) |
subject | Σ | 1..1 | Reference(HL7® AT Core Patient Profile) | Patient conform HL7 AT. Make sure the patient is identifiable somehow |
authorizingPrescription | 1..1 | Reference(2 ELGA e-Medication MedicationRequest (eMedRequest)) | Prescription that authorized dispense of this medication | |
type | 0..1 | CodeableConcept | Possible values: FFC (First-fill complete for completly fulfilled orders), FFP (first-fill part fill, for pratially fulfilled orders) Binding: ActPharmacySupplyType (example): ActPharmacySupplyType | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationDispense.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/medicationdispense-status|5.0.0 from the FHIR Standard | |
MedicationDispense.medication | required | https://termgit.elga.gv.at/CodeSystem/asp-listehttps://termgit.elga.gv.at/CodeSystem/asp-liste | |
MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | External identifier | |||||
basedOn | 0..* | Reference(CarePlan) | Plan that is fulfilled by this dispense | |||||
partOf | 0..* | Reference(Procedure | MedicationAdministration) | Event that dispense is part of | |||||
status | ?!Σ | 1..1 | code | A dispense ends the chain of the workflow. Therefore the status is fixed to 'completed' Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. Required Pattern: completed | ||||
notPerformedReason | 0..1 | CodeableReference(DetectedIssue) | Why a dispense was not performed Binding: MedicationDispenseStatusReasonCodes (example) | |||||
statusChanged | 0..1 | dateTime | When the status changed | |||||
category | 0..* | CodeableConcept | Type of medication dispense Binding: MedicationDispenseAdministrationLocationCodes (example): A code describing where the dispensed medication is expected to be consumed or administered. | |||||
medication | Σ | 1..1 | CodeableReference(Medication) | Medication in conformance with the ELGA e-Medication used PZN (i.e. ASP-Liste). | Arzneimittel entsprechend der ELGA e-Medikation verwendet PZN (d.h. ASP-Liste). Binding: https://termgit.elga.gv.at/CodeSystem/asp-liste (required) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) | ||||
subject | Σ | 1..1 | Reference(HL7® AT Core Patient Profile) | Patient conform HL7 AT. Make sure the patient is identifiable somehow | ||||
encounter | 0..1 | Reference(Encounter) | Encounter 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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | 0..1 | CodeableConcept | Who performed the dispense and what they did Binding: MedicationDispensePerformerFunctionCodes (example): A code describing the role an individual played in dispensing a medication. | |||||
actor | 1..1 | Reference(Organization) | Reference to dispensing pharmacy (GDA index) | |||||
location | 0..1 | Reference(Location) | Where the dispense occurred | |||||
authorizingPrescription | 1..1 | Reference(2 ELGA e-Medication MedicationRequest (eMedRequest)) | Prescription that authorized dispense of this medication | |||||
type | 0..1 | CodeableConcept | Possible values: FFC (First-fill complete for completly fulfilled orders), FFP (first-fill part fill, for pratially fulfilled orders) Binding: ActPharmacySupplyType (example): ActPharmacySupplyType | |||||
quantity | 0..1 | SimpleQuantity | Amount dispensed | |||||
daysSupply | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |||||
recorded | 0..1 | dateTime | When the recording of the dispense started | |||||
whenPrepared | ΣC | 0..1 | dateTime | When product was packaged and reviewed | ||||
whenHandedOver | C | 0..1 | dateTime | When product was given out | ||||
destination | 0..1 | Reference(Location) | Where the medication was/will be sent | |||||
receiver | 0..* | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the medication or where the medication was delivered | |||||
note | 0..* | Annotation | Information about the dispense | |||||
renderedDosageInstruction | 0..1 | markdown | Full representation of the dosage instructions | |||||
dosageInstruction | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | Σ | 0..1 | integer | The order of the dosage instructions | ||||
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
timing | Σ | 0..1 | Timing | When medication should be administered | ||||
asNeeded | ΣC | 0..1 | boolean | Take "as needed" | ||||
asNeededFor | ΣC | 0..* | CodeableConcept | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | ||||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
doseAndRate | Σ | 0..* | Element | Amount of medication administered, to be administered or typical amount to be administered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
Slices for dose[x] | Σ | 0..1 | Amount of medication per dose Slice: Unordered, Open by type:$this | |||||
doseRange | Range | |||||||
doseQuantity | Quantity(SimpleQuantity) | |||||||
dose[x]:doseQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | ΣC | 0..1 | code | Coded form of the unit Binding: https://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsform (required) | ||||
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |||||
rateRatio | Ratio | |||||||
rateRange | Range | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
maxDosePerPeriod | Σ | 0..* | Ratio | Upper limit on medication per unit of time | ||||
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
substitution | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
wasSubstituted | 1..1 | boolean | Whether a substitution was or was not performed on the dispense | |||||
type | 0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): ActSubstanceAdminSubstitutionCode | |||||
reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason | |||||
responsibleParty | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the substitution | |||||
eventHistory | 0..* | Reference(Provenance) | A list of relevant lifecycle events | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationDispense.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
MedicationDispense.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/medicationdispense-status|5.0.0 from the FHIR Standard | |
MedicationDispense.notPerformedReason | example | MedicationDispenseStatusReasonCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reason from the FHIR Standard | |
MedicationDispense.category | example | MedicationDispenseAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-admin-location from the FHIR Standard | |
MedicationDispense.medication | required | https://termgit.elga.gv.at/CodeSystem/asp-listehttps://termgit.elga.gv.at/CodeSystem/asp-liste | |
MedicationDispense.performer.function | example | MedicationDispensePerformerFunctionCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-function from the FHIR Standard | |
MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | |
MedicationDispense.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | |
MedicationDispense.dosageInstruction.asNeededFor | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
MedicationDispense.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | |
MedicationDispense.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | |
MedicationDispense.dosageInstruction.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | |
MedicationDispense.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://terminology.hl7.org/ValueSet/dose-rate-type | |
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.code | required | https://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsformhttps://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsform | |
MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | |
MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared | |
qty-3 | error | MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from MedicationDispense
Differential View
This structure is derived from MedicationDispense
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | 0..* | MedicationDispense | Dispensing a medication to a named patient | |
status | 1..1 | code | A dispense ends the chain of the workflow. Therefore the status is fixed to 'completed' Required Pattern: completed | |
medication | 1..1 | CodeableReference(Medication) | Medication in conformance with the ELGA e-Medication used PZN (i.e. ASP-Liste). | Arzneimittel entsprechend der ELGA e-Medikation verwendet PZN (d.h. ASP-Liste). Binding: https://termgit.elga.gv.at/CodeSystem/asp-liste (required) | |
concept | 1..1 | CodeableConcept | Reference to a concept (by class) | |
reference | 0..0 | |||
subject | 1..1 | Reference(HL7® AT Core Patient Profile) | Patient conform HL7 AT. Make sure the patient is identifiable somehow | |
performer | ||||
actor | 1..1 | Reference(Organization) | Reference to dispensing pharmacy (GDA index) | |
authorizingPrescription | 1..1 | Reference(2 ELGA e-Medication MedicationRequest (eMedRequest)) | Prescription that authorized dispense of this medication | |
type | 0..1 | CodeableConcept | Possible values: FFC (First-fill complete for completly fulfilled orders), FFP (first-fill part fill, for pratially fulfilled orders) | |
dosageInstruction | ||||
doseAndRate | ||||
Slices for dose[x] | 0..1 | Range, SimpleQuantity | Amount of medication per dose Slice: Unordered, Open by type:$this | |
dose[x]:doseQuantity | 0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
code | 0..1 | code | Coded form of the unit Binding: https://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsform (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationDispense.medication | required | https://termgit.elga.gv.at/CodeSystem/asp-listehttps://termgit.elga.gv.at/CodeSystem/asp-liste | |
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.code | required | https://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsformhttps://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsform |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | A dispense ends the chain of the workflow. Therefore the status is fixed to 'completed' Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. Required Pattern: completed |
medication | Σ | 1..1 | CodeableReference(Medication) | Medication in conformance with the ELGA e-Medication used PZN (i.e. ASP-Liste). | Arzneimittel entsprechend der ELGA e-Medikation verwendet PZN (d.h. ASP-Liste). Binding: https://termgit.elga.gv.at/CodeSystem/asp-liste (required) |
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) |
subject | Σ | 1..1 | Reference(HL7® AT Core Patient Profile) | Patient conform HL7 AT. Make sure the patient is identifiable somehow |
authorizingPrescription | 1..1 | Reference(2 ELGA e-Medication MedicationRequest (eMedRequest)) | Prescription that authorized dispense of this medication | |
type | 0..1 | CodeableConcept | Possible values: FFC (First-fill complete for completly fulfilled orders), FFP (first-fill part fill, for pratially fulfilled orders) Binding: ActPharmacySupplyType (example): ActPharmacySupplyType | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationDispense.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/medicationdispense-status|5.0.0 from the FHIR Standard | |
MedicationDispense.medication | required | https://termgit.elga.gv.at/CodeSystem/asp-listehttps://termgit.elga.gv.at/CodeSystem/asp-liste | |
MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named patient mdd-1: whenHandedOver cannot be before whenPrepared | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | External identifier | |||||
basedOn | 0..* | Reference(CarePlan) | Plan that is fulfilled by this dispense | |||||
partOf | 0..* | Reference(Procedure | MedicationAdministration) | Event that dispense is part of | |||||
status | ?!Σ | 1..1 | code | A dispense ends the chain of the workflow. Therefore the status is fixed to 'completed' Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. Required Pattern: completed | ||||
notPerformedReason | 0..1 | CodeableReference(DetectedIssue) | Why a dispense was not performed Binding: MedicationDispenseStatusReasonCodes (example) | |||||
statusChanged | 0..1 | dateTime | When the status changed | |||||
category | 0..* | CodeableConcept | Type of medication dispense Binding: MedicationDispenseAdministrationLocationCodes (example): A code describing where the dispensed medication is expected to be consumed or administered. | |||||
medication | Σ | 1..1 | CodeableReference(Medication) | Medication in conformance with the ELGA e-Medication used PZN (i.e. ASP-Liste). | Arzneimittel entsprechend der ELGA e-Medikation verwendet PZN (d.h. ASP-Liste). Binding: https://termgit.elga.gv.at/CodeSystem/asp-liste (required) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) | ||||
subject | Σ | 1..1 | Reference(HL7® AT Core Patient Profile) | Patient conform HL7 AT. Make sure the patient is identifiable somehow | ||||
encounter | 0..1 | Reference(Encounter) | Encounter 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 | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | 0..1 | CodeableConcept | Who performed the dispense and what they did Binding: MedicationDispensePerformerFunctionCodes (example): A code describing the role an individual played in dispensing a medication. | |||||
actor | 1..1 | Reference(Organization) | Reference to dispensing pharmacy (GDA index) | |||||
location | 0..1 | Reference(Location) | Where the dispense occurred | |||||
authorizingPrescription | 1..1 | Reference(2 ELGA e-Medication MedicationRequest (eMedRequest)) | Prescription that authorized dispense of this medication | |||||
type | 0..1 | CodeableConcept | Possible values: FFC (First-fill complete for completly fulfilled orders), FFP (first-fill part fill, for pratially fulfilled orders) Binding: ActPharmacySupplyType (example): ActPharmacySupplyType | |||||
quantity | 0..1 | SimpleQuantity | Amount dispensed | |||||
daysSupply | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |||||
recorded | 0..1 | dateTime | When the recording of the dispense started | |||||
whenPrepared | ΣC | 0..1 | dateTime | When product was packaged and reviewed | ||||
whenHandedOver | C | 0..1 | dateTime | When product was given out | ||||
destination | 0..1 | Reference(Location) | Where the medication was/will be sent | |||||
receiver | 0..* | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the medication or where the medication was delivered | |||||
note | 0..* | Annotation | Information about the dispense | |||||
renderedDosageInstruction | 0..1 | markdown | Full representation of the dosage instructions | |||||
dosageInstruction | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | Σ | 0..1 | integer | The order of the dosage instructions | ||||
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
timing | Σ | 0..1 | Timing | When medication should be administered | ||||
asNeeded | ΣC | 0..1 | boolean | Take "as needed" | ||||
asNeededFor | ΣC | 0..* | CodeableConcept | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | ||||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | ||||
doseAndRate | Σ | 0..* | Element | Amount of medication administered, to be administered or typical amount to be administered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
Slices for dose[x] | Σ | 0..1 | Amount of medication per dose Slice: Unordered, Open by type:$this | |||||
doseRange | Range | |||||||
doseQuantity | Quantity(SimpleQuantity) | |||||||
dose[x]:doseQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | ΣC | 0..1 | code | Coded form of the unit Binding: https://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsform (required) | ||||
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |||||
rateRatio | Ratio | |||||||
rateRange | Range | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
maxDosePerPeriod | Σ | 0..* | Ratio | Upper limit on medication per unit of time | ||||
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
substitution | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
wasSubstituted | 1..1 | boolean | Whether a substitution was or was not performed on the dispense | |||||
type | 0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): ActSubstanceAdminSubstitutionCode | |||||
reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason | |||||
responsibleParty | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the substitution | |||||
eventHistory | 0..* | Reference(Provenance) | A list of relevant lifecycle events | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationDispense.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
MedicationDispense.status | required | Pattern: completedhttp://hl7.org/fhir/ValueSet/medicationdispense-status|5.0.0 from the FHIR Standard | |
MedicationDispense.notPerformedReason | example | MedicationDispenseStatusReasonCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-status-reason from the FHIR Standard | |
MedicationDispense.category | example | MedicationDispenseAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-admin-location from the FHIR Standard | |
MedicationDispense.medication | required | https://termgit.elga.gv.at/CodeSystem/asp-listehttps://termgit.elga.gv.at/CodeSystem/asp-liste | |
MedicationDispense.performer.function | example | MedicationDispensePerformerFunctionCodeshttp://hl7.org/fhir/ValueSet/medicationdispense-performer-function from the FHIR Standard | |
MedicationDispense.type | example | ActPharmacySupplyTypehttp://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType | |
MedicationDispense.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | |
MedicationDispense.dosageInstruction.asNeededFor | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
MedicationDispense.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | |
MedicationDispense.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | |
MedicationDispense.dosageInstruction.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | |
MedicationDispense.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://terminology.hl7.org/ValueSet/dose-rate-type | |
MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.code | required | https://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsformhttps://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsform | |
MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | |
MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationDispense | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationDispense | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared | |
qty-3 | error | MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from MedicationDispense
Other representations of profile: CSV, Excel, Schematron