Skip to content

Conversation

thomasyopes
Copy link
Contributor

@thomasyopes thomasyopes commented Jun 12, 2025

Issues:

Description

  • default missing or non-normalizable healthie genders to "U"
  • clean-up gender normalization code

Testing

  • Local
    • unit tests pass
  • Staging
    • unit tests pass
    • create two patients in healthie with missing gender and non-supported gender and confirm both create
  • Sandbox
    • unit tests pass
  • Production
    • unit tests pass
    • cx confirms working genders

Release Plan

  • Merge this

Summary by CodeRabbit

  • New Features
    • Gender normalization for patient data now uses standardized constants for improved consistency.
  • Bug Fixes
    • Corrected a test case description related to date of birth validation.
  • Tests
    • Added comprehensive tests for gender normalization functions and constants.
  • Refactor
    • Updated gender-related types and error handling to use new constants and provide clearer error messages.

Thomas Yopes added 4 commits June 12, 2025 12:56
Ref: ENG-462

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Ref: ENG-462

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Ref: ENG-462

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Ref: ENG-462

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Copy link

linear bot commented Jun 12, 2025

Ref: ENG-462

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Ref: ENG-462

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Copy link

coderabbitai bot commented Jun 13, 2025

Walkthrough

The changes introduce normalized gender constants and update gender normalization logic across the codebase. The HealthieApi now formats patient gender using the new normalization functions and constants. The gender domain module exports explicit gender constants, updates type definitions, and enhances error handling. Corresponding tests are added and updated for these behaviors.

Changes

File(s) Change Summary
packages/shared/src/domain/gender.ts Added exported gender constants, updated GenderAtBirth type, improved normalization functions and errors.
packages/core/src/external/ehr/healthie/index.ts Added private formatPatient method; getPatient now returns patient with normalized gender.
packages/shared/src/domain/tests/gender.test.ts Added new tests for gender normalization functions and constants.
packages/shared/src/domain/tests/dob.test.ts Fixed test description for normalizeDob error case.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant HealthieApi
    participant GenderDomain

    Client->>HealthieApi: getPatient({ cxId, patientId })
    HealthieApi->>HealthieApi: fetch patient data
    HealthieApi->>GenderDomain: normalizeGenderSafe(patient.gender)
    GenderDomain-->>HealthieApi: normalized gender or undefined
    HealthieApi->>HealthieApi: formatPatient(patient) (sets gender to normalized or unknown)
    HealthieApi-->>Client: formatted patient object
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: C0DC22F1F67F0000: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-13T00_24_52_507Z-debug-0.log

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

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 (2)
packages/shared/src/domain/gender.ts (1)

14-26: Consider table-driven lookup for easier maintenance & O(1) lookup

The long if/else chain is readable now but will not scale when more aliases appear. A simple map makes this deterministic, unit-testable, and avoids repeated toLowerCase() calls:

-export function normalizeGenderSafe(gender: string): GenderAtBirth | undefined {
-  const lowerGender = gender.toLowerCase().trim();
-  if (lowerGender === "male" || lowerGender === "m") {
-    return maleGender;
-  } else if (lowerGender === "female" || lowerGender === "f") {
-    return femaleGender;
-  } else if (lowerGender === "other" || lowerGender === "o") {
-    return otherGender;
-  } else if (lowerGender === "unknown" || lowerGender === "unk" || lowerGender === "u") {
-    return unknownGender;
-  }
-  return undefined;
-}
+const genderMap: Record<string, GenderAtBirth> = {
+  male: maleGender,
+  m: maleGender,
+  female: femaleGender,
+  f: femaleGender,
+  other: otherGender,
+  o: otherGender,
+  unknown: unknownGender,
+  unk: unknownGender,
+  u: unknownGender,
+};
+
+export function normalizeGenderSafe(gender: string): GenderAtBirth | undefined {
+  return genderMap[gender.trim().toLowerCase()];
+}

Less branching, easier to eyeball for gaps.

packages/shared/src/domain/__tests__/gender.test.ts (1)

47-53: Use test.each for clearer parameterised cases

Jest has native support for table-driven tests; it yields cleaner output and automatic naming:

-    describe("valid inputs", () => {
-      for (const { input, expectedOutput } of tests) {
-        it(`should return ${expectedOutput} when input is ${input}`, () => {
-          expect(normalizeGender(input)).toBe(expectedOutput);
-        });
-      }
-    });
+    describe.each(tests)("$input -> $expectedOutput", ({ input, expectedOutput }) => {
+      it("normalizes correctly", () => {
+        expect(normalizeGender(input)).toBe(expectedOutput);
+      });
+    });

