Package | fhir.nigeriaImmunization |
Type | StructureDefinition |
Id | AdministerVaccine |
FHIR Version | R4 |
Source | http://example.org/https://build.fhir.org/ig/IntelliSOFT-Consulting/Nigeria-Immunization-FHIR-IG/StructureDefinition-AdministerVaccine.html |
URL | http://example.org/StructureDefinition/AdministerVaccine |
Version | 0.1.0 |
Status | draft |
Date | 2025-05-28T07:10:29+00:00 |
Name | AdministerVaccine |
Title | IMMZ.D Administer Vaccine |
Realm | us |
Authority | hl7 |
Description | A logical model for capturing vaccine administration details |
Type | http://example.org/StructureDefinition/AdministerVaccine |
Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition AdministerVaccine
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
![]() ![]() | 0..* | Base | IMMZ.D Administer Vaccine | |
![]() ![]() ![]() | 1..1 | string | Name of health facility | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Facility type Binding: IMMZ.D#IMMZ.D.DE2 (required) | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Session type Binding: IMMZ.D#IMMZ.D.DE6 (required) | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Vaccine type | |
![]() ![]() ![]() | 0..1 | boolean | Contraindicated | |
![]() ![]() ![]() | 0..* | CodeableConcept | Contraindications to immunization Binding: IMMZ.D#IMMZ.D.DE12 (required) | |
![]() ![]() ![]() | 1..1 | dateTime | Date and time of vaccination | |
![]() ![]() ![]() | 1..1 | string | Vaccine Administering Center | |
![]() ![]() ![]() | 1..1 | string | Vaccine batch number | |
![]() ![]() ![]() | 1..1 | date | Expiration date | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Site administered Binding: IMMZ.D#IMMZ.D.DE21 (required) | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Route of administration Binding: IMMZ.D#IMMZ.D.DE27 (required) | |
![]() ![]() ![]() | 1..1 | Quantity | Dose quantity | |
![]() ![]() ![]() | 1..1 | string | Health worker identifier | |
{ "resourceType": "StructureDefinition", "id": "AdministerVaccine", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "url": "http://example.org/StructureDefinition/AdministerVaccine", "version": "0.1.0", "name": "AdministerVaccine", "title": "IMMZ.D Administer Vaccine", "status": "draft", "date": "2025-05-28T07:10:29+00:00", "publisher": "intellisoftkenya.com", "contact": [ { "name": "intellisoftkenya.com", "telecom": [ { "system": "url", "value": "https://www.intellisoftkenya.com/" } ] }, { "name": "IntelliSOFT Consulting Kenya.", "telecom": [ { "system": "email", "value": "info@intellisoftkenya.com", "use": "work" } ] } ], "description": "A logical model for capturing vaccine administration details", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "NG", "display": "Nigeria" } ] } ], "fhirVersion": "4.0.1", "kind": "logical", "abstract": false, "type": "http://example.org/StructureDefinition/AdministerVaccine", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base", "derivation": "specialization", "snapshot": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "4.0.1" } ], "element": [ { "id": "AdministerVaccine", "path": "AdministerVaccine", "short": "IMMZ.D Administer Vaccine", "definition": "A logical model for capturing vaccine administration details", "min": 0, "max": "*", "base": { "path": "Base", "min": 0, "max": "*" }, "isModifier": false }, { "id": "AdministerVaccine.nameOfHealthFacility", "path": "AdministerVaccine.nameOfHealthFacility", "code": [ { "code": "IMMZ.D.DE1" } ], "short": "Name of health facility", "definition": "Name of the facility where the vaccination is taking place.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.nameOfHealthFacility", "min": 1, "max": "1" }, "type": [ { "code": "string" } ] }, { "id": "AdministerVaccine.facilityType", "path": "AdministerVaccine.facilityType", "code": [ { "code": "IMMZ.D.DE2" } ], "short": "Facility type", "definition": "The type of health facility. Uses the IMMZ.D CodeSystem.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.facilityType", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "IMMZ.D#IMMZ.D.DE2" } }, { "id": "AdministerVaccine.sessionType", "path": "AdministerVaccine.sessionType", "code": [ { "code": "IMMZ.D.DE6" } ], "short": "Session type", "definition": "Type of immunization session. Uses the IMMZ.D CodeSystem.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.sessionType", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "IMMZ.D#IMMZ.D.DE6" } }, { "id": "AdministerVaccine.vaccineType", "path": "AdministerVaccine.vaccineType", "code": [ { "code": "IMMZ.D.DE10" } ], "short": "Vaccine type", "definition": "Type of vaccine administered. Uses IMMZ.F Vaccine Library codes.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.vaccineType", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ] }, { "id": "AdministerVaccine.contraindicated", "path": "AdministerVaccine.contraindicated", "code": [ { "code": "IMMZ.D.DE11" } ], "short": "Contraindicated", "definition": "Immunization not recommended due to contraindications.", "min": 0, "max": "1", "base": { "path": "AdministerVaccine.contraindicated", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ] }, { "id": "AdministerVaccine.contraindications", "path": "AdministerVaccine.contraindications", "code": [ { "code": "IMMZ.D.DE12" } ], "short": "Contraindications to immunization", "definition": "Specific situations where certain vaccines should not be administered. Uses the IMMZ.D CodeSystem.", "min": 0, "max": "*", "base": { "path": "AdministerVaccine.contraindications", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "IMMZ.D#IMMZ.D.DE12" } }, { "id": "AdministerVaccine.vaccinationDateTime", "path": "AdministerVaccine.vaccinationDateTime", "code": [ { "code": "IMMZ.D.DE17" } ], "short": "Date and time of vaccination", "definition": "The date and time the vaccine was administered.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.vaccinationDateTime", "min": 1, "max": "1" }, "type": [ { "code": "dateTime" } ] }, { "id": "AdministerVaccine.vaccineAdministeringCenter", "path": "AdministerVaccine.vaccineAdministeringCenter", "code": [ { "code": "IMMZ.D.DE18" } ], "short": "Vaccine Administering Center", "definition": "Facility where vaccine was administered.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.vaccineAdministeringCenter", "min": 1, "max": "1" }, "type": [ { "code": "string" } ] }, { "id": "AdministerVaccine.vaccineBatchNumber", "path": "AdministerVaccine.vaccineBatchNumber", "code": [ { "code": "IMMZ.D.DE19" } ], "short": "Vaccine batch number", "definition": "Batch or lot number of vaccine.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.vaccineBatchNumber", "min": 1, "max": "1" }, "type": [ { "code": "string" } ] }, { "id": "AdministerVaccine.expirationDate", "path": "AdministerVaccine.expirationDate", "code": [ { "code": "IMMZ.D.DE20" } ], "short": "Expiration date", "definition": "Expiration date of the vaccine. Use last day of the month if only month is given.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.expirationDate", "min": 1, "max": "1" }, "type": [ { "code": "date" } ] }, { "id": "AdministerVaccine.siteAdministered", "path": "AdministerVaccine.siteAdministered", "code": [ { "code": "IMMZ.D.DE21" } ], "short": "Site administered", "definition": "Body site where vaccine was administered. Uses the IMMZ.D CodeSystem.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.siteAdministered", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "IMMZ.D#IMMZ.D.DE21" } }, { "id": "AdministerVaccine.routeOfAdministration", "path": "AdministerVaccine.routeOfAdministration", "code": [ { "code": "IMMZ.D.DE27" } ], "short": "Route of administration", "definition": "Route of delivery of the vaccine. Uses the IMMZ.D CodeSystem.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.routeOfAdministration", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "IMMZ.D#IMMZ.D.DE27" } }, { "id": "AdministerVaccine.doseQuantity", "path": "AdministerVaccine.doseQuantity", "code": [ { "code": "IMMZ.D.DE32" } ], "short": "Dose quantity", "definition": "Quantity of vaccine product administered.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.doseQuantity", "min": 1, "max": "1" }, "type": [ { "code": "Quantity" } ] }, { "id": "AdministerVaccine.healthWorkerIdentifier", "path": "AdministerVaccine.healthWorkerIdentifier", "code": [ { "code": "IMMZ.D.DE33" } ], "short": "Health worker identifier", "definition": "Person, organization, or role of the vaccinator. Can be populated from a Health Worker Registry.", "min": 1, "max": "1", "base": { "path": "AdministerVaccine.healthWorkerIdentifier", "min": 1, "max": "1" }, "type": [ { "code": "string" } ] } ] }, "differential": { "element": [ { "id": "AdministerVaccine", "path": "AdministerVaccine", "short": "IMMZ.D Administer Vaccine", "definition": "A logical model for capturing vaccine administration details" }, { "id": "AdministerVaccine.nameOfHealthFacility", "path": "AdministerVaccine.nameOfHealthFacility", "code": [ { "code": "IMMZ.D.DE1" } ], "short": "Name of health facility", "definition": "Name of the facility where the vaccination is taking place.", "min": 1, "max": "1", "type": [ { "code": "string" } ] }, { "id": "AdministerVaccine.facilityType", "path": "AdministerVaccine.facilityType", "code": [ { "code": "IMMZ.D.DE2" } ], "short": "Facility type", "definition": "The type of health facility. Uses the IMMZ.D CodeSystem.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "IMMZ.D#IMMZ.D.DE2" } }, { "id": "AdministerVaccine.sessionType", "path": "AdministerVaccine.sessionType", "code": [ { "code": "IMMZ.D.DE6" } ], "short": "Session type", "definition": "Type of immunization session. Uses the IMMZ.D CodeSystem.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "IMMZ.D#IMMZ.D.DE6" } }, { "id": "AdministerVaccine.vaccineType", "path": "AdministerVaccine.vaccineType", "code": [ { "code": "IMMZ.D.DE10" } ], "short": "Vaccine type", "definition": "Type of vaccine administered. Uses IMMZ.F Vaccine Library codes.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ] }, { "id": "AdministerVaccine.contraindicated", "path": "AdministerVaccine.contraindicated", "code": [ { "code": "IMMZ.D.DE11" } ], "short": "Contraindicated", "definition": "Immunization not recommended due to contraindications.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ] }, { "id": "AdministerVaccine.contraindications", "path": "AdministerVaccine.contraindications", "code": [ { "code": "IMMZ.D.DE12" } ], "short": "Contraindications to immunization", "definition": "Specific situations where certain vaccines should not be administered. Uses the IMMZ.D CodeSystem.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "IMMZ.D#IMMZ.D.DE12" } }, { "id": "AdministerVaccine.vaccinationDateTime", "path": "AdministerVaccine.vaccinationDateTime", "code": [ { "code": "IMMZ.D.DE17" } ], "short": "Date and time of vaccination", "definition": "The date and time the vaccine was administered.", "min": 1, "max": "1", "type": [ { "code": "dateTime" } ] }, { "id": "AdministerVaccine.vaccineAdministeringCenter", "path": "AdministerVaccine.vaccineAdministeringCenter", "code": [ { "code": "IMMZ.D.DE18" } ], "short": "Vaccine Administering Center", "definition": "Facility where vaccine was administered.", "min": 1, "max": "1", "type": [ { "code": "string" } ] }, { "id": "AdministerVaccine.vaccineBatchNumber", "path": "AdministerVaccine.vaccineBatchNumber", "code": [ { "code": "IMMZ.D.DE19" } ], "short": "Vaccine batch number", "definition": "Batch or lot number of vaccine.", "min": 1, "max": "1", "type": [ { "code": "string" } ] }, { "id": "AdministerVaccine.expirationDate", "path": "AdministerVaccine.expirationDate", "code": [ { "code": "IMMZ.D.DE20" } ], "short": "Expiration date", "definition": "Expiration date of the vaccine. Use last day of the month if only month is given.", "min": 1, "max": "1", "type": [ { "code": "date" } ] }, { "id": "AdministerVaccine.siteAdministered", "path": "AdministerVaccine.siteAdministered", "code": [ { "code": "IMMZ.D.DE21" } ], "short": "Site administered", "definition": "Body site where vaccine was administered. Uses the IMMZ.D CodeSystem.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "IMMZ.D#IMMZ.D.DE21" } }, { "id": "AdministerVaccine.routeOfAdministration", "path": "AdministerVaccine.routeOfAdministration", "code": [ { "code": "IMMZ.D.DE27" } ], "short": "Route of administration", "definition": "Route of delivery of the vaccine. Uses the IMMZ.D CodeSystem.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "valueSet": "IMMZ.D#IMMZ.D.DE27" } }, { "id": "AdministerVaccine.doseQuantity", "path": "AdministerVaccine.doseQuantity", "code": [ { "code": "IMMZ.D.DE32" } ], "short": "Dose quantity", "definition": "Quantity of vaccine product administered.", "min": 1, "max": "1", "type": [ { "code": "Quantity" } ] }, { "id": "AdministerVaccine.healthWorkerIdentifier", "path": "AdministerVaccine.healthWorkerIdentifier", "code": [ { "code": "IMMZ.D.DE33" } ], "short": "Health worker identifier", "definition": "Person, organization, or role of the vaccinator. Can be populated from a Health Worker Registry.", "min": 1, "max": "1", "type": [ { "code": "string" } ] } ] } }