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 (single)
| Official URL: http://smart.who.int/icvp/StructureDefinition/ICVPEvent | Version: 0.3.0 | |||
| Active as of 2025-10-30 | Computable Name: ICVPEvent | |||
ICVP for a single vaccincation event
Usages:
- This Logical Model Profile 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.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ICVP |
0..* | ICVP | ICVP 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 | |
| nationality |
0..1 | code | Nationality | |
 nid |
0..1 | Identifier | National Identification Document | |
| ndt |
0..1 | code | National ID Document Type Binding: hl7VS-identifierType (extensible) | |
| guardian |
0..1 | string | Parent/Guardian | |
 issuer |
0..1 | Reference(Organization) | Document issuer | |
  vaccineDetails |
1..1 | ICVPVaccineDetails | Vaccine Details | |
| 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 (single) API
ICVP for a single vaccincation event
Version: 1.0.0
Endpoints
GET /StructureDefinition-ICVPEvent.schema.json
JSON Schema definition for the Logical Model StructureDefinition-ICVPEvent
This endpoint serves the JSON Schema definition for the Logical Model StructureDefinition-ICVPEvent.
Schema Definition
StructureDefinition-ICVPEvent
Description: ICVP for a single vaccincation event
Type: object
Schema ID: http://smart.who.int/base/StructureDefinition-ICVPEvent.schema.json
Properties
- resourceType (string): Resource type identifier for ICVPEvent logical model
- @context (unknown): JSON-LD context for this logical model with ValueSet vocabularies
- @type (string): JSON-LD type identifier for ICVPEvent logical model
- ICVP (array): Data elements for the Model International Certificate of Vaccination or Prophylaxis.
- 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 (unknown): 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-ICVPEvent.schema.json",
"title": "ICVP (single)",
"description": "ICVP for a single vaccincation event",
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"const": "ICVPEvent",
"description": "Resource type identifier for ICVPEvent 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 ICVPEvent logical model",
"examples": [
"LogicalModel-ICVPEvent"
]
},
"ICVP": {
"type": "array",
"items": {
"type": "object",
"description": "FHIR "
},
"description": "Data elements for the Model International Certificate of Vaccination or Prophylaxis."
},
"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": {
"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"
},
"guardian": {
"type": "string",
"description": "Name of Parent or Guardian"
},
"issuer": {
"type": "object",
"description": "Document issuer"
},
"vaccineDetails": {
"$ref": "http://smart.who.int/base/StructureDefinition-ICVPVaccineDetails.schema.json",
"description": "Vaccine Details"
}
},
"required": [
"resourceType",
"name",
"dob",
"vaccineDetails"
],
"resourceDefinition": "http://smart.who.int/icvp/StructureDefinition/ICVPEvent",
"fhir:parent": "http://smart.who.int/icvp/StructureDefinition/ICVP",
"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 ICVP
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVP |
0..* | ICVP | ICVP Instances of this logical model can be the target of a Reference | |
| vaccineDetails |
1..1 | ICVPVaccineDetails | Vaccine Details | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVP |
0..* | ICVP | ICVP 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 | |
| nationality |
0..1 | code | Nationality | |
| nid |
0..1 | Identifier | National Identification Document | |
| ndt |
0..1 | code | National ID Document Type Binding: hl7VS-identifierType (extensible) | |
| guardian |
0..1 | string | Parent/Guardian | |
| issuer |
0..1 | Reference(Organization) | Document issuer | |
| vaccineDetails |
1..1 | ICVPVaccineDetails | Vaccine Details | |
| 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 ICVP
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVP |
0..* | ICVP | ICVP 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 | |
| nationality |
0..1 | code | Nationality | |
| nid |
0..1 | Identifier | National Identification Document | |
| ndt |
0..1 | code | National ID Document Type Binding: hl7VS-identifierType (extensible) | |
| guardian |
0..1 | string | Parent/Guardian | |
| issuer |
0..1 | Reference(Organization) | Document issuer | |
| vaccineDetails |
1..1 | ICVPVaccineDetails | Vaccine Details | |
| 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 ICVP
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVP |
0..* | ICVP | ICVP Instances of this logical model can be the target of a Reference | |
| vaccineDetails |
1..1 | ICVPVaccineDetails | Vaccine Details | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ICVP |
0..* | ICVP | ICVP 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 | |
| nationality |
0..1 | code | Nationality | |
| nid |
0..1 | Identifier | National Identification Document | |
| ndt |
0..1 | code | National ID Document Type Binding: hl7VS-identifierType (extensible) | |
| guardian |
0..1 | string | Parent/Guardian | |
| issuer |
0..1 | Reference(Organization) | Document issuer | |
| vaccineDetails |
1..1 | ICVPVaccineDetails | Vaccine Details | |
| 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 ICVP