New ConsultTranscriptionSummarisationReferral LetterEvidenceAuto Field PopulationClinical Decision SupportClinical Code SuggestionsAmbient Dictation

Summarisation

POST /api/v1/summarisation/soapReturns a SOAP summary in string format based on a consultation transcription provided. The SOAP summary is formatted with each header (Subjective, Objective, Assessment, and Plans) enclosed in double asterisks.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
REQUIREDtranscriptstring
A consultation transcription. It does not need to follow the format of transcription endpoint.
Domain
BASE URL
1https://usescrubs.com
Sample Request
CURL
NodeJS
Python
Go
CURL
1curl --location 'https://usescrubs.com/api/v1/summarisation/soap' \
2--header 'X-Scrubs-HCI-Code: 00A123' \
3--header 'X-Scrubs-HCI-Provider: SAMPLE_EHR_1' \
4--header 'Content-Type: application/json' \
5--data '{
6    "transcript": "Hi, doctor, I have been having a headache for the past 1 week ..."
7}'
Sample Response
JSON
1{
2    "summary": "**Subjective:**\n1. Chief complaint: Headache for the past 1 week.\n2. ..."
3}
POST /api/v1/summarisation/pvsReturns a Patient Visitation Summary (PVS) in string format. This endpoint requires both a transcript and a summary from a consultation to generate a PVS. The PVS summary is formatted with each header enclosed in double asterisks.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
REQUIREDtranscriptstring
A consultation transcription. It does not need to follow the format of transcription endpoint.
REQUIREDsummarystring
A consultation summary. It does not need to follow the format of summaries from the summary endpoint but should resemble a SOAP note.
Domain
BASE URL
1https://usescrubs.com
Sample Request
CURL
NodeJS
Python
Go
CURL
1curl --location 'https://usescrubs.com/api/v1/summarisation/pvs' \
2--header 'X-Scrubs-HCI-Code: 00A123' \
3--header 'X-Scrubs-HCI-Provider: SAMPLE_EHR_1' \
4--header 'Content-Type: application/json' \
5--data '{
6    "transcript":"Hi, doctor, I have been having a headache for the past 1 week ...",
7    "summary":"Patient reports having a headache for the past week ..."
8}'
Sample Response
JSON
1{
2    "pvs": "**Visit Summary:**\nDuring your visit today, we discussed ..."
3}
Contact us: support@usescrubs.com