SMART Product Dataset for Prequalified Vaccines
0.2.0 - ci-build

SMART Product Dataset for Prequalified Vaccines, 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/litlfred/smart-pcmt-vaxprequal/ and changes regularly. See the Directory of published versions

Logical Model: WHO PreQual Product Ingredient

Official URL: http://smart.who.int/pcmt-vaxprequal/StructureDefinition/PreQualProductIngredient Version: 0.2.0
Draft as of 2026-03-25 Computable Name: PreQualProductIngredient

Logical model for product ingredient details from the WHO PreQual API (ProductIngredients).

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PreQualProductIngredient 0..* Base WHO PreQual Product Ingredient
Instances of this logical model can be the target of a Reference
... ingredientId 0..1 Identifier Ingredient ID
... ingredientType 0..1 code Ingredient type code from PreQualDatabaseMetadata (e.g. VxFVP)
... unit 0..1 string Measurement unit
... productComponentType 0..1 code Product component type code from PreQualDatabaseMetadata (e.g. Diluent)
... function 0..1 string Ingredient function

doco Documentation for this format

API Information

WHO PreQual Product Ingredient API

Logical model for product ingredient details from the WHO PreQual API (ProductIngredients).

Version: 1.0.0

Endpoints

GET /StructureDefinition-PreQualProductIngredient.schema.json

JSON Schema definition for the Logical Model StructureDefinition-PreQualProductIngredient

This endpoint serves the JSON Schema definition for the Logical Model StructureDefinition-PreQualProductIngredient.

Schema Definition

StructureDefinition-PreQualProductIngredient

Description: Logical model for product ingredient details from the WHO PreQual API (ProductIngredients).

Type: object

Full Schema (JSON) 

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-PreQualProductIngredient.schema.json",
  "title": "WHO PreQual Product Ingredient",
  "description": "Logical model for product ingredient details\nfrom the WHO PreQual API (ProductIngredients).",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "PreQualProductIngredient",
      "description": "Resource type identifier for PreQualProductIngredient logical model"
    },
    "ingredientId": {
      "type": "object",
      "description": "Ingredient ID"
    },
    "ingredientType": {
      "type": "string",
      "description": "Ingredient type code from PreQualDatabaseMetadata (e.g. VxFVP)"
    },
    "unit": {
      "type": "string",
      "description": "Measurement unit"
    },
    "product": {
      "type": "string",
      "description": "Product reference ID"
    },
    "productComponentType": {
      "type": "string",
      "description": "Product component type code from PreQualDatabaseMetadata (e.g. Diluent)"
    },
    "function": {
      "type": "string",
      "description": "Ingredient function"
    }
  },
  "required": [
    "resourceType"
  ],
  "resourceDefinition": "http://smart.who.int/pcmt-vaxprequal/StructureDefinition/PreQualProductIngredient",
  "fhir:parent": "http://hl7.org/fhir/StructureDefinition/Base"
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PreQualProductIngredient 0..* Base WHO PreQual Product Ingredient
Instances of this logical model can be the target of a Reference
... ingredientId 0..1 Identifier Ingredient ID
... ingredientType 0..1 code Ingredient type code from PreQualDatabaseMetadata (e.g. VxFVP)
... unit 0..1 string Measurement unit
... productComponentType 0..1 code Product component type code from PreQualDatabaseMetadata (e.g. Diluent)
... function 0..1 string Ingredient function

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PreQualProductIngredient 0..* Base WHO PreQual Product Ingredient
Instances of this logical model can be the target of a Reference
... ingredientId 0..1 Identifier Ingredient ID
... ingredientType 0..1 code Ingredient type code from PreQualDatabaseMetadata (e.g. VxFVP)
... unit 0..1 string Measurement unit
... productComponentType 0..1 code Product component type code from PreQualDatabaseMetadata (e.g. Diluent)
... function 0..1 string Ingredient function

doco Documentation for this format

This structure is derived from Base

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PreQualProductIngredient 0..* Base WHO PreQual Product Ingredient
Instances of this logical model can be the target of a Reference
... ingredientId 0..1 Identifier Ingredient ID
... ingredientType 0..1 code Ingredient type code from PreQualDatabaseMetadata (e.g. VxFVP)
... unit 0..1 string Measurement unit
... productComponentType 0..1 code Product component type code from PreQualDatabaseMetadata (e.g. Diluent)
... function 0..1 string Ingredient function

doco Documentation for this format

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PreQualProductIngredient 0..* Base WHO PreQual Product Ingredient
Instances of this logical model can be the target of a Reference
... ingredientId 0..1 Identifier Ingredient ID
... ingredientType 0..1 code Ingredient type code from PreQualDatabaseMetadata (e.g. VxFVP)
... unit 0..1 string Measurement unit
... productComponentType 0..1 code Product component type code from PreQualDatabaseMetadata (e.g. Diluent)
... function 0..1 string Ingredient function

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PreQualProductIngredient 0..* Base WHO PreQual Product Ingredient
Instances of this logical model can be the target of a Reference
... ingredientId 0..1 Identifier Ingredient ID
... ingredientType 0..1 code Ingredient type code from PreQualDatabaseMetadata (e.g. VxFVP)
... unit 0..1 string Measurement unit
... productComponentType 0..1 code Product component type code from PreQualDatabaseMetadata (e.g. Diluent)
... function 0..1 string Ingredient function

doco Documentation for this format

This structure is derived from Base

Summary

 

Other representations of profile: CSV, Excel