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
id uuidrequired
The id of the asynchronous request.
client_request_id copilot_client_request_id (string)
Possible values: <= 128 characters
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.
status async_request_status (string)required
Possible values: [ONGOING, FAILED, SUCCEEDED]
async_request_failed
id uuidrequired
The id of the asynchronous request.
client_request_id copilot_client_request_id (string)
Possible values: <= 128 characters
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.
status async_request_status (string)required
Possible values: [ONGOING, FAILED, SUCCEEDED]
payload objectrequired
error_code integerrequired
error_message string
async_note_generation_succeeded
id uuidrequired
A unique identifier.
client_request_id copilot_client_request_id (string)
Possible values: <= 128 characters
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.
status async_request_status (string)required
Possible values: [ONGOING, FAILED, SUCCEEDED]
payload object
The generated note along with suggested Dot Phrases if applicable.
note objectrequired
The generated note.
title string
Title of the note.
sections object[]required
Content of the note structured in multiple sections.
Array [
key core_api_note_section_key (string)required
Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISK_FACTORS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, FOOD_HABITS, LIFESTYLE, PAST_MEDICAL_HISTORY, OBJECTIVES_AND_ADVICE, 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, HISTORY_OF_PRESENT_COMPLAINT, OBJECTIVE, SUBJECTIVE, SOCIAL_HISTORY, VITALS, WELL_CHILD_CARE]
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.
title stringrequired
The section title.
text stringrequired
Content of the note section.
]
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).
id uuidrequired
Unique identifier of the Dot Phrase.
title stringrequired
A user-friendly title for the Dot Phrase. Does not impact the matching logic.
trigger stringrequired
The text which, if present in the transcript, will prompt the suggestion of this Dot Phrase.
content_auto_update_enabled booleanrequired
If true, whenever this dot phrase is suggested, the replacement text will be automatically updated based on the encounter discussion.
replacement stringrequired
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.
note_section object
The key and the title of the section in the note where this Dot Phrase is suggested to go. There are three possible scenarios:
• No suggested section: Given the Dot Phrase's content, we found no appropriate section to suggest. You should decide for a default (for instance: any kind of "free text" area you might have).
• Suggested section already present in the note: We recommend you append the Dot Phrase's suggested text_to_insert to the section's content.
• Suggested section is not present in the note: Add a new section to the note with the provided key and title and use the Dot Phrase's suggested text_to_insert as the section's content.
key core_api_note_section_key (string)required
Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISK_FACTORS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, FOOD_HABITS, LIFESTYLE, PAST_MEDICAL_HISTORY, OBJECTIVES_AND_ADVICE, 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, HISTORY_OF_PRESENT_COMPLAINT, OBJECTIVE, SUBJECTIVE, SOCIAL_HISTORY, VITALS, WELL_CHILD_CARE]
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.
title stringrequired
Section title.
text_to_insert stringrequired
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 (from schema)

{}

Loading...