SOAP Note
A SOAP note is a structured way for healthcare professionals to document patient encounters, assessments, and treatment plans. It consists of four key components:
- Subjective (S): The patient's reported symptoms, concerns, and medical history.
- Objective (O): Clinician observations, physical exam findings, and diagnostic results.
- Assessment (A): Evaluation of the patient’s condition, including diagnosis, triage score, and relevant guidelines.
- Plan (P): Recommended treatments, care advice, and next steps for the patient.
SOAP notes ensure a standardized documentation format that improves communication and continuity of care.
API Environments
Bingli provides multiple environments for different use cases:
- Production EU:
https://fhir-gateway.api.bingli.eu/tenant-api/survey/{SURVEY-ID}/soap-note/
- Acceptance EU:
https://fhir-gateway.api.acc.bingli.be/tenant-api/survey/{SURVEY-ID}/soap-note/
- Production US:
https://fhir-gateway.api.bingli.us/tenant-api/survey/{SURVEY-ID}/soap-note/
Fetching a SOAP Note
GET - Retrieve SOAP Note
Endpoint
https://fhir-gateway.api.acc.bingli.be/tenant-api/survey/{SURVEY-ID}/soap-note
Description
This endpoint retrieves the SOAP note for a given survey, including subjective, objective, assessment, and plan details.
Request Details
Headers
Key | Value |
---|---|
Authorization | Bearer JWTTOKEN |
cURL Request
curl --location 'https://fhir-gateway.api.acc.bingli.be/tenant-api/survey/{SURVEY-ID}/soap-note' \
--header 'Authorization: Bearer <TOKEN>'
Parameters Explanation
surveyId
:surveyId
given by the Create Survey endpoint.
Example Response
{
"subjective": {
"clinicalNote": {
"text": "Patient reports severe headaches for the past three days.",
"date": "2025-02-11T12:11:33.686Z"
}
},
"objective": {
"observations": {
"text": "Blood pressure elevated, mild fever noted.",
"date": "2025-02-11T12:11:33.686Z"
}
},
"assessment": {
"triageScore": 3,
"guideline": "Hypertension management",
"question": "Have you experienced dizziness or nausea?",
"confirmedDiagnoses": [
{
"diagnosis": "Migraine",
"icdCode": "G43.9",
"isUrgent": false
}
],
"diagnoses": [
{
"diagnosis": "Possible Hypertension",
"icdCode": "I10",
"isUrgent": true
}
]
},
"plan": {
"treatmentPlan": "Monitor blood pressure for the next 48 hours and avoid caffeine.",
"careAdvices": [
{
"advice": "Stay hydrated and rest in a quiet, dark room."
}
]
}
}
Breakdown of SOAP Note Components
Subjective
- Clinical Note: The practitioner's summary of the patient's reported symptoms and medical history.
Objective
- Observations: Physical findings, test results, or diagnostic impressions recorded by the practitioner.
Assessment
- Triage Score: A severity level from 0-5 based on patient symptoms.
- Guideline Triggered: Clinical guideline relevant to the case.
- Question that Triggered the Score: The critical question that influenced triage scoring.
- Diagnoses:
- Possible Diagnoses: List of potential conditions with urgency level and ICD-10 classification.
- Confirmed Diagnoses: Any verified conditions.
Plan
- Treatment Plan: The recommended course of action for managing the patient’s condition.
- Care Advices: Specific recommendations for self-care or follow-up steps.
Conclusion
Fetching a SOAP note provides a structured overview of the patient's medical history, observations, diagnosis, and treatment plan. This documentation improves clinical decision-making and continuity of care. For further details, refer to the Bingli API Documentation or contact support@mybingli.com.