API Name: put-radiologyreport


This API creates the Radiology Report record which is associated to an encounter within a patient visit.

Specification


Endpoint [baseurl]/$put-radiologyreport
Protocol HTTPS
HTTP Method Post
HTTP Header Content-Type: application/fhir+json

Request Body

Remarks:

  • (All Slices) is an automatically generated section and should be ignored. Do not pass this as an input parameter. It will also not be part of response.

Bundle

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ C0..1Identifier
typeΣ C1..1codeBindingFixed Value
timestampΣ C0..1instant
totalΣ C0..1unsignedInt
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
relationΣ C1..1codeBinding
urlΣ C1..1uri
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ C0..1uri
resourceΣ C0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ C1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ C0..1uri
resourceΣ C1..1RadiologyReport
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ C1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ C0..1uri
resourceΣ C1..1ServiceRequest
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ C1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ C0..1uri
resourceΣ C1..1PractitionerRole | Location
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ C1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ C0..1uri
resourceΣ C1..1Investigation
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ C1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature
issuesΣ C0..1OperationOutcome
{
"resourceType": "Bundle",
"type": "transaction",
"entry": [
{
"fullUrl": "urn:uuid:diagnosticreport-radiology-001",
"resourceType": "DiagnosticReport",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-radiologyreport"
]
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/record-id",
"value": "RAD-RPT-2026-001234"
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/accession-no",
"value": "ACC-RAD-2026-001234"
}
],
"basedOn": [
{
"reference": "urn:uuid:servicerequest-radiology-001"
}
],
"status": "final",
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0074",
"code": "RAD"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "30746-2",
"display": "Chest X-ray"
}
],
"text": "Chest Radiograph, Posteroanterior and Lateral Views"
},
"subject": {
"reference": "Patient/patient-001",
"type": "Patient",
"system": "https://fhir.synapxe.sg/NamingSystem/nric-fin",
"value": "S1234567A"
}
},
"reference": "Encounter/encounter-001",
"type": "Encounter",
"system": "https://fhir.synapxe.sg/NamingSystem/visit-number",
"value": "VN-2026-001234"
}
},
"effectiveDateTime": "2026-02-10T10:30:00+08:00",
"issued": "2026-02-10T14:45:00+08:00",
{
"reference": "urn:uuid:practitionerrole-radiologist-001"
}
],
{
"type": "Practitioner",
"system": "https://fhir.synapxe.sg/NamingSystem/mcr",
"value": "M12345"
}
}
],
"result": [
{
"reference": "urn:uuid:observation-investigation-001"
},
{
"reference": "urn:uuid:observation-investigation-002"
}
],
"note": [
{
"text": "Clinical Indication: Routine screening for pre-employment health assessment.\n\nTechnique: PA and lateral chest radiographs obtained.\n\nFindings:\nLungs: Clear lung fields bilaterally. No focal consolidation, mass, or pleural effusion.\nHeart: Normal cardiac silhouette. Cardiothoracic ratio within normal limits.\nBones: No acute bony abnormality.\nSoft tissues: Unremarkable.\n\nImpression: No acute cardiopulmonary abnormality."
}
],
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "17621005",
"display": "Normal"
}
],
"text": "No acute cardiopulmonary abnormality"
}
],
{
"contentType": "application/pdf",
"language": "en-SG",
"data": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL01lZGlhQm94IFswIDAgNjEyIDc5Ml0KL0NvbnRlbnRzIDQgMCBSCj4+CmVuZG9iago0IDAgb2JqCjw8L0xlbmd0aCA0NQo+PgpzdHJlYW0KQlQKLzEgMTIgVGYKMTAwIDcwMCBUZAooWC1yYXkgUmVwb3J0KSBUagpFVAplbmRzdHJlYW0KZW5kb2JqCjEgMCBvYmoKPDwvVHlwZSAvUGFnZXMKL0tpZHMgWzMgMCBSIF0KL0NvdW50IDEKL01lZGlhQm94IFswIDAgNjEyIDc5Ml0KPj4KZW5kb2JqCjUgMCBvYmoKPDwvVHlwZSAvQ2F0YWxvZwovUGFnZXMgMSAwIFIKPj4KZW5kb2JqCjYgMCBvYmoKPDwvUHJvZHVjZXIgKFNhbXBsZSBSYWRpb2xvZ3kgUmVwb3J0KQovQ3JlYXRpb25EYXRlIChEOjIwMjYwMjEwMTQ0NTAwKzA4JzAwJykKPj4KZW5kb2JqCnhyZWYKMCA3CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDE4MyAwMDAwMCBuIAowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA5OCAwMDAwMCBuIAowMDAwMDAwMjU0IDAwMDAwIG4gCjAwMDAwMDAzMDMgMDAwMDAgbiAKdHJhaWxlcgo8PC9TaXplIDcKL1Jvb3QgNSAwIFIKL0luZm8gNiAwIFIKPj4Kc3RhcnR4cmVmCjM5OAolJUVPRgo=",
"title": "Chest X-ray Report - 2026-02-10"
}
]
},
"request": {
"method": "POST",
"url": "DiagnosticReport"
}
},
{
"fullUrl": "urn:uuid:servicerequest-radiology-001",
"resourceType": "ServiceRequest",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-servicerequest"
]
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/service-request-id",
"value": "SR-RAD-2026-001234"
}
],
"status": "completed",
"intent": "order",
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "363679005",
"display": "Imaging"
}
]
}
],
"priority": "routine",
"subject": {
"reference": "Patient/patient-001",
"type": "Patient"
},
"reference": "Encounter/encounter-001",
"type": "Encounter"
},
"occurrenceDateTime": "2026-02-10T10:30:00+08:00",
"authoredOn": "2026-02-10T09:00:00+08:00",
"reference": "Practitioner/practitioner-001",
"display": "Dr. Sarah Tan"
}
},
"request": {
"method": "POST",
"url": "ServiceRequest"
}
},
{
"fullUrl": "urn:uuid:practitionerrole-radiologist-001",
"resourceType": "PractitionerRole",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-practitionerrole"
]
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/practitioner-role-id",
"value": "PR-RAD-001"
}
],
"active": true,
"reference": "Practitioner/practitioner-radiologist-001",
"display": "Dr. James Wong"
},
"reference": "Organization/org-radiology-001",
"display": "Department of Radiology"
},
"code": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "66862007",
"display": "Radiologist"
}
]
}
],
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "394914008",
"display": "Radiology"
}
],
"text": "Diagnostic Radiology"
}
]
},
"request": {
"method": "POST",
"url": "PractitionerRole"
}
},
{
"fullUrl": "urn:uuid:observation-investigation-001",
"resourceType": "Observation",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-investigation"
]
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/observation-id",
"value": "OBS-RAD-2026-001234-001"
}
],
"status": "final",
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "imaging",
"display": "Imaging"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "106048009",
"display": "Radiographic finding"
}
],
"text": "Lung fields assessment"
},
"subject": {
"reference": "Patient/patient-001",
"type": "Patient"
},
"effectiveDateTime": "2026-02-10T10:30:00+08:00",
"issued": "2026-02-10T14:45:00+08:00",
{
"reference": "urn:uuid:practitionerrole-radiologist-001"
}
],
"coding": [
{
"system": "http://snomed.info/sct",
"code": "17621005",
"display": "Normal"
}
],
"text": "Clear lung fields bilaterally"
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
"code": "N",
"display": "Normal"
}
]
}
],
"note": [
{
"text": "No focal consolidation, mass, or pleural effusion identified."
}
]
},
"request": {
"method": "POST",
"url": "Observation"
}
},
{
"fullUrl": "urn:uuid:observation-investigation-002",
"resourceType": "Observation",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-investigation"
]
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/observation-id",
"value": "OBS-RAD-2026-001234-002"
}
],
"status": "final",
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "imaging",
"display": "Imaging"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "301348004",
"display": "Heart size"
}
],
"text": "Cardiac silhouette assessment"
},
"subject": {
"reference": "Patient/patient-001",
"type": "Patient"
},
"effectiveDateTime": "2026-02-10T10:30:00+08:00",
"issued": "2026-02-10T14:45:00+08:00",
{
"reference": "urn:uuid:practitionerrole-radiologist-001"
}
],
"coding": [
{
"system": "http://snomed.info/sct",
"code": "17621005",
"display": "Normal"
}
],
"text": "Normal cardiac silhouette"
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
"code": "N",
"display": "Normal"
}
]
}
],
"note": [
{
"text": "Cardiothoracic ratio within normal limits."
}
]
},
"request": {
"method": "POST",
"url": "Observation"
}
}
]
}

