PH eReferral Implementation Guide
0.3.0-draft - draft Philippines

PH eReferral Implementation Guide, published by UP Manila SILab. This guide is not an authorized publication; it is the continuous build for version 0.3.0-draft built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jgsuess/ph-ereferral/ and changes regularly. See the Directory of published versions

Resource Architecture

Resource Architecture

This page documents the FHIR resource types used in the eReferral scenario, how they are grouped into transaction bundles, which FHIR design patterns they follow, and how the clinical workflow and data-dictionary mapping are visualised. For the source artefact descriptions and the agile methodology, see the Approach page.


Resource Diagram

The diagram below shows the FHIR resource types used and their relationships.

FHIR Resource Instances — ANC ScenarioFHIR Resource Instances — ANC ScenarioBundle A — RegistrationBundle B — ANC Contact«admin»patient-charity-ex : Patientname = "Charity Santos"gender = femalebirthDate = 2001-08-15identifier = PhilSys, PhilHealthaddress = Barangay Malusog, QCtelecom = +63-917-xxxDD: REF-20..REF-27«admin»relatedperson-companion-ex : RelatedPersonname = "Maria Santos"relationship = MotherDD: REF-28«admin»organization-sending-facility-ex : Organizationname = "Barangay Malusog HC"identifier = DOH000-OO-0-0000123DD: REF-4..REF-7«admin»practitioner-abraham-ex : Practitionername = "Abraham Reyes"DD: REF-1«admin»practitionerrole-abraham-ex : PractitionerRolecode = ClerkDD: REF-1«clinical»encounter-registration-ex : Encounterstatus = finishedclass = AMBtype = Registrationperiod = 08:00-08:15DD: REF-43«admin»practitioner-jane-ex : Practitionername = "Jane Dela Cruz"DD: REF-1«admin»practitionerrole-jane-ex : PractitionerRolecode = NurseDD: REF-1«admin»organization-receiving-facility-ex : Organizationname = "Metro Imaging Centre"identifier = DOH000-OO-0-0000456DD: REF-9, REF-10«clinical»encounter-anc-ex : Encounterstatus = finishedclass = AMBtype = Prenatal initial visitperiod = 08:30-10:00DD: REF-43«clinical»condition-pregnancy-ex : Conditioncode = SNOMED 77386006 PregnantclinicalStatus = activeverificationStatus = provisionalDD: REF-40«clinical»observation-chief-complaint-ex : Observationcode = LOINC 10154-3value = "Missed cycle, nausea"DD: REF-30«clinical»observation-blood-pressure-ex : Observationcode = LOINC 85354-9systolic = 110 mmHgdiastolic = 70 mmHgDD: REF-32«clinical»observation-heart-rate-ex : Observationcode = LOINC 8867-4value = 78 /minDD: REF-33«clinical»observation-respiratory-rate-ex : Observationcode = LOINC 9279-1value = 18 /minDD: REF-34«clinical»observation-oxygen-saturation-ex : Observationcode = LOINC 59408-5value = 98 %DD: REF-35«clinical»observation-temperature-ex : Observationcode = LOINC 8310-5value = 36.8 CelDD: REF-36«clinical»observation-weight-ex : Observationcode = LOINC 29463-7value = 55 kgDD: REF-37«clinical»medicationadministration-ifa-ex : MedicationAdministrationmedication = Iron + Folic Acidstatus = completeddosage = "1 tablet daily"DD: REF-38«workflow»servicerequest-ultrasound-ex : ServiceRequestcode = Obstetric ultrasoundpriority = routinecategory = DiagnosticsauthoredOn = 2026-02-24DD: REF-12..REF-15, REF-31«workflow»servicerequest-lab-orders-ex : ServiceRequestcode = Diabetes, HepB, HIVstatus = activeDD: REF-39«workflow»task-referral-ex : Taskstatus = requestedbusinessStatus = requestedDD: REF-16, REF-42patientpractitionerorganizationsubjectparticipantpractitionerorganizationsubjectparticipantsubjectencountersubjectencountersubjectencountersubjectencountersubjectencountersubjectencountersubjectencountersubjectencountersubjectcontextsubjectencounterrequesterperformerreasonReferencesubjectreasonReferencefocusforowner

