API Name: Observation.Create


This API creates a screening observation results record for a patient. The observations capture measurements taken during health screening sessions across multiple screening stages.

Specification


Endpoint [baseurl]/Observation/
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.
idΣ0..1id
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ0..1canonical(StructureDefinition)
securityΣ C0..*CodingBinding
tagΣ C0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
containedC0..*Resource
extensionC0..*Extension
modifierExtensionΣ ?! C0..0Extension
basedOnΣ C0..0Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ C0..0Reference(GenomicStudy | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | MedicationStatement | Procedure)
statusΣ ?!1..1codeBinding
category1..1CodeableConceptBinding
id0..0string
extensionC0..0Extension
id0..0string
extensionC0..0Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
textΣ0..0string
subjectΣ C1..1Reference(Patient)
focusΣ C0..0Reference(Resource)
encounterΣ C0..0Reference(Encounter)
effectiveDateTimedateTime
issuedΣ0..0instant
id0..0string
extensionC0..0Extension
referenceΣ C0..0string
typeΣ1..1uriBindingFixed Value
id0..0string
extensionC0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ C1..1string
periodΣ C0..0Period
assignerΣ C0..0Reference(Organization)
displayΣ C1..1string
valueCodeableConceptCodeableConcept
valueQuantityQuantity
valueStringstring
dataAbsentReasonC0..0CodeableConceptBinding
bodyStructureC0..0Reference(BodyStructure)
specimenC0..0Reference(Specimen)
deviceC0..0Reference(Device)
hasMemberΣ C0..0Reference(MolecularSequence | Observation | QuestionnaireResponse)
derivedFromΣ C0..0Reference(DocumentReference | GenomicStudy | ImagingSelection | ImagingStudy | MolecularSequence | Observation | QuestionnaireResponse)
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..0string
extensionC0..0Extension
id0..0string
extensionC0..0Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
textΣ0..0string
valueAttachmentAttachment
valueBooleanboolean
valueCodeableConceptCodeableConcept
valueDateTimedateTime
valueIntegerinteger
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueReferenceReference(MolecularSequence)
valueSampledDataSampledData
valueStringstring
valueTimetime
dataAbsentReason0..0CodeableConceptBinding
interpretation0..0CodeableConceptBinding
referenceRange0..0see (referenceRange)
{
"resourceType": "Observation",
"meta": {
{
{
"url": "msgId",
"system": "https://fhir.synapxe.sg/NamingSystem/msg-id",
"value": "CR001"
}
},
{
"url": "msgSequenceId",
"system": "https://fhir.synapxe.sg/NamingSystem/msg-sequence-id",
"value": "001"
}
},
{
"url": "date",
"valueDateTime": "2026-04-01T15:00:00+08:00"
}
],
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-artifact"
}
],
"source": "HPB-IDEAS",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-observation"
],
"tag": [
{
"code": "TTSH"
}
]
},
"text": {
"status": "generated",
--- We have skipped the narrative for better readability of the resource ---
},
"status": "final",
{
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/screen-type",
"code": "firstScreen",
"display": "First Screen"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8302-2",
"display": "Body height"
}
]
},
"subject": {
"type": "Patient",
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S1234567A"
}
},
"effectiveDateTime": "2026-02-10T09:00:00+08:00",
{
"type": "Organization",
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "11234"
},
"display": "National University Hospital"
}
],
"value": 170.5,
"unit": "cm",
"system": "http://unitsofmeasure.org",
"code": "cm"
}
}

Successful Response

idΣ0..1id
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ0..1canonical(StructureDefinition)
securityΣ C0..*CodingBinding
tagΣ C0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
containedC0..*Resource
extensionC0..*Extension
modifierExtensionΣ ?! C0..0Extension
basedOnΣ C0..0Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ C0..0Reference(GenomicStudy | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | MedicationStatement | Procedure)
statusΣ ?!1..1codeBinding
category1..1CodeableConceptBinding
id0..0string
extensionC0..0Extension
id0..0string
extensionC0..0Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
textΣ0..0string
subjectΣ C1..1Reference(Patient)
focusΣ C0..0Reference(Resource)
encounterΣ C0..0Reference(Encounter)
effectiveDateTimedateTime
issuedΣ0..0instant
id0..0string
extensionC0..0Extension
referenceΣ C0..0string
typeΣ1..1uriBindingFixed Value
id0..0string
extensionC0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ C1..1string
periodΣ C0..0Period
assignerΣ C0..0Reference(Organization)
displayΣ C1..1string
valueCodeableConceptCodeableConcept
valueQuantityQuantity
valueStringstring
dataAbsentReasonC0..0CodeableConceptBinding
bodyStructureC0..0Reference(BodyStructure)
specimenC0..0Reference(Specimen)
deviceC0..0Reference(Device)
hasMemberΣ C0..0Reference(MolecularSequence | Observation | QuestionnaireResponse)
derivedFromΣ C0..0Reference(DocumentReference | GenomicStudy | ImagingSelection | ImagingStudy | MolecularSequence | Observation | QuestionnaireResponse)
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
id0..0string
extensionC0..0Extension
id0..0string
extensionC0..0Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
textΣ0..0string
valueAttachmentAttachment
valueBooleanboolean
valueCodeableConceptCodeableConcept
valueDateTimedateTime
valueIntegerinteger
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueReferenceReference(MolecularSequence)
valueSampledDataSampledData
valueStringstring
valueTimetime
dataAbsentReason0..0CodeableConceptBinding
interpretation0..0CodeableConceptBinding
referenceRange0..0see (referenceRange)
{
"resourceType": "Observation",
"id": "observation-example",
"meta": {
"lastUpdated": "2026-02-10T09:30:00.1+08:00",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-observation"
]
},
"status": "final",
{
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/screen-type",
"code": "firstScreen",
"display": "First Screen"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8302-2",
"display": "Body height"
}
]
},
"subject": {
"type": "Patient",
"system": "https://fhir.synapxe.sg/NamingSystem/nric",
"value": "S1234567A"
}
},
"effectiveDateTime": "2026-02-10T09:00:00+08:00",
{
"type": "Organization",
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "11234"
},
"display": "National University Hospital"
}
],
"value": 170.5,
"unit": "cm",
"system": "http://unitsofmeasure.org",
"code": "cm"
}
}

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