International Patient Summary Implementation Guide
2.0.0 - STU 2
International Patient Summary Implementation Guide
2.0.0 - STU 2
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 2.0.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
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips | Version: 2.0.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.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  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
| |||||||||||||||
| 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. | |||||||||||||||
| form |
SO | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medicine Doseform - IPS (preferred)
| |||||||||||||||
 ingredient |
SO | 0..* | BackboneElement | Active or inactive ingredient
| |||||||||||||||
 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
| ||||||||||||||||
 itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | ||||||||||||||||||
  itemReference |
Reference(Substance | Medication) | ||||||||||||||||||
| strength |
SO | 0..1 | Ratio | Quantity of ingredient present
| |||||||||||||||
| Documentation for this format | |||||||||||||||||||
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | MedicationsUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ipsFrom this IG | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1From the FHIR Standard | |
| Medication.form | preferred | MedicineDoseFormUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-doseformFrom this IG | |
| Medication.ingredient.item[x] | preferred | MedicineActiveSubstancesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ipsFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
| ||||||||||||
| form |
SO | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medicine Doseform - IPS (preferred)
| ||||||||||||
 ingredient |
SO | 0..* | BackboneElement | Active or inactive ingredient
| ||||||||||||
| item[x] |
SO | 1..1 | The actual ingredient or content Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
| |||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||
| itemReference |
Reference(Substance | Medication) | |||||||||||||||
| strength |
SO | 0..1 | Ratio | Quantity of ingredient present
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | MedicationsUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ipsFrom this IG | |
| Medication.form | preferred | MedicineDoseFormUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-doseformFrom this IG | |
| Medication.ingredient.item[x] | preferred | MedicineActiveSubstancesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ipsFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 | |||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||
| 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
| |||||||||||||||
| 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: Medicine Doseform - IPS (preferred)
| |||||||||||||||
| amount |
Σ | 0..1 | Ratio | Amount of drug in package | |||||||||||||||
| ingredient |
SO | 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] |
SO | 1..1 | The actual ingredient or content Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
| ||||||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | ||||||||||||||||||
| itemReference |
Reference(Substance | Medication) | ||||||||||||||||||
| isActive |
0..1 | boolean | Active ingredient indicator | ||||||||||||||||
| strength |
SO | 0..1 | Ratio | Quantity of ingredient present
| |||||||||||||||
| 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 | |||||||||||||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Medication.code | preferred | MedicationsUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ipsFrom this IG | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1From the FHIR Standard | ||||
| Medication.form | preferred | MedicineDoseFormUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-doseformFrom this IG | ||||
| Medication.ingredient.item[x] | preferred | MedicineActiveSubstancesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ipsFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
| |||||||||||||||
| 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. | |||||||||||||||
| form |
SO | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medicine Doseform - IPS (preferred)
| |||||||||||||||
| ingredient |
SO | 0..* | BackboneElement | Active or inactive ingredient
| |||||||||||||||
| 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
| ||||||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | ||||||||||||||||||
| itemReference |
Reference(Substance | Medication) | ||||||||||||||||||
| strength |
SO | 0..1 | Ratio | Quantity of ingredient present
| |||||||||||||||
| Documentation for this format | |||||||||||||||||||
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | MedicationsUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ipsFrom this IG | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1From the FHIR Standard | |
| Medication.form | preferred | MedicineDoseFormUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-doseformFrom this IG | |
| Medication.ingredient.item[x] | preferred | MedicineActiveSubstancesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ipsFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
| ||||||||||||
| form |
SO | 0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medicine Doseform - IPS (preferred)
| ||||||||||||
| ingredient |
SO | 0..* | BackboneElement | Active or inactive ingredient
| ||||||||||||
| item[x] |
SO | 1..1 | The actual ingredient or content Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
| |||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||
| itemReference |
Reference(Substance | Medication) | |||||||||||||||
| strength |
SO | 0..1 | Ratio | Quantity of ingredient present
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | MedicationsUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ipsFrom this IG | |
| Medication.form | preferred | MedicineDoseFormUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-doseformFrom this IG | |
| Medication.ingredient.item[x] | preferred | MedicineActiveSubstancesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ipsFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 | |||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||
| 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
| |||||||||||||||
| 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: Medicine Doseform - IPS (preferred)
| |||||||||||||||
| amount |
Σ | 0..1 | Ratio | Amount of drug in package | |||||||||||||||
| ingredient |
SO | 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] |
SO | 1..1 | The actual ingredient or content Binding: Medicine Active Substances - IPS (preferred): SNOMED CT drug substances
| ||||||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | ||||||||||||||||||
| itemReference |
Reference(Substance | Medication) | ||||||||||||||||||
| isActive |
0..1 | boolean | Active ingredient indicator | ||||||||||||||||
| strength |
SO | 0..1 | Ratio | Quantity of ingredient present
| |||||||||||||||
| 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 | |||||||||||||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Medication.code | preferred | MedicationsUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ipsFrom this IG | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1From the FHIR Standard | ||||
| Medication.form | preferred | MedicineDoseFormUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-doseformFrom this IG | ||||
| Medication.ingredient.item[x] | preferred | MedicineActiveSubstancesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-active-substances-uv-ipsFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Patient Care. Package hl7.fhir.uv.ips#2.0.0 based on FHIR 4.0.1. Generated 2025-06-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change