Search Clinical Notes

Description: Search FHIR clinical notes for a patient, filtered by date range and text content. Returns a structured result with matching notes and relevant metadata.

search_clinical_notes Parameters

Required Parameters

None - all parameters are optional

Optional Parameters

1. end_date (date string or null)

2. • Default: null
   • Format: YYYY-MM-DD
   • Description: The latest date (inclusive) for filtering notes. Optional; if omitted, no upper date bound is used.

3. note_category (string or null)

   • Default: null
   • Description: High-level FHIR document category used to group clinical notes.
   • Available categories (must use exact string):
     • "History of Immunization"
     • "Anesthesia Records"
     • "Chemotherapy Records"
     • "Consult Note"
     • "Progress Note"
     • "Nursery Records"
     • "Labor and Delivery Records"
     • "Radiology Studies"
     • "Transfer Summary"
     • "Discharge Summary"
     • "Laboratory Studies"
     • "Cardiology Studies"
     • "Obstetrical Studies"
     • "Gastroenterology Endoscopy Studies"
     • "Pulmonary Studies"
     • "Neuromuscular Electrophysiology Studies"
     • "Pathology Studies"
     • "Procedure Note"
     • "Ophthalmology/Optometry Studies"
     • "Miscellaneous Studies"
     • "Dialysis Records"
     • "Neonatal Intensive Care Records"
     • "Critical Care Records"
     • "Perioperative Records"
     • "Evaluation and Management Note"
     • "History and Physical"
     • "Interventional Procedure Note"
     • "Pathology Procedure Note"
     • "Episode Summary Note"
     • "Transfer of Care Referral Note"
     • "Telephone Encounter Note"
     • "Pre-Operative Evaluation Note"
     • "Admission History and Physical"
     • "Counseling Note"
     • "Study Report"
     • "Summary of Death"
     • "Non-Patient Communication"
     • "Privacy Policy Organization Document"
     • "Privacy Policy Acknowledgment"
     • "Medication Summary"
     • "Personal Health Monitoring Report"
     • "Plan of Care Note"
     • "Diagnostic Imaging Study"
     • "Operative Note"
     • "Referral Note"
   • Note: Each value is defined in the LOINC Document Ontology 'Class' hierarchy and corresponds to FHIR DocumentReference.category. Use this field for broad filtering by category. If omitted, no category filtering is applied.

4. note_type (string or null)

   • Default: null
   • Description: Specific clinical note or report type to filter.
   • Available note types (must use exact string):
     • "Progress Note"
     • "Discharge Summary"
     • "History and Physical"
     • "Consultation Note"
     • "Operative Note"
     • "Radiology Report"
     • "Pathology Report"
     • "Emergency Department Note"
     • "Nursing Note"
     • "Therapy Note"
     • "Psychiatric Note"
     • "Cardiology Note"
     • "Critical Care Note"
     • "Anesthesia Note"
     • "Operative Report"
     • "Procedure Note"
     • "Pre-Operative Note"
     • "Post-Operative Note"
     • "Care Plan"
     • "Triage Note"
   • Note: Each value corresponds to a specific LOINC code from the FHIR Document Type Codes ValueSet. Use this field for fine-grained filtering of a particular note or report type. If omitted, all note types are included.

5. number_of_notes (integer)

   • Default: 10
   • Description: Number of top matching notes to return. Default is 10.

6. search_text (string or null)

7. • Default: null
   • Description: Text to search for within the patient's clinical notes. This is optional but recommended to narrow down results.

8. start_date (date string or null)

   • Default: null
   • Format: YYYY-MM-DD
   • Description: The earliest date (inclusive) for filtering notes. Optional; if omitted, no lower date bound is used.

9. use_similarity_search (boolean)

   • Default: true
   • Description: If true, performs semantic similarity search on clinical notes. If false, uses traditional keyword search.

When to Use search_clinical_notes

This tool searches FHIR clinical notes for a given patient within a date range and for specific text. Use when:

• Users ask for specific clinical notes or documentation
• Searching for particular content within notes
• Looking for notes by category or type
• If no search text is provided, the most recent notes will be returned
• Returns matching notes and relevant metadata

Returns:

• FhirNotesSearchOutput:
  • notes (List[FhirNote]): List of matching clinical notes as FhirNote objects, each with:
    • note_id (str): Unique identifier for the clinical note.
    • patient_id (str): Identifier for the patient associated with the note.
    • text (str): The full text content of the clinical note.
    • resource_reference (str): Reference to the original FHIR resource.
    • meta (dict): Metadata associated with the clinical note.
  • error (Optional[str]): Error message if search failed.