IHE Pharmacy Medication Overview
0.1.0 - ci-build
IHE Pharmacy Medication Overview, published by Integrating the Healthcare Enterprise (IHE). This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/pharm-meow/ and changes regularly. See the Directory of published versions
Active as of 2024-06-16 |
Definitions for the MedicinalProductLM logical model.
Guidance on how to interpret the contents of this table can be found here
0. MedicinalProductLM | |
Definition | Logical model for prescribed/dispensed medication. The model is shared by statements, requests, dispensations, and treatment lines. Each of those may have different restrictions in FHIR profile. |
Short | Medicinal product (model) |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. MedicinalProductLM.identifier | |
Definition | The identifier(s) of the product, independently of the level of product. If several identifiers are specified, they shall not have conflicting meanings. |
Short | The identifier(s) of the product, independently of the level of product. If several identifiers are specified, they shall not have conflicting meanings. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | BackboneElement(Class) |
4. MedicinalProductLM.identifier.medicinalProductIdentifier | |
Definition | Identifier at the product level - can be MPID or national identifier |
Short | Identifier at the product level - can be MPID or national identifier |
Control | 0..* |
Type | Element(II) |
6. MedicinalProductLM.identifier.packagedProductIdentifier | |
Definition | Identifier at the package level - can be PCID or national |
Short | Identifier at the package level - can be PCID or national |
Control | 0..* |
Type | Element(II) |
8. MedicinalProductLM.identifier.pharmaceuticalProductIdentifier | |
Definition | Identifier at the virtual or administrable product level - can be PhPID or national virtual/administrable product code |
Short | Identifier at the virtual or administrable product level - can be PhPID or national virtual/administrable product code |
Control | 0..* |
Type | Element(II) |
10. MedicinalProductLM.productCode | |
Definition | Code for the product that is actually being specified, in established terminologies |
Short | Code for the product that is actually being specified, in established terminologies |
Control | 0..1 |
Type | Element(CD) |
12. MedicinalProductLM.classification | |
Definition | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) |
Short | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) |
Control | 0..* |
Type | Element(CD) |
14. MedicinalProductLM.packSize | |
Definition | Overall amount of product in one package (100ml; 20 tablets; 1 creme & 6 pessaries) |
Short | Overall amount of product in one package (100ml; 20 tablets; 1 creme & 6 pessaries) |
Control | 0..* |
Type | Element(PQ) |
16. MedicinalProductLM.productName | |
Definition | Name of the product (full name, invented name, other) |
Short | Name of the product (full name, invented name, other) |
Control | 0..* |
Type | BackboneElement(Class) |
18. MedicinalProductLM.productName.name | |
Definition | Name of type and language that is relevant for the users |
Short | Name of type and language that is relevant for the users |
Control | 1..1 |
Type | Element(ST) |
20. MedicinalProductLM.productName.language | |
Definition | Language of the name |
Short | Language of the name |
Control | 0..1 |
Type | Element(CD) |
22. MedicinalProductLM.productName.type | |
Definition | Type of the name (full name, common name, etc) |
Short | Type of the name (full name, common name, etc) |
Control | 0..1 |
Type | Element(CD) |
24. MedicinalProductLM.doseForm | |
Definition | Dose form(s) on a product level. Dose form for a single package item is defined below. |
Short | Dose form(s) on a product level. Dose form for a single package item is defined below. |
Control | 0..1 |
Type | Element(CD) |
26. MedicinalProductLM.item | |
Definition | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined |
Short | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined |
Control | 0..* |
Type | BackboneElement(Class) |
28. MedicinalProductLM.item.doseForm | |
Definition | Dose form |
Short | Dose form |
Control | 0..1 |
Type | Element(CD) |
30. MedicinalProductLM.item.ingredient | |
Definition | Ingredients |
Short | Ingredients |
Control | 1..* |
Type | BackboneElement(Class) |
32. MedicinalProductLM.item.ingredient.role | |
Definition | Role (active ingredient, excipient). Typically excipients are not needed, so by default active ingredients are expected. |
Short | Role (active ingredient, excipient). Typically excipients are not needed, so by default active ingredients are expected. |
Control | 0..1 |
Type | Element(CD) |
34. MedicinalProductLM.item.ingredient.substance | |
Definition | Substance |
Short | Substance |
Control | 1..1 |
Type | Element(CD) |
36. MedicinalProductLM.item.ingredient.strengthInfo | |
Definition | Concentration or presentation strength |
Short | Concentration or presentation strength |
Control | 0..* |
Type | BackboneElement(Class) |
38. MedicinalProductLM.item.ingredient.strengthInfo.strength | |
Definition | Concentration or presentation strength of the precise active ingredient |
Short | Concentration or presentation strength of the precise active ingredient |
Control | 1..1 |
Type | Element(RTO) |
40. MedicinalProductLM.item.ingredient.strengthInfo.strengthType | |
Definition | Type of strength that is expressed |
Short | Type of strength that is expressed |
Control | 0..1 |
Type | Element(CD) |
42. MedicinalProductLM.item.ingredient.strengthInfo.strengthSubstance | |
Definition | Substance that the strength refers to, if different from the main substance |
Short | Substance that the strength refers to, if different from the main substance |
Control | 0..1 |
Type | Element(CD) |
44. MedicinalProductLM.item.unitOfPresentation | |
Definition | Unit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package. |
Short | Unit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package. |
Control | 0..1 |
Type | Element(CD) |
46. MedicinalProductLM.item.containedQuantity | |
Definition | Manufactured item quantity for liquids (3ml/vial) |
Short | Manufactured item quantity for liquids (3ml/vial) |
Control | 0..1 |
Type | Element(PQ) |
48. MedicinalProductLM.item.amount | |
Definition | Number of such manufactured items in this product (5 vials) |
Short | Number of such manufactured items in this product (5 vials) |
Control | 0..1 |
Type | Element(PQ) |
50. MedicinalProductLM.device | |
Definition | Administration device included in the product |
Short | Administration device included in the product |
Control | 0..* |
Type | BackboneElement(Class) |
52. MedicinalProductLM.device.deviceQuantity | |
Definition | Number of such devices |
Short | Number of such devices |
Control | 1..1 |
Type | Element(PQ) |
54. MedicinalProductLM.device.device | |
Definition | Device coded |
Short | Device coded |
Control | 1..1 |
Type | Element(CD) |
Guidance on how to interpret the contents of this table can be found here
0. MedicinalProductLM | |
Definition | Logical model for prescribed/dispensed medication. The model is shared by statements, requests, dispensations, and treatment lines. Each of those may have different restrictions in FHIR profile. Base definition for all types defined in FHIR type system. |
Short | Medicinal product (model)Base for all types and resources |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. MedicinalProductLM.identifier | |
Definition | The identifier(s) of the product, independently of the level of product. If several identifiers are specified, they shall not have conflicting meanings. |
Short | The identifier(s) of the product, independently of the level of product. If several identifiers are specified, they shall not have conflicting meanings. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
4. MedicinalProductLM.identifier.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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()) |
6. MedicinalProductLM.identifier.medicinalProductIdentifier | |
Definition | Identifier at the product level - can be MPID or national identifier |
Short | Identifier at the product level - can be MPID or national identifier |
Control | 0..* |
Type | Element(II) |
8. MedicinalProductLM.identifier.packagedProductIdentifier | |
Definition | Identifier at the package level - can be PCID or national |
Short | Identifier at the package level - can be PCID or national |
Control | 0..* |
Type | Element(II) |
10. MedicinalProductLM.identifier.pharmaceuticalProductIdentifier | |
Definition | Identifier at the virtual or administrable product level - can be PhPID or national virtual/administrable product code |
Short | Identifier at the virtual or administrable product level - can be PhPID or national virtual/administrable product code |
Control | 0..* |
Type | Element(II) |
12. MedicinalProductLM.productCode | |
Definition | Code for the product that is actually being specified, in established terminologies |
Short | Code for the product that is actually being specified, in established terminologies |
Control | 0..1 |
Type | Element(CD) |
14. MedicinalProductLM.classification | |
Definition | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) |
Short | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) |
Control | 0..* |
Type | Element(CD) |
16. MedicinalProductLM.packSize | |
Definition | Overall amount of product in one package (100ml; 20 tablets; 1 creme & 6 pessaries) |
Short | Overall amount of product in one package (100ml; 20 tablets; 1 creme & 6 pessaries) |
Control | 0..* |
Type | Element(PQ) |
18. MedicinalProductLM.productName | |
Definition | Name of the product (full name, invented name, other) |
Short | Name of the product (full name, invented name, other) |
Control | 0..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. MedicinalProductLM.productName.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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()) |
22. MedicinalProductLM.productName.name | |
Definition | Name of type and language that is relevant for the users |
Short | Name of type and language that is relevant for the users |
Control | 1..1 |
Type | Element(ST) |
24. MedicinalProductLM.productName.language | |
Definition | Language of the name |
Short | Language of the name |
Control | 0..1 |
Type | Element(CD) |
26. MedicinalProductLM.productName.type | |
Definition | Type of the name (full name, common name, etc) |
Short | Type of the name (full name, common name, etc) |
Control | 0..1 |
Type | Element(CD) |
28. MedicinalProductLM.doseForm | |
Definition | Dose form(s) on a product level. Dose form for a single package item is defined below. |
Short | Dose form(s) on a product level. Dose form for a single package item is defined below. |
Control | 0..1 |
Type | Element(CD) |
30. MedicinalProductLM.item | |
Definition | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined |
Short | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined |
Control | 0..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
32. MedicinalProductLM.item.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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()) |
34. MedicinalProductLM.item.doseForm | |
Definition | Dose form |
Short | Dose form |
Control | 0..1 |
Type | Element(CD) |
36. MedicinalProductLM.item.ingredient | |
Definition | Ingredients |
Short | Ingredients |
Control | 1..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
38. MedicinalProductLM.item.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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()) |
40. MedicinalProductLM.item.ingredient.role | |
Definition | Role (active ingredient, excipient). Typically excipients are not needed, so by default active ingredients are expected. |
Short | Role (active ingredient, excipient). Typically excipients are not needed, so by default active ingredients are expected. |
Control | 0..1 |
Type | Element(CD) |
42. MedicinalProductLM.item.ingredient.substance | |
Definition | Substance |
Short | Substance |
Control | 1..1 |
Type | Element(CD) |
44. MedicinalProductLM.item.ingredient.strengthInfo | |
Definition | Concentration or presentation strength |
Short | Concentration or presentation strength |
Control | 0..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
46. MedicinalProductLM.item.ingredient.strengthInfo.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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()) |
48. MedicinalProductLM.item.ingredient.strengthInfo.strength | |
Definition | Concentration or presentation strength of the precise active ingredient |
Short | Concentration or presentation strength of the precise active ingredient |
Control | 1..1 |
Type | Element(RTO) |
50. MedicinalProductLM.item.ingredient.strengthInfo.strengthType | |
Definition | Type of strength that is expressed |
Short | Type of strength that is expressed |
Control | 0..1 |
Type | Element(CD) |
52. MedicinalProductLM.item.ingredient.strengthInfo.strengthSubstance | |
Definition | Substance that the strength refers to, if different from the main substance |
Short | Substance that the strength refers to, if different from the main substance |
Control | 0..1 |
Type | Element(CD) |
54. MedicinalProductLM.item.unitOfPresentation | |
Definition | Unit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package. |
Short | Unit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package. |
Control | 0..1 |
Type | Element(CD) |
56. MedicinalProductLM.item.containedQuantity | |
Definition | Manufactured item quantity for liquids (3ml/vial) |
Short | Manufactured item quantity for liquids (3ml/vial) |
Control | 0..1 |
Type | Element(PQ) |
58. MedicinalProductLM.item.amount | |
Definition | Number of such manufactured items in this product (5 vials) |
Short | Number of such manufactured items in this product (5 vials) |
Control | 0..1 |
Type | Element(PQ) |
60. MedicinalProductLM.device | |
Definition | Administration device included in the product |
Short | Administration device included in the product |
Control | 0..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
62. MedicinalProductLM.device.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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()) |
64. MedicinalProductLM.device.deviceQuantity | |
Definition | Number of such devices |
Short | Number of such devices |
Control | 1..1 |
Type | Element(PQ) |
66. MedicinalProductLM.device.device | |
Definition | Device coded |
Short | Device coded |
Control | 1..1 |
Type | Element(CD) |
Guidance on how to interpret the contents of this table can be found here
0. MedicinalProductLM | |
Definition | Logical model for prescribed/dispensed medication. The model is shared by statements, requests, dispensations, and treatment lines. Each of those may have different restrictions in FHIR profile. |
Short | Medicinal product (model) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. MedicinalProductLM.identifier | |
Definition | The identifier(s) of the product, independently of the level of product. If several identifiers are specified, they shall not have conflicting meanings. |
Short | The identifier(s) of the product, independently of the level of product. If several identifiers are specified, they shall not have conflicting meanings. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
4. MedicinalProductLM.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
6. MedicinalProductLM.identifier.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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on MedicinalProductLM.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. MedicinalProductLM.identifier.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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. MedicinalProductLM.identifier.medicinalProductIdentifier | |
Definition | Identifier at the product level - can be MPID or national identifier |
Short | Identifier at the product level - can be MPID or national identifier |
Control | 0..* |
Type | Element(II) |
12. MedicinalProductLM.identifier.packagedProductIdentifier | |
Definition | Identifier at the package level - can be PCID or national |
Short | Identifier at the package level - can be PCID or national |
Control | 0..* |
Type | Element(II) |
14. MedicinalProductLM.identifier.pharmaceuticalProductIdentifier | |
Definition | Identifier at the virtual or administrable product level - can be PhPID or national virtual/administrable product code |
Short | Identifier at the virtual or administrable product level - can be PhPID or national virtual/administrable product code |
Control | 0..* |
Type | Element(II) |
16. MedicinalProductLM.productCode | |
Definition | Code for the product that is actually being specified, in established terminologies |
Short | Code for the product that is actually being specified, in established terminologies |
Control | 0..1 |
Type | Element(CD) |
18. MedicinalProductLM.classification | |
Definition | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) |
Short | Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.) |
Control | 0..* |
Type | Element(CD) |
20. MedicinalProductLM.packSize | |
Definition | Overall amount of product in one package (100ml; 20 tablets; 1 creme & 6 pessaries) |
Short | Overall amount of product in one package (100ml; 20 tablets; 1 creme & 6 pessaries) |
Control | 0..* |
Type | Element(PQ) |
22. MedicinalProductLM.productName | |
Definition | Name of the product (full name, invented name, other) |
Short | Name of the product (full name, invented name, other) |
Control | 0..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. MedicinalProductLM.productName.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
26. MedicinalProductLM.productName.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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on MedicinalProductLM.productName.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
28. MedicinalProductLM.productName.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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() ) |
30. MedicinalProductLM.productName.name | |
Definition | Name of type and language that is relevant for the users |
Short | Name of type and language that is relevant for the users |
Control | 1..1 |
Type | Element(ST) |
32. MedicinalProductLM.productName.language | |
Definition | Language of the name |
Short | Language of the name |
Control | 0..1 |
Type | Element(CD) |
34. MedicinalProductLM.productName.type | |
Definition | Type of the name (full name, common name, etc) |
Short | Type of the name (full name, common name, etc) |
Control | 0..1 |
Type | Element(CD) |
36. MedicinalProductLM.doseForm | |
Definition | Dose form(s) on a product level. Dose form for a single package item is defined below. |
Short | Dose form(s) on a product level. Dose form for a single package item is defined below. |
Control | 0..1 |
Type | Element(CD) |
38. MedicinalProductLM.item | |
Definition | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined |
Short | A medication item. For combination packs, this can be manufactured items with each item having its own dose form and ingredients+strengths defined |
Control | 0..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
40. MedicinalProductLM.item.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
42. MedicinalProductLM.item.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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on MedicinalProductLM.item.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
44. MedicinalProductLM.item.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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() ) |
46. MedicinalProductLM.item.doseForm | |
Definition | Dose form |
Short | Dose form |
Control | 0..1 |
Type | Element(CD) |
48. MedicinalProductLM.item.ingredient | |
Definition | Ingredients |
Short | Ingredients |
Control | 1..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
50. MedicinalProductLM.item.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
52. MedicinalProductLM.item.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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on MedicinalProductLM.item.ingredient.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
54. MedicinalProductLM.item.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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() ) |
56. MedicinalProductLM.item.ingredient.role | |
Definition | Role (active ingredient, excipient). Typically excipients are not needed, so by default active ingredients are expected. |
Short | Role (active ingredient, excipient). Typically excipients are not needed, so by default active ingredients are expected. |
Control | 0..1 |
Type | Element(CD) |
58. MedicinalProductLM.item.ingredient.substance | |
Definition | Substance |
Short | Substance |
Control | 1..1 |
Type | Element(CD) |
60. MedicinalProductLM.item.ingredient.strengthInfo | |
Definition | Concentration or presentation strength |
Short | Concentration or presentation strength |
Control | 0..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
62. MedicinalProductLM.item.ingredient.strengthInfo.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
64. MedicinalProductLM.item.ingredient.strengthInfo.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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on MedicinalProductLM.item.ingredient.strengthInfo.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
66. MedicinalProductLM.item.ingredient.strengthInfo.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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() ) |
68. MedicinalProductLM.item.ingredient.strengthInfo.strength | |
Definition | Concentration or presentation strength of the precise active ingredient |
Short | Concentration or presentation strength of the precise active ingredient |
Control | 1..1 |
Type | Element(RTO) |
70. MedicinalProductLM.item.ingredient.strengthInfo.strengthType | |
Definition | Type of strength that is expressed |
Short | Type of strength that is expressed |
Control | 0..1 |
Type | Element(CD) |
72. MedicinalProductLM.item.ingredient.strengthInfo.strengthSubstance | |
Definition | Substance that the strength refers to, if different from the main substance |
Short | Substance that the strength refers to, if different from the main substance |
Control | 0..1 |
Type | Element(CD) |
74. MedicinalProductLM.item.unitOfPresentation | |
Definition | Unit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package. |
Short | Unit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package. |
Control | 0..1 |
Type | Element(CD) |
76. MedicinalProductLM.item.containedQuantity | |
Definition | Manufactured item quantity for liquids (3ml/vial) |
Short | Manufactured item quantity for liquids (3ml/vial) |
Control | 0..1 |
Type | Element(PQ) |
78. MedicinalProductLM.item.amount | |
Definition | Number of such manufactured items in this product (5 vials) |
Short | Number of such manufactured items in this product (5 vials) |
Control | 0..1 |
Type | Element(PQ) |
80. MedicinalProductLM.device | |
Definition | Administration device included in the product |
Short | Administration device included in the product |
Control | 0..* |
Type | BackboneElement(Class) |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
82. MedicinalProductLM.device.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
84. MedicinalProductLM.device.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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on MedicinalProductLM.device.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
86. MedicinalProductLM.device.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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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() ) |
88. MedicinalProductLM.device.deviceQuantity | |
Definition | Number of such devices |
Short | Number of such devices |
Control | 1..1 |
Type | Element(PQ) |
90. MedicinalProductLM.device.device | |
Definition | Device coded |
Short | Device coded |
Control | 1..1 |
Type | Element(CD) |