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 HCERT Payload

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

Mininmial vaccine detail in DVC payload for use within an HCERT Payload using the ICVP Product Catalogue

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
.. ICVPMinVaccineDetails C 0..* DVCMinVaccineDetails ICVP HCERT Payload

Elements defined in Ancestors:vp, dt, cn, is, bo, vls, vle
Constraints: must-have-issuer-or-clinician-name
... vp 1..1 string ICVP Product Catalog ID
Binding: WHO ICVP Vaccine Product Ids (required)
... dt 1..1 date Date of vaccination, YYYY-MM-DD format
... cn 0..1 string Name of supervising clinician
... bo 1..1 string Batch No
... vls 0..1 date Certificate Validity periods start date
... vle 0..1 date Certificate Validity periods end date

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVPMinVaccineDetails.​vp Base required WHO ICVP Vaccine Product Ids 📦0.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
must-have-issuer-or-clinician-name error ICVPMinVaccineDetails Either issuer or clinicianName must be present is.exists() or cn.exists()

API Information

ICVP HCERT Payload API

Mininmial vaccine detail in DVC payload for use within an HCERT Payload using the ICVP Product Catalogue

Version: 1.0.0

Endpoints

GET /StructureDefinition-ICVPMinVaccineDetails.schema.json

JSON Schema definition for the Logical Model StructureDefinition-ICVPMinVaccineDetails

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

Schema Definition

StructureDefinition-ICVPMinVaccineDetails

Description: Mininmial vaccine detail in DVC payload for use within an HCERT Payload using the ICVP Product Catalogue

Type: object

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

Properties

  • resourceType (string): Resource type identifier for ICVPMinVaccineDetails logical model
  • @context (unknown): JSON-LD context for this logical model with ValueSet vocabularies
  • @type (string): JSON-LD type identifier for ICVPMinVaccineDetails logical model
  • vp (string): ICVP Product Catalog ID
  • dt (string): Date of vaccination, YYYY-MM-DD format
  • cn (string): Name of supervising clinician
  • is (string): Certificate issuer id (referenced organization)
  • bo (string): Batch No
  • vls (string): Certificate Validity periods start date
  • vle (string): Certificate Validity periods end date

Required fields: resourceType, vp, dt, bo

Full Schema (JSON) 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-ICVPMinVaccineDetails.schema.json",
  "title": "ICVP HCERT Payload",
  "description": "Mininmial vaccine detail in DVC payload for use within an HCERT Payload using the ICVP Product Catalogue",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "ICVPMinVaccineDetails",
      "description": "Resource type identifier for ICVPMinVaccineDetails logical model"
    },
    "@context": {
      "description": "JSON-LD context for this logical model with ValueSet vocabularies",
      "anyOf": [
        {
          "type": "string",
          "format": "uri",
          "description": "URI reference to external JSON-LD context"
        },
        {
          "type": "object",
          "description": "Inline JSON-LD context",
          "properties": {
            "@version": {
              "type": "number",
              "const": 1.1
            },
            "fhir": {
              "type": "string",
              "const": "http://hl7.org/fhir/"
            }
          },
          "additionalProperties": {
            "type": "string",
            "format": "uri"
          }
        },
        {
          "type": "array",
          "description": "Array of JSON-LD context objects/URIs",
          "items": {
            "anyOf": [
              {
                "type": "string",
                "format": "uri"
              },
              {
                "type": "object"
              }
            ]
          }
        }
      ]
    },
    "@type": {
      "type": "string",
      "description": "JSON-LD type identifier for ICVPMinVaccineDetails logical model",
      "examples": [
        "LogicalModel-ICVPMinVaccineDetails"
      ]
    },
    "vp": {
      "type": "string",
      "description": "ICVP Product Catalog ID"
    },
    "dt": {
      "type": "string",
      "format": "date",
      "description": "Date of vaccination, YYYY-MM-DD format"
    },
    "cn": {
      "type": "string",
      "description": "Name of supervising clinician"
    },
    "is": {
      "type": "string",
      "description": "Certificate issuer id (referenced organization)"
    },
    "bo": {
      "type": "string",
      "description": "Batch No"
    },
    "vls": {
      "type": "string",
      "format": "date",
      "description": "Certificate Validity periods start date"
    },
    "vle": {
      "type": "string",
      "format": "date",
      "description": "Certificate Validity periods end date"
    }
  },
  "required": [
    "resourceType",
    "vp",
    "dt",
    "bo"
  ],
  "resourceDefinition": "http://smart.who.int/icvp/StructureDefinition/ICVPMinVaccineDetails",
  "fhir:parent": "http://smart.who.int/trust-phw/StructureDefinition/DVCMinVaccineDetails",
  "jsonld:valuesets": [
    "ICVPProductIds"
  ],
  "jsonld:contextTemplate": {
    "@version": 1.1,
    "fhir": "http://hl7.org/fhir/",
    "ICVPProductIds": "http://smart.who.int/base/ValueSet-ICVPProductIds.jsonld"
  }
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from DVCMinVaccineDetails

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVPMinVaccineDetails 0..* DVCMinVaccineDetails ICVP HCERT Payload

