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

Resource Profile: CH EMED Medication Profile

Defining URL:http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-medication
Version:2.0.0
Name:CHEMEDMedication
Title:CH EMED Medication Profile
Status:Active as of 2022-02-11 09:56:31+0100
Definition:

Definition of the medication

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-medication

Formal Views of Profile Content

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

This structure is derived from Medication

Summary

Mandatory: 0 element (9 nested mandatory elements)
Must-Support: 4 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Medication.code.coding is sliced based on the value of value:system

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*MedicationCH EMED Medication
ch-emed-med-1: Medication or ingredient name has to be specified
... code 0..1CodeableConceptCodes that identify this medication
.... Slices for coding 0..*CodingCode of the medication (GTIN)
Slice: Unordered, Open by value:system
..... coding:GTIN 0..*CodingCode defined by a terminology system
...... system 1..1uriGlobal Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
.... text S1..1stringMedication name
... form 0..1CodeableConceptGalenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... coding S1..*CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... amount 0..1CHEMEDRatioWithEmedUnitsPackage size
.... itemCodeableConcept 1..1CodeableConceptThe actual ingredient or content
..... coding 0..*CodingIngredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
..... text S1..1stringIngredient name
.... strength S0..1CHEMEDRatioWithEmedUnitsDose per unit

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*MedicationCH EMED Medication
ch-emed-med-1: Medication or ingredient name has to be specified
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode of the medication (GTIN)
Slice: Unordered, Open by value:system
..... coding:GTIN Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriGlobal Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ1..1stringMedication name
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... form 0..1CodeableConceptGalenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ1..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... amount I0..1CHEMEDRatioWithEmedUnitsPackage size
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for item[x] 1..1CodeableConceptThe actual ingredient or content
Slice: Unordered, Closed by type:$this
..... item[x]:itemCodeableConcept 1..1CodeableConceptThe actual ingredient or content
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingIngredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
...... text SΣ1..1stringIngredient name
.... isActive 0..1booleanActive ingredient indicator
.... strength SI0..1CHEMEDRatioWithEmedUnitsDose per unit
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*MedicationCH EMED Medication
ch-emed-med-1: Medication or ingredient name has to be specified
... code Σ0..1CodeableConceptCodes that identify this medication
.... text Σ1..1stringMedication name
... form 0..1CodeableConceptGalenic form
.... coding Σ1..*CodingCode defined by a terminology system
... ingredient 0..*BackboneElementActive or inactive ingredient
.... item[x]:itemCodeableConcept 1..1CodeableConceptThe actual ingredient or content
..... text Σ1..1stringIngredient name
.... strength I0..1CHEMEDRatioWithEmedUnitsDose per unit

doco Documentation for this format

This structure is derived from Medication

Summary

Mandatory: 0 element (9 nested mandatory elements)
Must-Support: 4 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Medication.code.coding is sliced based on the value of value:system

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*MedicationCH EMED Medication
ch-emed-med-1: Medication or ingredient name has to be specified
... code 0..1CodeableConceptCodes that identify this medication
.... Slices for coding 0..*CodingCode of the medication (GTIN)
Slice: Unordered, Open by value:system
..... coding:GTIN 0..*CodingCode defined by a terminology system
...... system 1..1uriGlobal Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
.... text S1..1stringMedication name
... form 0..1CodeableConceptGalenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... coding S1..*CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... amount 0..1CHEMEDRatioWithEmedUnitsPackage size
.... itemCodeableConcept 1..1CodeableConceptThe actual ingredient or content
..... coding 0..*CodingIngredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
..... text S1..1stringIngredient name
.... strength S0..1CHEMEDRatioWithEmedUnitsDose per unit

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*MedicationCH EMED Medication
ch-emed-med-1: Medication or ingredient name has to be specified
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode of the medication (GTIN)
Slice: Unordered, Open by value:system
..... coding:GTIN Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriGlobal Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ1..1stringMedication name
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... form 0..1CodeableConceptGalenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ1..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... amount I0..1CHEMEDRatioWithEmedUnitsPackage size
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for item[x] 1..1CodeableConceptThe actual ingredient or content
Slice: Unordered, Closed by type:$this
..... item[x]:itemCodeableConcept 1..1CodeableConceptThe actual ingredient or content
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingIngredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
...... text SΣ1..1stringIngredient name
.... isActive 0..1booleanActive ingredient indicator
.... strength SI0..1CHEMEDRatioWithEmedUnitsDose per unit
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.statusrequiredMedication Status Codes
Medication.formrequiredPharmaceuticalDoseFormEDQM
Medication.ingredient.item[x]:itemCodeableConcept.codingextensibleActivePharmaceuticalIngredient

Constraints

IdGradePathDetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeMedicationA resource should have narrative for robust management
: text.`div`.exists()
ch-emed-med-1errorMedicationMedication or ingredient name has to be specified
: code.text.exists() or ingredient.itemCodeableConcept.text.exists()
ele-1errorMedication.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.code.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.code.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.code.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.code.coding:GTINAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.code.coding:GTIN.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.code.coding:GTIN.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.code.coding:GTIN.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.code.coding:GTIN.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.code.coding:GTIN.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.code.coding:GTIN.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.code.coding:GTIN.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.code.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.manufacturerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.formAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.form.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.form.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.form.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.form.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.form.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.form.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.form.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.form.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.form.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.form.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.form.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.amountAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
rat-1errorMedication.amountNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
ele-1errorMedication.ingredientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.ingredient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.ingredient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.ingredient.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.ingredient.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.ingredient.item[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.ingredient.item[x]:itemCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.ingredient.item[x]:itemCodeableConcept.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.ingredient.item[x]:itemCodeableConcept.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.ingredient.item[x]:itemCodeableConcept.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.ingredient.item[x]:itemCodeableConcept.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.ingredient.isActiveAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.ingredient.strengthAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
rat-1errorMedication.ingredient.strengthNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
ele-1errorMedication.batchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.batch.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.batch.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.batch.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.batch.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.batch.lotNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.batch.expirationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())