Summarisation

POST /api/v1/summarisation/soapReturns a SOAP summary in JSON format based on a consultation transcription provided. The SOAP summary is formatted with the property keys: subjective , objective , assessment , and plan .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

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

CURL

1curl --location 'https://usescrubs.com/api/v1/summarisation/soap' \
2--header 'X-Scrubs-Clinic-Code: 00A123' \
3--header 'X-Scrubs-Clinic-Provider: SAMPLE_EHR_1' \
4--header 'X-Scrubs-Clinic-Output-Language: fil' \
5--header 'Content-Type: application/json' \
6--data '{
7    "transcript": "Hi, doctor, I have been having a headache for the past 1 week ..."
8}'

Sample Response

JSON

1{
2    "summary": {
3        "subjective": "1. Chief complaint: Nausea and loss of appetite ...",
4        "objective": "1. Abdominal examination: No significant findings ...",
5        "assessment": "Viral Gastroenteritis",
6        "plan": "1. Prescribe antiemetics for nausea and pain relievers ..."
7    }
8}

POST /api/v1/summarisation/pvsReturns a Patient Visitation Summary (PVS) in JSON format. This endpoint requires both a transcript and a summary from a consultation to generate a PVS. The PVS summary is formatted with the property keys: visit_summary , plans , and instructions .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

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

CURL

1curl --location 'https://usescrubs.com/api/v1/summarisation/pvs' \
2--header 'X-Scrubs-Clinic-Code: 00A123' \
3--header 'X-Scrubs-Clinic-Provider: SAMPLE_EHR_1' \
4--header 'X-Scrubs-Clinic-Output-Language: fil' \
5--header 'Content-Type: application/json' \
6--data '{
7    "transcript":"Hi, doctor, I have been having a headache for the past 1 week ...",
8    "summary":"Patient reports having a headache for the past week ..."
9}'

Sample Response

JSON

1{
2    "pvs": {
3        "visit_summary": "During your visit today, we discussed ...",
4        "plans": "1. Tension Headache: This is a type of headache ...",
5        "instructions": "Please take the prescribed medications ..."
6    }
7}

POST /api/v1/summarisation/transform-noteTransforms a clinical summary into the exact style and format of a given template while preserving template headers and structure. This endpoint takes a summary and a template and returns the summary content reformatted to match the template structure. Headers and labels from the template are preserved exactly, while content areas are filled with relevant information from the summary. If no relevant information is found for a template section, it will be left blank. Supports multi-language output via the X-Scrubs-Clinic-Output-Language header.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

REQUIREDsummarystring

A consultation summary. It does not need to follow the format of summaries from the summary endpoint but should resemble a SOAP note.

REQUIREDtemplatestring

The template format/structure that the summary should be transformed into. Headers and structure will be preserved exactly as provided.

Domain

BASE URL

1https://usescrubs.com

Sample Request

CURL

NodeJS

Python

CURL

1curl --location 'https://usescrubs.com/api/v1/summarisation/transform-note' \
2--header 'X-Scrubs-Clinic-Code: 00A123' \
3--header 'X-Scrubs-Clinic-Provider: SAMPLE_EHR_1' \
4--header 'X-Scrubs-Clinic-Output-Language: en' \
5--header 'Content-Type: application/json' \
6--data '{
7    "summary": "Patient reports headache for past week, worsening. Normal vitals. Assessment: tension headache. Plan: ibuprofen, stress management.",
8    "template": "SOAP NOTE\n\nDate: ___________\nProvider: ___________\n\nCHIEF COMPLAINT:\n___________\n\nHISTORY:\n___________\n\nASSESSMENT:\n___________\n\nPLAN:\n___________"
9}'

Sample Response

JSON

1{
2    "transformed_note": "EMERGENCY DEPARTMENT SOAP NOTE\n\nDate: 2024-01-15\nProvider: Dr. Smith\n\nCHIEF COMPLAINT:\nHeadache for 1 week\n\nHISTORY OF PRESENT ILLNESS:\nPatient reports headache for past week, gradually worsening...\n\nASSESSMENT AND PLAN:\n1. Tension headache - ibuprofen and stress management\n2. Follow up if symptoms worsen\n\nProvider: Dr. Smith"
3}