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/ICVPMin Version: 0.3.0
Active as of 2025-10-30 Computable Name: ICVPMin

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

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

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
.. ICVPMin 0..* DVCMin ICVP HCERT Payload

Elements defined in Ancestors:n, dob, s, ntl, nid, ndt, gn, v
... n 1..1 string Person name
... dob 1..1 date Date of birth in YYYY-MM-DD format
... s 0..1 code Sex
... nid 0..1 string National Identification Document
... ndt 0..1 code National ID Document Type
Binding: hl7VS-identifierType (extensible)
... gn 0..1 string Parent or Guardian Name
... v 1..* ICVPMinVaccineDetails Vaccine Details

doco Documentation for this format

Terminology Bindings

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

API Information

ICVP HCERT Payload API

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

Version: 1.0.0

Endpoints

GET /StructureDefinition-ICVPMin.schema.json

JSON Schema definition for the Logical Model StructureDefinition-ICVPMin

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

Schema Definition

StructureDefinition-ICVPMin

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

Type: object

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

Properties

  • resourceType (string): Resource type identifier for ICVPMin logical model
  • @context (unknown): JSON-LD context for this logical model with ValueSet vocabularies
  • @type (string): JSON-LD type identifier for ICVPMin logical model
  • n (string): Person name
  • dob (string): Date of birth in YYYY-MM-DD format
  • s (string): Sex
  • ntl (string): Nationality
  • nid (string): National Identification Document
  • ndt (unknown): National ID Document Type
  • gn (string): Parent or Guardian Name
  • v (array): Vaccine Details

Required fields: resourceType, n, dob, v

Full Schema (JSON) 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-ICVPMin.schema.json",
  "title": "ICVP HCERT Payload",
  "description": "Mininmial DVC payload for use within an HCERT Payload using the ICVP Product Catalogue",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "ICVPMin",
      "description": "Resource type identifier for ICVPMin 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 ICVPMin logical model",
      "examples": [
        "LogicalModel-ICVPMin"
      ]
    },
    "n": {
      "type": "string",
      "description": "Person name"
    },
    "dob": {
      "type": "string",
      "format": "date",
      "description": "Date of birth in YYYY-MM-DD format"
    },
    "s": {
      "type": "string",
      "description": "Sex"
    },
    "ntl": {
      "type": "string",
      "description": "Nationality"
    },
    "nid": {
      "type": "string",
      "description": "National Identification Document"
    },
    "ndt": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet v2-0203 (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet v2-0203 (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-v2-0203.jsonld",
              "description": "JSON-LD type reference to ValueSet v2-0203"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet v2-0203"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "National ID Document Type"
    },
    "gn": {
      "type": "string",
      "description": "Parent or Guardian Name"
    },
    "v": {
      "type": "array",
      "items": {
        "$ref": "http://smart.who.int/base/StructureDefinition-ICVPMinVaccineDetails.schema.json"
      },
      "minItems": 1,
      "description": "Vaccine Details"
    }
  },
  "required": [
    "resourceType",
    "n",
    "dob",
    "v"
  ],
  "resourceDefinition": "http://smart.who.int/icvp/StructureDefinition/ICVPMin",
  "fhir:parent": "http://smart.who.int/trust-phw/StructureDefinition/DVCMin",
  "jsonld:valuesets": [
    "v2-0203"
  ],
  "jsonld:contextTemplate": {
    "@version": 1.1,
    "fhir": "http://hl7.org/fhir/",
    "v2-0203": "http://smart.who.int/base/ValueSet-v2-0203.jsonld"
  }
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from DVCMin

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVPMin 0..* DVCMin ICVP HCERT Payload

Elements defined in Ancestors:n, dob, s, ntl, nid, ndt, gn, v
... v 1..* ICVPMinVaccineDetails Vaccine Details

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVPMin 0..* DVCMin ICVP HCERT Payload

Elements defined in Ancestors:n, dob, s, ntl, nid, ndt, gn, v
... n 1..1 string Person name
... dob 1..1 date Date of birth in YYYY-MM-DD format
... s 0..1 code Sex
... nid 0..1 string National Identification Document
... ndt 0..1 code National ID Document Type
Binding: hl7VS-identifierType (extensible)
... gn 0..1 string Parent or Guardian Name
... v 1..* ICVPMinVaccineDetails Vaccine Details

doco Documentation for this format

Terminology Bindings

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

This structure is derived from DVCMin

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVPMin 0..* DVCMin ICVP HCERT Payload

Elements defined in Ancestors:n, dob, s, ntl, nid, ndt, gn, v
... n 1..1 string Person name
... dob 1..1 date Date of birth in YYYY-MM-DD format
... s 0..1 code Sex
... nid 0..1 string National Identification Document
... ndt 0..1 code National ID Document Type
Binding: hl7VS-identifierType (extensible)
... gn 0..1 string Parent or Guardian Name
... v 1..* ICVPMinVaccineDetails Vaccine Details

doco Documentation for this format

Terminology Bindings

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

Differential View

This structure is derived from DVCMin

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVPMin 0..* DVCMin ICVP HCERT Payload

Elements defined in Ancestors:n, dob, s, ntl, nid, ndt, gn, v
... v 1..* ICVPMinVaccineDetails Vaccine Details

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ICVPMin 0..* DVCMin ICVP HCERT Payload

Elements defined in Ancestors:n, dob, s, ntl, nid, ndt, gn, v
... n 1..1 string Person name
... dob 1..1 date Date of birth in YYYY-MM-DD format
... s 0..1 code Sex
... nid 0..1 string National Identification Document
... ndt 0..1 code National ID Document Type
Binding: hl7VS-identifierType (extensible)
... gn 0..1 string Parent or Guardian Name
... v 1..* ICVPMinVaccineDetails Vaccine Details

doco Documentation for this format

Terminology Bindings

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

This structure is derived from DVCMin

Summary

 

Other representations of profile: CSV, Excel