New Consult

POST /api/v2/consultation/uploadReturns a response containing the case note summary, transcript, and diagnosis . This endpoint is ideal for cases where granular calls to separate endpoints are not required, offering a more streamlined way to access the core functionalities of the Scrubs API.

Optional parameter patientData can be provided as a JSON string in the form data to incorporate additional structured patient data, such as past medical history, medications, or previous examination findings, into the generated SOAP note.

Customisation of the returned fields to suit your organisation's needs is available on request.HEADER PARAMETERS

REQUIREDX-Scrubs-Clinic-Codestring

Clinic code or identifier of the clinic making the API request.

REQUIREDX-Scrubs-Clinic-Providerstring

Provider ID associated with your EHR application.

OPTIONALX-Scrubs-Clinic-Output-Languagestring

Language for the output response. Supported ISO 639-1 codes: en, fil, th, vi, id, ms, km, lo, my, tl, zh, ja, ko, ru, hi. Defaults to English if not specified.

REQUIREDX-Scrubs-<any-other-header>any

Other required headers depending on your organisation's provider ID.

BODY PARAMETERS

REQUIREDaudiofile

Audio data file. We support: MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4A, Ogg, Opus, and WebM encoded audio files.

OPTIONALpatientDataobject

An optional object containing structured patient data that will be incorporated into the output to provide additional context. This can include past medical history, medications, allergies, previous examination findings, or other relevant patient information.

Domain

BASE URL

1https://proxy.usescrubs.com

Sample Request

CURL

NodeJS

Python

CURL

1curl --location 'https://proxy.usescrubs.com/api/v2/consultation/upload' \
2--header 'X-Scrubs-Clinic-Code: 00A123' \
3--header 'X-Scrubs-Clinic-Provider: SAMPLE_EHR_1' \
4--header 'Content-Type: multipart/form-data' \
5--form 'audio=@path/to/your/audiofile.mp3'

Sample Response

JSON

1{
2    "transcript": "SPEAKER: S1\nHi, doctor, I have been having a stomach ache ...",
3    "original_transcript": "SPEAKER: S1\nHai Dok, perut aku sakit nih ...",
4    "summary": {
5        "subjective": "1. Chief complaint: Nausea and loss of appetite ...",
6        "objective": "1. Abdominal examination: No significant findings ...",
7        "assessment": "Viral Gastroenteritis",
8        "plan": "1. Prescribe antiemetics for nausea and pain relievers ..."
9    },
10    "diagnosis": [
11        {
12            "diagnosis": "Viral Gastroenteritis",
13            "explanation": "The patient's symptoms of nausea, vomiting, diarrhea ...",
14            "codes": [
15                "111843007",
16                "111844001",
17                "186153004"
18            ]
19        },
20        {
21            "diagnosis": "Gastritis",
22            "explanation": "Given the recent travel to China and consumption of ...",
23            "codes": [
24                "4556007"
25            ]
26        },
27        {
28            "diagnosis": "Food Poisoning",
29            "explanation": "The presence of distinct foodborne symptoms, with ...",
30            "codes": [
31                "75258004",
32                "281107009"
33            ]
34        }
35    ]
36}