Skip to content

PATCH RELEASE ENG-422 Minimize hits to FHIR DB upon CQ DQ #3967

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 6, 2025
Merged

PATCH RELEASE ENG-422 Minimize hits to FHIR DB upon CQ DQ #3967

merged 1 commit into from
Jun 6, 2025

Conversation

leite08
Copy link
Member

@leite08 leite08 commented Jun 6, 2025 •
edited by coderabbitai bot
Loading

Issues:

Dependencies

none

Description

Minimize hits to FHIR DB upon CQ DQ.

Testing

none

Release Plan

  • ⚠️ This is pointing to master/production
  • Merge this

Summary by CodeRabbit

  • Bug Fixes
    • Improved accuracy in identifying which document references need to be downloaded by considering existing FHIR documents during the process. This helps prevent unnecessary downloads and ensures up-to-date document management.

@leite08
refactor: load docrefs once from fhir server for each dq resp
b868088 
Ref eng-422

Signed-off-by: Rafael Leite <2132564+leite08@users.noreply.github.com>
@linear Linear
Copy link

linear bot commented Jun 6, 2025

ENG-422 Don't load DocRefs from FHIR server unnecessarily

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jun 6, 2025 •
edited
Loading

Walkthrough

The changes update the logic for determining non-existent document references by modifying the getNonExistentDocRefs function to require existing FHIR document references as an argument, rather than fetching them internally. The calling code now retrieves these references and supplies them to the function, streamlining the data flow between components.

Changes

File(s) Change Summary
packages/api/src/external/carequality/document/get-non-existent-doc-refs.ts Updated getNonExistentDocRefs to require fhirDocRefs parameter and removed internal fetching of FHIR docs.
packages/api/src/external/carequality/document/process-outbound-document-query-resps.ts Modified to fetch FHIR document references and pass them to getNonExistentDocRefs when determining downloads.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant FHIRDocModule as FHIR Document Module
    participant CarequalityDoc as Carequality Document Module

    Caller->>FHIRDocModule: getDocuments(patientId, cxId)
    FHIRDocModule-->>Caller: fhirDocRefs
    Caller->>CarequalityDoc: getNonExistentDocRefs(documents, patientId, cxId, fhirDocRefs)
    CarequalityDoc->>S3: checkDocRefsExistInS3(documents)
    S3-->>CarequalityDoc: s3DocRefs
    CarequalityDoc-->>Caller: nonExistentDocRefs
Loading

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error code ERR_SSL_WRONG_VERSION_NUMBER
npm error errno ERR_SSL_WRONG_VERSION_NUMBER
npm error request to https://10.0.0.28:4873/punycode/-/punycode-2.3.1.tgz failed, reason: C01C86A9D47F0000:error:0A00010B:SSL routines:ssl3_get_record:wrong version number:../deps/openssl/openssl/ssl/record/ssl3_record.c:354:
npm error
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-06T05_20_19_448Z-debug-0.log

📜 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 efac9a1 and b868088.

📒 Files selected for processing (2)
  • packages/api/src/external/carequality/document/get-non-existent-doc-refs.ts (2 hunks)
  • packages/api/src/external/carequality/document/process-outbound-document-query-resps.ts (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.ts`: - Use the Onion Pattern to organize a package's code in layers - Try to use immutable code and avoid sharing state across different functions, objects, and systems - Try...

**/*.ts: - Use the Onion Pattern to organize a package's code in layers

  • Try to use immutable code and avoid sharing state across different functions, objects, and systems
  • Try to build code that's idempotent whenever possible
  • Prefer functional programming style functions: small, deterministic, 1 input, 1 output
  • Minimize coupling / dependencies
  • Avoid modifying objects received as parameter
  • Only add comments to code to explain why something was done, not how it works
  • Naming
    • classes, enums: PascalCase
    • constants, variables, functions: camelCase
    • file names: kebab-case
    • table and column names: snake_case
    • Use meaningful names, so whoever is reading the code understands what it means
    • Don’t use negative names, like notEnabled, prefer isDisabled
    • For numeric values, if the type doesn’t convey the unit, add the unit to the name
  • Typescript
    • Use types
    • Prefer const instead of let
    • Avoid any and casting from any to other types
    • Type predicates: only applicable to narrow down the type, not to force a complete type conversion
    • Prefer deconstructing parameters for functions instead of multiple parameters that might be of
      the same type
    • Don’t use null inside the app, only on code interacting with external interfaces/services,
      like DB and HTTP; convert to undefined before sending inwards into the code
    • Use async/await instead of .then()
    • Use the strict equality operator ===, don’t use abstract equality operator ==
    • When calling a Promise-returning function asynchronously (i.e., not awaiting), use .catch() to
      handle errors (see processAsyncError and emptyFunction depending on the case)
    • Date and Time
      • Always use buildDayjs() to create dayjs instances
      • Prefer dayjs.duration(...) to create duration consts and keep them as duration
  • Prefer Nullish Coalesce (??) than the OR operator (||) to provide a default value
  • Avoid creating arrow functions
  • Use truthy syntax instead of in - i.e., if (data.link) not if ('link' in data)
  • Error handling
    • Pass the original error as the new one’s cause so the stack trace is persisted
    • Error messages should have a static message - add dynamic data to MetriportError's additionalInfo prop
    • Avoid sending multiple events to Sentry for a single error
  • Global constants and variables
    • Move literals to constants declared after imports when possible (avoid magic numbers)
    • Avoid shared, global objects
  • Avoid using console.log and console.error in packages other than utils, infra and shared,
    and try to use out().log instead
  • Avoid multi-line logs
    • don't send objects as a second parameter to console.log() or out().log()
    • don't create multi-line strings when using JSON.stringify()
  • Use eslint to enforce code style
  • Use prettier to format code
  • max column length is 100 chars
  • multi-line comments use /** */
  • scripts: top-level comments go after the import
  • packages/api/src/external/carequality/document/process-outbound-document-query-resps.ts
  • packages/api/src/external/carequality/document/get-non-existent-doc-refs.ts
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: check-pr / lint-build-test
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (6)
packages/api/src/external/carequality/document/process-outbound-document-query-resps.ts (3)

5-5: LGTM: Good addition for FHIR optimization.

Adding the import for getDocuments supports the optimization to reduce FHIR DB hits.

247-247: Excellent optimization: Single FHIR DB call per batch.

This change effectively reduces FHIR database hits by retrieving all existing document references once per getRespWithDocsToDownload execution, rather than potentially multiple times within getNonExistentDocRefs. This aligns perfectly with the PR objective.

270-271: LGTM: Consistent with function signature update.

The additional fhirDocRefs parameter correctly passes the pre-retrieved FHIR documents to avoid redundant database calls. The parameter placement follows the expected order.

packages/api/src/external/carequality/document/get-non-existent-doc-refs.ts (3)

3-3: LGTM: Appropriate type import for new parameter.

The import for DocumentReferenceWithId correctly supports the new function signature.

19-20: Excellent refactoring: Dependency injection improves function purity.

The updated function signature follows functional programming principles by accepting dependencies as parameters rather than fetching them internally. This makes the function more testable and eliminates redundant FHIR DB calls.

22-26: LGTM: Simplified async logic achieves optimization goal.

The removal of the concurrent getDocuments call successfully eliminates redundant FHIR database access while maintaining the same filtering logic. The function now relies on the externally provided fhirDocRefs, which aligns with the PR objective to minimize FHIR DB hits.

✨ Finishing Touches
  • 📝 Generate Docstrings
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@leite08 leite08 changed the title patch: improve carequality document processing and deduplication PATCH RELEASE ENG-422 Minimize hits to FHIR DB upon CQ DQ Jun 6, 2025
@leite08 leite08 marked this pull request as ready for review June 6, 2025 05:18
lucasdellabella
lucasdellabella previously approved these changes Jun 6, 2025
View reviewed changes
@leite08 leite08 added this pull request to the merge queue Jun 6, 2025
Merged via the queue into master with commit b1a6de9 Jun 6, 2025
16 checks passed
@leite08 leite08 dismissed lucasdellabella’s stale review June 6, 2025 14:58

The merge-base changed after approval.

@leite08 leite08 deleted the eng-422-fix-load-docref-from-fhir-server-on-dq branch June 6, 2025 14:58
@leite08 leite08 mentioned this pull request Jun 6, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Jun 30, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucasdellabella lucasdellabella lucasdellabella left review comments

@Goncharo Goncharo Awaiting requested review from Goncharo Goncharo is a code owner

@Orta21 Orta21 Awaiting requested review from Orta21 Orta21 is a code owner

@RamilGaripov RamilGaripov Awaiting requested review from RamilGaripov RamilGaripov is a code owner

@thomasyopes thomasyopes Awaiting requested review from thomasyopes thomasyopes is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@leite08 @lucasdellabella