Zambia Immunizations FHIR Implementation Guide
1.0.1 - ci-build
Zambia Immunizations FHIR Implementation Guide
1.0.1 - ci-build
Zambia Immunizations FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/Zambia-Immunizations/ and changes regularly. See the Directory of published versions
| Official URL: http://moh.gov.zm/fhir/immunizations/StructureDefinition/vaccine-administration | Version: 1.0.1 | |||
| Active as of 2024-09-30 | Computable Name: Vaccines | |||
Records the vaccine administered to the patient.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Immunization |
Immunization | |||
  vaccineCode |
1..1 | CodeableConcept | Vaccine administered Binding: Vaccine Codes (extensible) | |
 encounter |
1..1 | Reference(Encounter - Target Facility Encounter) | Encounter immunization was part of | |
  Slices for occurrence[x] |
1..1 | dateTime | Vaccine administration date Slice: Unordered, Open by type:$this | |
   occurrence[x]:occurrenceDateTime |
1..1 | dateTime | Vaccine administration date | |
| performer |
1..* | BackboneElement | Who performed event | |
 actor |
1..1 | Reference(Organization - Healthcare Service Provider Profile) | Individual or organization who was performing | |
| protocolApplied |
S | 0..1 | BackboneElement | Protocol followed by the provider |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.vaccineCode | extensible | VSVaccineshttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccinesfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
 vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine administered Binding: Vaccine Codes (extensible) |
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized |
| encounter |
1..1 | Reference(Encounter - Target Facility Encounter) | Encounter immunization was part of | |
| Slices for occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this |
| occurrence[x]:occurrenceDateTime |
Σ | 1..1 | dateTime | Vaccine administration date |
| performer |
Σ | 1..* | BackboneElement | Who performed event |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
Σ | 1..1 | Reference(Organization - Healthcare Service Provider Profile) | Individual or organization who was performing |
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency |
 protocolApplied |
S | 0..1 | BackboneElement | Protocol followed by the provider |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| doseNumber |
1..1 | string | Dose number within series | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|5.0.0from the FHIR Standard | |
| Immunization.vaccineCode | extensible | VSVaccineshttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccinesfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| basedOn |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | Authority that the immunization event is based on | ||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | ||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: ImmunizationStatusReasonCodes (example) | |||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine administered Binding: Vaccine Codes (extensible) | ||||
| administeredProduct |
0..1 | CodeableReference(Medication) | Product that was administered | |||||
| manufacturer |
0..1 | CodeableReference(Organization) | Vaccine manufacturer | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter |
1..1 | Reference(Encounter - Target Facility Encounter) | Encounter immunization was part of | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information in support of the immunization | |||||
| Slices for occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this | ||||
| occurrence[x]:occurrenceDateTime |
Σ | 1..1 | dateTime | Vaccine administration date | ||||
| primarySource |
Σ | 0..1 | boolean | Indicates context the data was captured in | ||||
| informationSource |
0..1 | CodeableReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Indicates the source of a reported record Binding: ImmunizationOriginCodes (example) | |||||
| location |
0..1 | Reference(Location) | Where immunization occurred | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example) | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example) | |||||
| doseQuantity |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| performer |
Σ | 1..* | BackboneElement | Who performed event | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible) | ||||
| actor |
Σ | 1..1 | Reference(Organization - Healthcare Service Provider Profile) | Individual or organization who was performing | ||||
| note |
Σ | 0..* | Annotation | Additional immunization notes | ||||
| reason |
0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Binding: ImmunizationReasonCodes (example) | |||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| programEligibility |
0..* | BackboneElement | Patient eligibility for a specific vaccination program | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| program |
1..1 | CodeableConcept | The program that eligibility is declared for Binding: CodesForVaccineFundingPrograms (example) | |||||
| programStatus |
1..1 | CodeableConcept | The patient's eligibility status for the program Binding: ImmunizationProgramEligibility (example) | |||||
| fundingSource |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) | |||||
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| date |
0..1 | dateTime | When reaction started | |||||
| manifestation |
0..1 | CodeableReference(Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
S | 0..1 | BackboneElement | Protocol followed by the provider | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |||||
| doseNumber |
1..1 | string | Dose number within series | |||||
| seriesDoses |
0..1 | string | Recommended number of doses for immunity | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| Immunization.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|5.0.0from the FHIR Standard | |
| Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reasonfrom the FHIR Standard | |
| Immunization.vaccineCode | extensible | VSVaccineshttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccinesfrom this IG | |
| Immunization.informationSource | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originfrom the FHIR Standard | |
| Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-sitefrom the FHIR Standard | |
| Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-routefrom the FHIR Standard | |
| Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | |
| Immunization.reason | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reasonfrom the FHIR Standard | |
| Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reasonfrom the FHIR Standard | |
| Immunization.programEligibility.program | example | CodesForVaccineFundingProgramshttp://hl7.org/fhir/ValueSet/immunization-vaccine-funding-programfrom the FHIR Standard | |
| Immunization.programEligibility.programStatus | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityfrom the FHIR Standard | |
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourcefrom the FHIR Standard | |
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-diseasefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() |
This structure is derived from Immunization
Summary
Mandatory: 3 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization |
Immunization | |||
| vaccineCode |
1..1 | CodeableConcept | Vaccine administered Binding: Vaccine Codes (extensible) | |
| encounter |
1..1 | Reference(Encounter - Target Facility Encounter) | Encounter immunization was part of | |
| Slices for occurrence[x] |
1..1 | dateTime | Vaccine administration date Slice: Unordered, Open by type:$this | |
| occurrence[x]:occurrenceDateTime |
1..1 | dateTime | Vaccine administration date | |
| performer |
1..* | BackboneElement | Who performed event | |
| actor |
1..1 | Reference(Organization - Healthcare Service Provider Profile) | Individual or organization who was performing | |
| protocolApplied |
S | 0..1 | BackboneElement | Protocol followed by the provider |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.vaccineCode | extensible | VSVaccineshttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccinesfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine administered Binding: Vaccine Codes (extensible) |
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized |
| encounter |
1..1 | Reference(Encounter - Target Facility Encounter) | Encounter immunization was part of | |
| Slices for occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this |
| occurrence[x]:occurrenceDateTime |
Σ | 1..1 | dateTime | Vaccine administration date |
| performer |
Σ | 1..* | BackboneElement | Who performed event |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor |
Σ | 1..1 | Reference(Organization - Healthcare Service Provider Profile) | Individual or organization who was performing |
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency |
| protocolApplied |
S | 0..1 | BackboneElement | Protocol followed by the provider |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| doseNumber |
1..1 | string | Dose number within series | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|5.0.0from the FHIR Standard | |
| Immunization.vaccineCode | extensible | VSVaccineshttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccinesfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| basedOn |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | Authority that the immunization event is based on | ||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | ||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: ImmunizationStatusReasonCodes (example) | |||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine administered Binding: Vaccine Codes (extensible) | ||||
| administeredProduct |
0..1 | CodeableReference(Medication) | Product that was administered | |||||
| manufacturer |
0..1 | CodeableReference(Organization) | Vaccine manufacturer | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter |
1..1 | Reference(Encounter - Target Facility Encounter) | Encounter immunization was part of | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information in support of the immunization | |||||
| Slices for occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this | ||||
| occurrence[x]:occurrenceDateTime |
Σ | 1..1 | dateTime | Vaccine administration date | ||||
| primarySource |
Σ | 0..1 | boolean | Indicates context the data was captured in | ||||
| informationSource |
0..1 | CodeableReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Indicates the source of a reported record Binding: ImmunizationOriginCodes (example) | |||||
| location |
0..1 | Reference(Location) | Where immunization occurred | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example) | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example) | |||||
| doseQuantity |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| performer |
Σ | 1..* | BackboneElement | Who performed event | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible) | ||||
| actor |
Σ | 1..1 | Reference(Organization - Healthcare Service Provider Profile) | Individual or organization who was performing | ||||
| note |
Σ | 0..* | Annotation | Additional immunization notes | ||||
| reason |
0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Binding: ImmunizationReasonCodes (example) | |||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| programEligibility |
0..* | BackboneElement | Patient eligibility for a specific vaccination program | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| program |
1..1 | CodeableConcept | The program that eligibility is declared for Binding: CodesForVaccineFundingPrograms (example) | |||||
| programStatus |
1..1 | CodeableConcept | The patient's eligibility status for the program Binding: ImmunizationProgramEligibility (example) | |||||
| fundingSource |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) | |||||
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| date |
0..1 | dateTime | When reaction started | |||||
| manifestation |
0..1 | CodeableReference(Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
S | 0..1 | BackboneElement | Protocol followed by the provider | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |||||
| doseNumber |
1..1 | string | Dose number within series | |||||
| seriesDoses |
0..1 | string | Recommended number of doses for immunity | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| Immunization.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|5.0.0from the FHIR Standard | |
| Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reasonfrom the FHIR Standard | |
| Immunization.vaccineCode | extensible | VSVaccineshttp://moh.gov.zm/fhir/immunizations/ValueSet/vs-vaccinesfrom this IG | |
| Immunization.informationSource | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originfrom the FHIR Standard | |
| Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-sitefrom the FHIR Standard | |
| Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-routefrom the FHIR Standard | |
| Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | |
| Immunization.reason | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reasonfrom the FHIR Standard | |
| Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reasonfrom the FHIR Standard | |
| Immunization.programEligibility.program | example | CodesForVaccineFundingProgramshttp://hl7.org/fhir/ValueSet/immunization-vaccine-funding-programfrom the FHIR Standard | |
| Immunization.programEligibility.programStatus | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityfrom the FHIR Standard | |
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourcefrom the FHIR Standard | |
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-diseasefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() |
This structure is derived from Immunization
Summary
Mandatory: 3 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron