SMART Product Catalog
0.1.0 - ci-build
SMART Product Catalog, published by WHO. 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/WorldHealthOrganization/smart-pcmt/tree/draft-logical-model and changes regularly. See the Directory of published versions
| Draft as of 2025-01-28 |
Definitions for the GenericProductModel logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. GenericProductModel | |
| Definition | Generic Product Base definition for all types defined in FHIR type system. |
| Short | Generic ProductBase 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. GenericProductModel.identifier | |
| Definition | Identifier for the generic product |
| Short | Identifier for the generic product |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. GenericProductModel.status | |
| Definition | The status of the product in the catalog e.g. 'active' 'inactive' |
| Short | Product status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. GenericProductModel.productName | |
| Definition | The product Name(s) |
| Short | The product Name(s) |
| Control | 1..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. GenericProductModel.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 | idstring |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 10. GenericProductModel.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 GenericProductModel.productName.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. GenericProductModel.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()) |
| 14. GenericProductModel.productName.nameType | |
| Definition | The type of name e.g. 'official' or 'user-friendly' |
| Short | The type of name e.g. 'official' or 'user-friendly' |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. GenericProductModel.productName.name | |
| Definition | The name of the product |
| Short | The name of the product |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. GenericProductModel.description | |
| Definition | The description of the product |
| Short | The description of the product |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. GenericProductModel.classification | |
| Definition | A categorization or classification of the product e.g. ATC or others |
| Short | A categorization or classification of the product e.g. ATC or others |
| Control | 0..* |
| Type | CodeableConcept |
| 22. GenericProductModel.dosageForm | |
| Definition | The physical form of the medication |
| Short | The physical form of the medication |
| Control | 0..1 |
| Type | CodeableConcept |
| 24. GenericProductModel.routeOfAdministration | |
| Definition | The route of administration of the medication |
| Short | The route of administration of the medication |
| Control | 0..* |
| Type | CodeableConcept |
Guidance on how to interpret the contents of this table can be found here
| 0. GenericProductModel | |
| Definition | Generic Product |
| Short | Generic Product |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. GenericProductModel.identifier | |
| Definition | Identifier for the generic product |
| Short | Identifier for the generic product |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. GenericProductModel.status | |
| Definition | The status of the product in the catalog e.g. 'active' 'inactive' |
| Short | Product status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. GenericProductModel.productName | |
| Definition | The product Name(s) |
| Short | The product Name(s) |
| Control | 1..* |
| Type | BackboneElement |
| 8. GenericProductModel.productName.nameType | |
| Definition | The type of name e.g. 'official' or 'user-friendly' |
| Short | The type of name e.g. 'official' or 'user-friendly' |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. GenericProductModel.productName.name | |
| Definition | The name of the product |
| Short | The name of the product |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. GenericProductModel.description | |
| Definition | The description of the product |
| Short | The description of the product |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. GenericProductModel.classification | |
| Definition | A categorization or classification of the product e.g. ATC or others |
| Short | A categorization or classification of the product e.g. ATC or others |
| Control | 0..* |
| Type | CodeableConcept |
| 16. GenericProductModel.dosageForm | |
| Definition | The physical form of the medication |
| Short | The physical form of the medication |
| Control | 0..1 |
| Type | CodeableConcept |
| 18. GenericProductModel.routeOfAdministration | |
| Definition | The route of administration of the medication |
| Short | The route of administration of the medication |
| Control | 0..* |
| Type | CodeableConcept |
Guidance on how to interpret the contents of this table can be found here
| 0. GenericProductModel | |
| Definition | Generic Product |
| Short | Generic Product |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. GenericProductModel.identifier | |
| Definition | Identifier for the generic product |
| Short | Identifier for the generic product |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. GenericProductModel.status | |
| Definition | The status of the product in the catalog e.g. 'active' 'inactive' |
| Short | Product status |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. GenericProductModel.productName | |
| Definition | The product Name(s) |
| Short | The product Name(s) |
| Control | 1..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. GenericProductModel.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 |
| 10. GenericProductModel.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 GenericProductModel.productName.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. GenericProductModel.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()) |
| 14. GenericProductModel.productName.nameType | |
| Definition | The type of name e.g. 'official' or 'user-friendly' |
| Short | The type of name e.g. 'official' or 'user-friendly' |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. GenericProductModel.productName.name | |
| Definition | The name of the product |
| Short | The name of the product |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. GenericProductModel.description | |
| Definition | The description of the product |
| Short | The description of the product |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. GenericProductModel.classification | |
| Definition | A categorization or classification of the product e.g. ATC or others |
| Short | A categorization or classification of the product e.g. ATC or others |
| Control | 0..* |
| Type | CodeableConcept |
| 22. GenericProductModel.dosageForm | |
| Definition | The physical form of the medication |
| Short | The physical form of the medication |
| Control | 0..1 |
| Type | CodeableConcept |
| 24. GenericProductModel.routeOfAdministration | |
| Definition | The route of administration of the medication |
| Short | The route of administration of the medication |
| Control | 0..* |
| Type | CodeableConcept |