Skip to main content

helix.personmatching

Continuous Integration GitHub license

Entrypoint

helix_personmatching/matchers/matcher.py

Inputs

This code takes in:

  1. A source Patient/Person resource or a Bundle of Patient/Person resources
  2. A target Patient/Person resource or a Bundle of Patient/Person resources
  3. A set of rule options/weights
  4. Whether to return only successful matches or all match results
  5. (Optional) Matching threshold (between 0 and 1). Can also be set as an environment variable: PERSON_MATCH_THRESHOLD
  6. (Optional) Average score boost (between 0 and 1). Can also be set as an environment variable: PERSON_MATCH_AVERAGE_SCORE_BOOST

Outputs

  1. A list of match results where id_source is id of source record and id_target is id of matched record.

Logic

  1. The code runs through each rule and calculates a uniqueness probability (between 0 and 1) if the rule matches.
  2. The code then picks the rule with the highest uniqueness probability and uses that probability
  3. The code then calculates the average of all the other rule probabilities and boosts the uniqueness probability by it.
  4. 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:

  1. Field present in both sides and match -> exact_match
  2. Field present in both sides and partial match -> partial_match
  3. Field missing in both sides -> missing
  4. Field missing in one side -> missing
  5. 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)

Source distribution for helix.personmatching 3.0.1
File Size Uploaded
helix_personmatching-3.0.1.tar.gz 63.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for helix.personmatching 3.0.1
File Interpreter ABI Platform
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

Release history Release notifications | RSS feed

This release

3.0.1 This release

2 release files

3.0.0

2 release files

2.20

2 release files

2.3.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.0.64

2 release files

1.0.63

2 release files

1.0.62

2 release files

1.0.59

2 release files

1.0.58

2 release files

1.0.57

2 release files

1.0.53

2 release files

1.0.52

2 release files

1.0.51

2 release files

1.0.50

2 release files

1.0.49

2 release files

1.0.48

2 release files

1.0.47

2 release files

1.0.46

2 release files

1.0.42

2 release files

1.0.41

2 release files

1.0.40

2 release files

1.0.39

2 release files

1.0.37

2 release files

1.0.32

2 release files

1.0.31

2 release files

1.0.30

2 release files

1.0.28

2 release files

1.0.27

2 release files

1.0.26

2 release files

1.0.25

2 release files

1.0.24

2 release files

1.0.21

2 release files

1.0.20

2 release files

1.0.19

2 release files

1.0.18

2 release files

1.0.17

2 release files

1.0.10

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page