The 22 example resources are split across two transaction bundles that mirror the two business processes in the ANC scenario.

Bundle A — Registration (Process A)

Clerk Abraham registers patient Charity during her first visit. This bundle collects the demographic and administrative resources created at the front desk.

Resource Instance ID Key DD Elements
Patient patient-charity-ex REF-20 … REF-27
RelatedPerson relatedperson-companion-ex REF-28
Organization organization-sending-facility-ex REF-4 … REF-7
Practitioner practitioner-abraham-ex REF-1
PractitionerRole practitionerrole-abraham-ex REF-1
Encounter encounter-registration-ex REF-43

Bundle B — ANC Contact (Process B)

Nurse Jane conducts the antenatal care contact — recording clinical observations, dispensing medication, ordering lab tests, and creating the ultrasound referral.

Resource Instance ID Key DD Elements
Practitioner practitioner-jane-ex REF-1
PractitionerRole practitionerrole-jane-ex REF-1
Organization organization-receiving-facility-ex REF-9, REF-10
Encounter encounter-anc-ex REF-43
Condition condition-pregnancy-ex REF-40
Observation ×7 chief complaint, BP, HR, RR, SpO₂, temp, weight REF-30, REF-32 … REF-37
MedicationAdministration medicationadministration-ifa-ex REF-38
ServiceRequest ×2 ultrasound referral, lab orders REF-12, REF-13, REF-15, REF-31, REF-39
Task task-referral-ex REF-16, REF-42

FHIR Design Patterns

The FHIR specification defines a set of reusable Design Patterns that standardise how resources behave across clinical, administrative, and workflow domains. The table below shows which patterns this IG relies on and how they map to the eReferral resources.

Pattern Spec link Resources in this IG How it is applied
Request Event / Request ServiceRequest (×2) The ultrasound referral and laboratory orders follow the Request pattern — they capture the intent, priority, and coded reason for a service to be performed.
Event Event Observation (×7), MedicationAdministration, Encounter (×2), Condition Clinical acts that have already occurred use the Event pattern — vital-sign observations, medication dispensing, encounter records, and the pregnancy condition all carry status, timing, and performer.
Participant Participant Patient, Practitioner (×2), PractitionerRole (×2), RelatedPerson, Organization (×2) People and organisations are modelled with the Participant pattern. PractitionerRole links a Practitioner to an Organization and role code, following the Participant and RoleEntity pattern.
Workflow Workflow Task, ServiceRequest The referral lifecycle uses the Workflow pattern: a ServiceRequest expresses the clinical intent, while a Task tracks fulfilment state (requested → received → accepted). This follows the ServiceRequest + Task coordination approach.
Observation Observation Observation (×7) Vital signs and the chief complaint follow the Observation pattern with LOINC-coded types and quantity values. Blood pressure uses the component pattern for systolic/diastolic.
Bundle / Transaction Bundle Bundle (×2) Registration and ANC-contact resources are grouped into transaction Bundles, ensuring atomic submission of related resources.

Further reading: The FHIR Design Patterns overview explains the rationale behind these abstractions and how they promote consistency across implementation guides.


Scenario Activity Flow

The following activity diagram traces the clinical workflow through the two business processes, showing how Charity moves from registration with Abraham through to the ANC contact with Jane.

