Skip to content

Add US CLIA recognizer for clinical laboratory identifiers#2029

Open
Manas103 wants to merge 1 commit into
microsoft:mainfrom
Manas103:manas/add-us-clia-recognizer
Open

Add US CLIA recognizer for clinical laboratory identifiers#2029
Manas103 wants to merge 1 commit into
microsoft:mainfrom
Manas103:manas/add-us-clia-recognizer

Conversation

@Manas103
Copy link
Copy Markdown

Change Description

Adds a new predefined recognizer, UsCliaRecognizer, for the US Clinical Laboratory Improvement Amendments (CLIA) number — a 10-character identifier issued by CMS to certify clinical laboratories. CLIA numbers appear on lab orders, lab reports, and Medicare claims for laboratory services, and they are a common form of PHI in healthcare text.

Format (per CMS): NN D NNNNNNN

  • Positions 1–2: 2-digit numeric state code
  • Position 3: literal letter D (designates "lab")
  • Positions 4–10: 7-digit unique sequence

Example: 11D2030122. Reference: https://www.cms.gov/medicare/quality/clinical-laboratory-improvement-amendments

Why no checksum?

CLIA numbers do not have a publicly documented check-digit algorithm. The base regex therefore carries a low confidence (0.1 weak / 0.4 with separators), and the recognizer leans on context words (CLIA, lab, laboratory, clinical laboratory, lab id, lab number, …) to reach a confident match via the analyzer's context-enhancement layer. Degenerate sequences where all 7 trailing digits are identical (e.g. 11D0000000, 11D1111111) are rejected in invalidate_result as obvious placeholders. This matches the regex-only-with-context approach already used elsewhere in the codebase (e.g. UsMbiRecognizer, AbaRoutingRecognizer's weak tier).

What changed

  • New file: presidio-analyzer/presidio_analyzer/predefined_recognizers/country_specific/us/us_clia_recognizer.pyUsCliaRecognizer(PatternRecognizer) with COUNTRY_CODE = "us", SUPPORTED_ENTITY = "US_CLIA", two patterns (weak / with separators), 8 context words, and an invalidate_result that filters degenerate trailing sequences.
  • Registry plumbing: imported and re-exported from both predefined_recognizers/__init__.py and predefined_recognizers/country_specific/us/__init__.py, with __all__ updated.
  • YAML: new entry in presidio-analyzer/presidio_analyzer/conf/default_recognizers.yaml with enabled: false and country_code: us, matching the convention used by UsMbiRecognizer and UsNpiRecognizer.
  • Tests: new presidio-analyzer/tests/test_us_clia_recognizer.py with 12 parametrized cases (valid, lowercase d, dashed, spaced, multi-match, malformed, degenerate) plus 5 behavior tests (supported_entity, supported_language, context words, country code).
  • Docs: docs/supported_entities.md row added; CHANGELOG.md Unreleased Analyzer/Added bullet.

Issue reference

No existing issue tracks this; CLIA was a notable gap in the US healthcare-PII coverage alongside the already-present US_NPI, US_MBI, and MEDICAL_LICENSE (DEA) recognizers.

How to verify

cd presidio-analyzer
pytest tests/test_us_clia_recognizer.py -v

All 17 tests pass. The new module has 100% line coverage (measured via coverage run --source=...us_clia_recognizer -m pytest tests/test_us_clia_recognizer.py).

Smoke check:

from presidio_analyzer.predefined_recognizers import UsCliaRecognizer

r = UsCliaRecognizer()
r.analyze("Laboratory ID 11D2030122 on the report", ["US_CLIA"])
# -> [type: US_CLIA, start: 14, end: 24, score: 0.1]
# (Score is then context-boosted by AnalyzerEngine via the "laboratory" context word.)

Checklist

  • I have reviewed the contribution guidelines
  • I have signed the CLA (if required) — will sign when the CLA-bot fires on PR open
  • My code includes unit tests
  • All unit tests and lint checks pass locally
  • My PR contains documentation updates / additions if required

CLIA (Clinical Laboratory Improvement Amendments) numbers are 10-character
identifiers issued by CMS to certify clinical laboratories. They appear on
lab orders, lab reports, and Medicare claims for laboratory services.

Format: NN D NNNNNNN (2 digits, literal 'D', 7 digits).

There is no publicly documented checksum for CLIA numbers, so the base
regex carries a low confidence score (0.1) and the recognizer relies on
context words ('CLIA', 'lab', 'laboratory', etc.) to reach a meaningful
score. Degenerate trailing sequences (all identical digits) are rejected
via invalidate_result.

- New recognizer: UsCliaRecognizer (entity US_CLIA, COUNTRY_CODE us)
- Registered in default_recognizers.yaml (enabled: false, matching MBI/NPI)
- 17 parametrized + behavior tests; 100% line coverage on the new module
- CHANGELOG and supported_entities.md updated
@microsoft-github-policy-service
Copy link
Copy Markdown
Contributor

@Manas103 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

name=name,
)

def invalidate_result(self, pattern_text: str) -> bool: # noqa: D102
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this doesn't add additional guards over the regex, I would suggest to remove it.

[
# fmt: off
# Valid CLIA, weak base score (no separators, no context)
("11D2030122", 1, ((0, 10),), ((0.0, 0.4),),),
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add another example where the CLIA number is in the middle of a sentence

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds first-class Presidio Analyzer coverage for US CLIA (Clinical Laboratory Improvement Amendments) identifiers by introducing a new predefined, US-specific pattern recognizer and wiring it into the registry, tests, and public documentation.

Changes:

  • Added UsCliaRecognizer (US_CLIA) as a country-specific predefined PatternRecognizer with weak/medium regex tiers plus placeholder/degenerate-value invalidation.
  • Exported the recognizer through the predefined recognizers package and registered it in default_recognizers.yaml (disabled by default).
  • Added unit tests, updated supported entities documentation, and documented the change in CHANGELOG.md.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
presidio-analyzer/presidio_analyzer/predefined_recognizers/country_specific/us/us_clia_recognizer.py Implements the new US CLIA recognizer with patterns, context terms, and invalidation logic.
presidio-analyzer/presidio_analyzer/predefined_recognizers/country_specific/us/init.py Re-exports UsCliaRecognizer from the US country-specific package.
presidio-analyzer/presidio_analyzer/predefined_recognizers/init.py Re-exports UsCliaRecognizer from the top-level predefined recognizers package.
presidio-analyzer/presidio_analyzer/conf/default_recognizers.yaml Registers UsCliaRecognizer as predefined, US-tagged, and disabled by default.
presidio-analyzer/tests/test_us_clia_recognizer.py Adds unit coverage for matching, boundaries, scoring ranges, and metadata expectations.
docs/supported_entities.md Documents the new US_CLIA entity type in the supported entities list.
CHANGELOG.md Adds an Unreleased Analyzer “Added” entry for the new recognizer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants