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
Official URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/vaccination-certificate-coc | Version: 0.1.0 | |||
Active as of 2024-11-08 | Computable Name: VaccinationCertificate_CoC |
Data elements for the IMMZ.G Vaccination Status - Continuity of Care Data Dictionary.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from VaccinationCertificate_VS
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
vaccination-certificate-vs | 0..* | VaccinationCertificate_VS | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination IMMZ.G Vaccination Status- Continuity of Care Instances of this logical model can be the target of a Reference | |
sex | 0..1 | code | Sex | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
vaccination-certificate-vs | 0..* | VaccinationCertificate_VS | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination IMMZ.G Vaccination Status- Continuity of Care Instances of this logical model can be the target of a Reference | |
name | Σ | 1..1 | string | Client Name |
vaccination | 1..1 | BackboneElement | Vaccination Event | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
vaccine | 1..1 | code | Vaccine or prophylaxis | |
brand | 1..1 | code | Vaccine brand | |
lot | 1..1 | string | Vaccine lot number | |
date | 1..1 | dateTime | Date of vaccination | |
validFrom | 1..1 | date | Vaccination valid from | |
dose | 1..1 | positiveInt | Dose number | |
country | Σ | 1..1 | code | Country of vaccination |
sex | 0..1 | code | Sex | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
vaccination-certificate-vs | 0..* | VaccinationCertificate_VS | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination IMMZ.G Vaccination Status- Continuity of Care Instances of this logical model can be the target of a Reference | |
name | Σ | 1..1 | string | Client Name |
birthDate | Σ | 0..1 | date | Date of birth |
identifier | Σ | 0..1 | Identifier(5.1.0) | Unique identifier |
certificate | 0..1 | BackboneElement | Certificate Metadata | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
issuer | 1..1 | code | Certificate issuer | |
kid | 0..1 | string | Key ID used to verify the signature of the certificate | |
hcid | 1..1 | Identifier(5.1.0) | Health certificate identifier (HCID) | |
ddccid | 0..1 | Identifier(5.1.0) | DDCC Identifier | |
version | 1..1 | string | Certificate schema version | |
period | 1..1 | OrgPeriod(5.1.0) | Certificate Validity Period ext-1: Must have either extensions or value[x], not both | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
@url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | 0..1 | Value of extension | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
start | 0..1 | dateTime | Certificate valid from | |
end | 0..1 | dateTime | Certificate valid until | |
vaccination | 1..1 | BackboneElement | Vaccination Event | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
vaccine | 1..1 | code | Vaccine or prophylaxis | |
brand | 1..1 | code | Vaccine brand | |
manufacturer | 0..1 | code | Vaccine manufacturer | |
maholder | 0..1 | code | Vaccine market authorization holder | |
lot | 1..1 | string | Vaccine lot number | |
date | 1..1 | dateTime | Date of vaccination | |
validFrom | 1..1 | date | Vaccination valid from | |
dose | 1..1 | positiveInt | Dose number | |
totalDoses | 0..1 | positiveInt | Total doses | |
country | Σ | 1..1 | code | Country of vaccination |
centre | 0..1 | string | Administering centre | |
signature | 0..1 | QRSignature(5.1.0) | Signature of health worker | |
practitioner | 0..1 | Identifier(5.1.0) | Health worker identifier | |
disease | 0..1 | code | Disease or agent targeted | |
nextDose | 0..1 | date | Due date of next dose | |
sex | 0..1 | code | Sex | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ext-1 | error | vaccination-certificate-vs.certificate.period | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from VaccinationCertificate_VS
Differential View
This structure is derived from VaccinationCertificate_VS
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
vaccination-certificate-vs | 0..* | VaccinationCertificate_VS | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination IMMZ.G Vaccination Status- Continuity of Care Instances of this logical model can be the target of a Reference | |
sex | 0..1 | code | Sex | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
vaccination-certificate-vs | 0..* | VaccinationCertificate_VS | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination IMMZ.G Vaccination Status- Continuity of Care Instances of this logical model can be the target of a Reference | |
name | Σ | 1..1 | string | Client Name |
vaccination | 1..1 | BackboneElement | Vaccination Event | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
vaccine | 1..1 | code | Vaccine or prophylaxis | |
brand | 1..1 | code | Vaccine brand | |
lot | 1..1 | string | Vaccine lot number | |
date | 1..1 | dateTime | Date of vaccination | |
validFrom | 1..1 | date | Vaccination valid from | |
dose | 1..1 | positiveInt | Dose number | |
country | Σ | 1..1 | code | Country of vaccination |
sex | 0..1 | code | Sex | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
vaccination-certificate-vs | 0..* | VaccinationCertificate_VS | This is an abstracttype. Elements defined in Ancestors:name, birthDate, identifier, certificate, vaccination IMMZ.G Vaccination Status- Continuity of Care Instances of this logical model can be the target of a Reference | |
name | Σ | 1..1 | string | Client Name |
birthDate | Σ | 0..1 | date | Date of birth |
identifier | Σ | 0..1 | Identifier(5.1.0) | Unique identifier |
certificate | 0..1 | BackboneElement | Certificate Metadata | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
issuer | 1..1 | code | Certificate issuer | |
kid | 0..1 | string | Key ID used to verify the signature of the certificate | |
hcid | 1..1 | Identifier(5.1.0) | Health certificate identifier (HCID) | |
ddccid | 0..1 | Identifier(5.1.0) | DDCC Identifier | |
version | 1..1 | string | Certificate schema version | |
period | 1..1 | OrgPeriod(5.1.0) | Certificate Validity Period ext-1: Must have either extensions or value[x], not both | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
@url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | 0..1 | Value of extension | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
start | 0..1 | dateTime | Certificate valid from | |
end | 0..1 | dateTime | Certificate valid until | |
vaccination | 1..1 | BackboneElement | Vaccination Event | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
vaccine | 1..1 | code | Vaccine or prophylaxis | |
brand | 1..1 | code | Vaccine brand | |
manufacturer | 0..1 | code | Vaccine manufacturer | |
maholder | 0..1 | code | Vaccine market authorization holder | |
lot | 1..1 | string | Vaccine lot number | |
date | 1..1 | dateTime | Date of vaccination | |
validFrom | 1..1 | date | Vaccination valid from | |
dose | 1..1 | positiveInt | Dose number | |
totalDoses | 0..1 | positiveInt | Total doses | |
country | Σ | 1..1 | code | Country of vaccination |
centre | 0..1 | string | Administering centre | |
signature | 0..1 | QRSignature(5.1.0) | Signature of health worker | |
practitioner | 0..1 | Identifier(5.1.0) | Health worker identifier | |
disease | 0..1 | code | Disease or agent targeted | |
nextDose | 0..1 | date | Due date of next dose | |
sex | 0..1 | code | Sex | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ext-1 | error | vaccination-certificate-vs.certificate.period | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from VaccinationCertificate_VS