GDHCN Trust Network - Personal Health Wallet
0.1.0 - ci-build International flag

GDHCN Trust Network - Personal Health Wallet, 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-trust-phw/ and changes regularly. See the Directory of published versions

Logical Model: VaccineDetailsSD - Detailed Descriptions

Draft as of 2026-04-16

Definitions for the VaccineDetailsSD logical model.

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

0. DVCVaccineDetails
Definition

Vaccine Data elements for the Digital Vaccination Certificates


Base definition for all types defined in FHIR type system.

ShortDVC - Vaccine DetailsBase for all types and resources
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())
period-from-until-must-be-present-and-valid: If period is present, both start and end must be present, and start must be before end (validity.start.exists() and (validity.end.exists() implies validity.start <= validity.end))
2. DVCVaccineDetails.vaccine[x]
Definition

Vaccine or prophylaxis product

ShortVaccine or prophylaxis
Control1..1
TypeChoice of: CodeableConcept, Reference
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.11 (Vaccine or prophylaxis), LOINC: 39236-5 (Vaccine code), SNOMED CT: 787859002 (Vaccine product (medicinal product))
4. DVCVaccineDetails.vaccine[x].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
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
6. DVCVaccineDetails.vaccine[x].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 managable, 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 DVCVaccineDetails.vaccine[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. DVCVaccineDetails.vaccine[x].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())
    10. DVCVaccineDetails.date
    Definition

    Date of vaccination

    ShortDate
    Control1..1
    Typedate
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.13 (Date), LOINC: 30952-6 (Date and time of vaccination)
    12. DVCVaccineDetails.date.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
    This element is affected by the following invariants: ele-1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    14. DVCVaccineDetails.date.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 managable, 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())
    SlicingThis element introduces a set of slices on DVCVaccineDetails.date.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 16. DVCVaccineDetails.date.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())
      18. DVCVaccineDetails.date.value
      Definition

      The actual value

      ShortPrimitive value for date
      Control0..1
      Typedate
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      20. DVCVaccineDetails.issuer
      Definition

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

      ShortRelevant authority responsible for issuing this certificate
      Control0..1
      TypeReference(Organization)
      Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.15 (Relevant authority responsible for issuing this certificate)
      22. DVCVaccineDetails.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
      This element is affected by the following invariants: ele-1
      Typeidstring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      24. DVCVaccineDetails.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 managable, 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 DVCVaccineDetails.issuer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 26. DVCVaccineDetails.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())
        28. DVCVaccineDetails.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-2, 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()))
        30. DVCVaccineDetails.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") - must be a resource in resources
        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 known RESTful URL) or by resolving the target of the reference.

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

        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()))
        32. DVCVaccineDetails.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).

        This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..1
        This element is affected by the following invariants: ref-2
        TypeIdentifier
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. DVCVaccineDetails.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
        This element is affected by the following invariants: ref-2
        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()))
        36. DVCVaccineDetails.clinicianName
        Definition

        Name of supervising clinician, of 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
        Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.14 (Name of supervising clinician)
        38. DVCVaccineDetails.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
        This element is affected by the following invariants: ele-1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        40. DVCVaccineDetails.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 managable, 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())
        SlicingThis element introduces a set of slices on DVCVaccineDetails.clinicianName.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 42. DVCVaccineDetails.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
          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())
          44. DVCVaccineDetails.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
          46. DVCVaccineDetails.manufacturer
          Definition

          Manufacturer of vaccine or prophylaxis

          ShortManufacturer of vaccine or prophylaxis
          Control1..1
          TypeReference(Organization)
          Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.16 (Manufacturer of vaccine or prophylaxis), LOINC: 30957-5 (Manufacturer name [Identifier] Vaccine)
          48. DVCVaccineDetails.manufacturer.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
          This element is affected by the following invariants: ele-1
          Typeidstring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          50. DVCVaccineDetails.manufacturer.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 managable, 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 DVCVaccineDetails.manufacturer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 52. DVCVaccineDetails.manufacturer.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())
            54. DVCVaccineDetails.manufacturer.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-2, 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()))
            56. DVCVaccineDetails.manufacturer.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") - must be a resource in resources
            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 known RESTful URL) or by resolving the target of the reference.

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

            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()))
            58. DVCVaccineDetails.manufacturer.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).

            This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..1
            This element is affected by the following invariants: ref-2
            TypeIdentifier
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            60. DVCVaccineDetails.manufacturer.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
            This element is affected by the following invariants: ref-2
            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()))
            62. DVCVaccineDetails.batchNo
            Definition

            Batch No. of vaccine or prophylaxis

            ShortBatch No. of vaccine or prophylaxis
            Control1..1
            TypeCodeableConcept
            Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.17 (Batch No. of vaccine or prophylaxis), LOINC: 30959-1 (Lot number [Identifier] Vaccine)
            64. DVCVaccineDetails.batchNo.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
            This element is affected by the following invariants: ele-1
            Typeidstring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            66. DVCVaccineDetails.batchNo.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 managable, 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 DVCVaccineDetails.batchNo.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 68. DVCVaccineDetails.batchNo.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())
              70. DVCVaccineDetails.batchNo.coding
              Definition

              A reference to a code defined by a terminology system.

              ShortCode defined by a terminology system
              Comments

              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

              Control0..*
              TypeCoding
              Is Modifierfalse
              Summarytrue
              Requirements

              Allows for alternative encodings within a code system, and translations to other code systems.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              72. DVCVaccineDetails.batchNo.text
              Definition

              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

              ShortPlain text representation of the concept
              Comments

              Very often the text is the same as a displayName of one of the codings.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              74. DVCVaccineDetails.validity
              Definition

              Certificate valid from... until...

              ShortCertificate valid from... until...
              Control1..1
              TypePeriod
              Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.D5.DE.20 (Certificate valid from), ICVP.Core CodeSystem for Data Elements: ICVP.D5.DE.21 (Certificate valid until)
              76. DVCVaccineDetails.validity.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
              This element is affected by the following invariants: ele-1
              Typeidstring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              78. DVCVaccineDetails.validity.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 managable, 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 DVCVaccineDetails.validity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 80. DVCVaccineDetails.validity.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())
                82. DVCVaccineDetails.validity.start
                Definition

                The start of the period. The boundary is inclusive.

                ShortStarting time with inclusive boundary
                Comments

                If the low element is missing, the meaning is that the low boundary is not known.

                Control0..1
                This element is affected by the following invariants: per-1
                TypedateTime
                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()))
                84. DVCVaccineDetails.validity.end
                Definition

                The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                ShortEnd time with inclusive boundary, if not ongoing
                Comments

                The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                Control0..1
                This element is affected by the following invariants: per-1
                TypedateTime
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

                0. DVCVaccineDetails
                Logical ModelInstances of this logical model are not marked to be the target of a Reference
                2. DVCVaccineDetails.vaccine[x]
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                4. DVCVaccineDetails.vaccine[x].extension:SelectiveDisclosure
                Slice NameSelectiveDisclosure
                Control0..1
                TypeExtension(SelectiveDisclosure) (Extension Type: code)
                6. DVCVaccineDetails.date
                8. DVCVaccineDetails.date.extension
                SlicingThis element introduces a set of slices on DVCVaccineDetails.date.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 10. DVCVaccineDetails.date.extension:SelectiveDisclosure
                  Slice NameSelectiveDisclosure
                  Control0..1
                  TypeExtension(SelectiveDisclosure) (Extension Type: code)
                  12. DVCVaccineDetails.issuer
                  14. DVCVaccineDetails.issuer.extension:SelectiveDisclosure
                  Slice NameSelectiveDisclosure
                  Control0..1
                  TypeExtension(SelectiveDisclosure) (Extension Type: code)
                  16. DVCVaccineDetails.clinicianName
                  18. DVCVaccineDetails.clinicianName.extension
                  SlicingThis element introduces a set of slices on DVCVaccineDetails.clinicianName.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 20. DVCVaccineDetails.clinicianName.extension:SelectiveDisclosure
                    Slice NameSelectiveDisclosure
                    Control0..1
                    TypeExtension(SelectiveDisclosure) (Extension Type: code)
                    22. DVCVaccineDetails.manufacturer
                    24. DVCVaccineDetails.manufacturer.extension:SelectiveDisclosure
                    Slice NameSelectiveDisclosure
                    Control0..1
                    TypeExtension(SelectiveDisclosure) (Extension Type: code)
                    26. DVCVaccineDetails.batchNo
                    28. DVCVaccineDetails.batchNo.extension:SelectiveDisclosure
                    Slice NameSelectiveDisclosure
                    Control0..1
                    TypeExtension(SelectiveDisclosure) (Extension Type: code)
                    30. DVCVaccineDetails.validity
                    32. DVCVaccineDetails.validity.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. DVCVaccineDetails
                    Definition

                    Vaccine Data elements for the Digital Vaccination Certificates

                    ShortDVC - 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())
                    period-from-until-must-be-present-and-valid: If period is present, both start and end must be present, and start must be before end (validity.start.exists() and (validity.end.exists() implies validity.start <= validity.end))
                    2. DVCVaccineDetails.vaccine[x]
                    Definition

                    Vaccine or prophylaxis product

                    ShortVaccine or prophylaxis
                    Control1..1
                    TypeChoice of: CodeableConcept, Reference
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.11 (Vaccine or prophylaxis), LOINC: 39236-5 (Vaccine code), SNOMED CT: 787859002 (Vaccine product (medicinal product))
                    4. DVCVaccineDetails.vaccine[x].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
                    This element is affected by the following invariants: ele-1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    6. DVCVaccineDetails.vaccine[x].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 managable, 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 DVCVaccineDetails.vaccine[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 8. DVCVaccineDetails.vaccine[x].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())
                      10. DVCVaccineDetails.date
                      Definition

                      Date of vaccination

                      ShortDate
                      Control1..1
                      Typedate
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.13 (Date), LOINC: 30952-6 (Date and time of vaccination)
                      12. DVCVaccineDetails.date.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
                      14. DVCVaccineDetails.date.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 DVCVaccineDetails.date.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 16. DVCVaccineDetails.date.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())
                        18. DVCVaccineDetails.date.value
                        Definition

                        The actual value

                        ShortPrimitive value for date
                        Control0..1
                        Typedate
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        20. DVCVaccineDetails.issuer
                        Definition

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

                        ShortRelevant authority responsible for issuing this certificate
                        Control0..1
                        TypeReference(Organization)
                        Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.15 (Relevant authority responsible for issuing this certificate)
                        22. DVCVaccineDetails.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
                        This element is affected by the following invariants: ele-1
                        Typeid
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        24. DVCVaccineDetails.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 managable, 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 DVCVaccineDetails.issuer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 26. DVCVaccineDetails.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())
                          28. DVCVaccineDetails.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-2, 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()))
                          30. DVCVaccineDetails.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") - must be a resource in resources
                          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 known RESTful URL) or by resolving the target of the reference.

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

                          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()))
                          32. DVCVaccineDetails.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).

                          This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                          NoteThis is a business identifier, not a resource identifier (see discussion)
                          Control0..1
                          This element is affected by the following invariants: ref-2
                          TypeIdentifier
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          34. DVCVaccineDetails.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
                          This element is affected by the following invariants: ref-2
                          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()))
                          36. DVCVaccineDetails.clinicianName
                          Definition

                          Name of supervising clinician, of 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
                          Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.14 (Name of supervising clinician)
                          38. DVCVaccineDetails.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
                          40. DVCVaccineDetails.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 DVCVaccineDetails.clinicianName.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 42. DVCVaccineDetails.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
                            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())
                            44. DVCVaccineDetails.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
                            46. DVCVaccineDetails.manufacturer
                            Definition

                            Manufacturer of vaccine or prophylaxis

                            ShortManufacturer of vaccine or prophylaxis
                            Control1..1
                            TypeReference(Organization)
                            Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.16 (Manufacturer of vaccine or prophylaxis), LOINC: 30957-5 (Manufacturer name [Identifier] Vaccine)
                            48. DVCVaccineDetails.manufacturer.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
                            This element is affected by the following invariants: ele-1
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            50. DVCVaccineDetails.manufacturer.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 managable, 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 DVCVaccineDetails.manufacturer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 52. DVCVaccineDetails.manufacturer.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())
                              54. DVCVaccineDetails.manufacturer.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-2, 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()))
                              56. DVCVaccineDetails.manufacturer.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") - must be a resource in resources
                              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 known RESTful URL) or by resolving the target of the reference.

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

                              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()))
                              58. DVCVaccineDetails.manufacturer.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).

                              This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                              NoteThis is a business identifier, not a resource identifier (see discussion)
                              Control0..1
                              This element is affected by the following invariants: ref-2
                              TypeIdentifier
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              60. DVCVaccineDetails.manufacturer.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
                              This element is affected by the following invariants: ref-2
                              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()))
                              62. DVCVaccineDetails.batchNo
                              Definition

                              Batch No. of vaccine or prophylaxis

                              ShortBatch No. of vaccine or prophylaxis
                              Control1..1
                              TypeCodeableConcept
                              Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.C5.DE.17 (Batch No. of vaccine or prophylaxis), LOINC: 30959-1 (Lot number [Identifier] Vaccine)
                              64. DVCVaccineDetails.batchNo.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
                              This element is affected by the following invariants: ele-1
                              Typeid
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              66. DVCVaccineDetails.batchNo.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 managable, 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 DVCVaccineDetails.batchNo.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 68. DVCVaccineDetails.batchNo.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())
                                70. DVCVaccineDetails.batchNo.coding
                                Definition

                                A reference to a code defined by a terminology system.

                                ShortCode defined by a terminology system
                                Comments

                                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                Control0..*
                                TypeCoding
                                Is Modifierfalse
                                Summarytrue
                                Requirements

                                Allows for alternative encodings within a code system, and translations to other code systems.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                72. DVCVaccineDetails.batchNo.text
                                Definition

                                A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                ShortPlain text representation of the concept
                                Comments

                                Very often the text is the same as a displayName of one of the codings.

                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                74. DVCVaccineDetails.validity
                                Definition

                                Certificate valid from... until...

                                ShortCertificate valid from... until...
                                Control1..1
                                TypePeriod
                                Definitional CodesICVP.Core CodeSystem for Data Elements: ICVP.D5.DE.20 (Certificate valid from), ICVP.Core CodeSystem for Data Elements: ICVP.D5.DE.21 (Certificate valid until)
                                76. DVCVaccineDetails.validity.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
                                This element is affected by the following invariants: ele-1
                                Typeid
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                78. DVCVaccineDetails.validity.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 managable, 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 DVCVaccineDetails.validity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 80. DVCVaccineDetails.validity.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())
                                  82. DVCVaccineDetails.validity.start
                                  Definition

                                  The start of the period. The boundary is inclusive.

                                  ShortStarting time with inclusive boundary
                                  Comments

                                  If the low element is missing, the meaning is that the low boundary is not known.

                                  Control0..1
                                  This element is affected by the following invariants: per-1
                                  TypedateTime
                                  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()))
                                  84. DVCVaccineDetails.validity.end
                                  Definition

                                  The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                  ShortEnd time with inclusive boundary, if not ongoing
                                  Comments

                                  The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                  Control0..1
                                  This element is affected by the following invariants: per-1
                                  TypedateTime
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))