SMART ICVP
0.1.0 - ci-build

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

Logical Model: dICVPmin HCERT Payload

Official URL: http://smart.who.int/icvp/StructureDefinition/DVCPayload Version: 0.1.0
Draft as of 2025-02-16 Computable Name: DVCPayload

Payload for digital ICVP - dICVPmin CBOR Web Token Logical Model

Usage:

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

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DVCPayload C 0..* Base dICVPmin HCERT Payload
must-have-issuer-or-clinician-name: Either issuer or clinicianName must be present
... 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: http://terminology.hl7.org/CodeSystem/v2-0203 (extensible)
... gn 0..1 string Parent or Guardian Name
... v 1..1 BackboneElement Vaccination Group (see element details)
ele-1: All FHIR elements must have a @value or children
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... vp 1..1 string ICVP Product Catalog ID
Binding: preQualVaccines (required)
.... dt 1..1 date Date of vaccination, YYYY-MM-DD format
.... cn 0..1 string Name of supervising clinician
.... is 0..1 id Certificate issuer id (referenced organization)
.... 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

PathConformanceValueSetURI
DVCPayload.ndtextensiblehttp://terminology.hl7.org/CodeSystem/v2-0203
http://terminology.hl7.org/CodeSystem/v2-0203
DVCPayload.v.vprequiredpreQualVaccines (a valid code from Prequalified Vaccines)
http://smart.who.int/icvp/ValueSet/preQualVaccines
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
must-have-issuer-or-clinician-nameerrorDVCPayloadEither issuer or clinicianName must be present
: v.is.exists() or v.cn.exists()

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. DVCPayload C 0..* Base dICVPmin HCERT Payload
must-have-issuer-or-clinician-name: Either issuer or clinicianName must be present
... 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: http://terminology.hl7.org/CodeSystem/v2-0203 (extensible)
... gn 0..1 string Parent or Guardian Name
... v 1..1 BackboneElement Vaccination Group (see element details)
.... vp 1..1 string ICVP Product Catalog ID
Binding: preQualVaccines (required)
.... dt 1..1 date Date of vaccination, YYYY-MM-DD format
.... cn 0..1 string Name of supervising clinician
.... is 0..1 id Certificate issuer id (referenced organization)
.... 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 (Differential)

PathConformanceValueSetURI
DVCPayload.ndtextensiblehttp://terminology.hl7.org/CodeSystem/v2-0203
http://terminology.hl7.org/CodeSystem/v2-0203
DVCPayload.v.vprequiredpreQualVaccines (a valid code from Prequalified Vaccines)
http://smart.who.int/icvp/ValueSet/preQualVaccines
from this IG

Constraints

IdGradePath(s)DetailsRequirements
must-have-issuer-or-clinician-nameerrorDVCPayloadEither issuer or clinicianName must be present
: v.is.exists() or v.cn.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DVCPayload C 0..* Base dICVPmin HCERT Payload
must-have-issuer-or-clinician-name: Either issuer or clinicianName must be present
... 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: http://terminology.hl7.org/CodeSystem/v2-0203 (extensible)
... gn 0..1 string Parent or Guardian Name
... v 1..1 BackboneElement Vaccination Group (see element details)
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vp 1..1 string ICVP Product Catalog ID
Binding: preQualVaccines (required)
.... dt 1..1 date Date of vaccination, YYYY-MM-DD format
.... cn 0..1 string Name of supervising clinician
.... is 0..1 id Certificate issuer id (referenced organization)
.... 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

PathConformanceValueSetURI
DVCPayload.ndtextensiblehttp://terminology.hl7.org/CodeSystem/v2-0203
http://terminology.hl7.org/CodeSystem/v2-0203
DVCPayload.v.vprequiredpreQualVaccines (a valid code from Prequalified Vaccines)
http://smart.who.int/icvp/ValueSet/preQualVaccines
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
must-have-issuer-or-clinician-nameerrorDVCPayloadEither issuer or clinicianName must be present
: v.is.exists() or v.cn.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(6 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DVCPayload C 0..* Base dICVPmin HCERT Payload
must-have-issuer-or-clinician-name: Either issuer or clinicianName must be present
... 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: http://terminology.hl7.org/CodeSystem/v2-0203 (extensible)
... gn 0..1 string Parent or Guardian Name
... v 1..1 BackboneElement Vaccination Group (see element details)
ele-1: All FHIR elements must have a @value or children
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... vp 1..1 string ICVP Product Catalog ID
Binding: preQualVaccines (required)
.... dt 1..1 date Date of vaccination, YYYY-MM-DD format
.... cn 0..1 string Name of supervising clinician
.... is 0..1 id Certificate issuer id (referenced organization)
.... 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

PathConformanceValueSetURI
DVCPayload.ndtextensiblehttp://terminology.hl7.org/CodeSystem/v2-0203
http://terminology.hl7.org/CodeSystem/v2-0203
DVCPayload.v.vprequiredpreQualVaccines (a valid code from Prequalified Vaccines)
http://smart.who.int/icvp/ValueSet/preQualVaccines
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
must-have-issuer-or-clinician-nameerrorDVCPayloadEither issuer or clinicianName must be present
: v.is.exists() or v.cn.exists()

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. DVCPayload C 0..* Base dICVPmin HCERT Payload
must-have-issuer-or-clinician-name: Either issuer or clinicianName must be present
... 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: http://terminology.hl7.org/CodeSystem/v2-0203 (extensible)
... gn 0..1 string Parent or Guardian Name
... v 1..1 BackboneElement Vaccination Group (see element details)
.... vp 1..1 string ICVP Product Catalog ID
Binding: preQualVaccines (required)
.... dt 1..1 date Date of vaccination, YYYY-MM-DD format
.... cn 0..1 string Name of supervising clinician
.... is 0..1 id Certificate issuer id (referenced organization)
.... 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 (Differential)

PathConformanceValueSetURI
DVCPayload.ndtextensiblehttp://terminology.hl7.org/CodeSystem/v2-0203
http://terminology.hl7.org/CodeSystem/v2-0203
DVCPayload.v.vprequiredpreQualVaccines (a valid code from Prequalified Vaccines)
http://smart.who.int/icvp/ValueSet/preQualVaccines
from this IG

Constraints

IdGradePath(s)DetailsRequirements
must-have-issuer-or-clinician-nameerrorDVCPayloadEither issuer or clinicianName must be present
: v.is.exists() or v.cn.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DVCPayload C 0..* Base dICVPmin HCERT Payload
must-have-issuer-or-clinician-name: Either issuer or clinicianName must be present
... 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: http://terminology.hl7.org/CodeSystem/v2-0203 (extensible)
... gn 0..1 string Parent or Guardian Name
... v 1..1 BackboneElement Vaccination Group (see element details)
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vp 1..1 string ICVP Product Catalog ID
Binding: preQualVaccines (required)
.... dt 1..1 date Date of vaccination, YYYY-MM-DD format
.... cn 0..1 string Name of supervising clinician
.... is 0..1 id Certificate issuer id (referenced organization)
.... 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

PathConformanceValueSetURI
DVCPayload.ndtextensiblehttp://terminology.hl7.org/CodeSystem/v2-0203
http://terminology.hl7.org/CodeSystem/v2-0203
DVCPayload.v.vprequiredpreQualVaccines (a valid code from Prequalified Vaccines)
http://smart.who.int/icvp/ValueSet/preQualVaccines
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
must-have-issuer-or-clinician-nameerrorDVCPayloadEither issuer or clinicianName must be present
: v.is.exists() or v.cn.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(6 nested mandatory elements)

 

Other representations of profile: CSV, Excel