Successful Response

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
identifierΣ C0..1Identifier
typeΣ C1..1codeBindingFixed Value
timestampΣ C0..1instant
totalΣ C0..1unsignedInt
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
relationΣ C1..1codeBinding
urlΣ C1..1uri
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ C0..1uri
resourceΣ C0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ C1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ C0..1uri
resourceΣ C1..1RadiologyReport
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ C1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ C0..1uri
resourceΣ C1..1ServiceRequest
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ C1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ C0..1uri
resourceΣ C1..1PractitionerRole | Location
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ C1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
fullUrlΣ C0..1uri
resourceΣ C1..1Investigation
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
modeΣ0..1codeBinding
scoreΣ0..1decimal
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
methodΣ C1..1codeBinding
urlΣ1..1uri
ifNoneMatchΣ0..1string
ifModifiedSinceΣ0..1instant
ifMatchΣ0..1string
ifNoneExistΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
statusΣ1..1string
locationΣ0..1uri
etagΣ0..1string
lastModifiedΣ0..1instant
outcomeΣ0..1Resource
signatureΣ0..1Signature
issuesΣ C0..1OperationOutcome
{
"resourceType": "Bundle",
"type": "transaction-response",
"entry": [
{
"status": "201 Created",
"location": "DiagnosticReport/diagnosticreport-radiology-001/_history/1",
"etag": "1",
"lastModified": "2026-02-10T15:00:00.1+08:00"
}
},
{
"status": "201 Created",
"location": "ServiceRequest/servicerequest-radiology-001/_history/1",
"etag": "1",
"lastModified": "2026-02-10T15:00:00.101+08:00"
}
},
{
"status": "201 Created",
"location": "PractitionerRole/practitionerrole-radiologist-001/_history/1",
"etag": "1",
"lastModified": "2026-02-10T15:00:00.102+08:00"
}
},
{
"status": "201 Created",
"location": "Observation/observation-investigation-001/_history/1",
"etag": "1",
"lastModified": "2026-02-10T15:00:00.103+08:00"
}
},
{
"status": "201 Created",
"location": "Observation/observation-investigation-002/_history/1",
"etag": "1",
"lastModified": "2026-02-10T15:00:00.104+08:00"
}
}
]
}

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 group organization is not found
404 not-found E-10002 Group 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