Create report
POST/reports
Create detailed feedback or report issues directly related to specific API interactions.
Requestā
Responsesā
- 200
The created report id, to be referenced when emailing support.
Operation spec
{
"method": "post",
"path": "/reports",
"operationId": "create-report",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Input of the report.",
"properties": {
"rating": {
"type": "integer",
"minimum": 1,
"maximum": 5,
"description": "Optional rating for the output of the given response: from very bad (1) to perfect (5)."
},
"feedback": {
"type": "string",
"description": "Feedback on the given response. This should typically explain the rating, suggest specific improvements or highlight the good points."
},
"reply_to": {
"type": "string",
"format": "email",
"description": "Optional email address for Nabla to contact for additional information or clarification regarding the submitted report feedback."
},
"payload": {
"description": "Input and output of the related API call.",
"oneOf": [
{
"title": "GENERATE_NOTE",
"type": "object",
"required": [
"endpoint"
],
"properties": {
"endpoint": {
"type": "string",
"enum": [
"GENERATE_NOTE"
],
"description": "The report is about a call to the [Generate Note](/2025-04-03/server/generate-note) endpoint (or its async version)."
},
"input": {
"type": "object",
"description": "Input for note generation.",
"required": [
"transcript_items"
],
"properties": {
"transcript_items": {
"type": "array",
"description": "The transcript from which to generate the note.\n\nYou 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](/2025-04-03/server/transcribe-ws) 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`**.",
"items": {
"type": "object",
"description": "A portion of the transcribed consultation.",
"properties": {
"text": {
"type": "string",
"description": "The transcribed text.",
"example": "Also, Iām allergic to peanuts."
},
"speaker_type": {
"type": "string",
"enum": [
"DOCTOR",
"PATIENT",
"UNSPECIFIED"
],
"description": "Who said the text in this transcript item.",
"example": "DOCTOR",
"title": "speaker"
}
},
"required": [
"text",
"speaker_type"
],
"title": "transcript_item_request"
}
},
"previous_note": {
"description": "Optional initial Note to be enhanced using the new `transcript_items`.\nThis is useful if you generate notes gradually to avoid accumulating a very long transcript items list.\nTypically, this will be the last note Nabla generated for you along with the new `transcript_items` that did not serve for its generation.",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the note.",
"example": "Fever and strong headache"
},
"sections": {
"type": "array",
"description": "Sections of the note.",
"items": {
"type": "object",
"description": "A note section.",
"properties": {
"key": {
"type": "string",
"description": "A key identifying a section of a note.\nThe set of possible keys depend on the template that is used. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for possible values.",
"example": "CHIEF_COMPLAINT",
"enum": [
"ALLERGIES",
"APPOINTMENTS",
"ASSESSMENT",
"ASSESSMENT_AND_PLAN",
"CARDIOVASCULAR_RISK_FACTORS",
"CHIEF_COMPLAINT",
"CURRENT_MEDICATIONS",
"DIAGNOSTIC_TESTS_ORDERED",
"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_OBSTETRIC_HISTORY",
"PAST_SURGICAL_HISTORY",
"PHYSICAL_EXAM",
"PLAN",
"PRESCRIPTION",
"HISTORY_OF_PRESENT_COMPLAINT",
"OBJECTIVE",
"SUBJECTIVE",
"SOCIAL_HISTORY",
"VITALS",
"WELL_CHILD_CARE"
],
"title": "note_section_key"
},
"title": {
"type": "string",
"description": "The section title.",
"example": "Chief complaint"
},
"text": {
"type": "string",
"description": "Content of the note section.",
"example": "Sleep disorder"
}
},
"required": [
"key",
"title",
"text"
],
"title": "note_section_request"
}
}
},
"required": [
"sections"
],
"title": "note_request"
},
"patient_context": {
"type": "string",
"description": "Some contextual information that will be used to generate the note (for example name, gender, age, pronouns, medical history) [BETA].",
"maxLength": 700
}
},
"title": "generate_note_request"
},
"output": {
"type": "object",
"required": [
"note"
],
"properties": {
"note": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the note.",
"example": "Fever and strong headache"
},
"sections": {
"type": "array",
"description": "Sections of the note.",
"items": {
"type": "object",
"description": "A note section.",
"properties": {
"key": {
"type": "string",
"description": "A key identifying a section of a note.\nThe set of possible keys depend on the template that is used. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for possible values.",
"example": "CHIEF_COMPLAINT",
"enum": [
"ALLERGIES",
"APPOINTMENTS",
"ASSESSMENT",
"ASSESSMENT_AND_PLAN",
"CARDIOVASCULAR_RISK_FACTORS",
"CHIEF_COMPLAINT",
"CURRENT_MEDICATIONS",
"DIAGNOSTIC_TESTS_ORDERED",
"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_OBSTETRIC_HISTORY",
"PAST_SURGICAL_HISTORY",
"PHYSICAL_EXAM",
"PLAN",
"PRESCRIPTION",
"HISTORY_OF_PRESENT_COMPLAINT",
"OBJECTIVE",
"SUBJECTIVE",
"SOCIAL_HISTORY",
"VITALS",
"WELL_CHILD_CARE"
],
"title": "note_section_key"
},
"title": {
"type": "string",
"description": "The section title.",
"example": "Chief complaint"
},
"text": {
"type": "string",
"description": "Content of the note section.",
"example": "Sleep disorder"
}
},
"required": [
"key",
"title",
"text"
],
"title": "note_section_request"
}
}
},
"required": [
"sections"
],
"title": "note_request"
}
},
"title": "create_report_payload_generate_note_request_output"
},
"expected_output": {
"description": "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.",
"type": "object",
"required": [
"note"
],
"properties": {
"note": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the note.",
"example": "Fever and strong headache"
},
"sections": {
"type": "array",
"description": "Sections of the note.",
"items": {
"type": "object",
"description": "A note section.",
"properties": {
"key": {
"type": "string",
"description": "A key identifying a section of a note.\nThe set of possible keys depend on the template that is used. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for possible values.",
"example": "CHIEF_COMPLAINT",
"enum": [
"ALLERGIES",
"APPOINTMENTS",
"ASSESSMENT",
"ASSESSMENT_AND_PLAN",
"CARDIOVASCULAR_RISK_FACTORS",
"CHIEF_COMPLAINT",
"CURRENT_MEDICATIONS",
"DIAGNOSTIC_TESTS_ORDERED",
"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_OBSTETRIC_HISTORY",
"PAST_SURGICAL_HISTORY",
"PHYSICAL_EXAM",
"PLAN",
"PRESCRIPTION",
"HISTORY_OF_PRESENT_COMPLAINT",
"OBJECTIVE",
"SUBJECTIVE",
"SOCIAL_HISTORY",
"VITALS",
"WELL_CHILD_CARE"
],
"title": "note_section_key"
},
"title": {
"type": "string",
"description": "The section title.",
"example": "Chief complaint"
},
"text": {
"type": "string",
"description": "Content of the note section.",
"example": "Sleep disorder"
}
},
"required": [
"key",
"title",
"text"
],
"title": "note_section_request"
}
}
},
"required": [
"sections"
],
"title": "note_request"
}
},
"title": "create_report_payload_generate_note_request_output"
}
}
},
{
"title": "GENERATE_PATIENT_INSTRUCTIONS",
"type": "object",
"required": [
"endpoint"
],
"properties": {
"endpoint": {
"type": "string",
"enum": [
"GENERATE_PATIENT_INSTRUCTIONS"
],
"description": "The report is about a call to the [Generate Patient Instructions](/2025-04-03/server/copilot-generate-patient-instructions) endpoint."
},
"input": {
"type": "object",
"description": "The input to generate the patient instructions.",
"properties": {
"note": {
"description": "The Nabla-generated clinical note of the encounter.",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the note.",
"example": "Fever and strong headache"
},
"sections": {
"type": "array",
"description": "Sections of the note.",
"items": {
"type": "object",
"description": "A note section.",
"properties": {
"key": {
"type": "string",
"description": "A key identifying a section of a note.\nThe set of possible keys depend on the template that is used. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for possible values.",
"example": "CHIEF_COMPLAINT",
"enum": [
"ALLERGIES",
"APPOINTMENTS",
"ASSESSMENT",
"ASSESSMENT_AND_PLAN",
"CARDIOVASCULAR_RISK_FACTORS",
"CHIEF_COMPLAINT",
"CURRENT_MEDICATIONS",
"DIAGNOSTIC_TESTS_ORDERED",
"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_OBSTETRIC_HISTORY",
"PAST_SURGICAL_HISTORY",
"PHYSICAL_EXAM",
"PLAN",
"PRESCRIPTION",
"HISTORY_OF_PRESENT_COMPLAINT",
"OBJECTIVE",
"SUBJECTIVE",
"SOCIAL_HISTORY",
"VITALS",
"WELL_CHILD_CARE"
],
"title": "note_section_key"
},
"title": {
"type": "string",
"description": "The section title.",
"example": "Chief complaint"
},
"text": {
"type": "string",
"description": "Content of the note section.",
"example": "Sleep disorder"
}
},
"required": [
"key",
"title",
"text"
],
"title": "note_section_request"
}
}
},
"required": [
"sections"
],
"title": "note_request"
},
"note_locale": {
"type": "string",
"description": "Locale of the note.",
"enum": [
"ENGLISH_US",
"ENGLISH_UK",
"FRENCH_FR"
],
"example": "ENGLISH_US",
"title": "note_locale"
},
"note_template": {
"type": "string",
"enum": [
"GENERIC_MULTIPLE_SECTIONS",
"GENERIC_MULTIPLE_SECTIONS_AP_MERGED",
"GENERIC_SOAP",
"GENERIC_SOAP_AP_MERGED",
"GENERIC_SOAP_PLUS_EXAM_TESTS_AP_MERGED",
"GENERIC_APSO_AP_MERGED",
"EMERGENCY_MULTIPLE_SECTIONS",
"EMERGENCY_SOAP",
"WCC_MULTIPLE_SECTIONS",
"WCC_SOAP",
"PSYCHIATRY_MULTIPLE_SECTIONS",
"PSYCHIATRY_SOAP",
"PSYCHOLOGY_MULTIPLE_SECTIONS",
"CARDIOLOGY_MULTIPLE_SECTIONS",
"DIET_MULTIPLE_SECTIONS"
],
"description": "The template used to generate the note.\n\nSome templates are **only available in specific languages**. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for details.",
"example": "GENERIC_MULTIPLE_SECTIONS",
"title": "note_template"
},
"instructions_locale": {
"description": "Locale of the patient instructions.",
"type": "string",
"enum": [
"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",
"HAITIAN_HT"
],
"example": "ENGLISH_US",
"title": "speech_locale"
},
"recipient_type": {
"type": "string",
"enum": [
"PATIENT",
"PARENT"
],
"description": "Recipient type of the patient instructions. This is especially useful for pediatric encounters.",
"default": "PATIENT",
"example": "PATIENT",
"title": "patient_instructions_recipient_type"
}
},
"required": [
"note",
"note_locale",
"instructions_locale"
],
"title": "generate_patient_instructions_request"
},
"output": {
"type": "object",
"required": [
"instructions"
],
"properties": {
"instructions": {
"type": "string"
}
},
"title": "create_report_payload_generate_patient_instructions_request_output"
},
"expected_output": {
"description": "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.",
"type": "object",
"required": [
"instructions"
],
"properties": {
"instructions": {
"type": "string"
}
},
"title": "create_report_payload_generate_patient_instructions_request_output"
}
}
},
{
"title": "GENERATE_NORMALIZED_DATA",
"type": "object",
"required": [
"endpoint"
],
"properties": {
"endpoint": {
"type": "string",
"enum": [
"GENERATE_NORMALIZED_DATA"
],
"description": "The report is about a call to the [Generate Normalized Data](/2025-04-03/server/generate-normalized-data) endpoint."
},
"input": {
"type": "object",
"properties": {
"note": {
"description": "The Nabla-generated clinical note to normalize.",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the note.",
"example": "Fever and strong headache"
},
"sections": {
"type": "array",
"description": "Sections of the note.",
"items": {
"type": "object",
"description": "A note section.",
"properties": {
"key": {
"type": "string",
"description": "A key identifying a section of a note.\nThe set of possible keys depend on the template that is used. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for possible values.",
"example": "CHIEF_COMPLAINT",
"enum": [
"ALLERGIES",
"APPOINTMENTS",
"ASSESSMENT",
"ASSESSMENT_AND_PLAN",
"CARDIOVASCULAR_RISK_FACTORS",
"CHIEF_COMPLAINT",
"CURRENT_MEDICATIONS",
"DIAGNOSTIC_TESTS_ORDERED",
"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_OBSTETRIC_HISTORY",
"PAST_SURGICAL_HISTORY",
"PHYSICAL_EXAM",
"PLAN",
"PRESCRIPTION",
"HISTORY_OF_PRESENT_COMPLAINT",
"OBJECTIVE",
"SUBJECTIVE",
"SOCIAL_HISTORY",
"VITALS",
"WELL_CHILD_CARE"
],
"title": "note_section_key"
},
"title": {
"type": "string",
"description": "The section title.",
"example": "Chief complaint"
},
"text": {
"type": "string",
"description": "Content of the note section.",
"example": "Sleep disorder"
}
},
"required": [
"key",
"title",
"text"
],
"title": "note_section_request"
}
}
},
"required": [
"sections"
],
"title": "note_request"
},
"note_locale": {
"type": "string",
"description": "Locale of the note.",
"enum": [
"ENGLISH_US",
"ENGLISH_UK",
"FRENCH_FR"
],
"example": "ENGLISH_US",
"title": "note_locale"
},
"note_template": {
"type": "string",
"enum": [
"GENERIC_MULTIPLE_SECTIONS",
"GENERIC_MULTIPLE_SECTIONS_AP_MERGED",
"GENERIC_SOAP",
"GENERIC_SOAP_AP_MERGED",
"GENERIC_SOAP_PLUS_EXAM_TESTS_AP_MERGED",
"GENERIC_APSO_AP_MERGED",
"EMERGENCY_MULTIPLE_SECTIONS",
"EMERGENCY_SOAP",
"WCC_MULTIPLE_SECTIONS",
"WCC_SOAP",
"PSYCHIATRY_MULTIPLE_SECTIONS",
"PSYCHIATRY_SOAP",
"PSYCHOLOGY_MULTIPLE_SECTIONS",
"CARDIOLOGY_MULTIPLE_SECTIONS",
"DIET_MULTIPLE_SECTIONS"
],
"description": "The template used to generate the note.\n\nSome templates are **only available in specific languages**. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for details.",
"example": "GENERIC_MULTIPLE_SECTIONS",
"title": "note_template"
}
},
"required": [
"note",
"note_locale"
],
"title": "generate_normalized_data_request"
},
"output": {
"type": "object",
"required": [
"conditions",
"family_history"
],
"properties": {
"conditions": {
"description": "FHIR conditions (including their ICD-10 code) corresponding to the patient's medical conditions as mentioned in the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"properties": {
"clinical_status": {
"type": "string",
"enum": [
"ACTIVE",
"RESOLVED"
],
"description": "The [clinical status](https://www.hl7.org/fhir/condition-definitions.html#Condition.clinicalStatus) of the condition. Only `ACTIVE` and `RESOLVED` are supported for now.",
"example": "ACTIVE",
"title": "fhir_condition_clinical_status"
},
"coding": {
"type": "object",
"description": "An ICD-10 entry.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
}
},
"required": [
"code",
"display",
"system"
]
},
"categories": {
"description": "Categories of the condition.",
"type": "array",
"items": {
"type": "string",
"enum": [
"PROBLEM_LIST_ITEM",
"ENCOUNTER_DIAGNOSIS"
],
"description": "The category of a [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"example": "PROBLEM_LIST_ITEM",
"title": "fhir_condition_category"
}
}
},
"required": [
"coding"
]
}
},
"family_history": {
"description": "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.",
"type": "array",
"items": {
"type": "object",
"required": [
"conditions"
],
"properties": {
"relationship": {
"type": "string",
"description": "The relation to the patient of the family member the extracted conditions relate to, if applies.",
"enum": [
"MOTHER",
"FATHER",
"BROTHER",
"SISTER",
"SON",
"DAUGHTER",
"GRANDMOTHER",
"GRANDFATHER",
"AUNT",
"UNCLE",
"OTHER"
],
"title": "family_member_conditions_relationship"
},
"conditions": {
"description": "Conditions of the family member of the patient.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"properties": {
"clinical_status": {
"type": "string",
"enum": [
"ACTIVE",
"RESOLVED"
],
"description": "The [clinical status](https://www.hl7.org/fhir/condition-definitions.html#Condition.clinicalStatus) of the condition. Only `ACTIVE` and `RESOLVED` are supported for now.",
"example": "ACTIVE",
"title": "fhir_condition_clinical_status"
},
"coding": {
"type": "object",
"description": "An ICD-10 entry.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
}
},
"required": [
"code",
"display"
]
},
"categories": {
"description": "Categories of the condition.",
"type": "array",
"items": {
"type": "string",
"enum": [
"PROBLEM_LIST_ITEM",
"ENCOUNTER_DIAGNOSIS"
],
"description": "The category of a [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"example": "PROBLEM_LIST_ITEM",
"title": "fhir_condition_category"
}
}
},
"required": [
"coding"
]
}
}
}
}
},
"observations": {
"description": "FHIR observations (including their LOINC code) extracted from the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR observation](https://www.hl7.org/fhir/observation.html).",
"properties": {
"coding": {
"type": "object",
"description": "LOINC coding representation of this observation.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only LOINC is supported for now.",
"enum": [
"http://loinc.org"
]
},
"code": {
"type": "string",
"example": "29463-7",
"description": "Code of the LOINC entry."
},
"display": {
"type": "string",
"example": "Body weight",
"description": "Description of the LOINC entry."
}
},
"required": [
"code",
"display",
"system"
]
},
"value_quantity": {
"type": "object",
"description": "Value quantity for an observation.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
},
"value_range": {
"type": "object",
"description": "Value range for an observation.",
"properties": {
"low": {
"type": "object",
"description": "The lower bound of the range.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
},
"high": {
"type": "object",
"description": "The higher bound of the range.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
}
},
"required": [
"low",
"high"
]
},
"note": {
"type": "string",
"description": "Additional comment about the observation.",
"example": "Measured at rest."
}
},
"required": [
"coding"
]
}
}
},
"title": "create_report_payload_generate_normalized_data_request_output"
},
"expected_output": {
"description": "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.",
"type": "object",
"required": [
"conditions",
"family_history"
],
"properties": {
"conditions": {
"description": "FHIR conditions (including their ICD-10 code) corresponding to the patient's medical conditions as mentioned in the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"properties": {
"clinical_status": {
"type": "string",
"enum": [
"ACTIVE",
"RESOLVED"
],
"description": "The [clinical status](https://www.hl7.org/fhir/condition-definitions.html#Condition.clinicalStatus) of the condition. Only `ACTIVE` and `RESOLVED` are supported for now.",
"example": "ACTIVE",
"title": "fhir_condition_clinical_status"
},
"coding": {
"type": "object",
"description": "An ICD-10 entry.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
}
},
"required": [
"code",
"display",
"system"
]
},
"categories": {
"description": "Categories of the condition.",
"type": "array",
"items": {
"type": "string",
"enum": [
"PROBLEM_LIST_ITEM",
"ENCOUNTER_DIAGNOSIS"
],
"description": "The category of a [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"example": "PROBLEM_LIST_ITEM",
"title": "fhir_condition_category"
}
}
},
"required": [
"coding"
]
}
},
"family_history": {
"description": "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.",
"type": "array",
"items": {
"type": "object",
"required": [
"conditions"
],
"properties": {
"relationship": {
"type": "string",
"description": "The relation to the patient of the family member the extracted conditions relate to, if applies.",
"enum": [
"MOTHER",
"FATHER",
"BROTHER",
"SISTER",
"SON",
"DAUGHTER",
"GRANDMOTHER",
"GRANDFATHER",
"AUNT",
"UNCLE",
"OTHER"
],
"title": "family_member_conditions_relationship"
},
"conditions": {
"description": "Conditions of the family member of the patient.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"properties": {
"clinical_status": {
"type": "string",
"enum": [
"ACTIVE",
"RESOLVED"
],
"description": "The [clinical status](https://www.hl7.org/fhir/condition-definitions.html#Condition.clinicalStatus) of the condition. Only `ACTIVE` and `RESOLVED` are supported for now.",
"example": "ACTIVE",
"title": "fhir_condition_clinical_status"
},
"coding": {
"type": "object",
"description": "An ICD-10 entry.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
}
},
"required": [
"code",
"display"
]
},
"categories": {
"description": "Categories of the condition.",
"type": "array",
"items": {
"type": "string",
"enum": [
"PROBLEM_LIST_ITEM",
"ENCOUNTER_DIAGNOSIS"
],
"description": "The category of a [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"example": "PROBLEM_LIST_ITEM",
"title": "fhir_condition_category"
}
}
},
"required": [
"coding"
]
}
}
}
}
},
"observations": {
"description": "FHIR observations (including their LOINC code) extracted from the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR observation](https://www.hl7.org/fhir/observation.html).",
"properties": {
"coding": {
"type": "object",
"description": "LOINC coding representation of this observation.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only LOINC is supported for now.",
"enum": [
"http://loinc.org"
]
},
"code": {
"type": "string",
"example": "29463-7",
"description": "Code of the LOINC entry."
},
"display": {
"type": "string",
"example": "Body weight",
"description": "Description of the LOINC entry."
}
},
"required": [
"code",
"display",
"system"
]
},
"value_quantity": {
"type": "object",
"description": "Value quantity for an observation.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
},
"value_range": {
"type": "object",
"description": "Value range for an observation.",
"properties": {
"low": {
"type": "object",
"description": "The lower bound of the range.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
},
"high": {
"type": "object",
"description": "The higher bound of the range.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
}
},
"required": [
"low",
"high"
]
},
"note": {
"type": "string",
"description": "Additional comment about the observation.",
"example": "Measured at rest."
}
},
"required": [
"coding"
]
}
}
},
"title": "create_report_payload_generate_normalized_data_request_output"
}
}
}
],
"discriminator": {
"propertyName": "endpoint",
"mapping": {
"GENERATE_NOTE": {
"type": "object",
"required": [
"endpoint"
],
"properties": {
"endpoint": {
"type": "string",
"enum": [
"GENERATE_NOTE"
],
"description": "The report is about a call to the [Generate Note](/2025-04-03/server/generate-note) endpoint (or its async version)."
},
"input": {
"type": "object",
"description": "Input for note generation.",
"required": [
"transcript_items"
],
"properties": {
"transcript_items": {
"type": "array",
"description": "The transcript from which to generate the note.\n\nYou 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](/2025-04-03/server/transcribe-ws) 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`**.",
"items": {
"type": "object",
"description": "A portion of the transcribed consultation.",
"properties": {
"text": {
"type": "string",
"description": "The transcribed text.",
"example": "Also, Iām allergic to peanuts."
},
"speaker_type": {
"type": "string",
"enum": [
"DOCTOR",
"PATIENT",
"UNSPECIFIED"
],
"description": "Who said the text in this transcript item.",
"example": "DOCTOR",
"title": "speaker"
}
},
"required": [
"text",
"speaker_type"
],
"title": "transcript_item_request"
}
},
"previous_note": {
"description": "Optional initial Note to be enhanced using the new `transcript_items`.\nThis is useful if you generate notes gradually to avoid accumulating a very long transcript items list.\nTypically, this will be the last note Nabla generated for you along with the new `transcript_items` that did not serve for its generation.",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the note.",
"example": "Fever and strong headache"
},
"sections": {
"type": "array",
"description": "Sections of the note.",
"items": {
"type": "object",
"description": "A note section.",
"properties": {
"key": {
"type": "string",
"description": "A key identifying a section of a note.\nThe set of possible keys depend on the template that is used. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for possible values.",
"example": "CHIEF_COMPLAINT",
"enum": [
"ALLERGIES",
"APPOINTMENTS",
"ASSESSMENT",
"ASSESSMENT_AND_PLAN",
"CARDIOVASCULAR_RISK_FACTORS",
"CHIEF_COMPLAINT",
"CURRENT_MEDICATIONS",
"DIAGNOSTIC_TESTS_ORDERED",
"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_OBSTETRIC_HISTORY",
"PAST_SURGICAL_HISTORY",
"PHYSICAL_EXAM",
"PLAN",
"PRESCRIPTION",
"HISTORY_OF_PRESENT_COMPLAINT",
"OBJECTIVE",
"SUBJECTIVE",
"SOCIAL_HISTORY",
"VITALS",
"WELL_CHILD_CARE"
],
"title": "note_section_key"
},
"title": {
"type": "string",
"description": "The section title.",
"example": "Chief complaint"
},
"text": {
"type": "string",
"description": "Content of the note section.",
"example": "Sleep disorder"
}
},
"required": [
"key",
"title",
"text"
],
"title": "note_section_request"
}
}
},
"required": [
"sections"
],
"title": "note_request"
},
"patient_context": {
"type": "string",
"description": "Some contextual information that will be used to generate the note (for example name, gender, age, pronouns, medical history) [BETA].",
"maxLength": 700
}
},
"title": "generate_note_request"
},
"output": {
"type": "object",
"required": [
"note"
],
"properties": {
"note": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the note.",
"example": "Fever and strong headache"
},
"sections": {
"type": "array",
"description": "Sections of the note.",
"items": {
"type": "object",
"description": "A note section.",
"properties": {
"key": {
"type": "string",
"description": "A key identifying a section of a note.\nThe set of possible keys depend on the template that is used. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for possible values.",
"example": "CHIEF_COMPLAINT",
"enum": [
"ALLERGIES",
"APPOINTMENTS",
"ASSESSMENT",
"ASSESSMENT_AND_PLAN",
"CARDIOVASCULAR_RISK_FACTORS",
"CHIEF_COMPLAINT",
"CURRENT_MEDICATIONS",
"DIAGNOSTIC_TESTS_ORDERED",
"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_OBSTETRIC_HISTORY",
"PAST_SURGICAL_HISTORY",
"PHYSICAL_EXAM",
"PLAN",
"PRESCRIPTION",
"HISTORY_OF_PRESENT_COMPLAINT",
"OBJECTIVE",
"SUBJECTIVE",
"SOCIAL_HISTORY",
"VITALS",
"WELL_CHILD_CARE"
],
"title": "note_section_key"
},
"title": {
"type": "string",
"description": "The section title.",
"example": "Chief complaint"
},
"text": {
"type": "string",
"description": "Content of the note section.",
"example": "Sleep disorder"
}
},
"required": [
"key",
"title",
"text"
],
"title": "note_section_request"
}
}
},
"required": [
"sections"
],
"title": "note_request"
}
},
"title": "create_report_payload_generate_note_request_output"
},
"expected_output": {
"description": "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.",
"type": "object",
"required": [
"note"
],
"properties": {
"note": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the note.",
"example": "Fever and strong headache"
},
"sections": {
"type": "array",
"description": "Sections of the note.",
"items": {
"type": "object",
"description": "A note section.",
"properties": {
"key": {
"type": "string",
"description": "A key identifying a section of a note.\nThe set of possible keys depend on the template that is used. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for possible values.",
"example": "CHIEF_COMPLAINT",
"enum": [
"ALLERGIES",
"APPOINTMENTS",
"ASSESSMENT",
"ASSESSMENT_AND_PLAN",
"CARDIOVASCULAR_RISK_FACTORS",
"CHIEF_COMPLAINT",
"CURRENT_MEDICATIONS",
"DIAGNOSTIC_TESTS_ORDERED",
"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_OBSTETRIC_HISTORY",
"PAST_SURGICAL_HISTORY",
"PHYSICAL_EXAM",
"PLAN",
"PRESCRIPTION",
"HISTORY_OF_PRESENT_COMPLAINT",
"OBJECTIVE",
"SUBJECTIVE",
"SOCIAL_HISTORY",
"VITALS",
"WELL_CHILD_CARE"
],
"title": "note_section_key"
},
"title": {
"type": "string",
"description": "The section title.",
"example": "Chief complaint"
},
"text": {
"type": "string",
"description": "Content of the note section.",
"example": "Sleep disorder"
}
},
"required": [
"key",
"title",
"text"
],
"title": "note_section_request"
}
}
},
"required": [
"sections"
],
"title": "note_request"
}
},
"title": "create_report_payload_generate_note_request_output"
}
},
"title": "create_report_payload_generate_note_request"
},
"GENERATE_PATIENT_INSTRUCTIONS": {
"type": "object",
"required": [
"endpoint"
],
"properties": {
"endpoint": {
"type": "string",
"enum": [
"GENERATE_PATIENT_INSTRUCTIONS"
],
"description": "The report is about a call to the [Generate Patient Instructions](/2025-04-03/server/copilot-generate-patient-instructions) endpoint."
},
"input": {
"type": "object",
"description": "The input to generate the patient instructions.",
"properties": {
"note": {
"description": "The Nabla-generated clinical note of the encounter.",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the note.",
"example": "Fever and strong headache"
},
"sections": {
"type": "array",
"description": "Sections of the note.",
"items": {
"type": "object",
"description": "A note section.",
"properties": {
"key": {
"type": "string",
"description": "A key identifying a section of a note.\nThe set of possible keys depend on the template that is used. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for possible values.",
"example": "CHIEF_COMPLAINT",
"enum": [
"ALLERGIES",
"APPOINTMENTS",
"ASSESSMENT",
"ASSESSMENT_AND_PLAN",
"CARDIOVASCULAR_RISK_FACTORS",
"CHIEF_COMPLAINT",
"CURRENT_MEDICATIONS",
"DIAGNOSTIC_TESTS_ORDERED",
"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_OBSTETRIC_HISTORY",
"PAST_SURGICAL_HISTORY",
"PHYSICAL_EXAM",
"PLAN",
"PRESCRIPTION",
"HISTORY_OF_PRESENT_COMPLAINT",
"OBJECTIVE",
"SUBJECTIVE",
"SOCIAL_HISTORY",
"VITALS",
"WELL_CHILD_CARE"
],
"title": "note_section_key"
},
"title": {
"type": "string",
"description": "The section title.",
"example": "Chief complaint"
},
"text": {
"type": "string",
"description": "Content of the note section.",
"example": "Sleep disorder"
}
},
"required": [
"key",
"title",
"text"
],
"title": "note_section_request"
}
}
},
"required": [
"sections"
],
"title": "note_request"
},
"note_locale": {
"type": "string",
"description": "Locale of the note.",
"enum": [
"ENGLISH_US",
"ENGLISH_UK",
"FRENCH_FR"
],
"example": "ENGLISH_US",
"title": "note_locale"
},
"note_template": {
"type": "string",
"enum": [
"GENERIC_MULTIPLE_SECTIONS",
"GENERIC_MULTIPLE_SECTIONS_AP_MERGED",
"GENERIC_SOAP",
"GENERIC_SOAP_AP_MERGED",
"GENERIC_SOAP_PLUS_EXAM_TESTS_AP_MERGED",
"GENERIC_APSO_AP_MERGED",
"EMERGENCY_MULTIPLE_SECTIONS",
"EMERGENCY_SOAP",
"WCC_MULTIPLE_SECTIONS",
"WCC_SOAP",
"PSYCHIATRY_MULTIPLE_SECTIONS",
"PSYCHIATRY_SOAP",
"PSYCHOLOGY_MULTIPLE_SECTIONS",
"CARDIOLOGY_MULTIPLE_SECTIONS",
"DIET_MULTIPLE_SECTIONS"
],
"description": "The template used to generate the note.\n\nSome templates are **only available in specific languages**. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for details.",
"example": "GENERIC_MULTIPLE_SECTIONS",
"title": "note_template"
},
"instructions_locale": {
"description": "Locale of the patient instructions.",
"type": "string",
"enum": [
"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",
"HAITIAN_HT"
],
"example": "ENGLISH_US",
"title": "speech_locale"
},
"recipient_type": {
"type": "string",
"enum": [
"PATIENT",
"PARENT"
],
"description": "Recipient type of the patient instructions. This is especially useful for pediatric encounters.",
"default": "PATIENT",
"example": "PATIENT",
"title": "patient_instructions_recipient_type"
}
},
"required": [
"note",
"note_locale",
"instructions_locale"
],
"title": "generate_patient_instructions_request"
},
"output": {
"type": "object",
"required": [
"instructions"
],
"properties": {
"instructions": {
"type": "string"
}
},
"title": "create_report_payload_generate_patient_instructions_request_output"
},
"expected_output": {
"description": "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.",
"type": "object",
"required": [
"instructions"
],
"properties": {
"instructions": {
"type": "string"
}
},
"title": "create_report_payload_generate_patient_instructions_request_output"
}
},
"title": "create_report_payload_generate_patient_instructions_request"
},
"GENERATE_NORMALIZED_DATA": {
"type": "object",
"required": [
"endpoint"
],
"properties": {
"endpoint": {
"type": "string",
"enum": [
"GENERATE_NORMALIZED_DATA"
],
"description": "The report is about a call to the [Generate Normalized Data](/2025-04-03/server/generate-normalized-data) endpoint."
},
"input": {
"type": "object",
"properties": {
"note": {
"description": "The Nabla-generated clinical note to normalize.",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the note.",
"example": "Fever and strong headache"
},
"sections": {
"type": "array",
"description": "Sections of the note.",
"items": {
"type": "object",
"description": "A note section.",
"properties": {
"key": {
"type": "string",
"description": "A key identifying a section of a note.\nThe set of possible keys depend on the template that is used. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for possible values.",
"example": "CHIEF_COMPLAINT",
"enum": [
"ALLERGIES",
"APPOINTMENTS",
"ASSESSMENT",
"ASSESSMENT_AND_PLAN",
"CARDIOVASCULAR_RISK_FACTORS",
"CHIEF_COMPLAINT",
"CURRENT_MEDICATIONS",
"DIAGNOSTIC_TESTS_ORDERED",
"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_OBSTETRIC_HISTORY",
"PAST_SURGICAL_HISTORY",
"PHYSICAL_EXAM",
"PLAN",
"PRESCRIPTION",
"HISTORY_OF_PRESENT_COMPLAINT",
"OBJECTIVE",
"SUBJECTIVE",
"SOCIAL_HISTORY",
"VITALS",
"WELL_CHILD_CARE"
],
"title": "note_section_key"
},
"title": {
"type": "string",
"description": "The section title.",
"example": "Chief complaint"
},
"text": {
"type": "string",
"description": "Content of the note section.",
"example": "Sleep disorder"
}
},
"required": [
"key",
"title",
"text"
],
"title": "note_section_request"
}
}
},
"required": [
"sections"
],
"title": "note_request"
},
"note_locale": {
"type": "string",
"description": "Locale of the note.",
"enum": [
"ENGLISH_US",
"ENGLISH_UK",
"FRENCH_FR"
],
"example": "ENGLISH_US",
"title": "note_locale"
},
"note_template": {
"type": "string",
"enum": [
"GENERIC_MULTIPLE_SECTIONS",
"GENERIC_MULTIPLE_SECTIONS_AP_MERGED",
"GENERIC_SOAP",
"GENERIC_SOAP_AP_MERGED",
"GENERIC_SOAP_PLUS_EXAM_TESTS_AP_MERGED",
"GENERIC_APSO_AP_MERGED",
"EMERGENCY_MULTIPLE_SECTIONS",
"EMERGENCY_SOAP",
"WCC_MULTIPLE_SECTIONS",
"WCC_SOAP",
"PSYCHIATRY_MULTIPLE_SECTIONS",
"PSYCHIATRY_SOAP",
"PSYCHOLOGY_MULTIPLE_SECTIONS",
"CARDIOLOGY_MULTIPLE_SECTIONS",
"DIET_MULTIPLE_SECTIONS"
],
"description": "The template used to generate the note.\n\nSome templates are **only available in specific languages**. Check [Note template](/2025-04-03/guides/note-templates/note-templates-sections) for details.",
"example": "GENERIC_MULTIPLE_SECTIONS",
"title": "note_template"
}
},
"required": [
"note",
"note_locale"
],
"title": "generate_normalized_data_request"
},
"output": {
"type": "object",
"required": [
"conditions",
"family_history"
],
"properties": {
"conditions": {
"description": "FHIR conditions (including their ICD-10 code) corresponding to the patient's medical conditions as mentioned in the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"properties": {
"clinical_status": {
"type": "string",
"enum": [
"ACTIVE",
"RESOLVED"
],
"description": "The [clinical status](https://www.hl7.org/fhir/condition-definitions.html#Condition.clinicalStatus) of the condition. Only `ACTIVE` and `RESOLVED` are supported for now.",
"example": "ACTIVE",
"title": "fhir_condition_clinical_status"
},
"coding": {
"type": "object",
"description": "An ICD-10 entry.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
}
},
"required": [
"code",
"display",
"system"
]
},
"categories": {
"description": "Categories of the condition.",
"type": "array",
"items": {
"type": "string",
"enum": [
"PROBLEM_LIST_ITEM",
"ENCOUNTER_DIAGNOSIS"
],
"description": "The category of a [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"example": "PROBLEM_LIST_ITEM",
"title": "fhir_condition_category"
}
}
},
"required": [
"coding"
]
}
},
"family_history": {
"description": "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.",
"type": "array",
"items": {
"type": "object",
"required": [
"conditions"
],
"properties": {
"relationship": {
"type": "string",
"description": "The relation to the patient of the family member the extracted conditions relate to, if applies.",
"enum": [
"MOTHER",
"FATHER",
"BROTHER",
"SISTER",
"SON",
"DAUGHTER",
"GRANDMOTHER",
"GRANDFATHER",
"AUNT",
"UNCLE",
"OTHER"
],
"title": "family_member_conditions_relationship"
},
"conditions": {
"description": "Conditions of the family member of the patient.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"properties": {
"clinical_status": {
"type": "string",
"enum": [
"ACTIVE",
"RESOLVED"
],
"description": "The [clinical status](https://www.hl7.org/fhir/condition-definitions.html#Condition.clinicalStatus) of the condition. Only `ACTIVE` and `RESOLVED` are supported for now.",
"example": "ACTIVE",
"title": "fhir_condition_clinical_status"
},
"coding": {
"type": "object",
"description": "An ICD-10 entry.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
}
},
"required": [
"code",
"display"
]
},
"categories": {
"description": "Categories of the condition.",
"type": "array",
"items": {
"type": "string",
"enum": [
"PROBLEM_LIST_ITEM",
"ENCOUNTER_DIAGNOSIS"
],
"description": "The category of a [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"example": "PROBLEM_LIST_ITEM",
"title": "fhir_condition_category"
}
}
},
"required": [
"coding"
]
}
}
}
}
},
"observations": {
"description": "FHIR observations (including their LOINC code) extracted from the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR observation](https://www.hl7.org/fhir/observation.html).",
"properties": {
"coding": {
"type": "object",
"description": "LOINC coding representation of this observation.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only LOINC is supported for now.",
"enum": [
"http://loinc.org"
]
},
"code": {
"type": "string",
"example": "29463-7",
"description": "Code of the LOINC entry."
},
"display": {
"type": "string",
"example": "Body weight",
"description": "Description of the LOINC entry."
}
},
"required": [
"code",
"display",
"system"
]
},
"value_quantity": {
"type": "object",
"description": "Value quantity for an observation.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
},
"value_range": {
"type": "object",
"description": "Value range for an observation.",
"properties": {
"low": {
"type": "object",
"description": "The lower bound of the range.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
},
"high": {
"type": "object",
"description": "The higher bound of the range.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
}
},
"required": [
"low",
"high"
]
},
"note": {
"type": "string",
"description": "Additional comment about the observation.",
"example": "Measured at rest."
}
},
"required": [
"coding"
]
}
}
},
"title": "create_report_payload_generate_normalized_data_request_output"
},
"expected_output": {
"description": "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.",
"type": "object",
"required": [
"conditions",
"family_history"
],
"properties": {
"conditions": {
"description": "FHIR conditions (including their ICD-10 code) corresponding to the patient's medical conditions as mentioned in the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"properties": {
"clinical_status": {
"type": "string",
"enum": [
"ACTIVE",
"RESOLVED"
],
"description": "The [clinical status](https://www.hl7.org/fhir/condition-definitions.html#Condition.clinicalStatus) of the condition. Only `ACTIVE` and `RESOLVED` are supported for now.",
"example": "ACTIVE",
"title": "fhir_condition_clinical_status"
},
"coding": {
"type": "object",
"description": "An ICD-10 entry.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
}
},
"required": [
"code",
"display",
"system"
]
},
"categories": {
"description": "Categories of the condition.",
"type": "array",
"items": {
"type": "string",
"enum": [
"PROBLEM_LIST_ITEM",
"ENCOUNTER_DIAGNOSIS"
],
"description": "The category of a [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"example": "PROBLEM_LIST_ITEM",
"title": "fhir_condition_category"
}
}
},
"required": [
"coding"
]
}
},
"family_history": {
"description": "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.",
"type": "array",
"items": {
"type": "object",
"required": [
"conditions"
],
"properties": {
"relationship": {
"type": "string",
"description": "The relation to the patient of the family member the extracted conditions relate to, if applies.",
"enum": [
"MOTHER",
"FATHER",
"BROTHER",
"SISTER",
"SON",
"DAUGHTER",
"GRANDMOTHER",
"GRANDFATHER",
"AUNT",
"UNCLE",
"OTHER"
],
"title": "family_member_conditions_relationship"
},
"conditions": {
"description": "Conditions of the family member of the patient.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"properties": {
"clinical_status": {
"type": "string",
"enum": [
"ACTIVE",
"RESOLVED"
],
"description": "The [clinical status](https://www.hl7.org/fhir/condition-definitions.html#Condition.clinicalStatus) of the condition. Only `ACTIVE` and `RESOLVED` are supported for now.",
"example": "ACTIVE",
"title": "fhir_condition_clinical_status"
},
"coding": {
"type": "object",
"description": "An ICD-10 entry.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
}
},
"required": [
"code",
"display"
]
},
"categories": {
"description": "Categories of the condition.",
"type": "array",
"items": {
"type": "string",
"enum": [
"PROBLEM_LIST_ITEM",
"ENCOUNTER_DIAGNOSIS"
],
"description": "The category of a [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"example": "PROBLEM_LIST_ITEM",
"title": "fhir_condition_category"
}
}
},
"required": [
"coding"
]
}
}
}
}
},
"observations": {
"description": "FHIR observations (including their LOINC code) extracted from the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR observation](https://www.hl7.org/fhir/observation.html).",
"properties": {
"coding": {
"type": "object",
"description": "LOINC coding representation of this observation.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only LOINC is supported for now.",
"enum": [
"http://loinc.org"
]
},
"code": {
"type": "string",
"example": "29463-7",
"description": "Code of the LOINC entry."
},
"display": {
"type": "string",
"example": "Body weight",
"description": "Description of the LOINC entry."
}
},
"required": [
"code",
"display",
"system"
]
},
"value_quantity": {
"type": "object",
"description": "Value quantity for an observation.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
},
"value_range": {
"type": "object",
"description": "Value range for an observation.",
"properties": {
"low": {
"type": "object",
"description": "The lower bound of the range.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
},
"high": {
"type": "object",
"description": "The higher bound of the range.",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
]
}
},
"required": [
"low",
"high"
]
},
"note": {
"type": "string",
"description": "Additional comment about the observation.",
"example": "Measured at rest."
}
},
"required": [
"coding"
]
}
}
},
"title": "create_report_payload_generate_normalized_data_request_output"
}
},
"title": "create_report_payload_generate_normalized_data_request"
}
}
},
"title": "create_report_payload_request"
}
},
"required": [
"payload"
],
"title": "create_report_request"
}
}
}
},
"responses": {
"200": {
"description": "The created report id, to be referenced when emailing support.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
}
}
}
}