NP Core Immunization
Sets minimum expectations for representing a vaccine administration event in Nepal, in support of the national Expanded Programme on Immunization (EPI) and routine care.
- Canonical URL
- http://fhir.digitalhealth.gov.np/core/StructureDefinition/np-core-immunization
- Resource / type
- Immunization
- Based on
- http://hl7.org/fhir/StructureDefinition/Immunization
- Claim conformance
- Put the canonical URL in
meta.profileof each instance.
Required elements
“Always” means the element must be present in every instance. Otherwise it is required only when its parent element is present.
| Element | Card. | When |
|---|---|---|
Immunization.statuscompleted | entered-in-error | not-done |
1..1 | Always |
Immunization.vaccineCodeVaccine product administered |
1..1 | Always |
Immunization.patientWho was immunized |
1..1 | Always |
Immunization.occurrence[x]Vaccine administration date |
1..1 | Always |
Immunization.performer.actorIndividual or organization who was performing |
1..1 | If parent present |
Immunization.protocolApplied.doseNumber[x]Dose number within series |
1..1 | If parent present |
Must-support elements
If your system has this data it SHALL send it, and receivers SHALL process it. Must-support does not by itself make an element mandatory.
- Immunization.status
- Immunization.vaccineCode
- Immunization.patient
- Immunization.encounter
- Immunization.primarySource
- Immunization.location
- Immunization.lotNumber
- Immunization.performer
- Immunization.performer.actor
- Immunization.protocolApplied
- Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt
Terminology bindings
required: codes SHALL come from the value set · extensible: use the value set if a suitable code exists · preferred / example: guidance only.
| Element | Strength | Value set |
|---|---|---|
Immunization.language |
preferred | http://hl7.org/fhir/ValueSet/languages |
Immunization.status |
required | http://hl7.org/fhir/ValueSet/immunization-status |
Immunization.statusReason |
example | http://hl7.org/fhir/ValueSet/immunization-status-reason |
Immunization.vaccineCode |
extensible | NP Core Vaccine Value Set http://fhir.digitalhealth.gov.np/core/ValueSet/np-core-vaccine-vs |
Immunization.reportOrigin |
example | http://hl7.org/fhir/ValueSet/immunization-origin |
Immunization.site |
example | http://hl7.org/fhir/ValueSet/immunization-site |
Immunization.route |
example | http://hl7.org/fhir/ValueSet/immunization-route |
Immunization.performer.function |
extensible | http://hl7.org/fhir/ValueSet/immunization-function |
Immunization.reasonCode |
example | http://hl7.org/fhir/ValueSet/immunization-reason |
Immunization.subpotentReason |
example | http://hl7.org/fhir/ValueSet/immunization-subpotent-reason |
Immunization.programEligibility |
example | http://hl7.org/fhir/ValueSet/immunization-program-eligibility |
Immunization.fundingSource |
example | http://hl7.org/fhir/ValueSet/immunization-funding-source |
Immunization.protocolApplied.targetDisease |
example | http://hl7.org/fhir/ValueSet/immunization-target-disease |
Official examples
Immunization/ExampleNPCoreImmunization
{
"resourceType": "Immunization",
"id": "ExampleNPCoreImmunization",
"meta": {
"profile": [
"http://fhir.digitalhealth.gov.np/core/StructureDefinition/np-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1051000221104",
"display": "Live attenuated Human poliovirus serotypes 1 and 3 antigens only vaccine product in oral dose form"
}
],
"text": "Bivalent Oral Polio Vaccine (bOPV)"
},
"patient": {
"reference": "Patient/ExampleNPCorePatient"
},
"encounter": {
"reference": "Encounter/ExampleNPCoreEncounter"
},
"occurrenceDateTime": "2026-05-10T10:00:00+05:45",
"primarySource": true,
"location": {
"reference": "Location/ExampleNPCoreLocation"
},
"lotNumber": "OPV-2024-LOT-0081",
"expirationDate": "2027-06-30",
"performer": [
{
"actor": {
"reference": "Practitioner/ExampleNPCorePractitioner"
}
}
],
"protocolApplied": [
{
"series": "EPI Schedule",
"doseNumberPositiveInt": 3
}
]
}
Narrative (text) removed for readability.