Skip to content

eng-41 patient in bundle as a bundle entry #3796

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
May 6, 2025
Merged

eng-41 patient in bundle as a bundle entry #3796

merged 1 commit into from
May 6, 2025

Conversation

leite08
Copy link
Member

@leite08 leite08 commented May 6, 2025 •
edited
Loading

Dependencies

none

Description

patient in bundle as a bundle entry

Testing

  • Local
    • includes patient as bundle entry
  • Staging
    • none
  • Sandbox
    • none
  • Production
    • none

Release Plan

  • Merge this

Summary by CodeRabbit

  • Bug Fixes
    • Improved the structure of search results to ensure patient resources are properly formatted within the returned data bundle.

@leite08
fix: patient in bundle as a bundle entry
56612f4 
Ref eng-41

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

linear bot commented May 6, 2025

ENG-41 Setup OpenSearch w/ medical-specific model

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 6, 2025 •
edited
Loading

Walkthrough

The update changes how a patient resource is added to filtered search results in the semantic search module. Instead of pushing the raw FHIR patient resource, it now wraps the resource using the buildBundleEntry function, ensuring it is included as a properly structured bundle entry in the returned bundle.

Changes

File(s) Change Summary
packages/core/src/external/opensearch/semantic/search.ts Modified to wrap the patient FHIR resource inside a bundle entry using buildBundleEntry before appending to results.

Possibly related PRs

📜 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 28f134e and 56612f4.

📒 Files selected for processing (1)
  • packages/core/src/external/opensearch/semantic/search.ts (2 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/core/src/external/opensearch/semantic/search.ts
🧬 Code Graph Analysis (1)
packages/core/src/external/opensearch/semantic/search.ts (1)
packages/core/src/external/fhir/shared/bundle.ts (1)
  • buildBundleEntry (184-190)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: check-pr / lint-build-test
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (actions)
🔇 Additional comments (2)
packages/core/src/external/opensearch/semantic/search.ts (2)

8-8: Good addition of the necessary import.

This import is correctly placed with other imports and is needed for the new implementation.

63-64: Good improvement for bundle structure consistency.

This change properly wraps the patient resource in a bundle entry structure before adding it to the results array, ensuring consistency with how other resources are represented in the bundle. This aligns with FHIR specifications where all resources in a bundle should be contained within bundle entries.

The previous implementation was adding the raw FHIR patient resource to the results, which would have created an inconsistent bundle structure.

✨ 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.
    • 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.

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 marked this pull request as ready for review May 6, 2025 22:42
@leite08 leite08 enabled auto-merge May 6, 2025 22:42
@leite08 leite08 added this pull request to the merge queue May 6, 2025
@leite08 leite08 mentioned this pull request May 6, 2025
Merged
2 tasks
Merged via the queue into develop with commit a2f92e7 May 6, 2025
14 checks passed
@leite08 leite08 deleted the eng-41-initial-version-semantic-search_3 branch May 6, 2025 22:44
@leite08 leite08 restored the eng-41-initial-version-semantic-search_3 branch May 7, 2025 03:31
@coderabbitai coderabbitai bot mentioned this pull request May 23, 2025
Merged
6 tasks
This was referenced May 31, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Orta21 Orta21 Orta21 approved these changes

@Goncharo Goncharo Awaiting requested review from Goncharo Goncharo 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

@lucasdellabella lucasdellabella Awaiting requested review from lucasdellabella lucasdellabella 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 @Orta21