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
| Active as of 2024-11-08 |
Definitions for the vaccination-certificate-pov logical model.
Guidance on how to interpret the contents of this table can be found here
Guidance on how to interpret the contents of this table can be found here
| 0. vaccination-certificate-vs | |
| Definition | Data elements for the IMMZ.K Vaccination Status - Proof of Vaccination Dictionary. |
| Short | IMMZ.K Vaccination Status- Proof of Vaccination |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. vaccination-certificate-vs.name | |
| Definition | Client Name |
| Short | Client Name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. vaccination-certificate-vs.vaccination | |
| Definition | Vaccination Event |
| Short | Vaccination Event |
| Control | 1..1 |
| Type | BackboneElement |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE4 |
| Invariants | ele-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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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 |
| Short | Vaccine or prophylaxis |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE5 |
| 10. vaccination-certificate-vs.vaccination.brand | |
| Definition | Vaccine brand |
| Short | Vaccine brand |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE6 |
| 12. vaccination-certificate-vs.vaccination.lot | |
| Definition | Vaccine lot number |
| Short | Vaccine lot number |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE9 |
| 14. vaccination-certificate-vs.vaccination.date | |
| Definition | |
| Short | Date of vaccination |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE10 |
| 16. vaccination-certificate-vs.vaccination.validFrom | |
| Definition | Vaccination valid from |
| Short | Vaccination valid from |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE11 |
| 18. vaccination-certificate-vs.vaccination.dose | |
| Definition | Dose number |
| Short | Dose number |
| Control | 1..1 |
| Type | positiveInt |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE12 |
| 20. vaccination-certificate-vs.vaccination.country | |
| Definition | Country of vaccination |
| Short | Country of vaccination |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE14 |
Guidance on how to interpret the contents of this table can be found here
| 0. vaccination-certificate-vs | |
| Definition | Data elements for the IMMZ.K Vaccination Status - Proof of Vaccination Dictionary. |
| Short | IMMZ.K Vaccination Status- Proof of Vaccination |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. vaccination-certificate-vs.name | |
| Definition | Client Name |
| Short | Client Name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. vaccination-certificate-vs.birthDate | |
| Definition | Date of birth |
| Short | Date of birth |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 6. vaccination-certificate-vs.identifier | |
| Definition | Unique identifier |
| Short | Unique identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Extension(Identifier) (Extension Type: Identifier) |
| Summary | true |
| 8. vaccination-certificate-vs.certificate | |
| Definition | Certificate Metadata |
| Short | Certificate Metadata |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This 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: |
| 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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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 |
| Short | Certificate issuer |
| Control | 1..1 |
| Type | code |
| Primitive Value | This 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 |
| Short | Key ID used to verify the signature of the certificate |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. vaccination-certificate-vs.certificate.hcid | |
| Definition | Health certificate identifier (HCID) |
| Short | Health certificate identifier (HCID) |
| Control | 1..1 |
| Type | Extension(Identifier) (Extension Type: Identifier) |
| 22. vaccination-certificate-vs.certificate.ddccid | |
| Definition | DDCC Identifier |
| Short | DDCC Identifier |
| Control | 0..1 |
| Type | Extension(Identifier) (Extension Type: Identifier) |
| 24. vaccination-certificate-vs.certificate.version | |
| Definition | Certificate schema version |
| Short | Certificate schema version |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. vaccination-certificate-vs.certificate.period | |
| Definition | Certificate Validity Period |
| Short | Certificate Validity Period |
| Control | 1..1 |
| Type | Extension(Organization Period) (Extension Type: Period) |
| Invariants | ele-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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This 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: |
| 32. vaccination-certificate-vs.certificate.period.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies 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. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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). |
| Short | Value of extension |
| Control | 0..1 |
| Type | Choice 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] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-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 |
| Short | Certificate valid from |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. vaccination-certificate-vs.certificate.period.end | |
| Definition | Certificate valid until |
| Short | Certificate valid until |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. vaccination-certificate-vs.vaccination | |
| Definition | Vaccination Event |
| Short | Vaccination Event |
| Control | 1..1 |
| Type | BackboneElement |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE4 |
| Invariants | ele-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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This 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: |
| 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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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 |
| Short | Vaccine or prophylaxis |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE5 |
| 50. vaccination-certificate-vs.vaccination.brand | |
| Definition | Vaccine brand |
| Short | Vaccine brand |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE6 |
| 52. vaccination-certificate-vs.vaccination.manufacturer | |
| Definition | Vaccine manufacturer |
| Short | Vaccine manufacturer |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE7 |
| 54. vaccination-certificate-vs.vaccination.maholder | |
| Definition | Vaccine market authorization holder |
| Short | Vaccine market authorization holder |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE8 |
| 56. vaccination-certificate-vs.vaccination.lot | |
| Definition | Vaccine lot number |
| Short | Vaccine lot number |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE9 |
| 58. vaccination-certificate-vs.vaccination.date | |
| Definition | |
| Short | Date of vaccination |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE10 |
| 60. vaccination-certificate-vs.vaccination.validFrom | |
| Definition | Vaccination valid from |
| Short | Vaccination valid from |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE11 |
| 62. vaccination-certificate-vs.vaccination.dose | |
| Definition | Dose number |
| Short | Dose number |
| Control | 1..1 |
| Type | positiveInt |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE12 |
| 64. vaccination-certificate-vs.vaccination.totalDoses | |
| Definition | Total doses |
| Short | Total doses |
| Control | 0..1 |
| Type | positiveInt |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE13 |
| 66. vaccination-certificate-vs.vaccination.country | |
| Definition | Country of vaccination |
| Short | Country of vaccination |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE14 |
| 68. vaccination-certificate-vs.vaccination.centre | |
| Definition | Administering centre |
| Short | Administering centre |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE15 |
| 70. vaccination-certificate-vs.vaccination.signature | |
| Definition | Signature of health worker |
| Short | Signature of health worker |
| Control | 0..1 |
| Type | Extension(QuestionnaireResponse Signature) (Extension Type: Signature) |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE16 |
| 72. vaccination-certificate-vs.vaccination.practitioner | |
| Definition | Health worker identifier |
| Short | Health worker identifier |
| Control | 0..1 |
| Type | Extension(Identifier) (Extension Type: Identifier) |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE17 |
| 74. vaccination-certificate-vs.vaccination.disease | |
| Definition | Disease or agent targeted |
| Short | Disease or agent targeted |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE18 |
| 76. vaccination-certificate-vs.vaccination.nextDose | |
| Definition | Due date of next dose |
| Short | Due date of next dose |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.H CodeSystem for Vaccine status DE19 |