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
This page provides access to Data Access Kit (DAK) API documentation and schemas.
These endpoints provide lists of all available schemas and vocabularies of each type:
Enumeration of all available ValueSet schemas
Enumeration of all available Logical Model schemas
JSON Schema definitions for FHIR ValueSets, providing structured enumeration of allowed code values:
JSON Schema for WHO PreQualificaiton Presentation ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO PreQualificaiton Vaccine Product Ids ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO PreQualification Database Metadata ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO PreQualificaiton VaccineType ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema definitions for FHIR Logical Models, defining structured data elements and their relationships:
Logical model for document details from the WHO PreQual API (DocumentDetails).
Logical model for the manufacturer/applicant organization from the WHO PreQual API (ProductDetails.ApplicantOrganization).
Logical model for the vaccine type details from the WHO PreQual API (ProductDetails.VaccineDetails). Contains only vaccine-type-level fields that are stable across products. Product-specific fields (CommercialName, RouteOfAdministration) remain on FinishedVaccineProducts.
Logical model for manufacturing site details from the WHO PreQual API (SiteDetails).
Logical model for product ingredient details from the WHO PreQual API (ProductIngredients).
Logical model for product packaging details from the WHO PreQual API (ProductPackaging).
WHO Vaccine PreQual DB - Finished Vaccine Products. Logical model for the WHO PreQual DB as provided by the backend API at: https://extranet.who.int/prequal/vaccines/prequalified-vaccines This model provides authoritative vaccine product IDs and a richer data structure compared to the CSV export. Sub-objects with Identification.Id are modeled as separate logical models and linked via references. Key fields from the API (FinishedVaccineProducts): ProductDetails.Identification.Id - Vaccine Product ID (authoritative) ProductDetails.Identification.Name - Product reference name (e.g. FVP-P-447) ProductDetails.Type - Product type code (e.g. Finished Vaccine Product) ProductDetails.DateOfPreQualifiedAcceptance - Date of prequalification ProductDetails.AssessmentProcedure - Assessment procedure code ProductDetails.ApplicantOrganization - Manufacturer/applicant with ID, name, address ProductDetails.Presentation - Presentation form (Vial, Ampoule, etc.) ProductDetails.PharmaceuticalForm - Pharmaceutical form details ProductDetails.DosageDetails.NoOfDosagesPerPrimaryContainer - Number of doses ProductDetails.NRADetails - Responsible NRA with ID, name, address ProductDetails.VaccineDetails - Vaccine type with full, abbreviated, and commercial names ProductDetails.StorageDetails - Storage temperature and shelf life ProductDetails.Status - Prequalification status code
Logical model for the bulk supplier organization from the WHO PreQual API (ProductDetails.BulkSupplier).
Logical model for the responsible National Regulatory Authority (NRA) from the WHO PreQual API (ProductDetails.NRADetails).
Complete API specification documentation for all available endpoints:
API endpoints for WHO PreQualificaiton Presentation Schema
API endpoints for WHO PreQualificaiton Vaccine Product Ids Schema
API endpoints for WHO PreQualification Database Metadata Schema
API endpoints for WHO PreQualificaiton VaccineType Schema
API endpoints for WHO PreQual Document Detail
API endpoints for WHO PreQual Manufacturer
API endpoints for WHO PreQual Vaccine
API endpoints for WHO PreQual Site Detail
API endpoints for WHO PreQual Product Ingredient
API endpoints for WHO PreQual Product Packaging
API endpoints for WHO Vaccine PreQual DB - Finished Vaccine Products
API endpoints for WHO PreQual Bulk Supplier
Complete list of all available ValueSet schemas
Complete list of all available Logical Model schemas
OpenAPI specification for StructureDefinition-PreQualSiteDetail
OpenAPI specification for StructureDefinition-PreQualProductPackaging
OpenAPI specification for ValueSet-PreQualProductIds
OpenAPI specification for StructureDefinition-PreQualManufacturer
OpenAPI specification for ValueSet-PreQualPresentation
OpenAPI specification for ValueSet-PreQualVaccineType
OpenAPI specification for StructureDefinition-PreQualVaccine
OpenAPI specification for StructureDefinition-PreQualDocumentDetail
OpenAPI specification for StructureDefinition-PreQualNRA
OpenAPI specification for StructureDefinition-PreQualBulkSupplier
OpenAPI specification for ValueSet-PreQualDatabaseMetadata
OpenAPI specification for StructureDefinition-FinishedVaccineProducts
OpenAPI specification for StructureDefinition-PreQualProductIngredient
Each JSON Schema can be used to validate data structures in your applications.
The JSON-LD vocabularies provide semantic web integration for ValueSet enumerations.
All schemas are derived from the FHIR definitions in this implementation guide.
The enumeration endpoints provide machine-readable lists of all available schemas.
This documentation hub is automatically generated from the available schema and API definitions.