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, Genomics 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 |
| Genomics Report | http://terminology.hl7.org/CodeSystem/v2-0074 | GE |
| 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=GE
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|S9876543D&category=GE"
}
],
{
"https://fhir.synapxe.sg/StructureDefinition/profile-genomicsreport"
]
},
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h1>Genomic Analysis Report</h1><h2>Patient: Jane Doe (S9876543D)</h2><h2>Report Date: 2026-07-29</h2><h2>Status: Final</h2><h2>Findings</h2><p><strong>BRCA1 Mutation Detected</strong></p><p>A pathogenic BRCA1 mutation (c.68_69delAG, p.E23Vfs*17) has been identified in the patient's germline DNA in heterozygous state.</p><h3>Genetic Variant Details:</h3><ul><li>Gene: BRCA1 (HGNC:1100)</li><li>Mutation: c.68_69delAG</li><li>Protein Impact: p.E23Vfs*17</li><li>Allelic State: Heterozygous</li><li>Clinical Significance: Pathogenic</li></ul><h3>Molecular Biomarker:</h3><ul><li>BRCA1 mRNA Expression: 2.5-fold change relative to control</li></ul><h2>Clinical Interpretation</h2><p>The detected BRCA1 mutation is associated with significantly increased lifetime risk of breast and ovarian cancers. Genetic counseling and preventive measures are strongly recommended.</p><h2>Recommendations</h2><ul><li>Genetic counseling for the patient and at-risk family members</li><li>Consideration of prophylactic hormone therapy or preventive mastectomy</li><li>Enhanced surveillance protocols</li></ul><h2>Interpretation</h2><p>Dr. John Smith (M45678)<br/>Singapore Genomics Laboratory (HCI-98765)</p></div>"
},
{
}
}
],
{
},
{
}
],
],
]
},
},
{
}
}
],
{
}
}
],
],
{
},
{
}
],
"conclusion": "Pathogenic BRCA1 mutation detected. c.68_69delAG (p.E23Vfs*17) identified in heterozygous state. Recommend genetic counseling and preventive measures."
}
},
{
"https://fhir.synapxe.sg/StructureDefinition/profile-variant"
]
},
{
]
},
{
}
],
]
},
{
},
}
},
{
},
{
}
]
}
},
{
},
},
{
]
},
}
]
}
},
{
"https://fhir.synapxe.sg/StructureDefinition/profile-molecularbiomarker"
]
},
{
]
},
{
}
],
},
{
},
}
},
{
},
}
}
]
}
},
{
"https://fhir.synapxe.sg/StructureDefinition/profile-genomics-specimen"
]
},
]
},
},
}
}
},
{
"https://fhir.synapxe.sg/StructureDefinition/profile-genomics-servicerequest"
]
},
],
},
}
}
}
},
{
"https://fhir.synapxe.sg/StructureDefinition/profile-genomics-patient"
]
},
],
],
}
},
{
"https://fhir.synapxe.sg/StructureDefinition/profile-medicationrecommendation"
]
},
{
}
]
},
"description": "Consider prophylactic hormone therapy or preventive mastectomy. Genetic counseling recommended for family members.",
}
}
}
}
]
}
{
{
"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 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 |