API Name: List.$retrieve

This API retrieves list Bundle(s) containing Problem List or Patient Medication List data associated with a patient, identified by the patient's identifier.

Specification

Endpoint [baseurl]/List/$retrieve
Protocol HTTPS
HTTP Method GET
HTTP Header Accept: application/fhir+json

Request Parameters

Parameter Type Cardinality Description
patient.identifier token 1..1 The patient's identifier in system\|value format. Use https://fhir.synapxe.sg/NamingSystem/nric\|<NRIC>.
type token 0..1 Filter by list type. Use problem-list for Problem List or medication-list for Patient Medication List.
date date 0..2 Filter by list date. Supports ge and le prefixes for date range (e.g. ge2026-01-01&date=le2026-06-30).
status token 0..1 Filter by list status (e.g. current).
_count number 0..1 Maximum number of results to return per page.

List Type Codes

List Type System Code
Problem List http://loinc.org 11450-4
Patient Medication List http://loinc.org 10160-0

Example Request

GET [baseurl]/List/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S1234567A

Successful Response

The response is a searchset Bundle containing the matching List resource(s) and their associated resources, each conforming to the respective allowed profile.

Profile Name StructureDefinition StructureDefinition URL
Problem List Problem List Bundle Profile https://fhir.synapxe.sg/StructureDefinition/profile-bundle-problemlist
Patient Medication List Patient Medication List Bundle Profile https://fhir.synapxe.sg/StructureDefinition/profile-bundle-patientmedicationlist
{
"resourceType": "Bundle",
"id": "5f7b50a2-638f-5901-ba37-cd5df7256c91",
"meta": {
"lastUpdated": "2026-09-02T17:49:51+08:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "List/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S8992784F"
}
],
"entry": [
{
"fullUrl": "urn:uuid:ceb8c344-fec9-5f63-9c9b-8f03ac61ab30",
"resource": {
"resourceType": "List",
"id": "ceb8c344-fec9-5f63-9c9b-8f03ac61ab30",
"meta": {
"versionId": "1",
"lastUpdated": "2026-09-02T17:49:51+08:00",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-list-problem"
]
},
"extension": [
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-lastUpdatedBy",
"valueString": "SHMODEL1167"
}
],
"identifier": [
{
"system": "https://fhir.synapxe.sg/NamingSystem/record-id",
"value": "Z6828176^JHS-EPIC"
}
],
"status": "current",
"mode": "snapshot",
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "11450-4",
"display": "Problem List"
}
],
"text": "Non-reconciled PPL"
},
"subject": [
{
"type": "Patient",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S8992784F"
},
"display": "UOGC IP"
}
],
"encounter": {
"type": "Encounter",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/event-id",
"value": "100700203532"
}
},
"source": {
"type": "Organization",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "0700000"
}
},
"entry": [
{
"item": {
"reference": "urn:uuid:67a69b44-b367-5202-b879-f6b8cca03387"
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "urn:uuid:67a69b44-b367-5202-b879-f6b8cca03387",
"resource": {
"resourceType": "Condition",
"id": "67a69b44-b367-5202-b879-f6b8cca03387",
"meta": {
"versionId": "1",
"lastUpdated": "2026-09-02T17:49:51+08:00",
"source": "JHS-EPIC",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-problem"
]
},
"contained": [
{
"resourceType": "PractitionerRole",
"id": "creator-role",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-practitionerrole"
]
},
"practitioner": {
"type": "Practitioner",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/mcr",
"value": "SHMODEL1167"
},
"display": "ASP, PHYSICIAN SENIOR - EMERGENCY DEPARTMENT"
},
"organization": {
"type": "Organization",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "0700000"
}
},
"code": [
{
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/practitioner-role",
"code": "creator",
"display": "Creator"
}
]
}
]
},
{
"resourceType": "PractitionerRole",
"id": "updater-role",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-practitionerrole"
]
},
"practitioner": {
"type": "Practitioner",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/mcr",
"value": "SHMODEL1167"
},
"display": "ASP, PHYSICIAN SENIOR - EMERGENCY DEPARTMENT"
},
"organization": {
"type": "Organization",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "0700000"
}
},
"code": [
{
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/practitioner-role",
"code": "updater",
"display": "Updater"
}
]
}
]
}
],
"extension": [
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-serviceSpeciality",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/IPDC_Service_Specialty_(JHS-EPIC)",
"code": "SHGYN",
"display": "SH GYNAECOLOGY"
}
]
}
}
],
"identifier": [
{
"system": "https://fhir.synapxe.sg/NamingSystem/record-id",
"value": "14377311"
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/sequence-no",
"value": "1"
}
],
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active",
"display": "Active"
},
{
"system": "https://fhir.synapxe.sg/CodeSystem/Diagnosis_Status_(NEHR)",
"code": "Active",
"display": "Active"
}
]
},
"category": [
{
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Problem_Category_(NEHR)",
"code": "1",
"display": "Problem"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"version": "Jul2024",
"code": "21522001",
"display": "Abdominal pain"
}
]
},
"subject": {
"type": "Patient",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S8992784F"
},
"display": "UOGC IP"
},
"recordedDate": "2026-04-22T10:27:36+08:00",
"participant": [
{
"actor": {
"reference": "#creator-role"
}
},
{
"actor": {
"reference": "#updater-role"
}
},
{
"function": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/problem-participant-function",
"code": "custodian",
"display": "Custodian"
}
]
},
"actor": {
"type": "Organization",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "0700000"
}
}
}
]
},
"search": {
"mode": "include"
}
}
]
}
{
"resourceType": "Bundle",
"id": "a310ba01-f80e-535e-9e95-ba8aa26e4a8a",
"meta": {
"lastUpdated": "2026-09-01T15:36:51+08:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "List/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S8206348Z"
}
],
"entry": [
{
"fullUrl": "urn:uuid:cdf337b9-e635-5edd-b1c9-a8ea40d9c7d4",
"resource": {
"resourceType": "List",
"id": "cdf337b9-e635-5edd-b1c9-a8ea40d9c7d4",
"meta": {
"versionId": "1",
"lastUpdated": "2026-09-01T15:36:51+08:00",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-list-medicationstatement"
]
},
"identifier": [
{
"system": "https://fhir.synapxe.sg/NamingSystem/record-id",
"value": "0100000^100700306642"
}
],
"status": "current",
"mode": "working",
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Med_List_Type_(NEHR)",
"code": "1",
"display": "Patient's Medication List"
}
]
},
"subject": [
{
"type": "Patient",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S8206348Z"
},
"display": "MICHOME TEST PATIENT PASS 1"
}
],
"date": "2026-09-01T15:20:08+08:00",
"source": {
"extension": [
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-type",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Med_List_Source_(NEHR)",
"code": "2",
"display": "Clinical Records"
}
]
}
}
],
"reference": "urn:uuid:1c4e27ed-b67a-5859-9de8-7cdb660405fe"
},
"entry": [
{
"date": "2026-09-01T15:20:03+08:00",
"item": {
"reference": "urn:uuid:01371232-0b70-5344-a458-8dbefc8cbabc"
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "urn:uuid:01371232-0b70-5344-a458-8dbefc8cbabc",
"resource": {
"resourceType": "MedicationStatement",
"id": "01371232-0b70-5344-a458-8dbefc8cbabc",
"meta": {
"versionId": "1",
"lastUpdated": "2026-09-01T15:36:51+08:00",
"source": "JHS-EPIC",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-medicationstatement"
]
},
"identifier": [
{
"system": "https://fhir.synapxe.sg/NamingSystem/record-id",
"value": "1008193333"
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/sequence-no",
"value": "1"
}
],
"status": "recorded",
"category": [
{
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Med_List_Reviewed_Upon_(NEHR)",
"code": "2",
"display": "Discharge"
}
]
}
],
"medication": {
"reference": {
"reference": "urn:uuid:8a48bee6-325c-5c89-9238-8f1d170666d0"
}
},
"subject": {
"type": "Patient",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/mrn",
"value": "S8206348Z"
},
"display": "MICHOME TEST PATIENT PASS 1"
},
"dateAsserted": "2026-09-01T15:20:03+08:00",
"informationSource": [
{
"reference": "urn:uuid:ecf1d2db-2ce3-5e44-b3aa-0ec4cd78e87d",
"type": "PractitionerRole"
}
],
"dosage": [
{
"text": "Take 500 mg 3 times a day for 7 days.",
"timing": {
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Med_Frequency_(NEHR)",
"code": "229798009",
"display": "3 times a day"
}
]
}
},
"route": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Med_RouteofAdmin_(NEHR)",
"code": "26643006",
"display": "Oral"
}
]
},
"doseAndRate": [
{
"doseRange": {
"low": {
"value": 500,
"unit": "mg"
}
}
}
]
}
]
},
"search": {
"mode": "include"
}
},
{
"fullUrl": "urn:uuid:8a48bee6-325c-5c89-9238-8f1d170666d0",
"resource": {
"resourceType": "Medication",
"id": "8a48bee6-325c-5c89-9238-8f1d170666d0",
"meta": {
"versionId": "1",
"lastUpdated": "2026-09-01T15:36:51+08:00",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-medication"
]
},
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Singapore_Drug_Dictionary-Compressed",
"code": "0000-09-68X-1",
"display": "Paracetamol 500mg Tablet"
}
]
},
"doseForm": {
"text": "Tablet"
}
},
"search": {
"mode": "include"
}
},
{
"fullUrl": "urn:uuid:1c4e27ed-b67a-5859-9de8-7cdb660405fe",
"resource": {
"resourceType": "PractitionerRole",
"id": "1c4e27ed-b67a-5859-9de8-7cdb660405fe",
"meta": {
"versionId": "1",
"lastUpdated": "2026-09-01T15:36:51+08:00",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-practitionerrole"
]
},
"practitioner": {
"type": "Practitioner",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/mcr",
"value": "M07587F"
},
"display": "PHYSICIAN, SH SR."
},
"organization": {
"type": "Organization",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "0100000"
}
}
},
"search": {
"mode": "include"
}
},
{
"fullUrl": "urn:uuid:ecf1d2db-2ce3-5e44-b3aa-0ec4cd78e87d",
"resource": {
"resourceType": "PractitionerRole",
"id": "ecf1d2db-2ce3-5e44-b3aa-0ec4cd78e87d",
"meta": {
"versionId": "1",
"lastUpdated": "2026-09-01T15:36:51+08:00",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-practitionerrole"
]
},
"practitioner": {
"type": "Practitioner",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/mcr",
"value": "M07587F"
},
"display": "PHYSICIAN, SH SR."
},
"organization": {
"type": "Organization",
"identifier": {
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "0100000"
}
}
},
"search": {
"mode": "include"
}
}
]
}

Business Level Errors

This section details the business level errors exposed by OperationOutcome resource for this operation. Refer to API Error Handling for framework level errors.

For illustration only

http status code code details.coding.code details.text
404 not-found E-10000 No matching patient found based on NRIC, Date of Birth and Gender
404 not-found E-10001 Institution code for organization is not found
404 not-found E-10002 Organization code is not found
400 business-rule E-10003 Patient is not currently enrolled to the organization
400 duplicate E-10004 An attempt was made to create a duplicate record
400 invalid E-10005 Invalid allergy intolerance identifier
400 invalid E-10006 Invalid clinical or verification status