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
GENERATE_NOTE
endpoint stringrequired
Possible values: [GENERATE_NOTE]
The report is about a call to the Generate Note 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_type core_api_speaker (string)required
Possible values: [DOCTOR, PATIENT, UNSPECIFIED]
Who said the text in this transcript item.
]
note_template core_api_note_template (string)
Possible values: [GENERIC_MULTIPLE_SECTIONS, GENERIC_MULTIPLE_SECTIONS_AP_MERGED, GENERIC_SOAP, CARDIOLOGY_MULTIPLE_SECTIONS, PSYCHIATRY_MULTIPLE_SECTIONS, DIET_MULTIPLE_SECTIONS, PSYCHOLOGY_MULTIPLE_SECTIONS, WCC_MULTIPLE_SECTIONS, WCC_SOAP, EMERGENCY_MULTIPLE_SECTIONS, EMERGENCY_SOAP]
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 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]
Key of the note section this customization should apply to.
custom_instruction copilot_note_section_customization_custom_instruction (string)
Allow to customize a note section by providing specific guidelines. These guidelines must be as clear and concise as possible for best results.
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.
title string
Title of the note.
sections object[]required
Sections of the note.
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.
]
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
title string
Title of the note.
sections object[]required
Sections of the note.
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.
]
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
title string
Title of the note.
sections object[]required
Sections of the note.
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.
]
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.
title string
Title of the note.
sections object[]required
Sections of the note.
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.
]
note_locale note_locale (string)required
Possible values: [ENGLISH_US, ENGLISH_UK, FRENCH_FR]
Locale of the note.
note_template core_api_note_template (string)
Possible values: [GENERIC_MULTIPLE_SECTIONS, GENERIC_MULTIPLE_SECTIONS_AP_MERGED, GENERIC_SOAP, CARDIOLOGY_MULTIPLE_SECTIONS, PSYCHIATRY_MULTIPLE_SECTIONS, DIET_MULTIPLE_SECTIONS, PSYCHOLOGY_MULTIPLE_SECTIONS, WCC_MULTIPLE_SECTIONS, WCC_SOAP, EMERGENCY_MULTIPLE_SECTIONS, EMERGENCY_SOAP]
The desired template of the generated note.
Some templates are only available in specific languages. Check Note template for details.
instructions_locale speech_locale (string)required
Possible values: [ENGLISH_US, ENGLISH_UK, SPANISH_ES, SPANISH_MX, FRENCH_FR, ARABIC_EG, ARABIC_LB, ARABIC_MA, ARABIC_SA, ARMENIAN_AM, BENGALI_IN, CANTONESE_CN, CROATIAN_HR, FILIPINO_PH, GERMAN_DE, GREEK_GR, GUJARATI_IN, HEBREW_IL, HINDI_IN, ITALIAN_IT, JAPANESE_JP, KHMER_KH, KOREAN_KR, MANDARIN_CN, PERSIAN_IR, POLISH_PL, PORTUGUESE_PT, PUNJABI_IN, RUSSIAN_RU, SERBIAN_RS, TAMIL_IN, TELUGU_IN, THAI_TH, URDU_IN, VIETNAMESE_VN]
The spoken or written locale of the transcript, representing both the language and its specific regional variant.
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.
title string
Title of the note.
sections object[]required
Sections of the note.
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.
]
note_locale note_locale (string)required
Possible values: [ENGLISH_US, ENGLISH_UK, FRENCH_FR]
Locale of the note.
note_template core_api_note_template (string)
Possible values: [GENERIC_MULTIPLE_SECTIONS, GENERIC_MULTIPLE_SECTIONS_AP_MERGED, GENERIC_SOAP, CARDIOLOGY_MULTIPLE_SECTIONS, PSYCHIATRY_MULTIPLE_SECTIONS, DIET_MULTIPLE_SECTIONS, PSYCHOLOGY_MULTIPLE_SECTIONS, WCC_MULTIPLE_SECTIONS, WCC_SOAP, EMERGENCY_MULTIPLE_SECTIONS, EMERGENCY_SOAP]
The desired template of the generated note.
Some templates are only available in specific languages. Check Note template for details.
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...