Skip to main content

Create report

POST 
/reports

Create detailed feedback or report issues directly related to specific API interactions.

Request​

Body

required
    ratinginteger

    Optional rating for the output of the given response: from very bad (1) to perfect (5).

    Possible values: >= 1 and <= 5

    feedbackstring

    Feedback on the given response. This should typically explain the rating, suggest specific improvements or highlight the good points.

    reply_toemail

    Optional email address for Nabla to contact for additional information or clarification regarding the submitted report feedback.

    payload object

    required

    Input and output of the related API call.
    oneOf
    endpointstringrequired

    The report is about a call to the Digest endpoint (or its async version).

    Possible values: [digest]

    input

    object

    The object containing the information needed to generate a note.
    output_objectsdigest_output_object (string)[]required

    Specifies which items you want us to send you back. In other words, which feature(s) you want to use, for now only note generation is available.

    Possible values: [note]

    languagecopilot_language (string)required

    Language of the given transcript and the desired note ('fr' and 'en' are deprecated, and correspond to 'fr-FR' and 'en-US' respectively. Generating a note in 'es-ES' and 'es-MX' is not supported and will be soon removed).

    Possible values: [fr, en, en-US, en-GB, fr-FR, es-ES, es-MX]

    Example: en-US

    transcript_items

    object[]

    required

    The transcript from which to generate the note. You don't need to specify each item's start or end time, but make sure they are sorted. In fact, due to its asynchronous nature, our [real-time transcription API](/core-api/reference/2024-04-22/server/copilot-listen-ws) does not guarantee the order. Thus, before calling this note-generation API please **filter-out non-final items and sort them by `start_offset_ms`**.

  • Array [

    • textstringrequired

    The transcribed text.

    Example: Also, I’m allergic to peanuts.
    speakercopilot_speaker (string)required

    Who said the text in this transcript item.

    Possible values: [doctor, patient, unspecified]

    Example: doctor

  • ]

    • section_stylecopilot_section_style (string)

    Choose a desired style for note sections:

    • paragraphs: Prioritizes generating paragraphs;

    • bullet_points: Prioritizes structuring content using bullet points.

    • auto: Automatically picks the most natural formatting option.

    Default is auto.

    Possible values: [auto, paragraphs, bullet_points]

    Example: paragraphs
    split_by_problemcopilot_split_by_problem (boolean)

    Flag to structure the content of the note sections according to distinct clinical problems or topics addressed during the consultation.

    When this flag is enabled, the text within some sections of the clinical note is organized into subsections, each corresponding to a specific problem or topic. This format aims to enhance the clarity and organization of the clinical note, making it easier to read and understand the different issues discussed during the consultation.

    Important: Currently, the application of this flag is limited to the HISTORY_OF_PRESENT_ILLNESS and SOAP_SUBJECTIVE sections and is only effective when the language is set to English (US or GB).

    Default value: false
    note_templatecopilot_note_template (string)

    The template used to generate the note.

    Some templates are only available in specific languages. Check Note template for details.

    Possible values: [GENERAL_MEDICINE, GENERAL_MEDICINE_AP_MERGED, CARDIOLOGY, PSYCHIATRY, DIET, PSYCHOLOGY, SOAP, GENERAL_MEDICINE_WCC, SOAP_WCC, GENERAL_MEDICINE_EMERGENCY, SOAP_EMERGENCY]

    Example: GENERAL_MEDICINE

    note

    object

    Optional initial Note to be enhanced using the new `transcript_items`. This is useful if you generate notes gradually to avoid accumulating a very long transcript items list. Typically, this will be the last note Nabla generated for you along with the new `transcript_items` that did not serve for its generation. **Important**: This is expected to be a recent (up to few-hours old) Nabla-generated note. If the note is too old or altered, you will get an error.

    sections

    object[]

    required

    Sections of the note.

  • 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
    textstring

    Content of the note section (required).

    Example: Sleep disorder

  • ]

    • patient_contextstring

    Some contextual information that will be used to generate the note (for example name, gender, age, pronouns, medical history) [BETA].

    Possible values: <= 700 characters

    output

    object

    note

    object

    required

    sections

    object[]

    required

    Sections of the note.

  • 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
    textstring

    Content of the note section (required).

    Example: Sleep disorder

  • ]

    • expected_output

    object

    The expected version of `output`. This is typically an improved version of the Nabla-generated note after it has been corrected or adjusted by the healthcare provider.

    note

    object

    required

    sections

    object[]

    required

    Sections of the note.

  • 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
    textstring

    Content of the note section (required).

    Example: Sleep disorder

  • ]

Responses​

Schema
    idstring