Elements defined in Ancestors:vp, dt, cn, is, bo, vls, vle
... vp 1..1 string ICVP Product Catalog ID
Binding: WHO ICVP Vaccine Product Ids (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ICVPMinVaccineDetails.​vp Base required WHO ICVP Vaccine Product Ids 📦0.3.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVPMinVaccineDetails C 0..* DVCMinVaccineDetails ICVP HCERT Payload

Elements defined in Ancestors:vp, dt, cn, is, bo, vls, vle
Constraints: must-have-issuer-or-clinician-name
... vp 1..1 string ICVP Product Catalog ID
Binding: WHO ICVP Vaccine Product Ids (required)
... dt 1..1 date Date of vaccination, YYYY-MM-DD format
... cn 0..1 string Name of supervising clinician
... bo 1..1 string Batch No
... vls 0..1 date Certificate Validity periods start date
... vle 0..1 date Certificate Validity periods end date

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVPMinVaccineDetails.​vp Base required WHO ICVP Vaccine Product Ids 📦0.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
must-have-issuer-or-clinician-name error ICVPMinVaccineDetails Either issuer or clinicianName must be present is.exists() or cn.exists()

This structure is derived from DVCMinVaccineDetails

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVPMinVaccineDetails C 0..* DVCMinVaccineDetails ICVP HCERT Payload

Elements defined in Ancestors:vp, dt, cn, is, bo, vls, vle
Constraints: must-have-issuer-or-clinician-name
... vp 1..1 string ICVP Product Catalog ID
Binding: WHO ICVP Vaccine Product Ids (required)
... dt 1..1 date Date of vaccination, YYYY-MM-DD format
... cn 0..1 string Name of supervising clinician
... bo 1..1 string Batch No
... vls 0..1 date Certificate Validity periods start date
... vle 0..1 date Certificate Validity periods end date

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVPMinVaccineDetails.​vp Base required WHO ICVP Vaccine Product Ids 📦0.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
must-have-issuer-or-clinician-name error ICVPMinVaccineDetails Either issuer or clinicianName must be present is.exists() or cn.exists()

Differential View

This structure is derived from DVCMinVaccineDetails

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVPMinVaccineDetails 0..* DVCMinVaccineDetails ICVP HCERT Payload

Elements defined in Ancestors:vp, dt, cn, is, bo, vls, vle
... vp 1..1 string ICVP Product Catalog ID
Binding: WHO ICVP Vaccine Product Ids (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ICVPMinVaccineDetails.​vp Base required WHO ICVP Vaccine Product Ids 📦0.3.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVPMinVaccineDetails C 0..* DVCMinVaccineDetails ICVP HCERT Payload

Elements defined in Ancestors:vp, dt, cn, is, bo, vls, vle
Constraints: must-have-issuer-or-clinician-name
... vp 1..1 string ICVP Product Catalog ID
Binding: WHO ICVP Vaccine Product Ids (required)
... dt 1..1 date Date of vaccination, YYYY-MM-DD format
... cn 0..1 string Name of supervising clinician
... bo 1..1 string Batch No
... vls 0..1 date Certificate Validity periods start date
... vle 0..1 date Certificate Validity periods end date

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVPMinVaccineDetails.​vp Base required WHO ICVP Vaccine Product Ids 📦0.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
must-have-issuer-or-clinician-name error ICVPMinVaccineDetails Either issuer or clinicianName must be present is.exists() or cn.exists()

This structure is derived from DVCMinVaccineDetails

Summary

 

Other representations of profile: CSV, Excel