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

Override Dob Or Age for Patients #2792

Merged
merged 2 commits into from
Jan 30, 2025

Conversation

Jacobjeevan
Copy link
Contributor

@Jacobjeevan Jacobjeevan commented Jan 29, 2025

Proposed Changes

  • Allow override for age or dob

Associated Issue

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

  • Bug Fixes
    • Improved patient year of birth calculation logic to consistently update based on age or date of birth, regardless of whether it's a new or existing patient record.
  • Tests
    • Added comprehensive tests for updating a patient's age and date of birth, ensuring accurate year of birth calculations in various scenarios.

@Jacobjeevan Jacobjeevan requested a review from a team as a code owner January 29, 2025 12:33
Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the perform_extra_deserialization method in the PatientCreateSpec class, fundamentally changing how year_of_birth is calculated. The updated logic removes the previous conditional update mechanism, now allowing year_of_birth to be set consistently based on age or date_of_birth for both create and update scenarios. This change simplifies the method's behavior by applying a uniform approach to deriving the birth year.

Changes

File Change Summary
care/emr/resources/patient/spec.py Removed is_update conditional check in perform_extra_deserialization method
Updated logic to always calculate year_of_birth from age or date_of_birth
care/emr/tests/test_patient_api.py Added test_update_patient_age_and_date_of_birth method to TestPatientViewSet for testing age and date of birth updates

Poem

🩺 Birthdays, ages, years untold
Code that once was rigid, now more bold
No more checks to hold us back
Year of birth finds its own track
Simplicity wins the day! 🎂

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@Jacobjeevan Jacobjeevan marked this pull request as draft January 29, 2025 12:34
Copy link
Contributor

@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/resources/patient/spec.py (1)

77-77: Consider timezone edge cases in year calculation.

Using timezone.now() for year calculation could lead to incorrect results near year boundaries depending on the timezone. For instance, it might be December 31st in one timezone but January 1st in another.

-    obj.year_of_birth = timezone.now().date().year - self.age
+    # Use the organization's timezone or a reference timezone for consistency
+    reference_date = timezone.localtime(timezone.now(), obj.geo_organization.timezone).date()
+    obj.year_of_birth = reference_date.year - self.age
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f9e1852 and 9945261.

📒 Files selected for processing (1)
  • care/emr/resources/patient/spec.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test / test
🔇 Additional comments (2)
care/emr/resources/patient/spec.py (2)

74-78: 🛠️ Refactor suggestion

Consider data loss implications when overriding date_of_birth.

When age is provided, setting date_of_birth to None might lead to loss of precise birth date information that could be important for medical records. Perhaps we should store both values?

Also, there's no validation for the age value. It might be worth adding some reasonable bounds, unless you enjoy having 200-year-old patients in your system. 😊

 if self.age:
+    if not 0 <= self.age <= 150:
+        raise ValueError("Age must be between 0 and 150 years")
     # override dob if user chooses to update age
     obj.date_of_birth = None
     obj.year_of_birth = timezone.now().date().year - self.age

74-79: Verify the impact on existing features.

The removal of the is_update check changes the behavior for update operations. Please ensure this doesn't affect any existing features that might depend on the previous behavior.

Copy link

codecov bot commented Jan 29, 2025

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 56.14%. Comparing base (f9c1b7f) to head (15059fe).
Report is 23 commits behind head on develop.

Files with missing lines Patch % Lines
care/emr/resources/patient/spec.py 0.00% 4 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2792      +/-   ##
===========================================
- Coverage    56.16%   56.14%   -0.02%     
===========================================
  Files          215      215              
  Lines        10191    10205      +14     
  Branches      1030     1031       +1     
===========================================
+ Hits          5724     5730       +6     
- Misses        4451     4459       +8     
  Partials        16       16              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Jacobjeevan Jacobjeevan marked this pull request as ready for review January 30, 2025 09:52
Copy link
Contributor

@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 (3)
care/emr/tests/test_patient_api.py (3)

142-161: Perhaps consider separating the permission combinations into individual test cases?

While the setup is comprehensive, it might be more maintainable to test each permission combination separately. Also, it seems you forgot to verify the calculated age from the initial date_of_birth.

 def test_update_patient_age_and_date_of_birth(self):
     # ... existing setup ...
     self.assertEqual(response.data["date_of_birth"], "1993-01-10")
     self.assertEqual(response.data["year_of_birth"], 1993)
+    current_year = datetime.datetime.now(datetime.UTC).year
+    expected_age = current_year - 1993
+    self.assertEqual(response.data["age"], expected_age)

172-177: The test seems to be missing some rather obvious assertions.

While you're verifying the date_of_birth and year_of_birth, you might want to also verify the calculated age and ensure the age field is properly handled in the response.

 self.assertEqual(response.data["date_of_birth"], "1992-01-10")
 self.assertEqual(response.data["year_of_birth"], 1992)
+current_year = datetime.datetime.now(datetime.UTC).year
+expected_age = current_year - 1992
+self.assertEqual(response.data["age"], expected_age)
+self.assertNotIn("age", patient_data)  # Verify age was removed from request

142-177: The test coverage seems a bit... minimal.

Consider adding test cases for:

  • Edge cases (e.g., age=0, age=120)
  • Invalid inputs (e.g., future date_of_birth, negative age)
  • Concurrent updates of both age and date_of_birth

Would you like me to generate the additional test cases?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9945261 and 15059fe.

📒 Files selected for processing (1)
  • care/emr/tests/test_patient_api.py (2 hunks)
🔇 Additional comments (1)
care/emr/tests/test_patient_api.py (1)

162-171: Time-dependent test that might fail around New Year's Eve... just saying.

The test calculates year_of_birth using the current year, which could lead to flaky tests around midnight on New Year's Eve. Also, it seems you're not verifying if the age field in the response matches the input age.

 patient_data["age"] = 33
 response = self.client.put(reverse_url, patient_data, format="json")
 self.assertEqual(response.status_code, status.HTTP_200_OK)
 self.assertEqual(response.data["date_of_birth"], None)
+self.assertEqual(response.data["age"], 33)
+# Consider freezing time or mocking datetime.now() to avoid time-dependent failures
 self.assertEqual(
     response.data["year_of_birth"],
     datetime.datetime.now(datetime.UTC).year - 33,
 )

@vigneshhari vigneshhari merged commit b52a239 into ohcnetwork:develop Jan 30, 2025
3 of 5 checks passed
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