CH EMED EPR
2.0.0-ci-build - ci-build
CH EMED EPR, published by CARA. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CARA-ch/ch-emed-epr/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.ch/ig/ch-emed-epr/StructureDefinition/ch-emed-epr-medicationstatement-treatmentplan | Version: 2.0.0-ci-build | |||
Draft as of 2024-12-20 | Computable Name: CHEMEDEPRMedicationStatement | |||
Copyright/Legal: CC0-1.0 |
Definition of the medication statement for the Medication Treatment Plan document
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHEMEDMedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | C | 0..* | CHEMEDMedicationStatement | CH EMED MedicationStatement (MTP and basis) split-dosage-unit-must-match-base-dosage: The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. |
meta | ||||
extension | D | 0..* | Extension | ✕ This element is not supported |
versionId | D | 0..1 | id | ✕ This element is not supported |
lastUpdated | D | 0..1 | instant | ✕ This element is not supported |
source | D | 0..1 | uri | ✕ This element is not supported |
security | D | 0..* | Coding | ✕ This element is not supported |
tag | D | 0..* | Coding | ✕ This element is not supported |
implicitRules | 0..0 | |||
Slices for extension | Content/Rules for all slices | |||
extension:substitution | 0..1 | CHEMEDExtSubstitution | Whether the dispenser can substitute the prescribed medicine/package by another that is deemed equivalent, for medical or logistical reasons. By default, substitution is authorized. | |
id | D | 0..1 | string | ✕ This element is not supported |
value[x] | 1..1 | CodeableConcept | Whether substitution is allowed or not Binding: Substance Administration Substitution Codes (required) | |
coding | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-substanceAdminSubstitution | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: N | |
display | 1..1 | string | Representation defined by the system Fixed Value: none | |
modifierExtension | 0..0 | |||
identifier | ||||
extension | D | 0..* | Extension | ✕ This element is not supported |
type | D | 0..1 | CodeableConcept | ✕ This element is not supported |
period | D | 0..1 | Period | ✕ This element is not supported |
assigner | D | 0..1 | Reference(CH EMED EPR Organization) | ✕ This element will be removed in PML(C) documents |
basedOn | D | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | ✕ This element will be removed in PML(C) documents |
partOf | D | 0..0 | ||
status | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Required Pattern: active | |
statusReason | D | 0..* | CodeableConcept | ✕ This element is not supported |
category | D | 0..1 | CodeableConcept | ✕ This element is not supported |
medication[x] | 1..1 | Reference(CH Core Medication) | What medication was taken | |
Slices for medication[x] | Content/Rules for all slices | |||
medication[x]:medicationReference | 0..1 | Reference(CH EMED EPR Medication) {c} | Reference to the contained medication | |
subject | 1..1 | Reference(CH EMED EPR Patient) {r, b} | Patient | |
id | D | 0..1 | string | ✕ This element is not supported |
extension | D | 0..* | Extension | ✕ This element is not supported |
context | D | 0..1 | Reference(Encounter | EpisodeOfCare) | ✕ This element will be removed in PML(C) documents |
effective[x] | D | 0..1 | dateTime, Period | ✕ Do not use. The effective period is contained in the main dosage |
informationSource | 1..1 | Reference(CH EMED EPR PractitionerRole | CH EMED EPR Patient | CH EMED EPR RelatedPerson) | The author of the medical decision, see also 'Guidance - Authorship' | |
derivedFrom | D | 0..* | Reference(Resource) | ✕ This element will be removed in PML(C) documents |
reasonCode | 0..* | CodeableConcept | The treatment reason(s) as text, and optionally coded | |
extension | D | 0..* | Extension | ✕ This element is not supported |
text | 1..1 | string | Plain text representation of the treatment reason(s) | |
reasonReference | D | 0..* | Reference(Condition | Observation | DiagnosticReport) | ✕ This element will be removed in PML(C) documents |
note | ||||
id | D | 0..1 | string | ✕ This element is not supported |
extension | D | 0..* | Extension | ✕ This element is not supported |
author[x] | D | 0..1 | Reference(Practitioner | Patient | RelatedPerson | Organization), string | ✕ The note author is ignored, as it cannot be different than the document and/or entry's author |
time | D | 0..1 | dateTime | ✕ This element is not supported |
text | 1..1 | markdown | The annotation text content (as raw text, no markdown allowed). | |
Slices for dosage | Content/Rules for all slices | |||
dosage:baseEntry | 1..1 | CHEMEDEPRDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) | |
dosage:additionalEntry | 0..* | CHEMEDEPRDosageSplit | CH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationStatement.extension:substitution.value[x] | required | CHEMEDEprActSubstanceAdminSubstitutionCodehttp://fhir.ch/ig/ch-emed-epr/ValueSet/ch-emed-epr-substance-admin-substitution-code from this IG |
Id | Grade | Path(s) | Details | Requirements |
split-dosage-unit-must-match-base-dosage | error | MedicationStatement | The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. : (dosage.count() > 1) implies dosage.doseAndRate.dose.ofType(Quantity).code.union(dosage.doseAndRate.dose.ofType(Range).low.code).union(dosage.doseAndRate.dose.ofType(Range).high.code).count() = 1 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | C | 0..* | CHEMEDMedicationStatement | CH EMED MedicationStatement (MTP and basis) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management ch-dosage-medstat: If one dosage element is present, it should not have a sequence number. If more than one dosage element is present, the base entry has the sequence number 1. split-dosage-unit-must-match-base-dosage: The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. |
contained | 1..* | Resource | Contained, inline Resources | |
Slices for extension | Content/Rules for all slices | |||
substitution | 0..1 | (Complex) | Whether the dispenser can substitute the prescribed medicine/package by another that is deemed equivalent, for medical or logistical reasons. By default, substitution is authorized. URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
id | D | 0..1 | string | ✕ This element is not supported |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution" | |
value[x] | 1..1 | CodeableConcept | Whether substitution is allowed or not Binding: Substance Administration Substitution Codes (required) ele-1: All FHIR elements must have a @value or children | |
coding | Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-substanceAdminSubstitution | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: N | |
display | 1..1 | string | Representation defined by the system Fixed Value: none | |
identifier | Σ | 1..1 | Identifier | MedicationStatement Identifier ele-1: All FHIR elements must have a @value or children |
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
type | ΣD | 0..1 | CodeableConcept | ✕ This element is not supported Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: urn:ietf:rfc:3986 |
value | Σ | 1..1 | string | Identifier value as UUID ele-1: All FHIR elements must have a @value or children Example General: 123456 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 |
period | ΣD | 0..1 | Period | ✕ This element is not supported ele-1: All FHIR elements must have a @value or children |
assigner | ΣD | 0..1 | Reference(CH EMED EPR Organization) | ✕ This element will be removed in PML(C) documents ele-1: All FHIR elements must have a @value or children |
basedOn | ΣD | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | ✕ This element will be removed in PML(C) documents ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. ele-1: All FHIR elements must have a @value or children Required Pattern: active |
statusReason | D | 0..* | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. ele-1: All FHIR elements must have a @value or children |
category | ΣD | 0..1 | CodeableConcept | ✕ This element is not supported Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. ele-1: All FHIR elements must have a @value or children |
Slices for medication[x] | Σ | 1..1 | Reference(CH Core Medication) | What medication was taken Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children |
medication[x]:medicationReference | Σ | 0..1 | Reference(CH EMED EPR Medication) {c} | Reference to the contained medication ele-1: All FHIR elements must have a @value or children |
subject | Σ | 1..1 | Reference(CH EMED EPR Patient) {r, b} | Patient ele-1: All FHIR elements must have a @value or children |
id | D | 0..1 | string | ✕ This element is not supported |
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
context | ΣD | 0..1 | Reference(Encounter | EpisodeOfCare) | ✕ This element will be removed in PML(C) documents ele-1: All FHIR elements must have a @value or children |
effective[x] | ΣD | 0..1 | ✕ Do not use. The effective period is contained in the main dosage ele-1: All FHIR elements must have a @value or children | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dateAsserted | Σ | 1..1 | dateTime | When the statement was asserted? ele-1: All FHIR elements must have a @value or children |
informationSource | 1..1 | Reference(CH EMED EPR PractitionerRole | CH EMED EPR Patient | CH EMED EPR RelatedPerson) | The author of the medical decision, see also 'Guidance - Authorship' ele-1: All FHIR elements must have a @value or children | |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
derivedFrom | D | 0..* | Reference(Resource) | ✕ This element will be removed in PML(C) documents ele-1: All FHIR elements must have a @value or children |
reasonCode | 0..* | CodeableConcept | The treatment reason(s) as text, and optionally coded Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. ele-1: All FHIR elements must have a @value or children | |
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
text | Σ | 1..1 | string | Plain text representation of the treatment reason(s) ele-1: All FHIR elements must have a @value or children |
reasonReference | D | 0..* | Reference(Condition | Observation | DiagnosticReport) | ✕ This element will be removed in PML(C) documents ele-1: All FHIR elements must have a @value or children |
Slices for dosage | 1..* | CHCoreDosage | How the medication should be taken Slice: Unordered, Closed by profile:$this ele-1: All FHIR elements must have a @value or children | |
dosage:baseEntry | C | 1..1 | CHEMEDEPRDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) ele-1: All FHIR elements must have a @value or children ch-dosage-4: For split dosage timing event and dose/rate are required base-dosage-text: It is a strong recommendation that the base dosage should contain the whole dosage information as narrative, including the information from split dosage elements. |
dosage:additionalEntry | 0..* | CHEMEDEPRDosageSplit | CH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest) ele-1: All FHIR elements must have a @value or children | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationStatement.extension:substitution.value[x] | required | CHEMEDEprActSubstanceAdminSubstitutionCodehttp://fhir.ch/ig/ch-emed-epr/ValueSet/ch-emed-epr-substance-admin-substitution-code from this IG | |
MedicationStatement.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
MedicationStatement.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
MedicationStatement.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | |
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | |
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | |
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
base-dosage-text | warning | MedicationStatement.dosage:baseEntry | It is a strong recommendation that the base dosage should contain the whole dosage information as narrative, including the information from split dosage elements. : text.exists() and text.trim().length() > 0 | |
ch-dosage-4 | error | MedicationStatement.dosage:baseEntry | For split dosage timing event and dose/rate are required : sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists()) | |
ch-dosage-medstat | error | MedicationStatement | If one dosage element is present, it should not have a sequence number.
If more than one dosage element is present, the base entry has the sequence number 1. : (dosage.count() > 1 implies dosage.where($this.conformsTo('http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-dosage') and sequence = 1).exists()) and (dosage.count() = 1 implies dosage.single().sequence.exists().not()) | |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationStatement | 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() | |
split-dosage-unit-must-match-base-dosage | error | MedicationStatement | The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. : (dosage.count() > 1) implies dosage.doseAndRate.dose.ofType(Quantity).code.union(dosage.doseAndRate.dose.ofType(Range).low.code).union(dosage.doseAndRate.dose.ofType(Range).high.code).count() = 1 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | C | 0..* | CHEMEDMedicationStatement | CH EMED MedicationStatement (MTP and basis) ch-dosage-medstat: If one dosage element is present, it should not have a sequence number. If more than one dosage element is present, the base entry has the sequence number 1. split-dosage-unit-must-match-base-dosage: The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
versionId | ΣD | 0..1 | id | ✕ This element is not supported | ||||
lastUpdated | ΣD | 0..1 | instant | ✕ This element is not supported | ||||
source | ΣD | 0..1 | uri | ✕ This element is not supported | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | ΣD | 0..* | Coding | ✕ This element is not supported Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | ΣD | 0..* | Coding | ✕ This element is not supported Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 1..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
substitution | 0..1 | (Complex) | Whether the dispenser can substitute the prescribed medicine/package by another that is deemed equivalent, for medical or logistical reasons. By default, substitution is authorized. URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution | |||||
id | D | 0..1 | string | ✕ This element is not supported | ||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution" | |||||
value[x] | 1..1 | CodeableConcept | Whether substitution is allowed or not Binding: Substance Administration Substitution Codes (required) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-substanceAdminSubstitution | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: N | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: none | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
identifier | Σ | 1..1 | Identifier | MedicationStatement Identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | ΣD | 0..1 | CodeableConcept | ✕ This element is not supported Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
value | Σ | 1..1 | string | Identifier value as UUID Example General: 123456 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 | ||||
period | ΣD | 0..1 | Period | ✕ This element is not supported | ||||
assigner | ΣD | 0..1 | Reference(CH EMED EPR Organization) | ✕ This element will be removed in PML(C) documents | ||||
basedOn | ΣD | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | ✕ This element will be removed in PML(C) documents | ||||
status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. Required Pattern: active | ||||
statusReason | D | 0..* | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | ||||
category | ΣD | 0..1 | CodeableConcept | ✕ This element is not supported Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | ||||
Slices for medication[x] | Σ | 1..1 | Reference(CH Core Medication) | What medication was taken Slice: Unordered, Closed by type:$this | ||||
medication[x]:medicationReference | Σ | 0..1 | Reference(CH EMED EPR Medication) {c} | Reference to the contained medication | ||||
subject | Σ | 1..1 | Reference(CH EMED EPR Patient) {r, b} | Patient | ||||
id | D | 0..1 | string | ✕ This element is not supported | ||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
context | ΣD | 0..1 | Reference(Encounter | EpisodeOfCare) | ✕ This element will be removed in PML(C) documents | ||||
effective[x] | ΣD | 0..1 | ✕ Do not use. The effective period is contained in the main dosage | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
dateAsserted | Σ | 1..1 | dateTime | When the statement was asserted? | ||||
informationSource | 1..1 | Reference(CH EMED EPR PractitionerRole | CH EMED EPR Patient | CH EMED EPR RelatedPerson) | The author of the medical decision, see also 'Guidance - Authorship' | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
derivedFrom | D | 0..* | Reference(Resource) | ✕ This element will be removed in PML(C) documents | ||||
reasonCode | 0..* | CodeableConcept | The treatment reason(s) as text, and optionally coded Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 1..1 | string | Plain text representation of the treatment reason(s) | ||||
reasonReference | D | 0..* | Reference(Condition | Observation | DiagnosticReport) | ✕ This element will be removed in PML(C) documents | ||||
note | 0..* | Annotation | Further information about the statement | |||||
id | D | 0..1 | string | ✕ This element is not supported | ||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
author[x] | ΣD | 0..1 | ✕ The note author is ignored, as it cannot be different than the document and/or entry's author | |||||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
authorString | string | |||||||
time | ΣD | 0..1 | dateTime | ✕ This element is not supported | ||||
text | Σ | 1..1 | markdown | The annotation text content (as raw text, no markdown allowed). | ||||
Slices for dosage | 1..* | CHCoreDosage | How the medication should be taken Slice: Unordered, Closed by profile:$this | |||||
dosage:baseEntry | C | 1..1 | CHEMEDEPRDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) ch-dosage-4: For split dosage timing event and dose/rate are required base-dosage-text: It is a strong recommendation that the base dosage should contain the whole dosage information as narrative, including the information from split dosage elements. | ||||
dosage:additionalEntry | 0..* | CHEMEDEPRDosageSplit | CH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest) | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MedicationStatement.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationStatement.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationStatement.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationStatement.extension:substitution.value[x] | required | CHEMEDEprActSubstanceAdminSubstitutionCodehttp://fhir.ch/ig/ch-emed-epr/ValueSet/ch-emed-epr-substance-admin-substitution-code from this IG | ||||
MedicationStatement.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationStatement.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
MedicationStatement.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | ||||
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.informationSource.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
base-dosage-text | warning | MedicationStatement.dosage:baseEntry | It is a strong recommendation that the base dosage should contain the whole dosage information as narrative, including the information from split dosage elements. : text.exists() and text.trim().length() > 0 | |
ch-dosage-4 | error | MedicationStatement.dosage:baseEntry | For split dosage timing event and dose/rate are required : sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists()) | |
ch-dosage-medstat | error | MedicationStatement | If one dosage element is present, it should not have a sequence number.
If more than one dosage element is present, the base entry has the sequence number 1. : (dosage.count() > 1 implies dosage.where($this.conformsTo('http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-dosage') and sequence = 1).exists()) and (dosage.count() = 1 implies dosage.single().sequence.exists().not()) | |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationStatement | 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() | |
split-dosage-unit-must-match-base-dosage | error | MedicationStatement | The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. : (dosage.count() > 1) implies dosage.doseAndRate.dose.ofType(Quantity).code.union(dosage.doseAndRate.dose.ofType(Range).low.code).union(dosage.doseAndRate.dose.ofType(Range).high.code).count() = 1 |
This structure is derived from CHEMEDMedicationStatement
Summary
Mandatory: 0 element(1 nested mandatory element)
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from CHEMEDMedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | C | 0..* | CHEMEDMedicationStatement | CH EMED MedicationStatement (MTP and basis) split-dosage-unit-must-match-base-dosage: The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. |
meta | ||||
extension | D | 0..* | Extension | ✕ This element is not supported |
versionId | D | 0..1 | id | ✕ This element is not supported |
lastUpdated | D | 0..1 | instant | ✕ This element is not supported |
source | D | 0..1 | uri | ✕ This element is not supported |
security | D | 0..* | Coding | ✕ This element is not supported |
tag | D | 0..* | Coding | ✕ This element is not supported |
implicitRules | 0..0 | |||
Slices for extension | Content/Rules for all slices | |||
extension:substitution | 0..1 | CHEMEDExtSubstitution | Whether the dispenser can substitute the prescribed medicine/package by another that is deemed equivalent, for medical or logistical reasons. By default, substitution is authorized. | |
id | D | 0..1 | string | ✕ This element is not supported |
value[x] | 1..1 | CodeableConcept | Whether substitution is allowed or not Binding: Substance Administration Substitution Codes (required) | |
coding | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-substanceAdminSubstitution | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: N | |
display | 1..1 | string | Representation defined by the system Fixed Value: none | |
modifierExtension | 0..0 | |||
identifier | ||||
extension | D | 0..* | Extension | ✕ This element is not supported |
type | D | 0..1 | CodeableConcept | ✕ This element is not supported |
period | D | 0..1 | Period | ✕ This element is not supported |
assigner | D | 0..1 | Reference(CH EMED EPR Organization) | ✕ This element will be removed in PML(C) documents |
basedOn | D | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | ✕ This element will be removed in PML(C) documents |
partOf | D | 0..0 | ||
status | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Required Pattern: active | |
statusReason | D | 0..* | CodeableConcept | ✕ This element is not supported |
category | D | 0..1 | CodeableConcept | ✕ This element is not supported |
medication[x] | 1..1 | Reference(CH Core Medication) | What medication was taken | |
Slices for medication[x] | Content/Rules for all slices | |||
medication[x]:medicationReference | 0..1 | Reference(CH EMED EPR Medication) {c} | Reference to the contained medication | |
subject | 1..1 | Reference(CH EMED EPR Patient) {r, b} | Patient | |
id | D | 0..1 | string | ✕ This element is not supported |
extension | D | 0..* | Extension | ✕ This element is not supported |
context | D | 0..1 | Reference(Encounter | EpisodeOfCare) | ✕ This element will be removed in PML(C) documents |
effective[x] | D | 0..1 | dateTime, Period | ✕ Do not use. The effective period is contained in the main dosage |
informationSource | 1..1 | Reference(CH EMED EPR PractitionerRole | CH EMED EPR Patient | CH EMED EPR RelatedPerson) | The author of the medical decision, see also 'Guidance - Authorship' | |
derivedFrom | D | 0..* | Reference(Resource) | ✕ This element will be removed in PML(C) documents |
reasonCode | 0..* | CodeableConcept | The treatment reason(s) as text, and optionally coded | |
extension | D | 0..* | Extension | ✕ This element is not supported |
text | 1..1 | string | Plain text representation of the treatment reason(s) | |
reasonReference | D | 0..* | Reference(Condition | Observation | DiagnosticReport) | ✕ This element will be removed in PML(C) documents |
note | ||||
id | D | 0..1 | string | ✕ This element is not supported |
extension | D | 0..* | Extension | ✕ This element is not supported |
author[x] | D | 0..1 | Reference(Practitioner | Patient | RelatedPerson | Organization), string | ✕ The note author is ignored, as it cannot be different than the document and/or entry's author |
time | D | 0..1 | dateTime | ✕ This element is not supported |
text | 1..1 | markdown | The annotation text content (as raw text, no markdown allowed). | |
Slices for dosage | Content/Rules for all slices | |||
dosage:baseEntry | 1..1 | CHEMEDEPRDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) | |
dosage:additionalEntry | 0..* | CHEMEDEPRDosageSplit | CH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationStatement.extension:substitution.value[x] | required | CHEMEDEprActSubstanceAdminSubstitutionCodehttp://fhir.ch/ig/ch-emed-epr/ValueSet/ch-emed-epr-substance-admin-substitution-code from this IG |
Id | Grade | Path(s) | Details | Requirements |
split-dosage-unit-must-match-base-dosage | error | MedicationStatement | The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. : (dosage.count() > 1) implies dosage.doseAndRate.dose.ofType(Quantity).code.union(dosage.doseAndRate.dose.ofType(Range).low.code).union(dosage.doseAndRate.dose.ofType(Range).high.code).count() = 1 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | C | 0..* | CHEMEDMedicationStatement | CH EMED MedicationStatement (MTP and basis) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management ch-dosage-medstat: If one dosage element is present, it should not have a sequence number. If more than one dosage element is present, the base entry has the sequence number 1. split-dosage-unit-must-match-base-dosage: The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. |
contained | 1..* | Resource | Contained, inline Resources | |
Slices for extension | Content/Rules for all slices | |||
substitution | 0..1 | (Complex) | Whether the dispenser can substitute the prescribed medicine/package by another that is deemed equivalent, for medical or logistical reasons. By default, substitution is authorized. URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
id | D | 0..1 | string | ✕ This element is not supported |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution" | |
value[x] | 1..1 | CodeableConcept | Whether substitution is allowed or not Binding: Substance Administration Substitution Codes (required) ele-1: All FHIR elements must have a @value or children | |
coding | Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-substanceAdminSubstitution | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: N | |
display | 1..1 | string | Representation defined by the system Fixed Value: none | |
identifier | Σ | 1..1 | Identifier | MedicationStatement Identifier ele-1: All FHIR elements must have a @value or children |
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
type | ΣD | 0..1 | CodeableConcept | ✕ This element is not supported Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: urn:ietf:rfc:3986 |
value | Σ | 1..1 | string | Identifier value as UUID ele-1: All FHIR elements must have a @value or children Example General: 123456 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 |
period | ΣD | 0..1 | Period | ✕ This element is not supported ele-1: All FHIR elements must have a @value or children |
assigner | ΣD | 0..1 | Reference(CH EMED EPR Organization) | ✕ This element will be removed in PML(C) documents ele-1: All FHIR elements must have a @value or children |
basedOn | ΣD | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | ✕ This element will be removed in PML(C) documents ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. ele-1: All FHIR elements must have a @value or children Required Pattern: active |
statusReason | D | 0..* | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. ele-1: All FHIR elements must have a @value or children |
category | ΣD | 0..1 | CodeableConcept | ✕ This element is not supported Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. ele-1: All FHIR elements must have a @value or children |
Slices for medication[x] | Σ | 1..1 | Reference(CH Core Medication) | What medication was taken Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children |
medication[x]:medicationReference | Σ | 0..1 | Reference(CH EMED EPR Medication) {c} | Reference to the contained medication ele-1: All FHIR elements must have a @value or children |
subject | Σ | 1..1 | Reference(CH EMED EPR Patient) {r, b} | Patient ele-1: All FHIR elements must have a @value or children |
id | D | 0..1 | string | ✕ This element is not supported |
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
context | ΣD | 0..1 | Reference(Encounter | EpisodeOfCare) | ✕ This element will be removed in PML(C) documents ele-1: All FHIR elements must have a @value or children |
effective[x] | ΣD | 0..1 | ✕ Do not use. The effective period is contained in the main dosage ele-1: All FHIR elements must have a @value or children | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dateAsserted | Σ | 1..1 | dateTime | When the statement was asserted? ele-1: All FHIR elements must have a @value or children |
informationSource | 1..1 | Reference(CH EMED EPR PractitionerRole | CH EMED EPR Patient | CH EMED EPR RelatedPerson) | The author of the medical decision, see also 'Guidance - Authorship' ele-1: All FHIR elements must have a @value or children | |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
derivedFrom | D | 0..* | Reference(Resource) | ✕ This element will be removed in PML(C) documents ele-1: All FHIR elements must have a @value or children |
reasonCode | 0..* | CodeableConcept | The treatment reason(s) as text, and optionally coded Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. ele-1: All FHIR elements must have a @value or children | |
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
text | Σ | 1..1 | string | Plain text representation of the treatment reason(s) ele-1: All FHIR elements must have a @value or children |
reasonReference | D | 0..* | Reference(Condition | Observation | DiagnosticReport) | ✕ This element will be removed in PML(C) documents ele-1: All FHIR elements must have a @value or children |
Slices for dosage | 1..* | CHCoreDosage | How the medication should be taken Slice: Unordered, Closed by profile:$this ele-1: All FHIR elements must have a @value or children | |
dosage:baseEntry | C | 1..1 | CHEMEDEPRDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) ele-1: All FHIR elements must have a @value or children ch-dosage-4: For split dosage timing event and dose/rate are required base-dosage-text: It is a strong recommendation that the base dosage should contain the whole dosage information as narrative, including the information from split dosage elements. |
dosage:additionalEntry | 0..* | CHEMEDEPRDosageSplit | CH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest) ele-1: All FHIR elements must have a @value or children | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationStatement.extension:substitution.value[x] | required | CHEMEDEprActSubstanceAdminSubstitutionCodehttp://fhir.ch/ig/ch-emed-epr/ValueSet/ch-emed-epr-substance-admin-substitution-code from this IG | |
MedicationStatement.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
MedicationStatement.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
MedicationStatement.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | |
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | |
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | |
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
base-dosage-text | warning | MedicationStatement.dosage:baseEntry | It is a strong recommendation that the base dosage should contain the whole dosage information as narrative, including the information from split dosage elements. : text.exists() and text.trim().length() > 0 | |
ch-dosage-4 | error | MedicationStatement.dosage:baseEntry | For split dosage timing event and dose/rate are required : sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists()) | |
ch-dosage-medstat | error | MedicationStatement | If one dosage element is present, it should not have a sequence number.
If more than one dosage element is present, the base entry has the sequence number 1. : (dosage.count() > 1 implies dosage.where($this.conformsTo('http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-dosage') and sequence = 1).exists()) and (dosage.count() = 1 implies dosage.single().sequence.exists().not()) | |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationStatement | 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() | |
split-dosage-unit-must-match-base-dosage | error | MedicationStatement | The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. : (dosage.count() > 1) implies dosage.doseAndRate.dose.ofType(Quantity).code.union(dosage.doseAndRate.dose.ofType(Range).low.code).union(dosage.doseAndRate.dose.ofType(Range).high.code).count() = 1 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | C | 0..* | CHEMEDMedicationStatement | CH EMED MedicationStatement (MTP and basis) ch-dosage-medstat: If one dosage element is present, it should not have a sequence number. If more than one dosage element is present, the base entry has the sequence number 1. split-dosage-unit-must-match-base-dosage: The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
versionId | ΣD | 0..1 | id | ✕ This element is not supported | ||||
lastUpdated | ΣD | 0..1 | instant | ✕ This element is not supported | ||||
source | ΣD | 0..1 | uri | ✕ This element is not supported | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | ΣD | 0..* | Coding | ✕ This element is not supported Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | ΣD | 0..* | Coding | ✕ This element is not supported Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 1..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
substitution | 0..1 | (Complex) | Whether the dispenser can substitute the prescribed medicine/package by another that is deemed equivalent, for medical or logistical reasons. By default, substitution is authorized. URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution | |||||
id | D | 0..1 | string | ✕ This element is not supported | ||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution" | |||||
value[x] | 1..1 | CodeableConcept | Whether substitution is allowed or not Binding: Substance Administration Substitution Codes (required) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-substanceAdminSubstitution | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: N | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: none | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
identifier | Σ | 1..1 | Identifier | MedicationStatement Identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | ΣD | 0..1 | CodeableConcept | ✕ This element is not supported Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
value | Σ | 1..1 | string | Identifier value as UUID Example General: 123456 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 | ||||
period | ΣD | 0..1 | Period | ✕ This element is not supported | ||||
assigner | ΣD | 0..1 | Reference(CH EMED EPR Organization) | ✕ This element will be removed in PML(C) documents | ||||
basedOn | ΣD | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | ✕ This element will be removed in PML(C) documents | ||||
status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. Required Pattern: active | ||||
statusReason | D | 0..* | CodeableConcept | ✕ This element is not supported Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | ||||
category | ΣD | 0..1 | CodeableConcept | ✕ This element is not supported Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | ||||
Slices for medication[x] | Σ | 1..1 | Reference(CH Core Medication) | What medication was taken Slice: Unordered, Closed by type:$this | ||||
medication[x]:medicationReference | Σ | 0..1 | Reference(CH EMED EPR Medication) {c} | Reference to the contained medication | ||||
subject | Σ | 1..1 | Reference(CH EMED EPR Patient) {r, b} | Patient | ||||
id | D | 0..1 | string | ✕ This element is not supported | ||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
context | ΣD | 0..1 | Reference(Encounter | EpisodeOfCare) | ✕ This element will be removed in PML(C) documents | ||||
effective[x] | ΣD | 0..1 | ✕ Do not use. The effective period is contained in the main dosage | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
dateAsserted | Σ | 1..1 | dateTime | When the statement was asserted? | ||||
informationSource | 1..1 | Reference(CH EMED EPR PractitionerRole | CH EMED EPR Patient | CH EMED EPR RelatedPerson) | The author of the medical decision, see also 'Guidance - Authorship' | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
derivedFrom | D | 0..* | Reference(Resource) | ✕ This element will be removed in PML(C) documents | ||||
reasonCode | 0..* | CodeableConcept | The treatment reason(s) as text, and optionally coded Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 1..1 | string | Plain text representation of the treatment reason(s) | ||||
reasonReference | D | 0..* | Reference(Condition | Observation | DiagnosticReport) | ✕ This element will be removed in PML(C) documents | ||||
note | 0..* | Annotation | Further information about the statement | |||||
id | D | 0..1 | string | ✕ This element is not supported | ||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
author[x] | ΣD | 0..1 | ✕ The note author is ignored, as it cannot be different than the document and/or entry's author | |||||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
authorString | string | |||||||
time | ΣD | 0..1 | dateTime | ✕ This element is not supported | ||||
text | Σ | 1..1 | markdown | The annotation text content (as raw text, no markdown allowed). | ||||
Slices for dosage | 1..* | CHCoreDosage | How the medication should be taken Slice: Unordered, Closed by profile:$this | |||||
dosage:baseEntry | C | 1..1 | CHEMEDEPRDosage | CH EMED Dosage (MedicationStatement / MedicationDispense) ch-dosage-4: For split dosage timing event and dose/rate are required base-dosage-text: It is a strong recommendation that the base dosage should contain the whole dosage information as narrative, including the information from split dosage elements. | ||||
dosage:additionalEntry | 0..* | CHEMEDEPRDosageSplit | CH EMED Dosage Split (MedicationStatement / MedicationDispense / MedicationRequest) | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MedicationStatement.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationStatement.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationStatement.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationStatement.extension:substitution.value[x] | required | CHEMEDEprActSubstanceAdminSubstitutionCodehttp://fhir.ch/ig/ch-emed-epr/ValueSet/ch-emed-epr-substance-admin-substitution-code from this IG | ||||
MedicationStatement.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationStatement.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
MedicationStatement.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | ||||
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.informationSource.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
base-dosage-text | warning | MedicationStatement.dosage:baseEntry | It is a strong recommendation that the base dosage should contain the whole dosage information as narrative, including the information from split dosage elements. : text.exists() and text.trim().length() > 0 | |
ch-dosage-4 | error | MedicationStatement.dosage:baseEntry | For split dosage timing event and dose/rate are required : sequence.exists() implies (timing.repeat.when.exists() and doseAndRate.dose.exists()) | |
ch-dosage-medstat | error | MedicationStatement | If one dosage element is present, it should not have a sequence number.
If more than one dosage element is present, the base entry has the sequence number 1. : (dosage.count() > 1 implies dosage.where($this.conformsTo('http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-dosage') and sequence = 1).exists()) and (dosage.count() = 1 implies dosage.single().sequence.exists().not()) | |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationStatement | 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() | |
split-dosage-unit-must-match-base-dosage | error | MedicationStatement | The unit for doseAndRate of different dosages (split dosage) belonging to the same statement/request/dispense must match. : (dosage.count() > 1) implies dosage.doseAndRate.dose.ofType(Quantity).code.union(dosage.doseAndRate.dose.ofType(Range).low.code).union(dosage.doseAndRate.dose.ofType(Range).high.code).count() = 1 |
This structure is derived from CHEMEDMedicationStatement
Summary
Mandatory: 0 element(1 nested mandatory element)
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron