helix.personmatching
Entrypoint
helix_personmatching/matchers/matcher.py
Inputs
This code takes in:
- A source Patient/Person resource or a Bundle of Patient/Person resources
- A target Patient/Person resource or a Bundle of Patient/Person resources
- A set of rule options/weights
- Whether to return only successful matches or all match results
- (Optional) Matching threshold (between 0 and 1). Can also be set as an environment variable:
PERSON_MATCH_THRESHOLD - (Optional) Average score boost (between 0 and 1). Can also be set as an environment variable:
PERSON_MATCH_AVERAGE_SCORE_BOOST
Outputs
- A list of match results where id_source is id of source record and id_target is id of matched record.
Logic
- The code runs through each rule and calculates a uniqueness probability (between 0 and 1) if the rule matches.
- The code then picks the rule with the highest uniqueness probability and uses that probability
- The code then calculates the average of all the other rule probabilities and boosts the uniqueness probability by it.
- The code then sees if any other boosting rules were requested and boosts the probability by those
Weights
There are five cases when matching fields of two records in a rule and the weights that are applied for each case:
- Field present in both sides and match ->
exact_match - Field present in both sides and partial match ->
partial_match - Field missing in both sides ->
missing - Field missing in one side ->
missing - Field present in both sides but do not match -> 0.0
For boosting rules, there is an additional boost weight.
Metadata
Release files for helix.personmatching 3.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| helix_personmatching-3.0.1.tar.gz | 63.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| helix_personmatching-3.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 164.3 kB
Release files / helix_personmatching-3.0.1.tar.gz
| Download URL | helix_personmatching-3.0.1.tar.gz |
|---|---|
| Size | 63.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ea9c3857a13c7f7c9df538cf7b70c0fa130e645dbd05e3fcb151c895f0a90527
|
|
BLAKE2b-256 checksum How to use checksums |
f70660004f7f8eac136977b2c20a28385af882270812bec4b08fed296fc90fe6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / helix_personmatching-3.0.1-py3-none-any.whl
| Download URL | helix_personmatching-3.0.1-py3-none-any.whl |
|---|---|
| Size | 101.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ac7ae630214714d07abe7a00c7fdb977419aa2c8b8f39aabe92c2680ef743a6e
|
|
BLAKE2b-256 checksum How to use checksums |
c355b42981fed773cecaa1ee647f99ab3c399c56d70a71fbad58b054dd1136d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|