New Consult

POST /api/v1/consultation/uploadReturns a response containing minimally the case note summary, and optionally transcript, evidence_map, pvs, and referral . 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.HEADER PARAMETERS
REQUIREDX-Scrubs-HCI-Codestring
HCI code of the clinic making the API request.
REQUIREDX-Scrubs-HCI-Providerstring
Provider ID associated with your EHR application.
BODY PARAMETERS
REQUIREDaudiofile
Binary audio data of an mp3-encoded file. If provided, this will take priority over audio_url.
REQUIREDaudio_urlstring
A publicly accessible URL hosting an mp3-encoded file.
OPTIONALgenerate_transcriptboolean
An optional parameter to generate the consultation transcript. Defaults to false if omitted.
OPTIONALgenerate_evidenceboolean
An optional parameter to generate evidence linking SOAP to transcript. Defaults to false if omitted.
OPTIONALgenerate_pvsboolean
An optional parameter to generate a patient visitation summary. Defaults to false if omitted.
OPTIONALgenerate_referralboolean
An optional parameter to generate a referral letter. Defaults to false if omitted.
Domain
BASE URL
1https://usescrubs.com
Sample Request
CURL
NodeJS
Python
Go
CURL
1curl --location 'https://usescrubs.com/api/v1/consultation/upload' \
2--header 'X-Scrubs-HCI-Code: 00A123' \
3--header 'X-Scrubs-HCI-Provider: SAMPLE_EHR_1' \
4--header 'Content-Type: multipart/form-data' \
5--form 'audio=@path/to/your/audiofile.mp3' \
6--form 'audio_url=https://example.com/path/to/audio.mp3' \
7--form 'generate_transcript=true' \
8--form 'generate_evidence=true' \
9--form 'generate_pvs=true' \
10--form 'generate_referral=true'
Sample Response
JSON
1{
2    "transcript": "SPEAKER: S1\nHi, doctor, I have been having a headache ...",
3    "summary": "**Subjective:**\n1. Chief complaint: Headache for the past 1 week.\n2. ...",
4    "evidence_map": {
5       "Patient reports having a headache for the past week": "Headache since last Monday.",
6       "Unable to work due to persistent headache": "Haven't worked for the past week.",
7       "Patient reports poor sleep": "A bit of poor sleep for the last 2 to 3 nights.",
8        ...
9    },
10    "pvs": "**Visit Summary:**\nDuring your visit today, we discussed ...",
11    "referral": "Dear [Name of Doctor], I am referring Mr. John [Patient's Last Name], ..."
12}
Contact us:hc@usescrubs.com