Encounter filters: add filter by external id

[rithviknishad]

Proposed Changes

• Encounter filters: add filter by external id
• Requested by @Jacobjeevan

Merge Checklist

• Tests added/fixed
• Update docs in /docs
• Linting Complete
• Any other necessary step

Only PR's with test cases included and passing lint and test pipelines will be reviewed

@ohcnetwork/care-backend-maintainers @ohcnetwork/care-backend-admins

Summary by CodeRabbit

• New Features
  • Enhanced encounter filtering by adding support for filtering encounters using their external ID (UUID)

[coderabbitai]

📝 Walkthrough

Walkthrough

A new UUID filter has been introduced to the EncounterFilters class, enabling filtering of encounters by their external ID. This subtle enhancement provides more granular filtering capabilities for encounter-related API queries, allowing developers to retrieve specific encounters using their unique external identifiers.

Changes

File	Change Summary
care/emr/api/viewsets/encounter.py	Added id = filters.UUIDFilter(field_name="external_id") to EncounterFilters class

Poem

🔍 A filter so small, yet precise
Encounters now dance to UUID's advice
External IDs, once hidden from sight
Now emerge with filtering might
Whispers Efficiency's gentle embrace 🕵️‍♀️

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

care/emr/api/viewsets/encounter.py (2)

49-49: Consider renaming the filter to avoid confusion with the primary key.

This new filter is a great enhancement for allowing searches by external ID. That said, using the name id can be a bit confusing, since id is commonly understood to mean the internal primary key. A more descriptive name, like external_id, can help confirm that it refers to the encounter's external identifier.

-    id = filters.UUIDFilter(field_name="external_id")
+    external_id = filters.UUIDFilter(field_name="external_id")

---

49-49: Include tests for the new filter.

Adding or updating tests to validate filtering by external ID is essential. If you haven't done so yet, please create test cases to confirm that encounters can be filtered correctly by this new parameter.

Would you like me to provide an example test snippet or open a GitHub issue to track this?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7d3a6a5 and fb1ca0e.

📒 Files selected for processing (1)

• care/emr/api/viewsets/encounter.py (1 hunks)