SMART Product Catalog, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.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/main and changes regularly. See the Directory of published versions
Logical Model: Product
| Official URL: http://smart.who.int/pcmt/StructureDefinition/Product | Version: 0.2.0 | |||
| Draft as of 2026-02-18 | Computable Name: Product | |||
A Product represents a physical item or set of items which can be held in inventory, ordered, exchanged, dispensed or other utilized within the health system, clinical and supply chain workflows.
Usages:
- Refer to this Logical Model: Product and Product Authorization
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Product |
0..* | Base | Product Instances of this logical model can be the target of a Reference | |
  identifier |
0..* | Identifier | Identifier for the product (e.g. SKUs, GTINs) | |
 name |
1..* | BackboneElement | The name of the product | |
  @id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| nameType |
1..1 | code | The type of name e.g. 'official' or 'user-friendly' Binding: Name Type for a Product (extensible) | |
 value |
1..1 | string | The name of the product | |
| description |
0..1 | string | The description of the product | |
| classification |
0..* | CodeableConcept | A categorization or classification of the product e.g. ICDS-11, ATC, WHODrug or others | |
| status |
1..1 | code | Product status Binding: Status for a Product (extensible) | |
 manufacturer |
0..1 | Reference(mCSD Organization) | Manufacturer | |
| countryOfOrigin |
0..1 | CodeableConcept | The country of origin Binding: http://smart.who.int/refmart/ValueSet/COUNTRYISO3 (example) | |
| shelfLife |
0..1 | SimpleQuantity | The shelf life of the product in days | |
| unitOfUse |
1..1 | CodeableConcept | The unit in which the generic product is used / counted | |
| dosageForm |
0..1 | CodeableConcept | The physical form of the medication Binding: DispensableDrugForm (example) | |
| routeOfAdministration |
0..* | CodeableConcept | The route of administration of the medication Binding: eHDSI Route of Administration  (example) | |
| doseQuantity |
0..1 | SimpleQuantity | The number of doses in this package | |
| strength |
0..1 | SimpleQuantity | The strength of the product e.g. 500 mg | |
| attribute |
0..* | BackboneElement | Attributes or characteristics of the product | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | The attribute type (e.g. a physical dimension) Binding: AttributeType for a Product (extensible) | |
  value[x] |
1..1 | The value of the attribute | ||
 valueString |
string | |||
| valueInteger |
integer | |||
| valueDecimal |
decimal | |||
| valueBoolean |
boolean | |||
| valueUrl |
url | |||
| valueDateTime |
dateTime | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueAnnotation |
Annotation | |||
| valueAddress |
Address | |||
| valueDuration |
Duration | |||
| valueCodeableConcept |
CodeableConcept | |||
| associatedProduct |
0..* | BackboneElement | Association(s) between a product and referenced products. Such relationships could be for packaging, representing duplicates/semantic equivalencies between Products, etc | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| product |
1..1 | Reference(Product) | The generic product characteristics | |
| relationship |
1..* | Coding | Relationship Binding: Product Relationships (extensible) | |
| quantity |
1..1 | Quantity | how many units of use of the generic product are in the product | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Product.name.nameType | Base | extensible | Name Type for a Product | 📦0.2.0 | This IG |
| Product.status | Base | extensible | Status for a Product | 📦0.2.0 | This IG |
| Product.countryOfOrigin | Base | example | http://smart.who.int/refmart/ValueSet/COUNTRYISO3 | Not State | Unknown |
| Product.dosageForm | Base | example | DispensableDrugForm | 📦3.0.0 | THO v7.0 |
| Product.routeOfAdministration | Base | example |
eHDSI Route of Administration
|
⏿8.1.0 | tx.hl7europe.eu |
| Product.attribute.type | Base | extensible | AttributeType for a Product | 📦0.2.0 | This IG |
| Product.associatedProduct.relationship | Base | extensible | Product Relationships | 📦0.2.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
API Information
Product API
A Product represents a physical item or set of items which can be held in inventory, ordered, exchanged, dispensed or other utilized within the health system, clinical and supply chain workflows.
Version: 1.0.0
Endpoints
GET /StructureDefinition-Product.schema.json
JSON Schema definition for the Logical Model StructureDefinition-Product
This endpoint serves the JSON Schema definition for the Logical Model StructureDefinition-Product.
Schema Definition
StructureDefinition-Product
Description: A Product represents a physical item or set of items which can be held in inventory, ordered, exchanged, dispensed or other utilized within the health system, clinical and supply chain workflows.
Type: object
Full Schema (JSON)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "http://smart.who.int/base/StructureDefinition-Product.schema.json",
"title": "Product",
"description": "A Product represents a physical item or set of items which can be held in inventory, ordered, exchanged, dispensed or other utilized within the health system, clinical and supply chain workflows.",
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"const": "Product",
"description": "Resource type identifier for Product logical model"
},
"@context": {
"description": "JSON-LD context for this logical model with ValueSet vocabularies",
"anyOf": [
{
"type": "string",
"format": "uri",
"description": "URI reference to external JSON-LD context"
},
{
"type": "object",
"description": "Inline JSON-LD context",
"properties": {
"@version": {
"type": "number",
"const": 1.1
},
"fhir": {
"type": "string",
"const": "http://hl7.org/fhir/"
}
},
"additionalProperties": {
"type": "string",
"format": "uri"
}
},
{
"type": "array",
"description": "Array of JSON-LD context objects/URIs",
"items": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "object"
}
]
}
}
]
},
"@type": {
"type": "string",
"description": "JSON-LD type identifier for Product logical model",
"examples": [
"LogicalModel-Product"
]
},
"identifier": {
"type": "array",
"items": {
"type": "object"
},
"description": "Identifier for the product (e.g. SKUs, GTINs)"
},
"name": {
"type": "array",
"items": {
"type": "object",
"description": "FHIR BackboneElement"
},
"minItems": 1,
"description": "The name of the product"
},
"id": {
"type": "object",
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."
},
"modifierExtension": {
"type": "array",
"items": {
"type": "object",
"description": "FHIR Extension"
},
"description": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."
},
"nameType": {
"oneOf": [
{
"type": "string",
"description": "Code from ValueSet NameType (plain string)"
},
{
"type": "object",
"description": "Code from ValueSet NameType (JSON-LD structure)",
"properties": {
"@type": {
"type": "string",
"const": "http://smart.who.int/base/ValueSet-NameType.jsonld",
"description": "JSON-LD type reference to ValueSet NameType"
},
"@id": {
"type": "string",
"format": "uri",
"description": "Full IRI of the code from ValueSet NameType"
}
},
"required": [
"@type",
"@id"
],
"additionalProperties": false
}
],
"description": "The type of name e.g. 'official' or 'user-friendly'"
},
"value": {
"type": "string",
"description": "The name of the product"
},
"description": {
"type": "string",
"description": "The description of the product"
},
"classification": {
"type": "array",
"items": {
"type": "object"
},
"description": "A categorization or classification of the product e.g. ICDS-11, ATC, WHODrug or others"
},
"status": {
"oneOf": [
{
"type": "string",
"description": "Code from ValueSet Status (plain string)"
},
{
"type": "object",
"description": "Code from ValueSet Status (JSON-LD structure)",
"properties": {
"@type": {
"type": "string",
"const": "http://smart.who.int/base/ValueSet-Status.jsonld",
"description": "JSON-LD type reference to ValueSet Status"
},
"@id": {
"type": "string",
"format": "uri",
"description": "Full IRI of the code from ValueSet Status"
}
},
"required": [
"@type",
"@id"
],
"additionalProperties": false
}
],
"description": "The status of the product in the catalog e.g. 'active' 'inactive'"
},
"manufacturer": {
"type": "object",
"description": "Manufacturer"
},
"countryOfOrigin": {
"oneOf": [
{
"type": "object",
"description": "FHIR CodeableConcept from ValueSet COUNTRYISO3",
"properties": {
"system": {
"type": "string",
"description": "Code system URI"
},
"code": {
"type": "string",
"description": "Code value"
},
"display": {
"type": "string",
"description": "Human readable display text"
}
},
"required": [
"system",
"code"
]
},
{
"type": "object",
"description": "CodeableConcept from ValueSet COUNTRYISO3 (JSON-LD structure)",
"properties": {
"@type": {
"type": "string",
"const": "http://smart.who.int/base/ValueSet-COUNTRYISO3.jsonld",
"description": "JSON-LD type reference to ValueSet COUNTRYISO3"
},
"@id": {
"type": "string",
"format": "uri",
"description": "Full IRI of the code from ValueSet COUNTRYISO3"
}
},
"required": [
"@type",
"@id"
],
"additionalProperties": false
}
],
"description": "The country of origin"
},
"shelfLife": {
"type": "object",
"description": "The shelf life of the product in days"
},
"unitOfUse": {
"type": "object",
"description": "The unit in which the generic product is used / counted"
},
"dosageForm": {
"oneOf": [
{
"type": "object",
"description": "FHIR CodeableConcept from ValueSet v3-DispensableDrugForm",
"properties": {
"system": {
"type": "string",
"description": "Code system URI"
},
"code": {
"type": "string",
"description": "Code value"
},
"display": {
"type": "string",
"description": "Human readable display text"
}
},
"required": [
"system",
"code"
]
},
{
"type": "object",
"description": "CodeableConcept from ValueSet v3-DispensableDrugForm (JSON-LD structure)",
"properties": {
"@type": {
"type": "string",
"const": "http://smart.who.int/base/ValueSet-v3-DispensableDrugForm.jsonld",
"description": "JSON-LD type reference to ValueSet v3-DispensableDrugForm"
},
"@id": {
"type": "string",
"format": "uri",
"description": "Full IRI of the code from ValueSet v3-DispensableDrugForm"
}
},
"required": [
"@type",
"@id"
],
"additionalProperties": false
}
],
"description": "The physical form of the medication"
},
"routeOfAdministration": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"description": "FHIR CodeableConcept from ValueSet eHDSIRouteofAdministration",
"properties": {
"system": {
"type": "string",
"description": "Code system URI"
},
"code": {
"type": "string",
"description": "Code value"
},
"display": {
"type": "string",
"description": "Human readable display text"
}
},
"required": [
"system",
"code"
]
},
{
"type": "object",
"description": "CodeableConcept from ValueSet eHDSIRouteofAdministration (JSON-LD structure)",
"properties": {
"@type": {
"type": "string",
"const": "http://smart.who.int/base/ValueSet-eHDSIRouteofAdministration.jsonld",
"description": "JSON-LD type reference to ValueSet eHDSIRouteofAdministration"
},
"@id": {
"type": "string",
"format": "uri",
"description": "Full IRI of the code from ValueSet eHDSIRouteofAdministration"
}
},
"required": [
"@type",
"@id"
],
"additionalProperties": false
}
],
"description": "CodeableConcept from ValueSet eHDSIRouteofAdministration. Supports both FHIR Coding structure and JSON-LD structure."
},
"description": "The route of administration of the medication"
},
"doseQuantity": {
"type": "object",
"description": "The number of doses in this package"
},
"strength": {
"type": "object",
"description": "The strength of the product e.g. 500 mg"
},
"attribute": {
"type": "array",
"items": {
"type": "object",
"description": "FHIR BackboneElement"
},
"description": "Attributes or characteristics of the product"
},
"type": {
"oneOf": [
{
"type": "object",
"description": "FHIR CodeableConcept from ValueSet AttributeType",
"properties": {
"system": {
"type": "string",
"description": "Code system URI"
},
"code": {
"type": "string",
"description": "Code value"
},
"display": {
"type": "string",
"description": "Human readable display text"
}
},
"required": [
"system",
"code"
]
},
{
"type": "object",
"description": "CodeableConcept from ValueSet AttributeType (JSON-LD structure)",
"properties": {
"@type": {
"type": "string",
"const": "http://smart.who.int/base/ValueSet-AttributeType.jsonld",
"description": "JSON-LD type reference to ValueSet AttributeType"
},
"@id": {
"type": "string",
"format": "uri",
"description": "Full IRI of the code from ValueSet AttributeType"
}
},
"required": [
"@type",
"@id"
],
"additionalProperties": false
}
],
"description": "The attribute type (e.g. a physical dimension)"
},
"value[x]": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "string",
"format": "uri"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "object"
},
{
"type": "object",
"description": "FHIR Ratio"
},
{
"type": "object",
"description": "FHIR Annotation"
},
{
"type": "object"
},
{
"type": "object",
"description": "FHIR Duration"
},
{
"type": "object"
}
],
"description": "The value of the attribute"
},
"associatedProduct": {
"type": "array",
"items": {
"type": "object",
"description": "FHIR BackboneElement"
},
"description": "Association(s) between a product and referenced products. Such relationships could be for packaging, representing duplicates/semantic equivalencies between Products, etc"
},
"product": {
"type": "object",
"description": "The generic product characteristics"
},
"relationship": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"description": "FHIR Coding from ValueSet ProductRelationship",
"properties": {
"system": {
"type": "string",
"description": "Code system URI"
},
"code": {
"type": "string",
"description": "Code value"
},
"display": {
"type": "string",
"description": "Human readable display text"
}
},
"required": [
"system",
"code"
]
},
{
"type": "object",
"description": "Coding from ValueSet ProductRelationship (JSON-LD structure)",
"properties": {
"@type": {
"type": "string",
"const": "http://smart.who.int/base/ValueSet-ProductRelationship.jsonld",
"description": "JSON-LD type reference to ValueSet ProductRelationship"
},
"@id": {
"type": "string",
"format": "uri",
"description": "Full IRI of the code from ValueSet ProductRelationship"
}
},
"required": [
"@type",
"@id"
],
"additionalProperties": false
}
],
"description": "Coding from ValueSet ProductRelationship. Supports both FHIR Coding structure and JSON-LD structure."
},
"minItems": 1,
"description": "The relationship of the the product to the refereneced product"
},
"quantity": {
"type": "object",
"description": "how many units of use of the generic product are in the product"
}
},
"required": [
"resourceType",
"name",
"nameType",
"value",
"status",
"unitOfUse",
"type",
"value[x]",
"product",
"relationship",
"quantity"
],
"resourceDefinition": "http://smart.who.int/pcmt/StructureDefinition/Product",
"fhir:parent": "http://hl7.org/fhir/StructureDefinition/Base",
"jsonld:valuesets": [
"v3-DispensableDrugForm",
"Status",
"AttributeType",
"COUNTRYISO3",
"eHDSIRouteofAdministration",
"ProductRelationship",
"NameType"
],
"jsonld:contextTemplate": {
"@version": 1.1,
"fhir": "http://hl7.org/fhir/",
"v3-DispensableDrugForm": "http://smart.who.int/base/ValueSet-v3-DispensableDrugForm.jsonld",
"Status": "http://smart.who.int/base/ValueSet-Status.jsonld",
"AttributeType": "http://smart.who.int/base/ValueSet-AttributeType.jsonld",
"COUNTRYISO3": "http://smart.who.int/base/ValueSet-COUNTRYISO3.jsonld",
"eHDSIRouteofAdministration": "http://smart.who.int/base/ValueSet-eHDSIRouteofAdministration.jsonld",
"ProductRelationship": "http://smart.who.int/base/ValueSet-ProductRelationship.jsonld",
"NameType": "http://smart.who.int/base/ValueSet-NameType.jsonld"
}
}
This documentation is automatically generated from the OpenAPI specification.
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Product |
0..* | Base | Product Instances of this logical model can be the target of a Reference | |
| identifier |
0..* | Identifier | Identifier for the product (e.g. SKUs, GTINs) | |
| name |
1..* | BackboneElement | The name of the product | |
| nameType |
1..1 | code | The type of name e.g. 'official' or 'user-friendly' Binding: Name Type for a Product (extensible) | |
| value |
1..1 | string | The name of the product | |
| description |
0..1 | string | The description of the product | |
| classification |
0..* | CodeableConcept | A categorization or classification of the product e.g. ICDS-11, ATC, WHODrug or others | |
| status |
1..1 | code | Product status Binding: Status for a Product (extensible) | |
| manufacturer |
0..1 | Reference(mCSD Organization) | Manufacturer | |
| countryOfOrigin |
0..1 | CodeableConcept | The country of origin Binding: http://smart.who.int/refmart/ValueSet/COUNTRYISO3 (example) | |
| shelfLife |
0..1 | SimpleQuantity | The shelf life of the product in days | |
| unitOfUse |
1..1 | CodeableConcept | The unit in which the generic product is used / counted | |
| dosageForm |
0..1 | CodeableConcept | The physical form of the medication Binding: DispensableDrugForm (example) | |
| routeOfAdministration |
0..* | CodeableConcept | The route of administration of the medication Binding: eHDSI Route of Administration (example) | |
| doseQuantity |
0..1 | SimpleQuantity | The number of doses in this package | |
| strength |
0..1 | SimpleQuantity | The strength of the product e.g. 500 mg | |
| attribute |
0..* | BackboneElement | Attributes or characteristics of the product | |
| type |
1..1 | CodeableConcept | The attribute type (e.g. a physical dimension) Binding: AttributeType for a Product (extensible) | |
| value[x] |
1..1 | The value of the attribute | ||
| valueString |
string | |||
| valueInteger |
integer | |||
| valueDecimal |
decimal | |||
| valueBoolean |
boolean | |||
| valueUrl |
url | |||
| valueDateTime |
dateTime | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueAnnotation |
Annotation | |||
| valueAddress |
Address | |||
| valueDuration |
Duration | |||
| valueCodeableConcept |
CodeableConcept | |||
| associatedProduct |
0..* | BackboneElement | Association(s) between a product and referenced products. Such relationships could be for packaging, representing duplicates/semantic equivalencies between Products, etc | |
| product |
1..1 | Reference(Product) | The generic product characteristics | |
| relationship |
1..* | Coding | Relationship Binding: Product Relationships (extensible) | |
| quantity |
1..1 | Quantity | how many units of use of the generic product are in the product | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Product.name.nameType | Base | extensible | Name Type for a Product | 📦0.2.0 | This IG |
| Product.status | Base | extensible | Status for a Product | 📦0.2.0 | This IG |
| Product.countryOfOrigin | Base | example | http://smart.who.int/refmart/ValueSet/COUNTRYISO3 | Not State | Unknown |
| Product.dosageForm | Base | example | DispensableDrugForm | 📦3.0.0 | THO v7.0 |
| Product.routeOfAdministration | Base | example |
eHDSI Route of Administration
|
⏿8.1.0 | tx.hl7europe.eu |
| Product.attribute.type | Base | extensible | AttributeType for a Product | 📦0.2.0 | This IG |
| Product.associatedProduct.relationship | Base | extensible | Product Relationships | 📦0.2.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Product |
0..* | Base | Product Instances of this logical model can be the target of a Reference | |
| identifier |
0..* | Identifier | Identifier for the product (e.g. SKUs, GTINs) | |
| name |
1..* | BackboneElement | The name of the product | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| nameType |
1..1 | code | The type of name e.g. 'official' or 'user-friendly' Binding: Name Type for a Product (extensible) | |
| value |
1..1 | string | The name of the product | |
| description |
0..1 | string | The description of the product | |
| classification |
0..* | CodeableConcept | A categorization or classification of the product e.g. ICDS-11, ATC, WHODrug or others | |
| status |
1..1 | code | Product status Binding: Status for a Product (extensible) | |
| manufacturer |
0..1 | Reference(mCSD Organization) | Manufacturer | |
| countryOfOrigin |
0..1 | CodeableConcept | The country of origin Binding: http://smart.who.int/refmart/ValueSet/COUNTRYISO3 (example) | |
| shelfLife |
0..1 | SimpleQuantity | The shelf life of the product in days | |
| unitOfUse |
1..1 | CodeableConcept | The unit in which the generic product is used / counted | |
| dosageForm |
0..1 | CodeableConcept | The physical form of the medication Binding: DispensableDrugForm (example) | |
| routeOfAdministration |
0..* | CodeableConcept | The route of administration of the medication Binding: eHDSI Route of Administration (example) | |
| doseQuantity |
0..1 | SimpleQuantity | The number of doses in this package | |
| strength |
0..1 | SimpleQuantity | The strength of the product e.g. 500 mg | |
| attribute |
0..* | BackboneElement | Attributes or characteristics of the product | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | The attribute type (e.g. a physical dimension) Binding: AttributeType for a Product (extensible) | |
| value[x] |
1..1 | The value of the attribute | ||
| valueString |
string | |||
| valueInteger |
integer | |||
| valueDecimal |
decimal | |||
| valueBoolean |
boolean | |||
| valueUrl |
url | |||
| valueDateTime |
dateTime | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueAnnotation |
Annotation | |||
| valueAddress |
Address | |||
| valueDuration |
Duration | |||
| valueCodeableConcept |
CodeableConcept | |||
| associatedProduct |
0..* | BackboneElement | Association(s) between a product and referenced products. Such relationships could be for packaging, representing duplicates/semantic equivalencies between Products, etc | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| product |
1..1 | Reference(Product) | The generic product characteristics | |
| relationship |
1..* | Coding | Relationship Binding: Product Relationships (extensible) | |
| quantity |
1..1 | Quantity | how many units of use of the generic product are in the product | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Product.name.nameType | Base | extensible | Name Type for a Product | 📦0.2.0 | This IG |
| Product.status | Base | extensible | Status for a Product | 📦0.2.0 | This IG |
| Product.countryOfOrigin | Base | example | http://smart.who.int/refmart/ValueSet/COUNTRYISO3 | Not State | Unknown |
| Product.dosageForm | Base | example | DispensableDrugForm | 📦3.0.0 | THO v7.0 |
| Product.routeOfAdministration | Base | example |
eHDSI Route of Administration
|
⏿8.1.0 | tx.hl7europe.eu |
| Product.attribute.type | Base | extensible | AttributeType for a Product | 📦0.2.0 | This IG |
| Product.associatedProduct.relationship | Base | extensible | Product Relationships | 📦0.2.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Base
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Product |
0..* | Base | Product Instances of this logical model can be the target of a Reference | |
| identifier |
0..* | Identifier | Identifier for the product (e.g. SKUs, GTINs) | |
| name |
1..* | BackboneElement | The name of the product | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| nameType |
1..1 | code | The type of name e.g. 'official' or 'user-friendly' Binding: Name Type for a Product (extensible) | |
| value |
1..1 | string | The name of the product | |
| description |
0..1 | string | The description of the product | |
| classification |
0..* | CodeableConcept | A categorization or classification of the product e.g. ICDS-11, ATC, WHODrug or others | |
| status |
1..1 | code | Product status Binding: Status for a Product (extensible) | |
| manufacturer |
0..1 | Reference(mCSD Organization) | Manufacturer | |
| countryOfOrigin |
0..1 | CodeableConcept | The country of origin Binding: http://smart.who.int/refmart/ValueSet/COUNTRYISO3 (example) | |
| shelfLife |
0..1 | SimpleQuantity | The shelf life of the product in days | |
| unitOfUse |
1..1 | CodeableConcept | The unit in which the generic product is used / counted | |
| dosageForm |
0..1 | CodeableConcept | The physical form of the medication Binding: DispensableDrugForm (example) | |
| routeOfAdministration |
0..* | CodeableConcept | The route of administration of the medication Binding: eHDSI Route of Administration (example) | |
| doseQuantity |
0..1 | SimpleQuantity | The number of doses in this package | |
| strength |
0..1 | SimpleQuantity | The strength of the product e.g. 500 mg | |
| attribute |
0..* | BackboneElement | Attributes or characteristics of the product | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | The attribute type (e.g. a physical dimension) Binding: AttributeType for a Product (extensible) | |
| value[x] |
1..1 | The value of the attribute | ||
| valueString |
string | |||
| valueInteger |
integer | |||
| valueDecimal |
decimal | |||
| valueBoolean |
boolean | |||
| valueUrl |
url | |||
| valueDateTime |
dateTime | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueAnnotation |
Annotation | |||
| valueAddress |
Address | |||
| valueDuration |
Duration | |||
| valueCodeableConcept |
CodeableConcept | |||
| associatedProduct |
0..* | BackboneElement | Association(s) between a product and referenced products. Such relationships could be for packaging, representing duplicates/semantic equivalencies between Products, etc | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| product |
1..1 | Reference(Product) | The generic product characteristics | |
| relationship |
1..* | Coding | Relationship Binding: Product Relationships (extensible) | |
| quantity |
1..1 | Quantity | how many units of use of the generic product are in the product | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Product.name.nameType | Base | extensible | Name Type for a Product | 📦0.2.0 | This IG |
| Product.status | Base | extensible | Status for a Product | 📦0.2.0 | This IG |
| Product.countryOfOrigin | Base | example | http://smart.who.int/refmart/ValueSet/COUNTRYISO3 | Not State | Unknown |
| Product.dosageForm | Base | example | DispensableDrugForm | 📦3.0.0 | THO v7.0 |
| Product.routeOfAdministration | Base | example |
eHDSI Route of Administration
|
⏿8.1.0 | tx.hl7europe.eu |
| Product.attribute.type | Base | extensible | AttributeType for a Product | 📦0.2.0 | This IG |
| Product.associatedProduct.relationship | Base | extensible | Product Relationships | 📦0.2.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Product |
0..* | Base | Product Instances of this logical model can be the target of a Reference | |
| identifier |
0..* | Identifier | Identifier for the product (e.g. SKUs, GTINs) | |
| name |
1..* | BackboneElement | The name of the product | |
| nameType |
1..1 | code | The type of name e.g. 'official' or 'user-friendly' Binding: Name Type for a Product (extensible) | |
| value |
1..1 | string | The name of the product | |
| description |
0..1 | string | The description of the product | |
| classification |
0..* | CodeableConcept | A categorization or classification of the product e.g. ICDS-11, ATC, WHODrug or others | |
| status |
1..1 | code | Product status Binding: Status for a Product (extensible) | |
| manufacturer |
0..1 | Reference(mCSD Organization) | Manufacturer | |
| countryOfOrigin |
0..1 | CodeableConcept | The country of origin Binding: http://smart.who.int/refmart/ValueSet/COUNTRYISO3 (example) | |
| shelfLife |
0..1 | SimpleQuantity | The shelf life of the product in days | |
| unitOfUse |
1..1 | CodeableConcept | The unit in which the generic product is used / counted | |
| dosageForm |
0..1 | CodeableConcept | The physical form of the medication Binding: DispensableDrugForm (example) | |
| routeOfAdministration |
0..* | CodeableConcept | The route of administration of the medication Binding: eHDSI Route of Administration (example) | |
| doseQuantity |
0..1 | SimpleQuantity | The number of doses in this package | |
| strength |
0..1 | SimpleQuantity | The strength of the product e.g. 500 mg | |
| attribute |
0..* | BackboneElement | Attributes or characteristics of the product | |
| type |
1..1 | CodeableConcept | The attribute type (e.g. a physical dimension) Binding: AttributeType for a Product (extensible) | |
| value[x] |
1..1 | The value of the attribute | ||
| valueString |
string | |||
| valueInteger |
integer | |||
| valueDecimal |
decimal | |||
| valueBoolean |
boolean | |||
| valueUrl |
url | |||
| valueDateTime |
dateTime | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueAnnotation |
Annotation | |||
| valueAddress |
Address | |||
| valueDuration |
Duration | |||
| valueCodeableConcept |
CodeableConcept | |||
| associatedProduct |
0..* | BackboneElement | Association(s) between a product and referenced products. Such relationships could be for packaging, representing duplicates/semantic equivalencies between Products, etc | |
| product |
1..1 | Reference(Product) | The generic product characteristics | |
| relationship |
1..* | Coding | Relationship Binding: Product Relationships (extensible) | |
| quantity |
1..1 | Quantity | how many units of use of the generic product are in the product | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Product.name.nameType | Base | extensible | Name Type for a Product | 📦0.2.0 | This IG |
| Product.status | Base | extensible | Status for a Product | 📦0.2.0 | This IG |
| Product.countryOfOrigin | Base | example | http://smart.who.int/refmart/ValueSet/COUNTRYISO3 | Not State | Unknown |
| Product.dosageForm | Base | example | DispensableDrugForm | 📦3.0.0 | THO v7.0 |
| Product.routeOfAdministration | Base | example |
eHDSI Route of Administration
|
⏿8.1.0 | tx.hl7europe.eu |
| Product.attribute.type | Base | extensible | AttributeType for a Product | 📦0.2.0 | This IG |
| Product.associatedProduct.relationship | Base | extensible | Product Relationships | 📦0.2.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Product |
0..* | Base | Product Instances of this logical model can be the target of a Reference | |
| identifier |
0..* | Identifier | Identifier for the product (e.g. SKUs, GTINs) | |
| name |
1..* | BackboneElement | The name of the product | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| nameType |
1..1 | code | The type of name e.g. 'official' or 'user-friendly' Binding: Name Type for a Product (extensible) | |
| value |
1..1 | string | The name of the product | |
| description |
0..1 | string | The description of the product | |
| classification |
0..* | CodeableConcept | A categorization or classification of the product e.g. ICDS-11, ATC, WHODrug or others | |
| status |
1..1 | code | Product status Binding: Status for a Product (extensible) | |
| manufacturer |
0..1 | Reference(mCSD Organization) | Manufacturer | |
| countryOfOrigin |
0..1 | CodeableConcept | The country of origin Binding: http://smart.who.int/refmart/ValueSet/COUNTRYISO3 (example) | |
| shelfLife |
0..1 | SimpleQuantity | The shelf life of the product in days | |
| unitOfUse |
1..1 | CodeableConcept | The unit in which the generic product is used / counted | |
| dosageForm |
0..1 | CodeableConcept | The physical form of the medication Binding: DispensableDrugForm (example) | |
| routeOfAdministration |
0..* | CodeableConcept | The route of administration of the medication Binding: eHDSI Route of Administration (example) | |
| doseQuantity |
0..1 | SimpleQuantity | The number of doses in this package | |
| strength |
0..1 | SimpleQuantity | The strength of the product e.g. 500 mg | |
| attribute |
0..* | BackboneElement | Attributes or characteristics of the product | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | The attribute type (e.g. a physical dimension) Binding: AttributeType for a Product (extensible) | |
| value[x] |
1..1 | The value of the attribute | ||
| valueString |
string | |||
| valueInteger |
integer | |||
| valueDecimal |
decimal | |||
| valueBoolean |
boolean | |||
| valueUrl |
url | |||
| valueDateTime |
dateTime | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueAnnotation |
Annotation | |||
| valueAddress |
Address | |||
| valueDuration |
Duration | |||
| valueCodeableConcept |
CodeableConcept | |||
| associatedProduct |
0..* | BackboneElement | Association(s) between a product and referenced products. Such relationships could be for packaging, representing duplicates/semantic equivalencies between Products, etc | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| product |
1..1 | Reference(Product) | The generic product characteristics | |
| relationship |
1..* | Coding | Relationship Binding: Product Relationships (extensible) | |
| quantity |
1..1 | Quantity | how many units of use of the generic product are in the product | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Product.name.nameType | Base | extensible | Name Type for a Product | 📦0.2.0 | This IG |
| Product.status | Base | extensible | Status for a Product | 📦0.2.0 | This IG |
| Product.countryOfOrigin | Base | example | http://smart.who.int/refmart/ValueSet/COUNTRYISO3 | Not State | Unknown |
| Product.dosageForm | Base | example | DispensableDrugForm | 📦3.0.0 | THO v7.0 |
| Product.routeOfAdministration | Base | example |
eHDSI Route of Administration
|
⏿8.1.0 | tx.hl7europe.eu |
| Product.attribute.type | Base | extensible | AttributeType for a Product | 📦0.2.0 | This IG |
| Product.associatedProduct.relationship | Base | extensible | Product Relationships | 📦0.2.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Base