API Name: put-composition


This API creates the Summary Note Composition record which is associated to an encounter within a patient visit. The Composition resource is used to store structured clinical notes, referencing supporting clinical resources such as QuestionnaireResponse, DiagnosticReport, Observation, Condition, Procedure, and ReferralRequest.

Specification


Endpoint [baseurl]/$put-composition
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.
  • Composition.type.coding.code must be set to SUM to indicate a Summary Note document type.
  • Composition.section.code differentiates section types as defined in the Doc Section Type value set.

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..1Composition
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..1Procedure
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..1QuestionnaireResponse
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..1https://fhir.synapxe.sg/StructureDefinition/profile-diagnosticreport
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..1Observation
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..1Condition
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..1ReferralRequest
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..1FileAttachment
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:summarynotes-composition-001",
"resourceType": "Composition",
"id": "summarynotes-001",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-composition"
]
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/record-id",
"value": "SN-REC-2026-00789"
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/accession-no",
"value": "SN-ACC-2026-00789"
}
],
"status": "final",
"type": {
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-version",
"valueString": "1.0"
}
],
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/nehr-doc-types",
"code": "SN",
"display": "Summary Notes"
}
]
},
"subject": [
{
"type": "Patient",
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S8765432A"
}
}
],
"type": "Encounter",
"system": "https://fhir.synapxe.sg/NamingSystem/event-id",
"value": "SN-ENC-2026-00789"
}
},
"date": "2026-02-09T16:00:00+08:00",
"author": [
{
"reference": "urn:uuid:practitionerrole-001"
}
],
"title": "Surgical Summary Notes - Laparoscopic Cholecystectomy",
"note": [
{
"text": "Patient underwent successful laparoscopic cholecystectomy. Recovery was uneventful."
}
],
{
"mode": {
"coding": [
{
"system": "http://hl7.org/fhir/CodeSystem/composition-attestation-mode",
"code": "official",
"display": "Official"
}
]
},
"time": "2026-02-09T16:00:00+08:00",
"party": {
"type": "Practitioner",
"system": "https://fhir.synapxe.sg/NamingSystem/mcr",
"value": "M55555"
},
"display": "Dr. Jennifer Lim"
}
}
],
"type": "Organization",
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "HCI-54321"
},
"display": "National University Hospital"
},
"event": [
{
"detail": [
{
"reference": "urn:uuid:sn-procedure-001"
}
}
]
}
],
"section": [
{
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/doc-section-type",
"code": "questionnaire",
"display": "Questionnaire"
}
]
},
"entry": [
{
"reference": "urn:uuid:sn-questionnaireresponse-001"
}
]
},
{
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/doc-section-type",
"code": "report",
"display": "Diagnostic Report"
}
]
},
"entry": [
{
"reference": "urn:uuid:diagnosticreport-001"
}
]
},
{
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/doc-section-type",
"code": "observation",
"display": "Observation"
}
]
},
"entry": [
{
"reference": "urn:uuid:sn-observation-001"
}
]
},
{
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/doc-section-type",
"code": "condition",
"display": "Condition"
}
]
},
"entry": [
{
"reference": "urn:uuid:sn-condition-001"
}
]
},
{
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/doc-section-type",
"code": "referralRequest",
"display": "Referral Request"
}
]
},
"entry": [
{
"reference": "urn:uuid:sn-referralrequest-001"
}
]
},
{
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/doc-section-type",
"code": "fileAttachment",
"display": "File Attachments"
}
]
},
"entry": [
{
"reference": "urn:uuid:fileattachment-001"
}
]
}
]
},
"request": {
"method": "POST",
"url": "Composition"
}
},
{
"fullUrl": "urn:uuid:practitionerrole-001",
"resourceType": "PractitionerRole",
"id": "practitionerrole-001",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-practitionerrole"
]
},
"system": "https://fhir.synapxe.sg/NamingSystem/mcr",
"value": "M55555"
},
"display": "Dr. Jennifer Lim"
},
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "HCI-54321"
},
"display": "National University Hospital"
},
"code": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304292004",
"display": "Surgeon"
}
]
}
],
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "394609007",
"display": "General surgery"
}
]
}
]
},
"request": {
"method": "POST",
"url": "PractitionerRole"
}
},
{
"fullUrl": "urn:uuid:sn-procedure-001",
"resourceType": "Procedure",
"id": "sn-procedure-001",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-sn-procedure"
]
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/procedure-id",
"value": "PROC-SN-2026-00789"
}
],
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "45595009",
"display": "Laparoscopic cholecystectomy"
}
],
"text": "Laparoscopic cholecystectomy with intraoperative cholangiography"
},
"subject": {
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S8765432A"
}
},
"system": "https://fhir.synapxe.sg/NamingSystem/event-id",
"value": "SN-ENC-2026-00789"
}
},
"start": "2026-02-09T09:00:00+08:00",
"end": "2026-02-09T11:30:00+08:00"
},
"recorded": "2026-02-09T11:30:00+08:00",
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304292004",
"display": "Surgeon"
}
]
},
"actor": {
"system": "https://fhir.synapxe.sg/NamingSystem/mcr",
"value": "M55555"
},
"display": "Dr. Jennifer Lim"
}
}
],
"reason": [
{
"concept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "235919008",
"display": "Acute cholecystitis"
}
]
}
}
],
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "28231008",
"display": "Gallbladder structure"
}
]
}
],
"outcome": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385669000",
"display": "Successful"
}
],
"text": "Procedure completed successfully without complications"
},
"report": [
{
"reference": "urn:uuid:diagnosticreport-001"
}
],
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183624006",
"display": "Follow-up 2 weeks"
}
]
}
],
"note": [
{
"text": "Gallbladder removed intact. No bile spillage. Hemostasis achieved. All ports closed appropriately."
}
]
},
"request": {
"method": "POST",
"url": "Procedure"
}
},
{
"fullUrl": "urn:uuid:sn-questionnaireresponse-001",
"resourceType": "QuestionnaireResponse",
"id": "sn-questionnaireresponse-001",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-sn-questionnaireresponse"
]
},
"questionnaire": "https://fhir.synapxe.sg/Questionnaire/surgical-assessment",
"status": "completed",
"subject": {
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S8765432A"
}
},
"system": "https://fhir.synapxe.sg/NamingSystem/event-id",
"value": "SN-ENC-2026-00789"
}
},
"authored": "2026-02-09T08:00:00+08:00",
"author": {
"system": "https://fhir.synapxe.sg/NamingSystem/mcr",
"value": "M55555"
},
"display": "Dr. Jennifer Lim"
},
"item": [
{
"linkId": "1",
"text": "Pre-operative Assessment",
"item": [
{
"linkId": "1.1",
"text": "ASA Classification",
"answer": [
{
"system": "http://snomed.info/sct",
"code": "413107003",
"display": "ASA II - Patient with mild systemic disease"
}
}
]
},
{
"linkId": "1.2",
"text": "Fasting Status",
"answer": [
{
"valueString": "NPO since midnight, 8 hours fasting"
}
]
}
]
},
{
"linkId": "2",
"text": "Intraoperative Findings",
"item": [
{
"linkId": "2.1",
"text": "Gallbladder condition",
"answer": [
{
"valueString": "Inflamed gallbladder with multiple small stones. No perforation."
}
]
},
{
"linkId": "2.2",
"text": "Any complications during surgery",
"answer": [
{
"valueBoolean": false
}
]
}
]
},
{
"linkId": "3",
"text": "Post-operative Plan",
"item": [
{
"linkId": "3.1",
"text": "Discharge plan",
"answer": [
{
"valueString": "Discharge on day 2 post-op if stable"
}
]
}
]
}
]
},
"request": {
"method": "POST",
"url": "QuestionnaireResponse"
}
},
{
"fullUrl": "urn:uuid:diagnosticreport-001",
"resourceType": "DiagnosticReport",
"id": "diagnosticreport-001",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-diagnosticreport"
]
},
"status": "final",
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0074",
"code": "SP",
"display": "Surgical Pathology"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "60567-5",
"display": "Comprehensive surgical pathology report"
}
],
"text": "Histopathology Report - Gallbladder"
},
"subject": {
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S8765432A"
}
},
"system": "https://fhir.synapxe.sg/NamingSystem/event-id",
"value": "SN-ENC-2026-00789"
}
},
"effectiveDateTime": "2026-02-09T11:30:00+08:00",
"issued": "2026-02-11T14:00:00+08:00",
{
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "HCI-54321"
},
"display": "National University Hospital - Pathology Department"
}
],
"result": [
{
"reference": "urn:uuid:sn-observation-001"
}
],
"conclusion": "Chronic cholecystitis with cholelithiasis. Multiple pigmented gallstones. No evidence of dysplasia or malignancy."
},
"request": {
"method": "POST",
"url": "DiagnosticReport"
}
},
{
"fullUrl": "urn:uuid:sn-observation-001",
"resourceType": "Observation",
"id": "sn-observation-001",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-sn-observation"
]
},
"status": "final",
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "laboratory",
"display": "Laboratory"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "22637-3",
"display": "Pathology report final diagnosis"
}
],
"text": "Histopathology findings"
},
"subject": {
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S8765432A"
}
},
"system": "https://fhir.synapxe.sg/NamingSystem/event-id",
"value": "SN-ENC-2026-00789"
}
},
"effectiveDateTime": "2026-02-11T14:00:00+08:00",
"issued": "2026-02-11T14:00:00+08:00",
{
"system": "https://fhir.synapxe.sg/NamingSystem/mcr",
"value": "M77777"
},
"display": "Dr. Ahmad Pathologist"
}
],
"valueString": "Gallbladder wall shows chronic inflammatory changes. Multiple pigmented stones identified. No evidence of dysplasia or malignancy.",
"note": [
{
"text": "Specimen: Gallbladder, entire. Gross description: Received fresh a 9cm gallbladder. Wall thickness ranges 0.2-0.5cm. Contains multiple black pigmented stones."
}
]
},
"request": {
"method": "POST",
"url": "Observation"
}
},
{
"fullUrl": "urn:uuid:sn-condition-001",
"resourceType": "Condition",
"id": "sn-condition-001",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-sn-condition"
]
},
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved",
"display": "Resolved"
}
]
},
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed",
"display": "Confirmed"
}
]
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"coding": [
{
"system": "http://snomed.info/sct",
"code": "24484000",
"display": "Severe"
}
]
},
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "235919008",
"display": "Acute cholecystitis"
}
],
"text": "Acute cholecystitis with cholelithiasis"
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "28231008",
"display": "Gallbladder structure"
}
]
}
],
"subject": {
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S8765432A"
}
},
"system": "https://fhir.synapxe.sg/NamingSystem/event-id",
"value": "SN-ENC-2026-00789"
}
},
"onsetDateTime": "2026-02-05T00:00:00+08:00",
"abatementDateTime": "2026-02-09T11:30:00+08:00",
"recordedDate": "2026-02-09T16:00:00+08:00",
"note": [
{
"text": "Patient presented with right upper quadrant pain, fever, and positive Murphy's sign. Ultrasound confirmed acute cholecystitis. Condition resolved following surgical removal of gallbladder."
}
]
},
"request": {
"method": "POST",
"url": "Condition"
}
},
{
"fullUrl": "urn:uuid:sn-referralrequest-001",
"resourceType": "ServiceRequest",
"id": "sn-referralrequest-001",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-sn-referralrequest"
]
},
"status": "active",
"intent": "order",
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "3457005",
"display": "Referral"
}
]
}
],
"priority": "routine",
"subject": {
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S8765432A"
}
},
"system": "https://fhir.synapxe.sg/NamingSystem/event-id",
"value": "SN-ENC-2026-00789"
}
},
"occurrenceDateTime": "2026-02-23T00:00:00+08:00",
"authoredOn": "2026-02-09T16:00:00+08:00",
"system": "https://fhir.synapxe.sg/NamingSystem/mcr",
"value": "M55555"
},
"display": "Dr. Jennifer Lim"
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "HCI-54321-GASTRO"
},
"display": "NUH Gastroenterology Clinic"
}
],
"note": [
{
"text": "Patient to be reviewed in 2 weeks for assessment of post-operative bile duct function and to rule out post-cholecystectomy syndrome."
}
]
},
"request": {
"method": "POST",
"url": "ServiceRequest"
}
},
{
"fullUrl": "urn:uuid:fileattachment-001",
"resourceType": "DocumentReference",
"id": "fileattachment-001",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-fileattachment"
]
},
"status": "current",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "18748-4",
"display": "Diagnostic imaging study"
}
],
"text": "Intraoperative cholangiogram images"
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/document-classcode",
"code": "image",
"display": "Image"
}
]
}
],
"subject": {
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S8765432A"
}
},
"content": [
{
"contentType": "image/dicom",
"url": "https://pacs.nuh.sg/studies/SN-2026-00789-cholangiogram",
"size": "1524288",
"title": "Intraoperative Cholangiogram",
"creation": "2026-02-09T10:15:00+08:00"
}
}
]
},
"request": {
"method": "POST",
"url": "DocumentReference"
}
}
]
}

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..1Composition
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..1Procedure
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..1QuestionnaireResponse
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..1https://fhir.synapxe.sg/StructureDefinition/profile-diagnosticreport
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..1Observation
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..1Condition
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..1ReferralRequest
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..1FileAttachment
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": "Composition/summarynotes-001/_history/1",
"etag": "1",
"lastModified": "2026-02-09T16:00:00.123+08:00"
}
},
{
"status": "201 Created",
"location": "PractitionerRole/practitionerrole-001/_history/1",
"etag": "1",
"lastModified": "2026-02-09T16:00:00.124+08:00"
}
},
{
"status": "201 Created",
"location": "Procedure/sn-procedure-001/_history/1",
"etag": "1",
"lastModified": "2026-02-09T16:00:00.125+08:00"
}
},
{
"status": "201 Created",
"location": "QuestionnaireResponse/sn-questionnaireresponse-001/_history/1",
"etag": "1",
"lastModified": "2026-02-09T16:00:00.126+08:00"
}
},
{
"status": "201 Created",
"location": "DiagnosticReport/diagnosticreport-001/_history/1",
"etag": "1",
"lastModified": "2026-02-09T16:00:00.127+08:00"
}
},
{
"status": "201 Created",
"location": "Observation/sn-observation-001/_history/1",
"etag": "1",
"lastModified": "2026-02-09T16:00:00.128+08:00"
}
},
{
"status": "201 Created",
"location": "Condition/sn-condition-001/_history/1",
"etag": "1",
"lastModified": "2026-02-09T16:00:00.129+08:00"
}
},
{
"status": "201 Created",
"location": "ServiceRequest/sn-referralrequest-001/_history/1",
"etag": "1",
"lastModified": "2026-02-09T16:00:00.13+08:00"
}
},
{
"status": "201 Created",
"location": "DocumentReference/fileattachment-001/_history/1",
"etag": "1",
"lastModified": "2026-02-09T16:00:00.131+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