Skip to main content

Create report

POST 

/reports

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

Request

Body

required
    rating integer

    Possible values: >= 1 and <= 5

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

    feedback string

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

    reply_to email

    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
    endpoint stringrequired

    Possible values: [digest]

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

    input object

    Input for note generation.

    note_locale note_locale (string)required

    Possible values: [ENGLISH_US, ENGLISH_UK, FRENCH_FR]

    Locale of the note.

    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 does not guarantee its results order. Thus, before calling this note-generation API please filter-out non-final items and sort them by start_offset_ms.

  • Array [
  • text stringrequired

    The transcribed text.

    speaker copilot_speaker (string)required

    Possible values: [doctor, patient, unspecified]

    Who said the text in this transcript item.

  • ]
  • note_template copilot_note_template (string)

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

    The desired template of the generated note.

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

    note_sections_customization object[]

    Advanced per-section customization options for the chosen template.

    You should only specify sections that belong to the given template, and only specify customization options that are supported for the given section. Also, only specify sections you want to customize, no need to be exhaustive.

    Check Note templates sections for compatibility matrix.

  • Array [
  • section_key copilot_note_section_key (string)required

    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]

    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.

    style copilot_note_section_customization_section_style (string)

    Possible values: [AUTO, PARAGRAPH, BULLET_POINTS]

    Specifies the desired style for the note section:

    PARAGRAPH: Prioritizes generating paragraphs;

    BULLET_POINTS: Prioritizes structuring content using bullet points.

    AUTO: Automatically picks the most natural formatting option.

    Default is AUTO.

    level_of_detail copilot_note_section_customization_level_of_detail (string)

    Possible values: [DEFAULT, DETAILED]

    Specifies the desired level of details. Use detailed to get more details in the note section.

    split_by_problem boolean

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

  • ]
  • previous_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 might get an error.

    sections object[]required

    Sections of the note.

  • Array [
  • key copilot_note_section_key (string)required

    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]

    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 (required).

  • ]
  • patient_context string

    Possible values: <= 700 characters

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

    output object
    note objectrequired
    sections object[]required

    Sections of the note.

  • Array [
  • key copilot_note_section_key (string)required

    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]

    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 (required).

  • ]
  • 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 objectrequired
    sections object[]required

    Sections of the note.

  • Array [
  • key copilot_note_section_key (string)required

    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]

    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 (required).

  • ]

Responses

The created report id, to be referenced when emailing support.

Schema
    id string
Loading...