Get an asynchronous note generation

GET 
/generate-note-async/:id

Poll the status —and results if successful— of an asynchronous note generation.

Request

Path Parameters

id uuidrequired
The id of the asynchronous request.
Example: 23A9981B-9E46-4ADB-BB0B-8E406C624540

Responses

200

The asynchronous note generation details.

application/json

Schema

Schema

oneOf

async_request_ongoing

iduuidrequired

The id of the asynchronous request.

Example: 98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6

client_request_idcopilot_client_request_id (string)

An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.

Note: this id must be different for every request. It is recommended to use a randomly generated UUID.

Possible values: <= 128 characters

statusasync_request_status (string)required

Possible values: [ongoing, failed, succeeded]

async_request_failed

iduuidrequired

The id of the asynchronous request.

Example: 98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6

client_request_idcopilot_client_request_id (string)

An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.

Note: this id must be different for every request. It is recommended to use a randomly generated UUID.

Possible values: <= 128 characters

statusasync_request_status (string)required

Possible values: [ongoing, failed, succeeded]

payload

object

required

error_codeintegerrequired

Example: 422

error_messagestring

Example: We can't generate the note when the transcript is too short.

async_note_generation_succeeded

iduuidrequired

The id of the asynchronous request.

Example: 98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6

client_request_idcopilot_client_request_id (string)

An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.

Note: this id must be different for every request. It is recommended to use a randomly generated UUID.

Possible values: <= 128 characters

statusasync_request_status (string)required

Possible values: [ongoing, failed, succeeded]

payload

object

The generated note along with suggested Dot Phrases if applicable.

note

object

required

The generated note.

titlestring

Title of the note.

Example: Fever and strong headache

sections

object[]

required

Content of the note structured in multiple sections.

Array [

keycopilot_note_section_key (string)required

A key identifying a section of a note. The set of possible keys depend on the template that is used. Check Note template for possible values.

Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISKS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, DIET_APPOINTMENTS, DIET_CHIEF_COMPLAINT, DIET_HABITS, DIET_LIFESTYLE, DIET_MEDICAL_HISTORY, DIET_OBJECTIVES, DIET_VITALS, FAMILY_HISTORY, HISTORY_OF_PRESENT_ILLNESS, IMAGING_RESULTS, IMMUNIZATIONS, LAB_RESULTS, MENTAL_HEALTH_EXAM, MENTAL_HEALTH_HISTORY, PAST_MEDICAL_HISTORY, PAST_OBSTETRIC_HISTORY, PAST_SURGICAL_HISTORY, PHYSICAL_EXAM, PLAN, PRESCRIPTION, PSYCHOLOGY_HISTORY_OF_COMPLAINT, SOAP_ASSESSMENT, SOAP_OBJECTIVE, SOAP_PLAN, SOAP_SUBJECTIVE, SOCIAL_HISTORY, VITALS, WELL_CHILD_CARE]

Example: CHIEF_COMPLAINT

titlestringrequired

The section title.

Example: Chief complaint

textstringrequired

Content of the note section.

Example: Sleep disorder

]

suggested_dot_phrases

object[]

A collection of Dot Phrases that were successfully matched to the encounter's transcript, given the Dot Phrases defined on the calling user. Will be null in the context of a Server API call (i.e. no calling user). This functionality enriches the generated note by expanding concise key sentences (triggers) into a more detailed format following the given Dot Phrase definition. Thus, enhancing the depth and utility of the note and facilitating a comprehensive review of patient assessments in a structured and conventional manner.

Array [

dot_phrase

object

Dot phrase, also referred to as EHR (Electronic Health Record) macro, is a concise abbreviation (`trigger`) that unfolds into a predefined, extended text (`replacement`).

iduuidrequired

Unique identifier of the Dot Phrase.

titlestringrequired

A user-friendly title for the Dot Phrase. Does not impact the matching logic.

Example: Normal physical exam

triggerstringrequired

The text which, if present in the transcript, will prompt the suggestion of this Dot Phrase.

Example: Your physical exam is normal

content_auto_update_enabledbooleanrequired

If true, whenever this dot phrase is suggested, the replacement text will be automatically updated based on the encounter discussion.

Example: false

replacementstringrequired

The replacement text for this Dot Phrase. If the Dot Phrase's trigger is detected, this text will be suggested in the note generation's response.

Example: - Heart Examination: Normal, with regular rate and rhythm, no murmurs. - Lung Assessment: Normal breath sounds, no wheezes, crackles, or rhonchi. - Abdominal Evaluation: Normal, no tenderness, masses, or hepatosplenomegaly.

note_section

object

keycopilot_note_section_key (string)required

A key identifying a section of a note. The set of possible keys depend on the template that is used. Check Note template for possible values.

Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISKS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, DIET_APPOINTMENTS, DIET_CHIEF_COMPLAINT, DIET_HABITS, DIET_LIFESTYLE, DIET_MEDICAL_HISTORY, DIET_OBJECTIVES, DIET_VITALS, FAMILY_HISTORY, HISTORY_OF_PRESENT_ILLNESS, IMAGING_RESULTS, IMMUNIZATIONS, LAB_RESULTS, MENTAL_HEALTH_EXAM, MENTAL_HEALTH_HISTORY, PAST_MEDICAL_HISTORY, PAST_OBSTETRIC_HISTORY, PAST_SURGICAL_HISTORY, PHYSICAL_EXAM, PLAN, PRESCRIPTION, PSYCHOLOGY_HISTORY_OF_COMPLAINT, SOAP_ASSESSMENT, SOAP_OBJECTIVE, SOAP_PLAN, SOAP_SUBJECTIVE, SOCIAL_HISTORY, VITALS, WELL_CHILD_CARE]

Example: CHIEF_COMPLAINT

titlestringrequired

Section title.

Example: Assessment & Plan.

text_to_insertstringrequired

The actual suggested content, to be inserted in the corresponding note section. Please note that the content might be different from the replacement in the original Dot Phrase definition. In fact, the text_to_insert takes into account the contextual information of the encounter and might change the original Dot Phrase replacement text, for instance to include exceptions.

Example: - Heart Examination: Normal, with regular rate and rhythm, no murmurs. - Lung Assessment: Normal breath sounds, no wheezes, crackles, or rhonchi. - Abdominal Evaluation: Normal, no tenderness, masses, or hepatosplenomegaly.

]

Example (from schema)

{}