Expand Feature Comparison Support

[cbrinson-rise8]

Description

NBS has requested that we add additional fields for feature comparisons. We won't need to block on any of these features, but we do need to have the ability to compare them in the second half of the algorithm.

Related Issues

closes #55

Additional Notes

• Add the following values to recordlinker.models.pii.PIIRecord
  • SSN (should validate that its 10 digits and conform to XXX-XX-XXXX format)
  • Race (need an Enum with the 8 races identified here)
  • Gender (need an Enum with the 5 genders identified here)
• Add the above 3 to recordlinker.models.pii.Feature, and additionally add 3 more
  • Telephone
  • Suffix
  • County
• Rename recordlinker.models.pii.PIIRecord.field_iter to recordlinker.models.pii.PIIRecord.feature_iter
• Update recordlinker.models.pii.PIIRecord.field_iter to extract the 6 features above
• Update recordlinker.linking.fhir_record_to_pii_record to extract the 6 features from a FHIR payload
• Add documentation to the docs/ directory to explain the process of adding a new Feature

HL7 FHIR resources

• https://build.fhir.org/patient-examples-general.json.html
• https://hl7.org/fhir/R5/patient.html
• https://hl7.org/fhir/R5/datatypes-examples.html#HumanName
• https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-race.html
• https://www.hl7.org/fhir/us/core/Patient-example.json.html

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

• I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
• I have reviewed my changes to ensure they are clear, concise, and well-documented.
• I have updated the documentation, if applicable.
• I have added or updated test cases to cover my changes, if applicable.
• I have minimized the number of reviewers to include only those essential for the review.
• I have notified teammates in the review thread to build awareness.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

• The code follows best practices and conventions.
• The changes implement the desired functionality or fix the reported issue.
• The tests cover the new changes and pass successfully.
• Any potential edge cases or error scenarios have been considered.

[codecov]

Codecov Report

Attention: Patch coverage is 94.82759% with 6 lines in your changes missing coverage. Please review.

Project coverage is 94.58%. Comparing base (0000ec5) to head (8782349).
Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
src/recordlinker/linking/link.py	50.00%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #88      +/-   ##
==========================================
+ Coverage   94.24%   94.58%   +0.34%     
==========================================
  Files          21       21              
  Lines        1025     1146     +121     
==========================================
+ Hits          966     1084     +118     
- Misses         59       62       +3     

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

[alhayward]

Nice work! Left two questions & a suggestion. I also left two clarifying questions on the Related Issue #55.

[cbrinson-rise8]

@ericbuckley @alhayward I adjusted the race and gender parsers to handle anything that doesn't map easily to just be either unknown or other. This is mainly to handle any values that aren't a part of these:
(8 races) https://www.hl7.org/fhir/us/core/ValueSet-omb-race-category.html
(5 genders) https://terminology.hl7.org/5.5.0/ValueSet-gender-identity.html

Do y'all think this is sufficient for now? Otherwise my thought was to just make the race field a string instead of an enum since there could be many different values depending on the data source.

code:
https://github.com/CDCgov/RecordLinker/pull/88/files#:~:text=%40pydantic.field_validator(%22race,return%20Race.OTHER

[ericbuckley]

Thanks for all the extra tests, that really helped clear up questions I had about behavior.