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/pin-all and changes regularly. See the Directory of published versions

Logical Model: ICVP ( Experimental )

Official URL: http://smart.who.int/icvp/StructureDefinition/ICVP Version: 0.2.0
Active as of 2025-10-04 Computable Name: ICVP

Data elements for the Model International Certificate of Vaccination or Prophylaxis.

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
.. ICVP 0..* PreQualDVC(0.1.0) ICVP

Elements defined in Ancestors:name, dob, sex, nationality, nid, ndt, guardian, issuer, vaccineDetails, vaccineDetails
Instances of this logical model can be the target of a Reference
... name 1..1 string Name
... dob 1..1 date Date of Birth
... sex 0..1 code Sex
... nid 0..1 Identifier National Identification Document
... ndt 0..1 code National ID Document Type
Binding: Hl7VSIdentifierType (2.0.0) (extensible)
... guardian 0..1 string Parent/Guardian
... issuer 0..1 Reference(Organization) Document issuer
... vaccineDetails 1..* ICVPVaccineDetails Vaccine Details

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVP.ndt Base extensible hl7VS-identifierType 📍2.0.0 THO v6.5

API Information

ICVP API

Data elements for the Model International Certificate of Vaccination or Prophylaxis.

Version: 1.0.0

Endpoints

GET /StructureDefinition-ICVP.schema.json

JSON Schema definition for the Logical Model StructureDefinition-ICVP

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

Schema Definition

StructureDefinition-ICVP

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

Type: object

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

Properties

  • resourceType (string): Resource type identifier for ICVP logical model
  • name (string): The full name of the client
  • dob (string): Date of Birth
  • sex (string): Sex
  • nationality (string): Nationality
  • nid (object): National Identification Document
  • ndt (unknown): National ID Document Type
  • guardian (string): Name of Parent or Guardian
  • issuer (object): Document issuer
  • vaccineDetails (array): Vaccine Details

Required fields: resourceType, name, dob, vaccineDetails

Full Schema (JSON) 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-ICVP.schema.json",
  "title": "ICVP",
  "description": "Data elements for the Model International Certificate of Vaccination or Prophylaxis.",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "ICVP",
      "description": "Resource type identifier for ICVP logical model"
    },
    "name": {
      "type": "string",
      "description": "The full name of the client"
    },
    "dob": {
      "type": "string",
      "format": "date",
      "description": "Date of Birth"
    },
    "sex": {
      "type": "string",
      "description": "Sex"
    },
    "nationality": {
      "type": "string",
      "description": "Nationality"
    },
    "nid": {
      "type": "object",
      "description": "National Identification Document"
    },
    "ndt": {
      "$ref": "ValueSet-v2-0203|2.0.0.schema.json",
      "description": "National ID Document Type"
    },
    "guardian": {
      "type": "string",
      "description": "Name of Parent or Guardian"
    },
    "issuer": {
      "type": "object",
      "description": "Document issuer"
    },
    "vaccineDetails": {
      "type": "array",
      "items": {
        "$ref": "http://smart.who.int/base/StructureDefinition-ICVPVaccineDetails.schema.json"
      },
      "minItems": 1,
      "description": "Vaccine Details"
    }
  },
  "required": [
    "resourceType",
    "name",
    "dob",
    "vaccineDetails"
  ],
  "resourceDefinition": "http://smart.who.int/icvp/StructureDefinition/ICVP",
  "fhir:parent": "http://smart.who.int/trust-phw/StructureDefinition/PreQualDVC|0.1.0"
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from PreQualDVC

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVP 0..* PreQualDVC(0.1.0) ICVP

Elements defined in Ancestors:name, dob, sex, nationality, nid, ndt, guardian, issuer, vaccineDetails, vaccineDetails
Instances of this logical model can be the target of a Reference
... vaccineDetails 1..* ICVPVaccineDetails Vaccine Details

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVP 0..* PreQualDVC(0.1.0) ICVP

Elements defined in Ancestors:name, dob, sex, nationality, nid, ndt, guardian, issuer, vaccineDetails, vaccineDetails
Instances of this logical model can be the target of a Reference
... name 1..1 string Name
... dob 1..1 date Date of Birth
... sex 0..1 code Sex
... nid 0..1 Identifier National Identification Document
... ndt 0..1 code National ID Document Type
Binding: Hl7VSIdentifierType (2.0.0) (extensible)
... guardian 0..1 string Parent/Guardian
... issuer 0..1 Reference(Organization) Document issuer
... vaccineDetails 1..* ICVPVaccineDetails Vaccine Details

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVP.ndt Base extensible hl7VS-identifierType 📍2.0.0 THO v6.5

This structure is derived from PreQualDVC

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVP 0..* PreQualDVC(0.1.0) ICVP

Elements defined in Ancestors:name, dob, sex, nationality, nid, ndt, guardian, issuer, vaccineDetails, vaccineDetails
Instances of this logical model can be the target of a Reference
... name 1..1 string Name
... dob 1..1 date Date of Birth
... sex 0..1 code Sex
... nid 0..1 Identifier National Identification Document
... ndt 0..1 code National ID Document Type
Binding: Hl7VSIdentifierType (2.0.0) (extensible)
... guardian 0..1 string Parent/Guardian
... issuer 0..1 Reference(Organization) Document issuer
... vaccineDetails 1..* ICVPVaccineDetails Vaccine Details

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVP.ndt Base extensible hl7VS-identifierType 📍2.0.0 THO v6.5

Differential View

This structure is derived from PreQualDVC

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVP 0..* PreQualDVC(0.1.0) ICVP

Elements defined in Ancestors:name, dob, sex, nationality, nid, ndt, guardian, issuer, vaccineDetails, vaccineDetails
Instances of this logical model can be the target of a Reference
... vaccineDetails 1..* ICVPVaccineDetails Vaccine Details

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVP 0..* PreQualDVC(0.1.0) ICVP

Elements defined in Ancestors:name, dob, sex, nationality, nid, ndt, guardian, issuer, vaccineDetails, vaccineDetails
Instances of this logical model can be the target of a Reference
... name 1..1 string Name
... dob 1..1 date Date of Birth
... sex 0..1 code Sex
... nid 0..1 Identifier National Identification Document
... ndt 0..1 code National ID Document Type
Binding: Hl7VSIdentifierType (2.0.0) (extensible)
... guardian 0..1 string Parent/Guardian
... issuer 0..1 Reference(Organization) Document issuer
... vaccineDetails 1..* ICVPVaccineDetails Vaccine Details

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ICVP.ndt Base extensible hl7VS-identifierType 📍2.0.0 THO v6.5

This structure is derived from PreQualDVC

Summary

 

Other representations of profile: CSV, Excel