Skip to main content
⚠️ Archived Version: This documentation is for an outdated version. Please visit the latest version.

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.

    sections

    object[]

    required

    Sections of the note.
  • Array [

  • keycopilot_note_section_key (string)required

    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.

    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]

    Example: CHIEF_COMPLAINT
    titlestringrequired

    The section title.

    Example: Chief complaint
    textstring

    Content of the note section (required).

    Example: Sleep disorder
  • ]

  • note_localecopilot_note_locale (string)required

    Locale of the note.

    Possible values: [en-US, en-GB, fr-FR]

    Example: en-US

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_statusfhir_condition_clinical_status (string)

    The clinical status of the condition. Only active and resolved are supported for now.

    Possible values: [active, resolved]

    Example: active

    coding

    object

    required

    ICD-10 coding representation of this condition.
    systemstringrequired

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

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

    codestringrequired

    Code of the ICD-10 entry.

    Example: G44.8
    displaystringrequired

    Description of the ICD-10 entry.

    Example: Other specified headache syndromes.
    categoriesfhir_condition_category (string)[]

    Categories of the condition.

    Possible values: [problem_list_item, encounter_diagnosis]

  • ]

  • 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_statusfhir_condition_clinical_status (string)

    The clinical status of the condition. Only active and resolved are supported for now.

    Possible values: [active, resolved]

    Example: active

    coding

    object

    required

    ICD-10 coding representation of this condition.
    systemstringrequired

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

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

    codestringrequired

    Code of the ICD-10 entry.

    Example: G44.8
    displaystringrequired

    Description of the ICD-10 entry.

    Example: Other specified headache syndromes.
    categoriesfhir_condition_category (string)[]

    Categories of the condition.

    Possible values: [problem_list_item, encounter_diagnosis]

  • ]

  • relationshipfamily_member_conditions_relationship (string)

    The relation to the patient of the family member the extracted conditions relate to, if applies.

    Possible values: [MOTHER, FATHER, BROTHER, SISTER, SON, DAUGHTER, GRANDMOTHER, GRANDFATHER, AUNT, UNCLE, OTHER]

  • ]

  • observations

    object[]

    required

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

  • coding

    object

    required

    LOINC coding representation of this observation.
    systemstringrequired

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

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

    codestringrequired

    Code of the LOINC entry.

    Example: 29463-7
    displaystringrequired

    Description of the LOINC entry.

    Example: Body weight

    value_quantity

    object

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

    The value of the quantity.

    unitstring

    The unit of the quantity.

    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]

    systemstringrequired

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

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

    codestring

    The UCUM code of the unit.

    Example: kg

    value_range

    object

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

    low

    object

    required

    The lower bound of the range.
    valuenumberrequired

    The value of the quantity.

    unitstring

    The unit of the quantity.

    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]

    systemstringrequired

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

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

    codestring

    The UCUM code of the unit.

    Example: kg

    high

    object

    required

    valuenumberrequired

    The value of the quantity.

    unitstring

    The unit of the quantity.

    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]

    systemstringrequired

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

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

    codestring

    The UCUM code of the unit.

    Example: kg
    notestring

    Additional comment about the observation.

    Example: Measured at rest.
  • ]