Immunization Record

Patient Immunization history is recorded using Immunization (MY Core) record.

If a Immunization is planned and shared with HIE, it will be stored as ImmunizationRecommendation (MY Core)


Click MY Core postman API link to view common API used in HIE.

[base] = address url e.g. "https://fhir.hie.moh.gov.my/baseR4/"
[type] = resource type e.g. "Patient | Encounter | Compostion"
@recordId = unique record id defined from source system e.g. "immunization-sample" | "immunizationrecommendation-sample"
@patientIdentifier = patient identifier such as mykad number or MRN e.g "HIE-00000003"

Sample Description Sample Body API Method API
Create/Update Immunization record

1.Immunization,

2.ImmunizationRecommendation

PUT [base]/Immunization/@patientId
Retrieve record with id - GET [base]/[type]/@recordId
Retrieve Immunization record with patient identifier - GET [base]/Immunization?patient.identifier=@patientIdentifier
Retrieve ImmunizationRecommendation record with patient identifier - GET [base]/ImmunizationRecommendati?patient.identifier=@patientIdentifier


Vaccine terminology

Vaccine code can be access at ValueSetVaccineCode (MY Core).

  • The CodeSystem is adopted from PhIS drug master list.

ImmunizationRecommendation & Immunization Relationship

Immunization record can exist independantly without an ImmunizationRecommendation.

If a planned vaccine has been administered which was initially stored as ImmunizationRecommendation. The Immunization record must be referenced in the ImmunizationRecommendation record as ImmunizationRecommendation.supportingImmunization.reference.

Immunization must be referenced by a matching ImmunizationRecommended based on the Vaccine code under Immunization.vaccineCode.coding.code for Immunization and ImmunizationRecommendation.recommendedation.vaccineCode.coding.code for ImmunizationRecommendation

Although it is possible for a single ImmunizationRecommendation to have multiple vaccine recommended in the base FHIR. HIE current design flow is only able to recommend one vaccine per ImmunizationRecommendation when a user records an entry using RekodPesakit in view of implementation complexity.