SMART ICVP
0.2.0 - ci-build
SMART ICVP, 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-icvp/tree/minor-fix and changes regularly. See the Directory of published versions
This page provides access to Data Access Kit (DAK) API documentation and schemas.
This page provides comprehensive documentation for all available DAK (Data Access Kit) API endpoints and schemas. The DAK API provides structured access to ValueSet enumerations and Logical Model definitions used throughout this implementation guide.
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 Vaccine Types for use in the ICVP ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Relationship Status for Contact in Patient ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Country ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for v2 SEX ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for WHO ICVP Vaccine Product Ids ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for VaccineManufacturer ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema definitions for FHIR Logical Models, defining structured data elements and their relationships:
DVC Icvp with Selective Disclosure
Data elements for the Model International Certificate of Vaccination or Prophylaxis.
Vaccine Data elements for the Paper Model International Certificate of Vaccination or Prophylaxis.
Mininmial DVC payload for use within an HCERT Payload using the ICVP Product Catalogue
ICVP Vaccine Details with Selective Disclosure
Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis
Data elements for the Paper Model International Certificate of Vaccination or Prophylaxis.
Mininmial vaccine detail in DVC payload for use within an HCERT Payload using the ICVP Product Catalogue
Complete API specification documentation for all available endpoints:
API endpoints for Vaccine Types for use in the ICVP Schema
API endpoints for Relationship Status for Contact in Patient Schema
API endpoints for WHO ICVP Vaccine Product Ids Schema
API endpoints for VaccineManufacturer Schema
API endpoints for DVC Icvp with Selective Disclosure
API endpoints for pICVP - Vaccine Details
API endpoints for ICVP Vaccine Details with Selective Disclosure
API endpoints for ICVP - Vaccine Details
API endpoints for ICVP HCERT Payload
Complete list of all available ValueSet schemas
Complete list of all available Logical Model schemas
OpenAPI specification for StructureDefinition-pICVPVaccineDetails
OpenAPI specification for StructureDefinition-ICVP
OpenAPI specification for StructureDefinition-ICVPEvent
OpenAPI specification for StructureDefinition-ICVPSD
OpenAPI specification for StructureDefinition-ICVPMin
OpenAPI specification for StructureDefinition-ICVPMinVaccineDetails
OpenAPI specification for StructureDefinition-pICVP
OpenAPI specification for ValueSet-VaccineManufacturer
OpenAPI specification for ValueSet-ICVPVaccineType
OpenAPI specification for StructureDefinition-ICVPVaccineDetails
OpenAPI specification for ValueSet-DVCRelationshipStatus
OpenAPI specification for ValueSet-ICVPProductIds
OpenAPI specification for StructureDefinition-ICVPVaccineDetailsSD
Each JSON Schema can be used to validate data structures in your applications. The schemas follow the JSON Schema Draft 2020-12 specification and include:
The JSON-LD vocabularies provide semantic web integration for ValueSet enumerations. Each vocabulary includes:
All schemas are derived from the FHIR definitions in this implementation guide. Each schema page includes links to the corresponding FHIR resource definitions for complete context.
The enumeration endpoints provide machine-readable lists of all available schemas, making it easy to discover and integrate with the available data structures programmatically.
This documentation hub is automatically generated from the available schema and API definitions.