ChanjoKE Immunization Implementation Guide
0.1.0 - ci-build

ChanjoKE Immunization Implementation Guide, published by Intellisoft Consulting Ltd. 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/IntelliSOFT-Consulting/ChanjoKe-FHIR-IG/ and changes regularly. See the Directory of published versions

Logical Model: VaccinationCertificate_CoC - Detailed Descriptions

Active as of 2024-11-08

Definitions for the vaccination-certificate-coc logical model.

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

0. vaccination-certificate-vs
Definition

Data elements for the IMMZ.G Vaccination Status - Continuity of Care Data Dictionary.

ShortIMMZ.G Vaccination Status- Continuity of Care
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. vaccination-certificate-vs.sex
Definition

Administrative gender

ShortSex
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. vaccination-certificate-vs
Definition

Data elements for the IMMZ.G Vaccination Status - Continuity of Care Data Dictionary.

ShortIMMZ.G Vaccination Status- Continuity of Care
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. vaccination-certificate-vs.name
Definition

Client Name

ShortClient Name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. vaccination-certificate-vs.vaccination
Definition

Vaccination Event

ShortVaccination Event
Control1..1
TypeBackboneElement
Definitional CodesIMMZ.H CodeSystem for Vaccine status DE4
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. vaccination-certificate-vs.vaccination.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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())
8. vaccination-certificate-vs.vaccination.vaccine
Definition

Vaccine or prophylaxis

ShortVaccine or prophylaxis
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.H CodeSystem for Vaccine status DE5
10. vaccination-certificate-vs.vaccination.brand
Definition

Vaccine brand

ShortVaccine brand
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.H CodeSystem for Vaccine status DE6
12. vaccination-certificate-vs.vaccination.lot
Definition

Vaccine lot number

ShortVaccine lot number
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.H CodeSystem for Vaccine status DE9
14. vaccination-certificate-vs.vaccination.date
Definition
Date of vaccination
Short Date of vaccination
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.H CodeSystem for Vaccine status DE10
16. vaccination-certificate-vs.vaccination.validFrom
Definition

Vaccination valid from

ShortVaccination valid from
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.H CodeSystem for Vaccine status DE11
18. vaccination-certificate-vs.vaccination.dose
Definition

Dose number

ShortDose number
Control1..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.H CodeSystem for Vaccine status DE12
20. vaccination-certificate-vs.vaccination.country
Definition

Country of vaccination

ShortCountry of vaccination
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Definitional CodesIMMZ.H CodeSystem for Vaccine status DE14
22. vaccination-certificate-vs.sex
Definition

Administrative gender

ShortSex
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. vaccination-certificate-vs
Definition

Data elements for the IMMZ.G Vaccination Status - Continuity of Care Data Dictionary.

ShortIMMZ.G Vaccination Status- Continuity of Care
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. vaccination-certificate-vs.name
Definition

Client Name

ShortClient Name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. vaccination-certificate-vs.birthDate
Definition

Date of birth

ShortDate of birth
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
6. vaccination-certificate-vs.identifier
Definition

Unique identifier

ShortUnique identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeExtension(Identifier) (Extension Type: Identifier)
Summarytrue
8. vaccination-certificate-vs.certificate
Definition

Certificate Metadata

ShortCertificate Metadata
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. vaccination-certificate-vs.certificate.id
Definition

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

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

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

ShortAdditional content defined by implementations
Comments

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

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

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    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())
    16. vaccination-certificate-vs.certificate.issuer
    Definition

    Certificate issuer

    ShortCertificate issuer
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. vaccination-certificate-vs.certificate.kid
    Definition

    Key ID used to verify the signature of the certificate

    ShortKey ID used to verify the signature of the certificate
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. vaccination-certificate-vs.certificate.hcid
    Definition

    Health certificate identifier (HCID)

    ShortHealth certificate identifier (HCID)
    Control1..1
    TypeExtension(Identifier) (Extension Type: Identifier)
    22. vaccination-certificate-vs.certificate.ddccid
    Definition

    DDCC Identifier

    ShortDDCC Identifier
    Control0..1
    TypeExtension(Identifier) (Extension Type: Identifier)
    24. vaccination-certificate-vs.certificate.version
    Definition

    Certificate schema version

    ShortCertificate schema version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    26. vaccination-certificate-vs.certificate.period
    Definition

    Certificate Validity Period

    ShortCertificate Validity Period
    Control1..1
    TypeExtension(Organization Period) (Extension Type: Period)
    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. vaccination-certificate-vs.certificate.period.id
    Definition

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

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    30. vaccination-certificate-vs.certificate.period.extension
    Definition

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

    ShortAdditional content defined by implementations
    Comments

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

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

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      34. vaccination-certificate-vs.certificate.period.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control0..1
      TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. vaccination-certificate-vs.certificate.period.start
      Definition

      Certificate valid from

      ShortCertificate valid from
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      38. vaccination-certificate-vs.certificate.period.end
      Definition

      Certificate valid until

      ShortCertificate valid until
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      40. vaccination-certificate-vs.vaccination
      Definition

      Vaccination Event

      ShortVaccination Event
      Control1..1
      TypeBackboneElement
      Definitional CodesIMMZ.H CodeSystem for Vaccine status DE4
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      42. vaccination-certificate-vs.vaccination.id
      Definition

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

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

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

      ShortAdditional content defined by implementations
      Comments

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

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

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        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())
        48. vaccination-certificate-vs.vaccination.vaccine
        Definition

        Vaccine or prophylaxis

        ShortVaccine or prophylaxis
        Control1..1
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE5
        50. vaccination-certificate-vs.vaccination.brand
        Definition

        Vaccine brand

        ShortVaccine brand
        Control1..1
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE6
        52. vaccination-certificate-vs.vaccination.manufacturer
        Definition

        Vaccine manufacturer

        ShortVaccine manufacturer
        Control0..1
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE7
        54. vaccination-certificate-vs.vaccination.maholder
        Definition

        Vaccine market authorization holder

        ShortVaccine market authorization holder
        Control0..1
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE8
        56. vaccination-certificate-vs.vaccination.lot
        Definition

        Vaccine lot number

        ShortVaccine lot number
        Control1..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE9
        58. vaccination-certificate-vs.vaccination.date
        Definition
        Date of vaccination
        
        Short Date of vaccination
        Control1..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE10
        60. vaccination-certificate-vs.vaccination.validFrom
        Definition

        Vaccination valid from

        ShortVaccination valid from
        Control1..1
        Typedate
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE11
        62. vaccination-certificate-vs.vaccination.dose
        Definition

        Dose number

        ShortDose number
        Control1..1
        TypepositiveInt
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE12
        64. vaccination-certificate-vs.vaccination.totalDoses
        Definition

        Total doses

        ShortTotal doses
        Control0..1
        TypepositiveInt
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE13
        66. vaccination-certificate-vs.vaccination.country
        Definition

        Country of vaccination

        ShortCountry of vaccination
        Control1..1
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE14
        68. vaccination-certificate-vs.vaccination.centre
        Definition

        Administering centre

        ShortAdministering centre
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE15
        70. vaccination-certificate-vs.vaccination.signature
        Definition

        Signature of health worker

        ShortSignature of health worker
        Control0..1
        TypeExtension(QuestionnaireResponse Signature) (Extension Type: Signature)
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE16
        72. vaccination-certificate-vs.vaccination.practitioner
        Definition

        Health worker identifier

        ShortHealth worker identifier
        Control0..1
        TypeExtension(Identifier) (Extension Type: Identifier)
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE17
        74. vaccination-certificate-vs.vaccination.disease
        Definition

        Disease or agent targeted

        ShortDisease or agent targeted
        Control0..1
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE18
        76. vaccination-certificate-vs.vaccination.nextDose
        Definition

        Due date of next dose

        ShortDue date of next dose
        Control0..1
        Typedate
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Definitional CodesIMMZ.H CodeSystem for Vaccine status DE19
        78. vaccination-certificate-vs.sex
        Definition

        Administrative gender

        ShortSex
        Control0..1
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension