Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Appointments: Filters and fix available_doctors API #2686

Merged
merged 7 commits into from
Jan 2, 2025

Conversation

rithviknishad
Copy link
Member

@rithviknishad rithviknishad commented Dec 26, 2024

Proposed Changes

  • Brief of changes made.

Associated Issue

  • Link to issue here, explain how the proposed solution will solve the reported issue/ feature request.

Architecture changes

  • Remove this section if not used

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 booking system filtering with new date and resource-based filters.
    • Improved doctor availability retrieval based on organizational context.
  • Improvements

    • Added ability to filter bookings by date and specific resource.
    • Refined user filtering to ensure organizational alignment.

Copy link

coderabbitai bot commented Dec 26, 2024

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The changes modify the booking filtering system in the EMR API, introducing enhanced querying capabilities for token bookings. A new date filter allows precise filtering by token slot start date, while a resource filter enables filtering based on schedulable user resources. The modifications also refine the user retrieval process, incorporating organizational context to improve the precision of doctor availability queries. It’s almost like they thought of everything!

Changes

File Change Summary
care/emr/api/viewsets/scheduling/booking.py - Added date filter for token_slot__start_datetime__date
- Introduced resource UUID filter with custom filter_by_resource method
- Updated available_doctors method to use FacilityOrganizationUser

Sequence Diagram

sequenceDiagram
    participant Client
    participant TokenBookingViewSet
    participant TokenBookingFilters
    participant SchedulableUserResource

    Client->>TokenBookingViewSet: Request filtered bookings
    TokenBookingViewSet->>TokenBookingFilters: Apply filters
    TokenBookingFilters->>SchedulableUserResource: Fetch resource by external ID
    SchedulableUserResource-->>TokenBookingFilters: Return matching resource
    TokenBookingFilters-->>TokenBookingViewSet: Filtered queryset
    TokenBookingViewSet-->>Client: Return filtered bookings
Loading

Poem

🕰️ Filters dancing, dates align,
Resources found, a code design.
Bookings filtered, precise and neat,
Organizational context, a filtering feat!
Efficiency whispers, soft and bright,
Oh, how they’ve made it all just right! 🔍


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a90aa70 and bc08761.

📒 Files selected for processing (1)
  • care/emr/api/viewsets/scheduling/booking.py (3 hunks)

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

@rithviknishad rithviknishad changed the base branch from develop to vigneshhari/health-details December 26, 2024 10:35
slot = UUIDFilter(field_name="token_slot__external_id")
resource = UUIDFilter(field_name="token_slot__resource__resource__external_id")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Switch this to get a resource and then filter by that, avoid all the joins.

Base automatically changed from vigneshhari/health-details to develop December 31, 2024 06:37
@rithviknishad rithviknishad changed the title Rithviknishad/appointments filters Appointments: Filters and fix available_doctors API Jan 2, 2025
@rithviknishad rithviknishad marked this pull request as ready for review January 2, 2025 11:42
@rithviknishad rithviknishad requested a review from a team as a code owner January 2, 2025 11:42
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
care/emr/api/viewsets/scheduling/booking.py (1)

29-36: Consider optimizing the resource retrieval logic.

Right now, retrieving the resource with .first() and handling the “no resource found” scenario is acceptable. However, you could wrap this in a try/except using get() for slightly neater logic and possibly skip an extra DB call. For example:

 def filter_by_resource(self, queryset, name, value):
-    resource = SchedulableUserResource.objects.filter(
-        resource__external_id=value
-    ).first()
-    if not resource:
-        return queryset.none()
-    return queryset.filter(token_slot__resource=resource)
+    from django.shortcuts import get_object_or_404
+    resource = get_object_or_404(
+        SchedulableUserResource, resource__external_id=value
+    )
+    return queryset.filter(token_slot__resource=resource)

It’s a minor improvement, but it helps unify how resources are accessed throughout your backend.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 954ddca and a90aa70.

📒 Files selected for processing (1)
  • care/emr/api/viewsets/scheduling/booking.py (3 hunks)
🔇 Additional comments (3)
care/emr/api/viewsets/scheduling/booking.py (3)

24-24: Nice addition for date-based filtering.

Adding a DateFilter for token_slot__start_datetime__date is a straightforward and meaningful way to refine queries by appointment date. Good job.


26-26: Method-based filter is a clean approach.

Defining a custom method-based filter for resource improves readability and maintainability. This approach keeps your filter logic self-contained within the filter class.


71-72: Validate filtering by organization.

Using FacilityOrganizationUser to ensure users belong to the facility’s organization is logical. Double-check that this is the only place you need to filter by the organization. If not, you might extract a helper method to avoid repeating this logic in other viewsets.

patient = UUIDFilter(field_name="patient__external_id")

def filter_by_resource(self, queryset, name, value):
resource = SchedulableUserResource.objects.filter(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do this inside an if value: block

@vigneshhari vigneshhari merged commit 0e288c7 into develop Jan 2, 2025
3 of 5 checks passed
@vigneshhari vigneshhari deleted the rithviknishad/appointments-filters branch January 2, 2025 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants