International Patient Summary Implementation Guide
1.1.0 - CI Build International flag

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions

Resource Profile: Medication (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips Version: 1.1.0
Standards status: Trial-use Maturity Level: 2 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.

Usage:

Formal Views of Profile Content

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

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... code S1..1CodeableConceptIPSMedication that was administered or was to be administered (medication code from any code system)
Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication

Additional BindingsPurpose
Medications - SNOMED CT IPS Free Setcandidate
WHO ATC - IPScandidate
Absent or Unknown Medication - IPScandidate
... form S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Doseform - IPS (preferred)
... ingredient S0..*BackboneElementActive or inactive ingredient
.... item[x] S1..1The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances

..... itemCodeableConceptCodeableConcept(CodeableConceptIPS)
..... itemReferenceReference(Substance | Medication)
.... strength S0..1RatioIPSA ratio of two Quantity values - a numerator and a denominator

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.codepreferredMedicationSnomedCodesAbsentUnknown
Additional Bindings Purpose Documentation
Medications - SNOMED CT IPS Free Set candidate

SNOMED medication terms available in IPS Free Set

WHO ATC - IPS candidate

WHO ATC classification

Absent or Unknown Medication - IPS candidate

Codes for absent or unknown medication

http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
from this IG
Medication.formpreferredMedicineDoseFormUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform
from this IG
Medication.ingredient.item[x]preferredMedicineActiveSubstancesUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code S1..1CodeableConceptIPSMedication that was administered or was to be administered (medication code from any code system)
Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication

Additional BindingsPurpose
Medications - SNOMED CT IPS Free Setcandidate
WHO ATC - IPScandidate
Absent or Unknown Medication - IPScandidate
... form S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Doseform - IPS (preferred)
... ingredient S0..*BackboneElementActive or inactive ingredient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] S1..1The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances

..... itemCodeableConceptCodeableConcept(CodeableConceptIPS)
..... itemReferenceReference(Substance | Medication)
.... strength SC0..1RatioIPSA ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codepreferredMedicationSnomedCodesAbsentUnknown
Additional Bindings Purpose Documentation
Medications - SNOMED CT IPS Free Set candidate

SNOMED medication terms available in IPS Free Set

WHO ATC - IPS candidate

WHO ATC classification

Absent or Unknown Medication - IPS candidate

Codes for absent or unknown medication

http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
from this IG
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formpreferredMedicineDoseFormUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform
from this IG
Medication.ingredient.item[x]preferredMedicineActiveSubstancesUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1idLogical 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 S1..1CodeableConceptIPSMedication that was administered or was to be administered (medication code from any code system)
Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication

Additional BindingsPurpose
Medications - SNOMED CT IPS Free Setcandidate
WHO ATC - IPScandidate
Absent or Unknown Medication - IPScandidate
... 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 S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Doseform - IPS (preferred)
... amount Σ0..1RatioAmount of drug in package
... ingredient S0..*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
.... item[x] S1..1The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances

..... itemCodeableConceptCodeableConcept(CodeableConceptIPS)
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength SC0..1RatioIPSA ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... 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

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codepreferredMedicationSnomedCodesAbsentUnknown
Additional Bindings Purpose Documentation
Medications - SNOMED CT IPS Free Set candidate

SNOMED medication terms available in IPS Free Set

WHO ATC - IPS candidate

WHO ATC classification

Absent or Unknown Medication - IPS candidate

Codes for absent or unknown medication

http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
from this IG
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formpreferredMedicineDoseFormUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform
from this IG
Medication.ingredient.item[x]preferredMedicineActiveSubstancesUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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())

This structure is derived from Medication

Summary

Mandatory: 1 element
Must-Support: 5 elements

Structures

This structure refers to these other structures:

Maturity: 2

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... code S1..1CodeableConceptIPSMedication that was administered or was to be administered (medication code from any code system)
Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication

Additional BindingsPurpose
Medications - SNOMED CT IPS Free Setcandidate
WHO ATC - IPScandidate
Absent or Unknown Medication - IPScandidate
... form S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Doseform - IPS (preferred)
... ingredient S0..*BackboneElementActive or inactive ingredient
.... item[x] S1..1The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances

..... itemCodeableConceptCodeableConcept(CodeableConceptIPS)
..... itemReferenceReference(Substance | Medication)
.... strength S0..1RatioIPSA ratio of two Quantity values - a numerator and a denominator

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.codepreferredMedicationSnomedCodesAbsentUnknown
Additional Bindings Purpose Documentation
Medications - SNOMED CT IPS Free Set candidate

SNOMED medication terms available in IPS Free Set

WHO ATC - IPS candidate

WHO ATC classification

Absent or Unknown Medication - IPS candidate

Codes for absent or unknown medication

http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
from this IG
Medication.formpreferredMedicineDoseFormUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform
from this IG
Medication.ingredient.item[x]preferredMedicineActiveSubstancesUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code S1..1CodeableConceptIPSMedication that was administered or was to be administered (medication code from any code system)
Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication

Additional BindingsPurpose
Medications - SNOMED CT IPS Free Setcandidate
WHO ATC - IPScandidate
Absent or Unknown Medication - IPScandidate
... form S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Doseform - IPS (preferred)
... ingredient S0..*BackboneElementActive or inactive ingredient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] S1..1The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances

..... itemCodeableConceptCodeableConcept(CodeableConceptIPS)
..... itemReferenceReference(Substance | Medication)
.... strength SC0..1RatioIPSA ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codepreferredMedicationSnomedCodesAbsentUnknown
Additional Bindings Purpose Documentation
Medications - SNOMED CT IPS Free Set candidate

SNOMED medication terms available in IPS Free Set

WHO ATC - IPS candidate

WHO ATC classification

Absent or Unknown Medication - IPS candidate

Codes for absent or unknown medication

http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
from this IG
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formpreferredMedicineDoseFormUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform
from this IG
Medication.ingredient.item[x]preferredMedicineActiveSubstancesUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1idLogical 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 S1..1CodeableConceptIPSMedication that was administered or was to be administered (medication code from any code system)
Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication

Additional BindingsPurpose
Medications - SNOMED CT IPS Free Setcandidate
WHO ATC - IPScandidate
Absent or Unknown Medication - IPScandidate
... 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 S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Doseform - IPS (preferred)
... amount Σ0..1RatioAmount of drug in package
... ingredient S0..*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
.... item[x] S1..1The actual ingredient or content
Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances

..... itemCodeableConceptCodeableConcept(CodeableConceptIPS)
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength SC0..1RatioIPSA ratio of two Quantity values - a numerator and a denominator
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... 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

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codepreferredMedicationSnomedCodesAbsentUnknown
Additional Bindings Purpose Documentation
Medications - SNOMED CT IPS Free Set candidate

SNOMED medication terms available in IPS Free Set

WHO ATC - IPS candidate

WHO ATC classification

Absent or Unknown Medication - IPS candidate

Codes for absent or unknown medication

http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips
from this IG
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formpreferredMedicineDoseFormUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform
from this IG
Medication.ingredient.item[x]preferredMedicineActiveSubstancesUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ips
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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())

This structure is derived from Medication

Summary

Mandatory: 1 element
Must-Support: 5 elements

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron