ICVP - Vaccine Details - SMART ICVP v0.3.0

SMART ICVP
0.3.0 - ci-build

SMART ICVP, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.3.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/main and changes regularly. See the Directory of published versions

Logical Model: ICVP - Vaccine Details ( Experimental )

Official URL: http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetails				Version: 0.3.0
Active as of 2025-10-30				Computable Name: ICVPVaccineDetails

Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis

Usages:

Derived from this Logical Model: ICVP Vaccine Details with Selective Disclosure and pICVP - Vaccine Details
Use this Logical Model: ICVP and DVC Icvp with Selective Disclosure

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.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
ICVPVaccineDetails	C	0..*	PreQualVaccineDetails	ICVP - Vaccine Details Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician
productID	C	1..1	Coding	Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id
date		1..1	date	Date
issuer		0..1	Reference(Organization)	Issuing Organization
clinicianName		0..1	string	Name of supervising clinician
batchNo		1..1	CodeableConcept	Batch No
validityPeriod		0..1	Period	Certificate validity period
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
is-a-prequal-product-id	error	ICVPVaccineDetails.productID	Product ID comes from the PreQual Database	`system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds'`
is-an-icvp-product-id	error	ICVPVaccineDetails.productID	Product ID comes from the ICVP vaccines from the PreQual Databatase	`system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds'`
must-have-issuer-or-clinician	error	ICVPVaccineDetails	Either issuer or clinicianName must be present	`issuer.exists() or clinicianName.exists()`

API Information

ICVP - Vaccine Details API

Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis

Version: 1.0.0

Endpoints

GET /StructureDefinition-ICVPVaccineDetails.schema.json

JSON Schema definition for the Logical Model StructureDefinition-ICVPVaccineDetails

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

Schema Definition

StructureDefinition-ICVPVaccineDetails

Description: Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis

Type: object

Schema ID: http://smart.who.int/base/StructureDefinition-ICVPVaccineDetails.schema.json

Properties

resourceType (string): Resource type identifier for ICVPVaccineDetails logical model
productID (object): Vaccine product information (note: use InventoryItem in FHIR R6)
date (string): Date of vaccine
issuer (object): Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center
clinicianName (string): Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre
batchNo (object): Batch No
validityPeriod (object): Certificate validity period

Required fields: resourceType, productID, date, batchNo

Full Schema (JSON)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-ICVPVaccineDetails.schema.json",
  "title": "ICVP - Vaccine Details",
  "description": "Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "ICVPVaccineDetails",
      "description": "Resource type identifier for ICVPVaccineDetails logical model"
    },
    "productID": {
      "type": "object",
      "description": "Vaccine product information (note: use InventoryItem in FHIR R6)"
    },
    "date": {
      "type": "string",
      "format": "date",
      "description": "Date of vaccine"
    },
    "issuer": {
      "type": "object",
      "description": "Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center"
    },
    "clinicianName": {
      "type": "string",
      "description": "Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre"
    },
    "batchNo": {
      "type": "object",
      "description": "Batch No"
    },
    "validityPeriod": {
      "type": "object",
      "description": "Certificate validity period"
    }
  },
  "required": [
    "resourceType",
    "productID",
    "date",
    "batchNo"
  ],
  "resourceDefinition": "http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetails",
  "fhir:parent": "http://smart.who.int/trust-phw/StructureDefinition/PreQualVaccineDetails"
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from PreQualVaccineDetails

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
ICVPVaccineDetails		0..*	PreQualVaccineDetails	ICVP - Vaccine Details Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID Instances of this logical model can be the target of a Reference
productID	C	1..1	Coding	Vaccine Product Constraints: is-an-icvp-product-id
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
is-an-icvp-product-id	error	ICVPVaccineDetails.productID	Product ID comes from the ICVP vaccines from the PreQual Databatase	`system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds'`

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
ICVPVaccineDetails	C	0..*	PreQualVaccineDetails	ICVP - Vaccine Details Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician
productID	C	1..1	Coding	Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id
date		1..1	date	Date
issuer		0..1	Reference(Organization)	Issuing Organization
clinicianName		0..1	string	Name of supervising clinician
batchNo		1..1	CodeableConcept	Batch No
validityPeriod		0..1	Period	Certificate validity period
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
is-a-prequal-product-id	error	ICVPVaccineDetails.productID	Product ID comes from the PreQual Database	`system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds'`
is-an-icvp-product-id	error	ICVPVaccineDetails.productID	Product ID comes from the ICVP vaccines from the PreQual Databatase	`system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds'`
must-have-issuer-or-clinician	error	ICVPVaccineDetails	Either issuer or clinicianName must be present	`issuer.exists() or clinicianName.exists()`

This structure is derived from PreQualVaccineDetails

Summary

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
ICVPVaccineDetails	C	0..*	PreQualVaccineDetails	ICVP - Vaccine Details Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician
productID	C	1..1	Coding	Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id
date		1..1	date	Date
issuer		0..1	Reference(Organization)	Issuing Organization
clinicianName		0..1	string	Name of supervising clinician
batchNo		1..1	CodeableConcept	Batch No
validityPeriod		0..1	Period	Certificate validity period
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
is-a-prequal-product-id	error	ICVPVaccineDetails.productID	Product ID comes from the PreQual Database	`system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds'`
is-an-icvp-product-id	error	ICVPVaccineDetails.productID	Product ID comes from the ICVP vaccines from the PreQual Databatase	`system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds'`
must-have-issuer-or-clinician	error	ICVPVaccineDetails	Either issuer or clinicianName must be present	`issuer.exists() or clinicianName.exists()`

Differential View

This structure is derived from PreQualVaccineDetails

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
ICVPVaccineDetails		0..*	PreQualVaccineDetails	ICVP - Vaccine Details Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID Instances of this logical model can be the target of a Reference
productID	C	1..1	Coding	Vaccine Product Constraints: is-an-icvp-product-id
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
is-an-icvp-product-id	error	ICVPVaccineDetails.productID	Product ID comes from the ICVP vaccines from the PreQual Databatase	`system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds'`

Snapshot View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
ICVPVaccineDetails	C	0..*	PreQualVaccineDetails	ICVP - Vaccine Details Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID Instances of this logical model can be the target of a Reference Constraints: must-have-issuer-or-clinician
productID	C	1..1	Coding	Vaccine Product Constraints: is-a-prequal-product-id, is-an-icvp-product-id
date		1..1	date	Date
issuer		0..1	Reference(Organization)	Issuing Organization
clinicianName		0..1	string	Name of supervising clinician
batchNo		1..1	CodeableConcept	Batch No
validityPeriod		0..1	Period	Certificate validity period
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
is-a-prequal-product-id	error	ICVPVaccineDetails.productID	Product ID comes from the PreQual Database	`system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds'`
is-an-icvp-product-id	error	ICVPVaccineDetails.productID	Product ID comes from the ICVP vaccines from the PreQual Databatase	`system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIds'`
must-have-issuer-or-clinician	error	ICVPVaccineDetails	Either issuer or clinicianName must be present	`issuer.exists() or clinicianName.exists()`

This structure is derived from PreQualVaccineDetails

Summary

Other representations of profile: CSV, Excel

IG © 2023+ WHO. Package smart.who.int.icvp#0.3.0 based on FHIR 4.0.1. Generated 2025-10-30
Links: Table of Contents | QA Report | Version History | License