Skip to main content
๐ŸŽ‰ API version '2024-10-01' just released with many new features. If you are still on an older version, check the migration guide.

Generate normalized data from a note

POST 

/generate-normalized-data

Generate normalized data from a Nabla-generated clinical note by extracting ICD-10 and LOINC codes in a FHIR-compliant structure.

It adeptly identifies and categorizes key medical information within the notes, such as past medical history, family medical history, clinical assessments, and vital signs.

Each piece of medical information is represented as an array of FHIR's conditions/observations, each including relevant ICD-10 codes, thereby ensuring compatibility with standardized medical data frameworks.

The Normalize functionality is tailored to enhance the integration of clinical notes into Electronic Health Records (EHRs), facilitating accurate and efficient documentation by aligning with FHIR protocols.

Requestโ€‹

Body

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

Responsesโ€‹

The normalized data extracted from the note.

Schema
    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

    ICD-10 coding representation of this condition.

    system stringrequired

    Possible values: [http://hl7.org/fhir/sid/icd-10-cm]

    The used coding system, only ICD-10 is supported for now.

    code stringrequired

    Code of the ICD-10 entry.

    display stringrequired

    Description of the ICD-10 entry.

    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 [
  • conditions object[]

    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

    ICD-10 coding representation of this condition.

    system stringrequired

    Possible values: [http://hl7.org/fhir/sid/icd-10-cm]

    The used coding system, only ICD-10 is supported for now.

    code stringrequired

    Code of the ICD-10 entry.

    display stringrequired

    Description of the ICD-10 entry.

    categories fhir_condition_category (string)[]

    Possible values: [PROBLEM_LIST_ITEM, ENCOUNTER_DIAGNOSIS]

    Categories of the condition.

  • ]
  • 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.

  • ]
  • observations object[]required

    FHIR observations (including their LOINC code) extracted from the clinical note.

  • Array [
  • coding objectrequired

    LOINC coding representation of this observation.

    system stringrequired

    Possible values: [http://loinc.org]

    The used coding system, only LOINC is supported for now.

    code stringrequired

    Code of the LOINC entry.

    display stringrequired

    Description of the LOINC entry.

    value_quantity object

    The value quantity for this observation, if not a range.

    value numberrequired

    The value of the quantity.

    unit string

    Possible values: [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]

    The unit of the quantity.

    system stringrequired

    Possible values: [https://ucum.org]

    The used coding system, only UCUM is supported for now.

    code string

    The UCUM code of the unit.

    value_range object

    The value range for this observation, if not a quantity.

    low objectrequired

    The lower bound of the range.

    value numberrequired

    The value of the quantity.

    unit string

    Possible values: [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]

    The unit of the quantity.

    system stringrequired

    Possible values: [https://ucum.org]

    The used coding system, only UCUM is supported for now.

    code string

    The UCUM code of the unit.

    high objectrequired

    The higher bound of the range.

    value numberrequired

    The value of the quantity.

    unit string

    Possible values: [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]

    The unit of the quantity.

    system stringrequired

    Possible values: [https://ucum.org]

    The used coding system, only UCUM is supported for now.

    code string

    The UCUM code of the unit.

    note string

    Additional comment about the observation.

  • ]
Loading...