International Patient Summary Implementation Guide
2.0.0 - STU 2 International flag

This page is part of the International Patient Summary Implementation Guide (v2.0.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Medication (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips Version: 2.0.0
Standards status: Trial-use Maturity Level: 3 Computable Name: MedicationIPS

This profile represents the constraints applied to the Medication resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A medication is described in the patient summary as an instance of a Medication resource constrained by this profile.

This profile constrains the representation of a medication, in the context of the international patient summary as specified by the IPS project of HL7 International.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SOΣ 1..1 CodeableConceptIPS Medication that was administered or was to be administered (medication code from any code system)
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Additional BindingsPurpose
WHO ATC - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... form SO 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
Additional BindingsPurpose
Medicine EDQM Doseform - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... ingredient SO 0..* BackboneElement Active or inactive ingredient
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] SO 1..1 The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... strength SO 0..1 Ratio Quantity of ingredient present
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.code Base preferred Medications - IPS 📦2.0.0 This IG
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base preferred SNOMED CT Form Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​item[x] Base preferred Medicine Active Substances - IPS 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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 error 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 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication 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()

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... code SO 1..1 CodeableConceptIPS Medication that was administered or was to be administered (medication code from any code system)
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Additional BindingsPurpose
WHO ATC - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... form SO 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
Additional BindingsPurpose
Medicine EDQM Doseform - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... ingredient SO 0..* BackboneElement Active or inactive ingredient
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... item[x] SO 1..1 The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... strength SO 0..1 Ratio Quantity of ingredient present
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.code Base preferred Medications - IPS 📦2.0.0 This IG
Medication.form Base preferred SNOMED CT Form Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​item[x] Base preferred Medicine Active Substances - IPS 📦2.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 SOΣ 1..1 CodeableConceptIPS Medication that was administered or was to be administered (medication code from any code system)
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Additional BindingsPurpose
WHO ATC - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... 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 SO 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
Additional BindingsPurpose
Medicine EDQM Doseform - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient SO 0..* BackboneElement Active or inactive ingredient
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... 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] SO 1..1 The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength SO 0..1 Ratio Quantity of ingredient present
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Medication.code Base preferred Medications - IPS 📦2.0.0 This IG
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base preferred SNOMED CT Form Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​item[x] Base preferred Medicine Active Substances - IPS 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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 error 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 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication 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()

This structure is derived from Medication

Summary

Mandatory: 1 element
Must-Support: 5 elements

Structures

This structure refers to these other structures:

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SOΣ 1..1 CodeableConceptIPS Medication that was administered or was to be administered (medication code from any code system)
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Additional BindingsPurpose
WHO ATC - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... form SO 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
Additional BindingsPurpose
Medicine EDQM Doseform - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... ingredient SO 0..* BackboneElement Active or inactive ingredient
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] SO 1..1 The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... strength SO 0..1 Ratio Quantity of ingredient present
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.code Base preferred Medications - IPS 📦2.0.0 This IG
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base preferred SNOMED CT Form Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​item[x] Base preferred Medicine Active Substances - IPS 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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 error 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 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication 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()

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... code SO 1..1 CodeableConceptIPS Medication that was administered or was to be administered (medication code from any code system)
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Additional BindingsPurpose
WHO ATC - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... form SO 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
Additional BindingsPurpose
Medicine EDQM Doseform - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... ingredient SO 0..* BackboneElement Active or inactive ingredient
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... item[x] SO 1..1 The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... strength SO 0..1 Ratio Quantity of ingredient present
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.code Base preferred Medications - IPS 📦2.0.0 This IG
Medication.form Base preferred SNOMED CT Form Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​item[x] Base preferred Medicine Active Substances - IPS 📦2.0.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 SOΣ 1..1 CodeableConceptIPS Medication that was administered or was to be administered (medication code from any code system)
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Additional BindingsPurpose
WHO ATC - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... 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 SO 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (preferred): SNOMED Doseform Terms
Additional BindingsPurpose
Medicine EDQM Doseform - IPS candidate
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient SO 0..* BackboneElement Active or inactive ingredient
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
.... 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] SO 1..1 The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength SO 0..1 Ratio Quantity of ingredient present
ObligationsActor
SHALL:populate-if-known Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Medication.code Base preferred Medications - IPS 📦2.0.0 This IG
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base preferred SNOMED CT Form Codes 📦4.0.1 FHIR Std.
Medication.ingredient.​item[x] Base preferred Medicine Active Substances - IPS 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error 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 error 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 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication 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()

This structure is derived from Medication

Summary

Mandatory: 1 element
Must-Support: 5 elements

Structures

This structure refers to these other structures:

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron