HL7® FHIR® Malaysia Core (MY Core) Implementation Guide
2.0.1 - ci-build

HL7® FHIR® Malaysia Core (MY Core) Implementation Guide - Local Development build (v2.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Immunization Records

A patient's immunization history is recorded using an Immunization (MY Core) record. If an Immunization is planned and shared with HIE, it will be stored as an ImmunizationRecommendation (MY Core)

Sample Data and API

These are some common APIs used in HIE.

[base] = server url e.g. "https://fhir.hie.moh.gov.my/baseR4/"
@recordId = unique record ID defined by the source system e.g. "immunization-sample" | "immunizationrecommendation-sample"
@patientIdentifier = Patient identifier such as a 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/@recordId
Retrieve record with ID - GET [base]/Immunization/@recordId
Retrieve Immunization record with Patient identifier - GET [base]/Immunization?patient.identifier=@patientIdentifier
Retrieve ImmunizationRecommendation record with Patient identifier - GET [base]/ImmunizationRecommendation?patient.identifier=@patientIdentifier

Vaccine terminology

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

  • This CodeSystem is adopted from the Malaysian Pharmacy Information System (PhIS) master drug list.

Relationship between Immunization & ImmunizationRecommendation

An Immunization record can exist independently without an ImmunizationRecommendation.

However, if a vaccine currently administered was initially stored as an ImmunizationRecommendation, then the Immunization record must be referenced in the ImmunizationRecommendation record under ImmunizationRecommendation.supportingImmunization.reference.

The vaccine code must also be recorded in the Immunization resource under Immunization.vaccineCode.coding.code, and in ImmunizationRecommendation.recommendation.vaccineCode.coding.code for the ImmunizationRecommendation.

Although it is possible for a single ImmunizationRecommendation to have multiple vaccine recommendations in the base FHIR® standards, the current HIE design flow recommends only one vaccine per ImmunizationRecommendation.