CH EMED (R4)
2.0.0 - STU 2
This page is part of the CH EMED (R4) (v2.0.0: STU 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Defining URL: | http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-medicationstatement-treatmentplan |
Version: | 2.0.0 |
Name: | CHEMEDMedicationStatementTreatmentPlan |
Title: | CH EMED MedicationStatement Profile (Medication Treatment Plan document) |
Status: | Active as of 2022-02-11 09:56:31+0100 |
Definition: | Definition of the medication statement for the Medication Treatment Plan document |
Publisher: | HL7 Switzerland |
Copyright: | CC-BY-SA-4.0 |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-medicationstatement-treatmentplan
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHEMEDMedicationStatement
This structure is derived from CHEMEDMedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | CHEMEDMedicationStatement | CH EMED MedicationStatement (Medication Treatment Plan document) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ch-emed-ext-substitution | 0..1 | CodeableConcept | Substitution URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution Binding: ActSubstanceAdminSubstitutionCode (preferred) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | I | 0..* | CHEMEDMedicationStatement | CH EMED MedicationStatement (Medication Treatment Plan document) |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 1..1 | Resource | Medication inline resource | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ch-emed-ext-substitution | 0..1 | CodeableConcept | Substitution URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution Binding: ActSubstanceAdminSubstitutionCode (preferred) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..1 | Identifier | MedicationStatement Identifier |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations 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 | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 1..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 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order |
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event |
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. Fixed Value: completed |
statusReason | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |
category | Σ | 0..1 | CodeableConcept | Type of medication usage 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() | What medication was taken Slice: Unordered, Closed by type:$this |
medication[x]:medicationReference | Σ | 1..1 | Reference(CH EMED Medication Profile) | Reference to the contained medication |
subject | Σ | 1..1 | Reference(CH Core Patient Profile) | Patient |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 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 | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement |
effective[x] | Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? |
informationSource | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
reasonCode | 0..1 | CodeableConcept | Treatment reason 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 | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Plain text representation of the concept |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |
note | 0..1 | Annotation | Annotation | |
Slices for dosage | 1..* | Dosage | How the medication should be taken Slice: Unordered, Closed by profile:$this | |
dosage:nonstructured | 0..1 | CHEMEDDosageNonStructured | Free text dosage instructions | |
dosage:structurednormal | 0..1 | CHEMEDDosageStructuredNormal | Structured Normal Dosing | |
dosage:structuredsplit | 0..* | CHEMEDDosageStructuredSplit | Structured Split Dosing | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | I | 0..* | CHEMEDMedicationStatement | CH EMED MedicationStatement (Medication Treatment Plan document) |
Documentation for this format |
This structure is derived from CHEMEDMedicationStatement
Differential View
This structure is derived from CHEMEDMedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | CHEMEDMedicationStatement | CH EMED MedicationStatement (Medication Treatment Plan document) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ch-emed-ext-substitution | 0..1 | CodeableConcept | Substitution URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution Binding: ActSubstanceAdminSubstitutionCode (preferred) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | I | 0..* | CHEMEDMedicationStatement | CH EMED MedicationStatement (Medication Treatment Plan document) |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 1..1 | Resource | Medication inline resource | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ch-emed-ext-substitution | 0..1 | CodeableConcept | Substitution URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-substitution Binding: ActSubstanceAdminSubstitutionCode (preferred) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..1 | Identifier | MedicationStatement Identifier |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations 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 | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 1..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 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order |
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event |
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. Fixed Value: completed |
statusReason | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |
category | Σ | 0..1 | CodeableConcept | Type of medication usage 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() | What medication was taken Slice: Unordered, Closed by type:$this |
medication[x]:medicationReference | Σ | 1..1 | Reference(CH EMED Medication Profile) | Reference to the contained medication |
subject | Σ | 1..1 | Reference(CH Core Patient Profile) | Patient |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 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 | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement |
effective[x] | Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? |
informationSource | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
reasonCode | 0..1 | CodeableConcept | Treatment reason 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 | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Plain text representation of the concept |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |
note | 0..1 | Annotation | Annotation | |
Slices for dosage | 1..* | Dosage | How the medication should be taken Slice: Unordered, Closed by profile:$this | |
dosage:nonstructured | 0..1 | CHEMEDDosageNonStructured | Free text dosage instructions | |
dosage:structurednormal | 0..1 | CHEMEDDosageStructuredNormal | Structured Normal Dosing | |
dosage:structuredsplit | 0..* | CHEMEDDosageStructuredSplit | Structured Split Dosing | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
MedicationStatement.language | preferred | CommonLanguages Max Binding: AllLanguages |
MedicationStatement.identifier.use | required | IdentifierUse |
MedicationStatement.identifier.type | extensible | Identifier Type Codes |
MedicationStatement.status | required | Fixed Value: completed |
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodes |
MedicationStatement.category | preferred | Medication usage category codes |
MedicationStatement.subject.type | extensible | ResourceType |
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodes |
Id | Grade | Path | Details | Requirements |
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() | |
ch-dosage-1 | error | MedicationStatement | If dosing is structured it must be normal or split dosing : dosage.where($this.conformsTo('http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-dosage-structured-normal')).count()=0 or dosage.where($this.conformsTo('http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-dosage-structured-split')).count()=0 | |
ele-1 | error | MedicationStatement.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | MedicationStatement.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | MedicationStatement.extension:substitution | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | MedicationStatement.extension:substitution | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | MedicationStatement.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | MedicationStatement.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | MedicationStatement.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | MedicationStatement.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | MedicationStatement.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.medication[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.medication[x]:medicationReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.subject.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | MedicationStatement.subject.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | MedicationStatement.subject.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.subject.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.subject.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.subject.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.context | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.effective[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.dateAsserted | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.informationSource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.derivedFrom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.reasonCode.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | MedicationStatement.reasonCode.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | MedicationStatement.reasonCode.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.reasonCode.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.dosage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.dosage:nonstructured | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.dosage:structurednormal | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | MedicationStatement.dosage:structuredsplit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |