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

Logical Model: ICVPVaccineDetailsSD - Detailed Descriptions

Draft as of 2025-08-19

Definitions for the ICVPVaccineDetailsSD logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. ICVPVaccineDetails
Definition

Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis

ShortICVP - Vaccine Details
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsmust-have-issuer-or-clinician: Either issuer or clinicianName must be present (issuer.exists() or clinicianName.exists())
2. ICVPVaccineDetails.productID
Definition

Vaccine product information (note: use InventoryItem in FHIR R6)

ShortVaccine Product
Control1..1
TypeCoding
Invariantsis-a-prequal-product-id: Product ID comes from the PreQual Databatase (system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs')
is-an-icvp-product-id: Product ID comes from the ICVP vaccines from the PreQual Databatase ( system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs' )
4. ICVPVaccineDetails.date
Definition

Date of vaccine

ShortDate
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. ICVPVaccineDetails.issuer
Definition

Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center

ShortIssuing Organization
Control0..1
TypeReference(Organization)
8. ICVPVaccineDetails.issuer.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
10. ICVPVaccineDetails.issuer.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ICVPVaccineDetails.issuer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 12. ICVPVaccineDetails.issuer.extension:SelectiveDisclosure
    Slice NameSelectiveDisclosure
    Definition

    Guidance that a document signing service with selective disclosure support (e.g. SD-JWT) should perform a selective disclosure of the content of the containing node of the extension in the JSON representation of the FHIR instance.

    The code value should be from a code system containing appropriate disclosure statements for the use case. The disclosure statement should describe the content that is to be disclosed at that node. For example a code such as 'disclose-date-of-birth' or 'disclose-vaccine-history'.

    ShortExtension
    Control0..1
    TypeExtension(SelectiveDisclosure) (Extension Type: code)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. ICVPVaccineDetails.issuer.reference
    Definition

    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

    ShortLiteral reference, Relative, internal or absolute URL
    Comments

    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

    Control0..1
    This element is affected by the following invariants: ref-1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. ICVPVaccineDetails.issuer.type
    Definition

    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

    ShortType the reference refers to (e.g. "Patient")
    Comments

    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
    (extensible to http://hl7.org/fhir/ValueSet/resource-types)

    Aa resource (or, for logical models, the URI of the logical model).

    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. ICVPVaccineDetails.issuer.identifier
    Definition

    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

    ShortLogical reference, when literal reference is not known
    Comments

    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    TypeIdentifier
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. ICVPVaccineDetails.issuer.display
    Definition

    Plain text narrative that identifies the resource in addition to the resource reference.

    ShortText alternative for the resource
    Comments

    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. ICVPVaccineDetails.clinicianName
    Definition

    Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre

    ShortName of supervising clinician
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    24. ICVPVaccineDetails.clinicianName.id
    Definition

    unique id for the element within a resource (for internal references)


    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    Shortxml:id (or equivalent in JSON)Unique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    26. ICVPVaccineDetails.clinicianName.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortExtensionAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on ICVPVaccineDetails.clinicianName.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 28. ICVPVaccineDetails.clinicianName.extension:SelectiveDisclosure
      Slice NameSelectiveDisclosure
      Definition

      Guidance that a document signing service with selective disclosure support (e.g. SD-JWT) should perform a selective disclosure of the content of the containing node of the extension in the JSON representation of the FHIR instance.

      The code value should be from a code system containing appropriate disclosure statements for the use case. The disclosure statement should describe the content that is to be disclosed at that node. For example a code such as 'disclose-date-of-birth' or 'disclose-vaccine-history'.

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(SelectiveDisclosure) (Extension Type: code)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      30. ICVPVaccineDetails.clinicianName.value
      Definition

      The actual value

      ShortPrimitive value for string
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Max Length:1048576
      32. ICVPVaccineDetails.batchNo
      Definition

      Batch No

      ShortBatch No
      Control1..1
      TypeCodeableConcept
      34. ICVPVaccineDetails.validityPeriod
      Definition

      Certificate validity period

      ShortCertificate validity period
      Control0..1
      TypePeriod

      Guidance on how to interpret the contents of this table can be foundhere

      0. ICVPVaccineDetails
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      2. ICVPVaccineDetails.issuer
      4. ICVPVaccineDetails.issuer.extension:SelectiveDisclosure
      Slice NameSelectiveDisclosure
      Control0..1
      TypeExtension(SelectiveDisclosure) (Extension Type: code)
      6. ICVPVaccineDetails.clinicianName
      8. ICVPVaccineDetails.clinicianName.extension
      SlicingThis element introduces a set of slices on ICVPVaccineDetails.clinicianName.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 10. ICVPVaccineDetails.clinicianName.extension:SelectiveDisclosure
        Slice NameSelectiveDisclosure
        Control0..1
        TypeExtension(SelectiveDisclosure) (Extension Type: code)

        Guidance on how to interpret the contents of this table can be foundhere

        0. ICVPVaccineDetails
        Definition

        Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis

        ShortICVP - Vaccine Details
        Control0..*
        Is Modifierfalse
        Logical ModelInstances of this logical model are not marked to be the target of a Reference
        Invariantsmust-have-issuer-or-clinician: Either issuer or clinicianName must be present (issuer.exists() or clinicianName.exists())
        2. ICVPVaccineDetails.productID
        Definition

        Vaccine product information (note: use InventoryItem in FHIR R6)

        ShortVaccine Product
        Control1..1
        TypeCoding
        Invariantsis-a-prequal-product-id: Product ID comes from the PreQual Databatase (system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs')
        is-an-icvp-product-id: Product ID comes from the ICVP vaccines from the PreQual Databatase ( system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs' )
        4. ICVPVaccineDetails.date
        Definition

        Date of vaccine

        ShortDate
        Control1..1
        Typedate
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        6. ICVPVaccineDetails.issuer
        Definition

        Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center

        ShortIssuing Organization
        Control0..1
        TypeReference(Organization)
        8. ICVPVaccineDetails.issuer.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        10. ICVPVaccineDetails.issuer.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on ICVPVaccineDetails.issuer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. ICVPVaccineDetails.issuer.extension:SelectiveDisclosure
          Slice NameSelectiveDisclosure
          Definition

          Guidance that a document signing service with selective disclosure support (e.g. SD-JWT) should perform a selective disclosure of the content of the containing node of the extension in the JSON representation of the FHIR instance.

          The code value should be from a code system containing appropriate disclosure statements for the use case. The disclosure statement should describe the content that is to be disclosed at that node. For example a code such as 'disclose-date-of-birth' or 'disclose-vaccine-history'.

          ShortExtension
          Control0..1
          TypeExtension(SelectiveDisclosure) (Extension Type: code)
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          14. ICVPVaccineDetails.issuer.reference
          Definition

          A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

          ShortLiteral reference, Relative, internal or absolute URL
          Comments

          Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

          Control0..1
          This element is affected by the following invariants: ref-1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          16. ICVPVaccineDetails.issuer.type
          Definition

          The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

          The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

          ShortType the reference refers to (e.g. "Patient")
          Comments

          This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

          Control0..1
          BindingUnless not suitable, these codes SHALL be taken from ResourceType
          (extensible to http://hl7.org/fhir/ValueSet/resource-types)

          Aa resource (or, for logical models, the URI of the logical model).

          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          18. ICVPVaccineDetails.issuer.identifier
          Definition

          An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

          ShortLogical reference, when literal reference is not known
          Comments

          When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

          When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

          Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

          Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..1
          TypeIdentifier
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          20. ICVPVaccineDetails.issuer.display
          Definition

          Plain text narrative that identifies the resource in addition to the resource reference.

          ShortText alternative for the resource
          Comments

          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          22. ICVPVaccineDetails.clinicianName
          Definition

          Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre

          ShortName of supervising clinician
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          24. ICVPVaccineDetails.clinicianName.id
          Definition

          unique id for the element within a resource (for internal references)

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          26. ICVPVaccineDetails.clinicianName.extension
          Definition

          An Extension

          ShortExtension
          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on ICVPVaccineDetails.clinicianName.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 28. ICVPVaccineDetails.clinicianName.extension:SelectiveDisclosure
            Slice NameSelectiveDisclosure
            Definition

            Guidance that a document signing service with selective disclosure support (e.g. SD-JWT) should perform a selective disclosure of the content of the containing node of the extension in the JSON representation of the FHIR instance.

            The code value should be from a code system containing appropriate disclosure statements for the use case. The disclosure statement should describe the content that is to be disclosed at that node. For example a code such as 'disclose-date-of-birth' or 'disclose-vaccine-history'.

            ShortExtension
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(SelectiveDisclosure) (Extension Type: code)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            30. ICVPVaccineDetails.clinicianName.value
            Definition

            The actual value

            ShortPrimitive value for string
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Max Length:1048576
            32. ICVPVaccineDetails.batchNo
            Definition

            Batch No

            ShortBatch No
            Control1..1
            TypeCodeableConcept
            34. ICVPVaccineDetails.validityPeriod
            Definition

            Certificate validity period

            ShortCertificate validity period
            Control0..1
            TypePeriod