Create report

POST 
/reports

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

Request

application/json

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
digest
endpoint stringrequired
Possible values: [digest]
The report is about a call to the Digest endpoint (or its async version).
input object
The object containing the information needed to generate a note.
output_objects digest_output_object (string)[]required
Possible values: [note]
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.
language copilot_language (string)required
Possible values: [fr, en, en-US, en-GB, fr-FR, es-ES, es-MX]
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).
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 the 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.
]
section_style copilot_section_style (string)
Possible values: [auto, paragraphs, bullet_points]
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.
split_by_problem copilot_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).
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 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 [
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 string
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 string
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 string
Content of the note section (required).
]
generate_patient_instructions
endpoint stringrequired
Possible values: [generate_patient_instructions]
The report is about a call to the Generate Patient Instructions endpoint.
input object
The input to generate the patient instructions.
note objectrequired
The Nabla-generated clinical note of the encounter.
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 string
Content of the note section (required).
]
note_locale copilot_note_locale (string)required
Possible values: [en-US, en-GB, fr-FR]
Locale of the note.
instructions_locale copilot_speech_locale (string)required
Possible values: [en-US, en-GB, fr-FR, es-ES, es-MX]
Locale of the patient instructions.
recipient_type copilot_patient_instructions_recipient_type (string)
Possible values: [PATIENT, PARENT]
Default value: PATIENT
Recipient type of the patient instructions. This is especially useful for pediatric encounters.
output object
instructions stringrequired
expected_output object
The expected version of output. This is typically an improved version of the Nabla-generated patient instructions after they have been corrected or adjusted by the healthcare provider.
instructions stringrequired
generate_normalized_data
endpoint stringrequired
Possible values: [generate_normalized_data]
The report is about a call to the Generate Normalized Data endpoint.
input object
note objectrequired
The Nabla-generated clinical note to normalize.
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 string
Content of the note section (required).
]
note_locale copilot_note_locale (string)required
Possible values: [en-US, en-GB, fr-FR]
Locale of the note.
output object
conditions object[]required
FHIR conditions (including their ICD-10 code) corresponding to the patient's medical conditions as mentioned in the clinical note.
Array [
clinical_status fhir_condition_clinical_status (string)
Possible values: [active, resolved]
The clinical status of the condition. Only active and resolved are supported for now.
coding objectrequired
An ICD-10 entry.
system string
Possible values: [http://hl7.org/fhir/sid/icd-10-cm]
The used coding system, only ICD10 is supported for now.
code stringrequired
Code of the ICD10.
display stringrequired
Description of the ICD10.
categories fhir_condition_category (string)[]
Possible values: [problem_list_item, encounter_diagnosis]
Categories of the condition.
]
family_history object[]required
FHIR conditions (including their ICD-10 code) representing family medical history details extracted from the clinical note. Each element includes the relationship to the patient and the list of related conditions.
Array [
relationship family_member_conditions_relationship (string)
Possible values: [MOTHER, FATHER, BROTHER, SISTER, SON, DAUGHTER, GRANDMOTHER, GRANDFATHER, AUNT, UNCLE, OTHER]
The relation to the patient of the family member the extracted conditions relate to, if applies.
conditions object[]required
Conditions of the family member of the patient.
Array [
clinical_status fhir_condition_clinical_status (string)
Possible values: [active, resolved]
The clinical status of the condition. Only active and resolved are supported for now.
coding objectrequired
An ICD-10 entry.
system string
Possible values: [http://hl7.org/fhir/sid/icd-10-cm]
The used coding system, only ICD10 is supported for now.
code stringrequired
Code of the ICD10.
display stringrequired
Description of the ICD10.
categories fhir_condition_category (string)[]
Possible values: [problem_list_item, encounter_diagnosis]
Categories of the condition.
]
]
expected_output object
The expected version of output. This is typically an improved version of the Nabla-generated normalized data after it has been corrected or adjusted by the healthcare provider.
conditions object[]required
FHIR conditions (including their ICD-10 code) corresponding to the patient's medical conditions as mentioned in the clinical note.
Array [
clinical_status fhir_condition_clinical_status (string)
Possible values: [active, resolved]
The clinical status of the condition. Only active and resolved are supported for now.
coding objectrequired
An ICD-10 entry.
system string
Possible values: [http://hl7.org/fhir/sid/icd-10-cm]
The used coding system, only ICD10 is supported for now.
code stringrequired
Code of the ICD10.
display stringrequired
Description of the ICD10.
categories fhir_condition_category (string)[]
Possible values: [problem_list_item, encounter_diagnosis]
Categories of the condition.
]
family_history object[]required
FHIR conditions (including their ICD-10 code) representing family medical history details extracted from the clinical note. Each element includes the relationship to the patient and the list of related conditions.
Array [
relationship family_member_conditions_relationship (string)
Possible values: [MOTHER, FATHER, BROTHER, SISTER, SON, DAUGHTER, GRANDMOTHER, GRANDFATHER, AUNT, UNCLE, OTHER]
The relation to the patient of the family member the extracted conditions relate to, if applies.
conditions object[]required
Conditions of the family member of the patient.
Array [
clinical_status fhir_condition_clinical_status (string)
Possible values: [active, resolved]
The clinical status of the condition. Only active and resolved are supported for now.
coding objectrequired
An ICD-10 entry.
system string
Possible values: [http://hl7.org/fhir/sid/icd-10-cm]
The used coding system, only ICD10 is supported for now.
code stringrequired
Code of the ICD10.
display stringrequired
Description of the ICD10.
categories fhir_condition_category (string)[]
Possible values: [problem_list_item, encounter_diagnosis]
Categories of the condition.
]
]

Responses

200

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

application/json

Schema

Schema

id string

Example (from schema)

{
  "id": "string"
}

Loading...