Same suggestion applies to the normalizeGenderSafe block below.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1327494 and f63850f.

📒 Files selected for processing (4)
  • packages/core/src/external/ehr/healthie/index.ts (3 hunks)
  • packages/shared/src/domain/__tests__/dob.test.ts (1 hunks)
  • packages/shared/src/domain/__tests__/gender.test.ts (1 hunks)
  • packages/shared/src/domain/gender.ts (1 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/shared/src/domain/__tests__/dob.test.ts
  • packages/core/src/external/ehr/healthie/index.ts
  • packages/shared/src/domain/gender.ts
  • packages/shared/src/domain/__tests__/gender.test.ts
🧬 Code Graph Analysis (3)
packages/core/src/external/ehr/healthie/index.ts (2)
packages/shared/src/interface/external/ehr/healthie/patient.ts (1)
  • Patient (22-22)
packages/shared/src/domain/gender.ts (2)
  • normalizeGenderSafe (14-26)
  • unknownGender (6-6)
packages/shared/src/domain/gender.ts (1)
packages/shared/src/index.ts (1)
  • BadRequestError (40-40)
packages/shared/src/domain/__tests__/gender.test.ts (1)
packages/shared/src/domain/gender.ts (6)
  • maleGender (3-3)
  • femaleGender (4-4)
  • otherGender (5-5)
  • unknownGender (6-6)
  • normalizeGender (28-32)
  • normalizeGenderSafe (14-26)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: check-pr / lint-build-test
  • GitHub Check: check-pr / lint-build-test
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
packages/shared/src/domain/gender.ts (1)

20-24:

❓ Verification inconclusive

"un" very likely means unknown, not other – please confirm

Mapping the token "un" to otherGender looks suspicious. In most interoperability specs (HL7 v2, FHIR, X12, etc.) the code UN/UNKN stands for unknown or undifferentiated, not other. A silent mis-classification here will ripple to every integration that relies on these constants.

-} else if (lowerGender === "other" || lowerGender === "un" || lowerGender === "o") {
-  return otherGender;
+} else if (lowerGender === "other" || lowerGender === "o") {
+  return otherGender;
+} else if (lowerGender === "unknown" || lowerGender === "unk" || lowerGender === "un" || lowerGender === "u") {
+  return unknownGender;

Please verify against the Healthie docs / inbound payloads and adjust, otherwise downstream analytics will be skewed.


Ensure correct mapping for “un” (unknown) rather than “other”

Mapping "un" to otherGender conflicts with common interoperability specs (e.g., HL7, FHIR) where UN/UNKN denotes unknown, not other. A silent mis-classification here will skew downstream analytics.

Proposed diff:

-} else if (lowerGender === "other" || lowerGender === "un" || lowerGender === "o") {
-  return otherGender;
+} else if (lowerGender === "other" || lowerGender === "o") {
+  return otherGender;
 } else if (lowerGender === "unknown" || lowerGender === "unk" || lowerGender === "u") {
-  return unknownGender;
+  return unknownGender;
+} else if (lowerGender === "un") {
+  return unknownGender;

Please verify this change against the Healthie inbound payload specifications to prevent any analytics discrepancies.

packages/shared/src/domain/__tests__/dob.test.ts (1)

5-7: 👍 Accurate test description fix

The rename from “zip” to “dob” matches the assertion and removes cognitive friction.

packages/core/src/external/ehr/healthie/index.ts (1)

506-512: formatPatient mutates semantic type – ensure Patient schema allows normalized codes

formatPatient replaces the raw gender string with our normalized single-letter codes.
Verify that:

  1. Patient’s gender field is typed as GenderAtBirth (or string) after code-gen;
  2. Any serializer that later pushes this object back to Healthie still sends the original raw value if required.

If Patient.gender is expected to stay untouched for round-trips, consider adding a new field (e.g., normalizedGender) instead of overriding the original.

@thomasyopes thomasyopes added this pull request to the merge queue Jun 13, 2025
Merged via the queue into develop with commit cdb0d1a Jun 13, 2025
16 checks passed
@thomasyopes thomasyopes deleted the eng-462-fix-healthie-gender branch June 13, 2025 16:22
@thomasyopes thomasyopes mentioned this pull request Jun 13, 2025
1 task
@coderabbitai coderabbitai bot mentioned this pull request Jul 3, 2025
5 tasks
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