API Name: DiagnosticReport.$retrieve
This API retrieves DiagnosticReport record(s) associated with a patient, identified by the patient's NRIC identifier. Supported report types include Lab Results, Radiology Reports, and Screening Reports (Breast, Cervical, Chronic Disease, Colorectal, and Pap Smear).
Specification
| Endpoint | [baseurl]/DiagnosticReport/$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>. |
category |
token | 0..1 | Filter by report category. Use a code from the table below to retrieve a specific report type. |
date |
date | 0..2 | Filter by report date. Supports ge and le prefixes for date range (e.g. ge2026-01-01&date=le2026-06-30). |
status |
token | 0..1 | Filter by report status (e.g. final, preliminary). |
_count |
number | 0..1 | Maximum number of results to return per page. |
Category Codes
| Report Type | System | Code |
|---|---|---|
| Lab Result | http://terminology.hl7.org/CodeSystem/v2-0074 | LAB |
| Radiology Report | http://terminology.hl7.org/CodeSystem/v2-0074 | RAD |
| Breast Screening Report | https://fhir.synapxe.sg/CodeSystem/screen-type | breast-screen |
| Cervical Screening Report | https://fhir.synapxe.sg/CodeSystem/screen-type | cervical-screen |
| Chronic Disease Screening Report | https://fhir.synapxe.sg/CodeSystem/screen-type | screen-for-life-chronic-disease |
| Colorectal Screening Report | https://fhir.synapxe.sg/CodeSystem/screen-type | colorectal-screen |
| Pap Smear Report | https://fhir.synapxe.sg/CodeSystem/screen-type | screen-for-life-pap-smear |
Example Request
GET [baseurl]/DiagnosticReport/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S9876543D&category=LAB
Successful Response
The response is a searchset Bundle containing the matching DiagnosticReport resource(s), each conforming to the profile for the requested report type.
{
{
"url": "[baseurl]/DiagnosticReport/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S9876543D&category=LAB"
}
],
{
},
{
},
{
}
],
{
{
}
]
}
],
]
},
}
},
}
},
{
}
}
]
},
}
}
]
}
{
{
"url": "[baseurl]/DiagnosticReport/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S1234567A&category=RAD"
}
],
{
},
{
},
{
}
],
{
{
}
]
}
],
},
}
},
}
},
{
}
}
]
},
}
}
]
}
{
{
"url": "[baseurl]/DiagnosticReport/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S1234567A&category=breast-screen"
}
],
{
},
],
{
}
]
},
}
},
{
{
}
]
},
}
}
]
},
}
}
]
}
{
{
"url": "[baseurl]/DiagnosticReport/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S1234567A&category=cervical-screen"
}
],
{
},
],
{
}
]
},
}
},
{
{
}
]
},
}
}
],
{
"text": "Negative for intraepithelial lesion or malignancy. HPV not detected. Routine screening recommended in 3 years."
}
]
},
}
}
]
}
{
{
"url": "[baseurl]/DiagnosticReport/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S1234567A&category=screen-for-life-chronic-disease"
}
],
{
},
],
{
}
]
},
}
},
{
}
}
]
},
}
}
]
}
{
{
"url": "[baseurl]/DiagnosticReport/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S1234567A&category=screen-for-life-colorectal"
}
],
{
},
],
{
}
]
},
}
},
{
}
}
],
{
{
}
]
},
}
},
{
]
},
}
}
]
},
}
}
]
}
{
{
"url": "[baseurl]/DiagnosticReport/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S8234567D&category=screen-for-life-pap-smear"
}
],
{
},
],
{
}
]
},
}
},
{
}
}
],
{
}
}
],
{
{
}
]
},
}
}
]
},
}
}
]
}
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 group organization is not found |
| 404 | not-found | E-10002 | Group 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 |