This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Page standards status: Trial-use | Maturity Level: 2 |
Definitions for the Medication-uv-ips resource profile.
1. Medication | |||||||||||||
Comments | IPS Medication | ||||||||||||
2. Medication.code | |||||||||||||
Definition | Medication that was administered or was to be administered. Several kinds of medication coding could be provided as:
The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available. A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. | ||||||||||||
Control | 10..1 | ||||||||||||
Binding | The codes SHOULD be taken from Medications - SNOMED CT + Absent/Unknown (IPS)For example codes, see SNOMEDCTMedicationCodes SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication A coded concept that defines the type of a medication.
| ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Must Support | true | ||||||||||||
3. Medication.form | |||||||||||||
Definition | Describes the form of the item. Powder; tablets; capsule. Administrable Pharmaceutical Dose Form. This code represents the form of the medication (e.g. tablet, capsule, liquid) Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected as referecne terminology for representing Pharmaceutical Dose forms;Pakages and Route of Administration. It is known that also alternative jurisdictional and international terminologies are known to be used for this concept domain, as NCI or SNOMED CT. | ||||||||||||
Binding | The codes SHOULD be taken from Medicine Doseform - IPSFor example codes, see SNOMEDCTFormCodes | ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Must Support | true | ||||||||||||
4. Medication.ingredient | |||||||||||||
Must Support | true | ||||||||||||
5. Medication.ingredient.item[x] | |||||||||||||
Binding | The codes SHOULD be taken from Medicine Active Substances - IPSFor codes, see (unbound) SNOMED CT drug substance | ||||||||||||
Type | Choice of: (CodeableConceptIPS), (Substance|Medication)) | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Must Support | true | ||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||||||||
Comments | The IDMP ISO 11238 standard addresses the identification and exchange of regulated information on substances. The Global Ingredient Archival System (GInAS) will provide a common global identifier for all of the substances used in medicinal products, providing a definition of substances globally consistent with this standard. Those identifiers however are yet available for concrete usage, therefore in this version of the template, SNOMED CT has been chosen as reference terminology also for the active substances. This choice will be revised based on the availability and the maturity of GInAS. | ||||||||||||
6. Medication.ingredient.strength | |||||||||||||
Type | Ratio(RatioIPS) | ||||||||||||
Must Support | true |
1. Medication | |||||||||||||
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. | ||||||||||||
Control | 0..* | ||||||||||||
Comments | IPS Medication | ||||||||||||
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) | ||||||||||||
2. Medication.implicitRules | |||||||||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | uri | ||||||||||||
Is Modifier | true | ||||||||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
3. Medication.modifierExtension | |||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
4. Medication.code | |||||||||||||
Definition | Medication that was administered or was to be administered. Several kinds of medication coding could be provided as:
The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available. A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. | ||||||||||||
Control | 10..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Binding | The codes SHOULD be taken from Medications - SNOMED CT + Absent/Unknown (IPS)For example codes, see SNOMEDCTMedicationCodes SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication A coded concept that defines the type of a medication.
| ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Must Support | true | ||||||||||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
5. Medication.status | |||||||||||||
Definition | A code to indicate if the medication is in active use. | ||||||||||||
Control | 0..1 | ||||||||||||
Binding | The codes SHALL be taken from Medication Status Codes A coded concept defining if the medication is in active use. | ||||||||||||
Type | code | ||||||||||||
Is Modifier | true | ||||||||||||
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
6. Medication.form | |||||||||||||
Definition | Describes the form of the item. Powder; tablets; capsule. Administrable Pharmaceutical Dose Form. This code represents the form of the medication (e.g. tablet, capsule, liquid) Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected as referecne terminology for representing Pharmaceutical Dose forms;Pakages and Route of Administration. It is known that also alternative jurisdictional and international terminologies are known to be used for this concept domain, as NCI or SNOMED CT. | ||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Binding | The codes SHOULD be taken from Medicine Doseform - IPSFor example codes, see SNOMEDCTFormCodes | ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Must Support | true | ||||||||||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
7. Medication.ingredient | |||||||||||||
Definition | Identifies a particular constituent of interest in the product. | ||||||||||||
Control | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Must Support | true | ||||||||||||
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
8. Medication.ingredient.modifierExtension | |||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
9. Medication.ingredient.item[x] | |||||||||||||
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. | ||||||||||||
Control | 1..1 | ||||||||||||
Binding | The codes SHOULD be taken from Medicine Active Substances - IPSFor codes, see (unbound) SNOMED CT drug substance | ||||||||||||
Type | Choice of: CodeableConcept(CodeableConceptIPS), Reference(Substance|Medication)) | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Must Support | true | ||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||||||||
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). | ||||||||||||
Comments | The IDMP ISO 11238 standard addresses the identification and exchange of regulated information on substances. The Global Ingredient Archival System (GInAS) will provide a common global identifier for all of the substances used in medicinal products, providing a definition of substances globally consistent with this standard. Those identifiers however are yet available for concrete usage, therefore in this version of the template, SNOMED CT has been chosen as reference terminology also for the active substances. This choice will be revised based on the availability and the maturity of GInAS. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
10. Medication.ingredient.strength | |||||||||||||
Definition | A relationship of two Quantity values - expressed as a numerator and a denominator. Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. | ||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Type | Ratio(RatioIPS) | ||||||||||||
Must Support | true | ||||||||||||
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) rat-1: Numerator 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())) |
1. Medication | |||||||||||||
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. | ||||||||||||
Control | 0..* | ||||||||||||
Comments | IPS Medication | ||||||||||||
2. Medication.id | |||||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | id | ||||||||||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||||||||||
3. Medication.meta | |||||||||||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Meta | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
4. Medication.implicitRules | |||||||||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | uri | ||||||||||||
Is Modifier | true | ||||||||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
5. Medication.language | |||||||||||||
Definition | The base language in which the resource is written. | ||||||||||||
Control | 0..1 | ||||||||||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||||||||||
Type | code | ||||||||||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
6. Medication.text | |||||||||||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Narrative | ||||||||||||
Alternate Names | narrativehtmlxhtmldisplay | ||||||||||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
7. Medication.contained | |||||||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Resource | ||||||||||||
Alternate Names | inline resourcesanonymous resourcescontained resources | ||||||||||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||||||||||
8. Medication.extension | |||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
9. Medication.modifierExtension | |||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
10. Medication.identifier | |||||||||||||
Definition | Business identifier for this medication. | ||||||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||
Control | 0..* | ||||||||||||
Type | Identifier | ||||||||||||
Comments | The serial number could be included as an identifier. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
11. Medication.code | |||||||||||||
Definition | Medication that was administered or was to be administered. Several kinds of medication coding could be provided as:
The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available. | ||||||||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Binding | The codes SHOULD be taken from Medications - SNOMED CT + Absent/Unknown (IPS)
SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medicatio
| ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Must Support | true | ||||||||||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
12. Medication.status | |||||||||||||
Definition | A code to indicate if the medication is in active use. | ||||||||||||
Control | 0..1 | ||||||||||||
Binding | The codes SHALL be taken from Medication Status Codes A coded concept defining if the medication is in active use | ||||||||||||
Type | code | ||||||||||||
Is Modifier | true | ||||||||||||
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
13. Medication.manufacturer | |||||||||||||
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Organization)) | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
14. Medication.form | |||||||||||||
Definition | Describes the form of the item. Powder; tablets; capsule. Administrable Pharmaceutical Dose Form. This code represents the form of the medication (e.g. tablet, capsule, liquid) Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected as referecne terminology for representing Pharmaceutical Dose forms;Pakages and Route of Administration. It is known that also alternative jurisdictional and international terminologies are known to be used for this concept domain, as NCI or SNOMED CT. | ||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Binding | The codes SHOULD be taken from Medicine Doseform - IPS | ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Must Support | true | ||||||||||||
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
15. Medication.amount | |||||||||||||
Definition | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Ratio | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
16. Medication.ingredient | |||||||||||||
Definition | Identifies a particular constituent of interest in the product. | ||||||||||||
Control | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Must Support | true | ||||||||||||
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
17. Medication.ingredient.id | |||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||||||||||
18. Medication.ingredient.extension | |||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
19. Medication.ingredient.modifierExtension | |||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensionsuser contentmodifiers | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
20. Medication.ingredient.item[x] | |||||||||||||
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. | ||||||||||||
Control | 1..1 | ||||||||||||
Binding | The codes SHOULD be taken from Medicine Active Substances - IPS SNOMED CT drug substance | ||||||||||||
Type | Choice of: CodeableConcept(CodeableConceptIPS), Reference(SubstanceMedication)) | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Must Support | true | ||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||||||||
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). | ||||||||||||
Comments | The IDMP ISO 11238 standard addresses the identification and exchange of regulated information on substances. The Global Ingredient Archival System (GInAS) will provide a common global identifier for all of the substances used in medicinal products, providing a definition of substances globally consistent with this standard. Those identifiers however are yet available for concrete usage, therefore in this version of the template, SNOMED CT has been chosen as reference terminology also for the active substances. This choice will be revised based on the availability and the maturity of GInAS. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
21. Medication.ingredient.isActive | |||||||||||||
Definition | Indication of whether this ingredient affects the therapeutic action of the drug. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive). | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
22. Medication.ingredient.strength | |||||||||||||
Definition | A relationship of two Quantity values - expressed as a numerator and a denominator. | ||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Type | Ratio(RatioIPS) | ||||||||||||
Must Support | true | ||||||||||||
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) rat-1: Numerator 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())) | ||||||||||||
23. Medication.batch | |||||||||||||
Definition | Information that only applies to packages (not products). | ||||||||||||
Control | 0..1 | ||||||||||||
Type | BackboneElement | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
24. Medication.batch.id | |||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||||||||||
25. Medication.batch.extension | |||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
26. Medication.batch.modifierExtension | |||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensionsuser contentmodifiers | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
27. Medication.batch.lotNumber | |||||||||||||
Definition | The assigned lot number of a batch of the specified product. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
28. Medication.batch.expirationDate | |||||||||||||
Definition | When this specific batch of product will expire. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |