SMART Empty IG
0.1.0 - ci-build
SMART Empty IG, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/DigitalSQR/smart-catopia-measles and changes regularly. See the Directory of published versions
| Active as of 2024-03-24 |
Definitions for the IMMZDCatUpdateVaccinationRecord logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. IMMZDCatUpdateVaccinationRecord | |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. IMMZDCatUpdateVaccinationRecord.vaccineProduct | |
| Binding | The codes SHALL be taken from Catopia MeaslesVaccine Products ValueSet (required to http://worldhealthorganization.github.io/smart/ValueSet/VSCatMeaslesVaccineProducts) |
Guidance on how to interpret the contents of this table can be found here
| 0. IMMZDCatUpdateVaccinationRecord | |
| Definition | Data elements for IMMZ.D Update Vaccination Record. |
| Short | IMMZ.D Update Vaccination Record |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. IMMZDCatUpdateVaccinationRecord.immunizatioEventStatus | |
| Definition | The current status of the individual immunization event |
| Short | The current status of the individual immunization event |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IMMZ.D1.DE1 CodeSystem for Immunization status (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE1VS) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. IMMZDCatUpdateVaccinationRecord.vaccineProduct | |
| Definition | The brand or trade name used to refer to the vaccine received |
| Short | Vaccine brand |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Catopia MeaslesVaccine Products ValueSet (required to http://worldhealthorganization.github.io/smart/ValueSet/VSCatMeaslesVaccineProducts) |
| Type | Coding |
| 6. IMMZDCatUpdateVaccinationRecord.dateTime | |
| Definition | Represents the visit/encounter date, which is the date and time when the vaccine was administered to the client |
| Short | Date and time of vaccination |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. IMMZDCatUpdateVaccinationRecord.countryOfVaccination | |
| Definition | The service delivery country where the vaccine administration occurred |
| Short | Country of vaccination |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Country ValueSet (required to http://smart.who.int/immunizations-measles/ValueSet/sgcountry) |
| Type | Coding |
Guidance on how to interpret the contents of this table can be found here
| 0. IMMZDCatUpdateVaccinationRecord | |
| Definition | Data elements for IMMZ.D Update Vaccination Record. |
| Short | IMMZ.D Update Vaccination Record |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. IMMZDCatUpdateVaccinationRecord.immunizatioEventStatus | |
| Definition | The current status of the individual immunization event |
| Short | The current status of the individual immunization event |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IMMZ.D1.DE1 CodeSystem for Immunization status (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE1VS) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. IMMZDCatUpdateVaccinationRecord.reasonNotDone | |
| Definition | The reason this immunization event was not performed |
| Short | Reason vaccine was not administered |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D1.DE5 CodeSystem for Reason Not Done (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE5VS) |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. IMMZDCatUpdateVaccinationRecord.vaccineProduct | |
| Definition | The brand or trade name used to refer to the vaccine received |
| Short | Vaccine brand |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Catopia MeaslesVaccine Products ValueSet (required to http://worldhealthorganization.github.io/smart/ValueSet/VSCatMeaslesVaccineProducts) |
| Type | Coding |
| 8. IMMZDCatUpdateVaccinationRecord.liveVaccine | |
| Definition | Uses a living but weakened version of the virus or one that's very similar |
| Short | Live attenuated vaccine |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. IMMZDCatUpdateVaccinationRecord.vaccineType | |
| Definition | Vaccine type/category that was administered or was to be administered. Any vaccine code available in the IMMZ.Z Vaccine Library list of codes applies in this data element |
| Short | Vaccine type |
| Control | 0..1 |
| Type | Coding |
| 12. IMMZDCatUpdateVaccinationRecord.dateTime | |
| Definition | Represents the visit/encounter date, which is the date and time when the vaccine was administered to the client |
| Short | Date and time of vaccination |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. IMMZDCatUpdateVaccinationRecord.countryOfVaccination | |
| Definition | The service delivery country where the vaccine administration occurred |
| Short | Country of vaccination |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Country ValueSet (required to http://smart.who.int/immunizations-measles/ValueSet/sgcountry) |
| Type | Coding |
| 16. IMMZDCatUpdateVaccinationRecord.vaccinationLocation | |
| Definition | The service delivery location where the vaccine administration occurred |
| Short | Vaccination location |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. IMMZDCatUpdateVaccinationRecord.vaccineManufacturer | |
| Definition | The manufacturer of the vaccine product |
| Short | Vaccine manufacturer |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. IMMZDCatUpdateVaccinationRecord.vaccineLotNumber | |
| Definition | Batch number or lot number of vaccine |
| Short | Vaccine batch number |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. IMMZDCatUpdateVaccinationRecord.vaccineMAH | |
| Definition | Name of the market authorization holder of the vaccine received. If market authorization holder is unknown, vaccine manufacturer is REQUIRED |
| Short | Vaccine market authorization holder |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. IMMZDCatUpdateVaccinationRecord.vaccineExpirationDate | |
| Definition | The expiration date of the vaccine |
| Short | Expiration date |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. IMMZDCatUpdateVaccinationRecord.vaccineDoseQuantity | |
| Definition | The quantity of vaccine product that was administered |
| Short | Dose quantity |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. IMMZDCatUpdateVaccinationRecord.healthWorker | |
| Definition | The person, organization, or role of the entity that performed the act of giving the vaccine to the client. The implementing system can choose to populate this field using data from a health worker registry or health facility registry |
| Short | Health worker identifier |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. IMMZDCatUpdateVaccinationRecord.vaccineDoseNumber | |
| Definition | Vaccine dose number including dose number within series |
| Short | Dose number |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. IMMZDCatUpdateVaccinationRecord.vaccineTotalDosesInSeries | |
| Definition | The recommended number of doses for immunity according to the national protocol |
| Short | Total doses in series |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |