| Package | smart.who.int.pcmt |
| Type | StructureDefinition |
| Id | Product |
| FHIR Version | R4 |
| Source | http://smart.who.int/pcmt/https://build.fhir.org/ig/WorldHealthOrganization/smart-pcmt/StructureDefinition-Product.html |
| URL | http://smart.who.int/pcmt/StructureDefinition/Product |
| Version | 0.2.0 |
| Status | draft |
| Date | 2025-07-01T08:14:20+00:00 |
| Name | Product |
| Title | Product |
| Authority | who |
| 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 | http://smart.who.int/pcmt/StructureDefinition/Product |
| Kind | logical |
| StructureDefinition | |
| Product | Product |
| ProductAuthorization | Product Authorization |
| PreQualDBwithIds | WHO Vaccine PreQual DB with IDs |
| StructureDefinition | |
| Product | Product |
| IHE.mCSD.Organization | mCSD Organization |
| ValueSet | |
| AttributeType | AttributeType for a Product |
| NameType | Name Type for a Product |
| ProductRelationship | Product Relationships |
| Status | Status for a Product |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition Product
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 | |
| 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 | |
| routeOfAdministration | 0..* | CodeableConcept | The route of administration of the medication | |
| 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 characterisitics of the product | |
| type | 1..1 | CodeableConcept | The attribute type (e.g. a physcial 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 | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "Product",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
}
],
"url": "http://smart.who.int/pcmt/StructureDefinition/Product",
"version": "0.2.0",
"name": "Product",
"title": "Product",
"status": "draft",
"date": "2025-07-01T08:14:20+00:00",
"publisher": "WHO",
"contact": [
{
"name": "WHO",
"telecom": [
{
"system": "url",
"value": "http://who.int"
}
]
}
],
"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.",
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://smart.who.int/pcmt/StructureDefinition/Product",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "Product",
"path": "Product",
"short": "Product",
"definition": "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.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "Product.identifier",
"path": "Product.identifier",
"short": "Identifier for the product (e.g. SKUs, GTINs)",
"definition": "Identifier for the product (e.g. SKUs, GTINs)",
"min": 0,
"max": "*",
"base": {
"path": "Product.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "Product.name",
"path": "Product.name",
"short": "The name of the product",
"definition": "The name of the product",
"min": 1,
"max": "*",
"base": {
"path": "Product.name",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "Product.name.id",
"path": "Product.name.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Product.name.extension",
"path": "Product.name.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Product.name.modifierExtension",
"path": "Product.name.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Product.name.nameType",
"path": "Product.name.nameType",
"short": "The type of name e.g. 'official' or 'user-friendly'",
"definition": "The type of name e.g. 'official' or 'user-friendly'",
"min": 1,
"max": "1",
"base": {
"path": "Product.name.nameType",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://smart.who.int/pcmt/ValueSet/NameType"
}
},
{
"id": "Product.name.value",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Product.name.value",
"short": "The name of the product",
"definition": "The name of the product",
"min": 1,
"max": "1",
"base": {
"path": "Product.name.value",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Product.description",
"path": "Product.description",
"short": "The description of the product",
"definition": "The description of the product",
"min": 0,
"max": "1",
"base": {
"path": "Product.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Product.classification",
"path": "Product.classification",
"short": "A categorization or classification of the product e.g. ICDS-11, ATC, WHODrug or others",
"definition": "A categorization or classification of the product e.g. ICDS-11, ATC, WHODrug or others",
"min": 0,
"max": "*",
"base": {
"path": "Product.classification",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.status",
"path": "Product.status",
"short": "Product status",
"definition": "The status of the product in the catalog e.g. 'active' 'inactive'",
"min": 1,
"max": "1",
"base": {
"path": "Product.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://smart.who.int/pcmt/ValueSet/Status"
}
},
{
"id": "Product.manufacturer",
"path": "Product.manufacturer",
"short": "Manufacturer",
"definition": "Manufacturer",
"min": 0,
"max": "1",
"base": {
"path": "Product.manufacturer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Organization"
]
}
]
},
{
"id": "Product.countryOfOrigin",
"path": "Product.countryOfOrigin",
"short": "The country of origin",
"definition": "The country of origin",
"min": 0,
"max": "1",
"base": {
"path": "Product.countryOfOrigin",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.shelfLife",
"path": "Product.shelfLife",
"short": "The shelf life of the product in days",
"definition": "The shelf life of the product in days",
"min": 0,
"max": "1",
"base": {
"path": "Product.shelfLife",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
]
},
{
"id": "Product.unitOfUse",
"path": "Product.unitOfUse",
"short": "The unit in which the generic product is used / counted",
"definition": "The unit in which the generic product is used / counted",
"min": 1,
"max": "1",
"base": {
"path": "Product.unitOfUse",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.dosageForm",
"path": "Product.dosageForm",
"short": "The physical form of the medication",
"definition": "The physical form of the medication",
"min": 0,
"max": "1",
"base": {
"path": "Product.dosageForm",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.routeOfAdministration",
"path": "Product.routeOfAdministration",
"short": "The route of administration of the medication",
"definition": "The route of administration of the medication",
"min": 0,
"max": "*",
"base": {
"path": "Product.routeOfAdministration",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.doseQuantity",
"path": "Product.doseQuantity",
"short": "The number of doses in this package",
"definition": "The number of doses in this package",
"min": 0,
"max": "1",
"base": {
"path": "Product.doseQuantity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
]
},
{
"id": "Product.strength",
"path": "Product.strength",
"short": "The strength of the product e.g. 500 mg",
"definition": "The strength of the product e.g. 500 mg",
"min": 0,
"max": "1",
"base": {
"path": "Product.strength",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
]
},
{
"id": "Product.attribute",
"path": "Product.attribute",
"short": "Attributes or characterisitics of the product",
"definition": "Attributes or characterisitics of the product",
"min": 0,
"max": "*",
"base": {
"path": "Product.attribute",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "Product.attribute.id",
"path": "Product.attribute.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Product.attribute.extension",
"path": "Product.attribute.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Product.attribute.modifierExtension",
"path": "Product.attribute.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Product.attribute.type",
"path": "Product.attribute.type",
"short": "The attribute type (e.g. a physcial dimension)",
"definition": "The attribute type (e.g. a physcial dimension)",
"min": 1,
"max": "1",
"base": {
"path": "Product.attribute.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://smart.who.int/pcmt/ValueSet/AttributeType"
}
},
{
"id": "Product.attribute.value[x]",
"path": "Product.attribute.value[x]",
"short": "The value of the attribute",
"definition": "The value of the attribute",
"min": 1,
"max": "1",
"base": {
"path": "Product.attribute.value[x]",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
},
{
"code": "integer"
},
{
"code": "decimal"
},
{
"code": "boolean"
},
{
"code": "url"
},
{
"code": "dateTime"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Annotation"
},
{
"code": "Address"
},
{
"code": "Duration"
},
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.associatedProduct",
"path": "Product.associatedProduct",
"short": "Association(s) between a product and referenced products. Such relationships could be for packaging, representing duplicates/semantic equivalencies between Products, etc",
"definition": "Association(s) between a product and referenced products. Such relationships could be for packaging, representing duplicates/semantic equivalencies between Products, etc",
"min": 0,
"max": "*",
"base": {
"path": "Product.associatedProduct",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "Product.associatedProduct.id",
"path": "Product.associatedProduct.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Product.associatedProduct.extension",
"path": "Product.associatedProduct.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Product.associatedProduct.modifierExtension",
"path": "Product.associatedProduct.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Product.associatedProduct.product",
"path": "Product.associatedProduct.product",
"short": "The generic product characteristics",
"definition": "The generic product characteristics",
"min": 1,
"max": "1",
"base": {
"path": "Product.associatedProduct.product",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://smart.who.int/pcmt/StructureDefinition/Product"
]
}
]
},
{
"id": "Product.associatedProduct.relationship",
"path": "Product.associatedProduct.relationship",
"short": "Relationship",
"definition": "The relationship of the the product to the refereneced product",
"min": 1,
"max": "*",
"base": {
"path": "Product.associatedProduct.relationship",
"min": 1,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://smart.who.int/pcmt/ValueSet/ProductRelationship"
}
},
{
"id": "Product.associatedProduct.quantity",
"path": "Product.associatedProduct.quantity",
"short": "how many units of use of the generic product are in the product",
"definition": "how many units of use of the generic product are in the product",
"min": 1,
"max": "1",
"base": {
"path": "Product.associatedProduct.quantity",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Quantity"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Product",
"path": "Product",
"short": "Product",
"definition": "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."
},
{
"id": "Product.identifier",
"path": "Product.identifier",
"short": "Identifier for the product (e.g. SKUs, GTINs)",
"definition": "Identifier for the product (e.g. SKUs, GTINs)",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "Product.name",
"path": "Product.name",
"short": "The name of the product",
"definition": "The name of the product",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "Product.name.nameType",
"path": "Product.name.nameType",
"short": "The type of name e.g. 'official' or 'user-friendly'",
"definition": "The type of name e.g. 'official' or 'user-friendly'",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://smart.who.int/pcmt/ValueSet/NameType"
}
},
{
"id": "Product.name.value",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Product.name.value",
"short": "The name of the product",
"definition": "The name of the product",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Product.description",
"path": "Product.description",
"short": "The description of the product",
"definition": "The description of the product",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Product.classification",
"path": "Product.classification",
"short": "A categorization or classification of the product e.g. ICDS-11, ATC, WHODrug or others",
"definition": "A categorization or classification of the product e.g. ICDS-11, ATC, WHODrug or others",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.status",
"path": "Product.status",
"short": "Product status",
"definition": "The status of the product in the catalog e.g. 'active' 'inactive' ",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://smart.who.int/pcmt/ValueSet/Status"
}
},
{
"id": "Product.manufacturer",
"path": "Product.manufacturer",
"short": "Manufacturer",
"definition": "Manufacturer",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Organization"
]
}
]
},
{
"id": "Product.countryOfOrigin",
"path": "Product.countryOfOrigin",
"short": "The country of origin",
"definition": "The country of origin",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.shelfLife",
"path": "Product.shelfLife",
"short": "The shelf life of the product in days",
"definition": "The shelf life of the product in days",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
]
},
{
"id": "Product.unitOfUse",
"path": "Product.unitOfUse",
"short": "The unit in which the generic product is used / counted",
"definition": "The unit in which the generic product is used / counted",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.dosageForm",
"path": "Product.dosageForm",
"short": "The physical form of the medication",
"definition": "The physical form of the medication",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.routeOfAdministration",
"path": "Product.routeOfAdministration",
"short": "The route of administration of the medication",
"definition": "The route of administration of the medication",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.doseQuantity",
"path": "Product.doseQuantity",
"short": "The number of doses in this package",
"definition": "The number of doses in this package",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
]
},
{
"id": "Product.strength",
"path": "Product.strength",
"short": "The strength of the product e.g. 500 mg",
"definition": "The strength of the product e.g. 500 mg",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
]
},
{
"id": "Product.attribute",
"path": "Product.attribute",
"short": "Attributes or characterisitics of the product",
"definition": "Attributes or characterisitics of the product",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "Product.attribute.type",
"path": "Product.attribute.type",
"short": "The attribute type (e.g. a physcial dimension)",
"definition": "The attribute type (e.g. a physcial dimension)",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://smart.who.int/pcmt/ValueSet/AttributeType"
}
},
{
"id": "Product.attribute.value[x]",
"path": "Product.attribute.value[x]",
"short": "The value of the attribute",
"definition": "The value of the attribute",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
},
{
"code": "integer"
},
{
"code": "decimal"
},
{
"code": "boolean"
},
{
"code": "url"
},
{
"code": "dateTime"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Annotation"
},
{
"code": "Address"
},
{
"code": "Duration"
},
{
"code": "CodeableConcept"
}
]
},
{
"id": "Product.associatedProduct",
"path": "Product.associatedProduct",
"short": "Association(s) between a product and referenced products. Such relationships could be for packaging, representing duplicates/semantic equivalencies between Products, etc",
"definition": "Association(s) between a product and referenced products. Such relationships could be for packaging, representing duplicates/semantic equivalencies between Products, etc",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "Product.associatedProduct.product",
"path": "Product.associatedProduct.product",
"short": "The generic product characteristics",
"definition": "The generic product characteristics",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://smart.who.int/pcmt/StructureDefinition/Product"
]
}
]
},
{
"id": "Product.associatedProduct.relationship",
"path": "Product.associatedProduct.relationship",
"short": "Relationship",
"definition": "The relationship of the the product to the refereneced product",
"min": 1,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://smart.who.int/pcmt/ValueSet/ProductRelationship"
}
},
{
"id": "Product.associatedProduct.quantity",
"path": "Product.associatedProduct.quantity",
"short": "how many units of use of the generic product are in the product",
"definition": "how many units of use of the generic product are in the product",
"min": 1,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
}
]
}
}