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 | BundleProblemList | https://fhir.synapxe.sg/StructureDefinition/profile-bundle-problemlist |
| Patient Medication List | BundlePatientMedicationList | https://fhir.synapxe.sg/StructureDefinition/profile-bundle-patientmedicationlist |
{
{
"url": "[baseurl]/List/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S1234567A&type=problem-list"
}
],
{
},
],
]
},
{
}
}
],
}
},
{
},
{
}
]
}
},
{
},
],
{
}
]
},
]
},
}
},
{
}
}
}
]
}
},
{
},
],
{
}
]
},
]
},
}
},
{
}
}
}
]
}
}
]
}
{
{
"url": "[baseurl]/List/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S1234567A&type=medication-list"
}
],
{
},
],
},
{
}
}
],
}
},
{
}
},
{
}
}
]
}
},
{
},
{
},
{
},
{
},
{
}
],
{
{
}
]
}
],
},
}
},
],
{
],
},
{
},
}
}
}
]
}
]
}
},
{
},
{
},
{
},
{
},
{
}
],
{
{
}
]
}
],
},
}
},
{
},
{
}
}
],
{
],
},
{
},
}
}
}
]
}
]
}
},
{
},
{
}
]
},
}
}
},
{
},
{
}
]
},
}
}
},
{
},
}
},
}
}
}
},
{
},
}
},
{
{
}
]
}
],
]
}
}
]
}
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 the provided identifier |
| 404 | not-found | E-10001 | Institution code for organization is not found |
| 404 | not-found | E-10002 | Organization code is not found |
| 400 | invalid | E-10003 | Missing required parameter: patient.identifier |
| 400 | invalid | E-10004 | Invalid patient identifier format. Expected system|value |
| 400 | business-rule | E-10005 | Patient is not currently enrolled to the organization |