CH.FHIR.IG.CH-EMED\CH EMED Medication Profile (MedicationStatement)

This page is part of the CH EMED (R4) (v0.2.0: STU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: CH EMED Medication Profile (MedicationStatement)

Defining URL:

http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-medication-medicationstatement

Version:

0.2.0

Name:

CHEMEDMedicationMedicationStatement

Title:

CH EMED Medication Profile (MedicationStatement)

Status:

Active as of 2021-02-12T16:01:26+01:00

Definition:

Definition of the medication for the medication statement

Publisher:

eHealth Suisse

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

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from Medication

Summary

Mandatory: 2 elements (8 nested mandatory elements)
Fixed Value: 1 element

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

Name	Card.	Type	Description & Constraints
Medication	0..*	Medication	CH EMED Medication (MedicationStatement)
code	1..1	CodeableConcept	Codes that identify this medication
coding	0..*	(Slice Definition)	GTIN code that identify this medication Slice: Unordered, Open by value:system
coding:GTIN	0..*	Coding	Code defined by a terminology system
system	1..1	uri	Global Trade Item Number (GS1) Fixed Value: urn:oid:2.51.1.1
code	1..1	code	Symbol in syntax defined by the system
display	1..1	string	Representation defined by the system
text	1..1	string	Name that identify this medication
form	0..1	CodeableConcept	Galenic form Binding: EDQM - Pharmaceutical Dose Form (required)
coding	1..*	Coding	Code defined by a terminology system
system	1..1	uri	Identity of the terminology system
code	1..1	code	Symbol in syntax defined by the system
display	1..1	string	Representation defined by the system
amount	0..1	Ratio	Package size
ingredient	0..*	BackboneElement	Active or inactive ingredient
itemCodeableConcept	1..1	CodeableConcept	Name of active ingredient
coding	0..*	Coding	Ingredients shall be coded with SNOMED CT Binding: ActivePharmaceuticalIngredient (extensible)
text	1..1	string	If no code ist available, the text should indicate the ingredient name
strength	0..1	Ratio	Dose per unit
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	CH EMED Medication (MedicationStatement)
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		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier for this medication
code	Σ	1..1	CodeableConcept	Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
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..*	(Slice Definition)	GTIN code that identify this medication Slice: Unordered, Open by value:system
coding:GTIN	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Global Trade Item Number (GS1) Fixed Value: urn:oid:2.51.1.1
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Name that identify this medication
status	?!Σ	0..1	code	active \| inactive \| entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
manufacturer	Σ	0..1	Reference(Organization)	Manufacturer of the item
form		0..1	CodeableConcept	Galenic form Binding: EDQM - Pharmaceutical Dose Form (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	Σ	1..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
amount	Σ	0..1	Ratio	Package size
ingredient		0..*	BackboneElement	Active or inactive ingredient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
item[x]		1..1	(Slice Definition)	The actual ingredient or content Slice: Unordered, Closed by type:$this
item[x]:itemCodeableConcept		1..1	CodeableConcept	Name of active ingredient
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	Ingredients shall be coded with SNOMED CT Binding: ActivePharmaceuticalIngredient (extensible)
text	Σ	1..1	string	If no code ist available, the text should indicate the ingredient name
isActive		0..1	boolean	Active ingredient indicator
strength		0..1	Ratio	Dose per unit
batch		0..1	BackboneElement	Details about packaged medications
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
lotNumber		0..1	string	Identifier assigned to batch
expirationDate		0..1	dateTime	When batch will expire
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	CH EMED Medication (MedicationStatement)
Documentation for this format

This structure is derived from Medication

Summary

Mandatory: 2 elements (8 nested mandatory elements)
Fixed Value: 1 element

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

Name	Card.	Type	Description & Constraints
Medication	0..*	Medication	CH EMED Medication (MedicationStatement)
code	1..1	CodeableConcept	Codes that identify this medication
coding	0..*	(Slice Definition)	GTIN code that identify this medication Slice: Unordered, Open by value:system
coding:GTIN	0..*	Coding	Code defined by a terminology system
system	1..1	uri	Global Trade Item Number (GS1) Fixed Value: urn:oid:2.51.1.1
code	1..1	code	Symbol in syntax defined by the system
display	1..1	string	Representation defined by the system
text	1..1	string	Name that identify this medication
form	0..1	CodeableConcept	Galenic form Binding: EDQM - Pharmaceutical Dose Form (required)
coding	1..*	Coding	Code defined by a terminology system
system	1..1	uri	Identity of the terminology system
code	1..1	code	Symbol in syntax defined by the system
display	1..1	string	Representation defined by the system
amount	0..1	Ratio	Package size
ingredient	0..*	BackboneElement	Active or inactive ingredient
itemCodeableConcept	1..1	CodeableConcept	Name of active ingredient
coding	0..*	Coding	Ingredients shall be coded with SNOMED CT Binding: ActivePharmaceuticalIngredient (extensible)
text	1..1	string	If no code ist available, the text should indicate the ingredient name
strength	0..1	Ratio	Dose per unit
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	CH EMED Medication (MedicationStatement)
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		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier for this medication
code	Σ	1..1	CodeableConcept	Codes that identify this medication Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
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..*	(Slice Definition)	GTIN code that identify this medication Slice: Unordered, Open by value:system
coding:GTIN	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Global Trade Item Number (GS1) Fixed Value: urn:oid:2.51.1.1
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	1..1	string	Name that identify this medication
status	?!Σ	0..1	code	active \| inactive \| entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
manufacturer	Σ	0..1	Reference(Organization)	Manufacturer of the item
form		0..1	CodeableConcept	Galenic form Binding: EDQM - Pharmaceutical Dose Form (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	Σ	1..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
amount	Σ	0..1	Ratio	Package size
ingredient		0..*	BackboneElement	Active or inactive ingredient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
item[x]		1..1	(Slice Definition)	The actual ingredient or content Slice: Unordered, Closed by type:$this
item[x]:itemCodeableConcept		1..1	CodeableConcept	Name of active ingredient
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	Ingredients shall be coded with SNOMED CT Binding: ActivePharmaceuticalIngredient (extensible)
text	Σ	1..1	string	If no code ist available, the text should indicate the ingredient name
isActive		0..1	boolean	Active ingredient indicator
strength		0..1	Ratio	Dose per unit
batch		0..1	BackboneElement	Details about packaged medications
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
lotNumber		0..1	string	Identifier assigned to batch
expirationDate		0..1	dateTime	When batch will expire
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet
Medication.language	preferred	CommonLanguages Max Binding: AllLanguages
Medication.code	example	SNOMEDCTMedicationCodes
Medication.status	required	Medication Status Codes
Medication.form	required	PharmaceuticalDoseFormEDQM
Medication.ingredient.item[x]:itemCodeableConcept.coding	extensible	ActivePharmaceuticalIngredient

Constraints

Id	Path	Details	Requirements
dom-2	Medication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	Medication	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	Medication	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	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Medication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	Medication.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Medication.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Medication.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Medication.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Medication.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.code.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Medication.code.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Medication.code.coding	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.code.coding:GTIN	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.code.coding:GTIN.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Medication.code.coding:GTIN.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Medication.code.coding:GTIN.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.code.coding:GTIN.version	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.code.coding:GTIN.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.code.coding:GTIN.display	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.code.coding:GTIN.userSelected	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.code.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.manufacturer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.form	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.form.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Medication.form.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Medication.form.coding	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.form.coding.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Medication.form.coding.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Medication.form.coding.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.form.coding.version	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.form.coding.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.form.coding.display	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.form.coding.userSelected	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.form.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.amount	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.ingredient	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.ingredient.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Medication.ingredient.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Medication.ingredient.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Medication.ingredient.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Medication.ingredient.item[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.ingredient.item[x]:itemCodeableConcept	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.ingredient.item[x]:itemCodeableConcept.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Medication.ingredient.item[x]:itemCodeableConcept.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Medication.ingredient.item[x]:itemCodeableConcept.coding	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.ingredient.item[x]:itemCodeableConcept.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.ingredient.isActive	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.ingredient.strength	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.batch	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.batch.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Medication.batch.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Medication.batch.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Medication.batch.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Medication.batch.lotNumber	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Medication.batch.expirationDate	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())