User Scenario 3.1 — First Antenatal Care ContactUser Scenario 3.1 — First Antenatal Care ContactCheck existing records→ no record foundBundle A — RegistrationPatient (REF-20..REF-27)RelatedPerson (REF-28)Organization (REF-4..REF-7)Practitioner: Abraham (REF-1)Encounter: registration (REF-43)Register patient in systemGenerate QR codefor return visitsCall Charity intocounselling roomClose door, lower shade(ensure privacy)Observation: chief complaint(LOINC 10154-3)REF-30Ask reason for visit→ Chief complaintAsk about LMP→ "around new year holiday"Administer pregnancy testPositiveCondition: pregnancyREF-40Record working impression→ Pregnant (SNOMED 77386006)Ask detailed questions:• Occupation• Smoking / caffeine• General health• Obstetric historyEstimate gestational age→ 12-15 weeks(exact date unknown)Inform: ultrasound neededbefore 24th weekRecord weight & heightConduct physical examVital Signs (REF-32..REF-37)BP: 110/70 mmHgHR: 78 bpmRR: 18/minSpO₂: 98%Temp: 36.8°CWeight: 55 kgTake blood pressureServiceRequest: lab ordersREF-39 (partial)Order lab tests:• Diabetes screen• Hepatitis B• HIVMedicationAdministrationREF-38Dispense IFA tablets(iron + folic acid, 1/day)Counsel on:• Reduce caffeine• Use condoms (STI risk)• Danger signs• Symptom managementBundle B — ANC ContactServiceRequest: ultrasound (REF-12..REF-15)Task: referral tracking (REF-16, REF-42)Organization: receiving (REF-9, REF-10)Create ultrasound referralto Metro Imaging CentreSchedule next ANC contactArrives at health centre(missed cycle, nausea)Provides demographic info(name, DOB, address, phone,PhilSys ID, PhilHealth ID)Wait in queueReceive referral slipfor imaging centreReceive SMS reminder(if consent given)Abraham (Clerk)Jane (Nurse)Charity (Client)

Data Dictionary to FHIR Mapping Diagram

The mapping diagram below provides a high-level view of how the seven clinical information groups in the data dictionary map to FHIR resource types. For the detailed element-by-element mapping, see the DD Mapping page.

Data Dictionary → FHIR Resource MappingData Dictionary → FHIR Resource Mapping«dd»01 Sending PractitionerREF-1: NameREF-2: Signature _(deferred)_REF-3: Signature time _(deferred)_«dd»02 Sending FacilityREF-4: Facility nameREF-5: NHFR codeREF-6: AddressREF-7: Contact number«dd»03 Receiving PractitionerREF-8: Receiving personnel_(not covered — N/A)_«dd»04 Receiving FacilityREF-9: Facility nameREF-10: NHFR code«dd»05 Referral RequestREF-11: HCPN _(deferred)_REF-12: Date of referralREF-13: Category / priorityREF-14: Time called _(N/A)_REF-15: Reason / service typeREF-16: Action: ReceivedREF-17: Action: Forwarded _(N/A)_REF-18: Return slip _(deferred)_REF-19: Call/email ref _(N/A)_«dd»06 Patient DemographicsREF-20: Full nameREF-21: GenderREF-22: Birth dateREF-23: Age _(computed)_REF-24: PhilSys IDREF-25: PhilHealth IDREF-26: AddressREF-27: ContactREF-28: Next of kinREF-29: PWD reg _(N/A)_«dd»07 Clinical InformationREF-30: Chief complaintREF-31: Clinical historyREF-32-37: Vital signs (×6)REF-38: Treatment givenREF-39: Lab results _(partial)_REF-40: Working impression«dd»Logistics / Decision / SystemREF-41: Transport _(N/A)_REF-42: ResponseREF-43: Referring encounterREF-44: Receiving encounter _(N/A)_REF-45-46: Navigators _(N/A)_«fhir»Practitioner+ PractitionerRole«deferred»Provenance_(Future Release)_«fhir»Organization(sending + receiving)«deferred»Communication«fhir»ServiceRequest(ultrasound + lab)«fhir»Task(referral tracking)«deferred»DocumentReference_(MVP excluded)_«fhir»Patient«fhir»RelatedPerson«fhir»Observation×7(vitals + complaint)«fhir»Condition(pregnancy)«fhir»MedicationAdministration(IFA)«deferred»DiagnosticReport_(pending results)_«fhir»Encounter(registration + ANC)REF-1REF-2,3(deferred)REF-4..7REF-8(N/A)REF-9,10REF-12,13,15REF-16REF-14,19(N/A)REF-18(deferred)REF-20..27REF-28REF-30, REF-32..37REF-31 (note)REF-38REF-39 (orders)REF-39(results pending)REF-40REF-42REF-43