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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

helix_personmatching-2.20.tar.gz (61.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

helix_personmatching-2.20-py3-none-any.whl (100.4 kB view details)

Uploaded Python 3

File details

Details for the file helix_personmatching-2.20.tar.gz.

File metadata

  • Download URL: helix_personmatching-2.20.tar.gz
  • Upload date:
  • Size: 61.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for helix_personmatching-2.20.tar.gz
Algorithm Hash digest
SHA256 c4d6230fb300baba4f97f0d1e9a11b07f09ce48166d02385a3ffb5241818b561
MD5 dae5cf120739b7215dd9806ce3e1e333
BLAKE2b-256 464e1b5d4b8d648ea9643663bde265cdc4e29697863960d660f133f748c2109f

See more details on using hashes here.

File details

Details for the file helix_personmatching-2.20-py3-none-any.whl.

File metadata

File hashes

Hashes for helix_personmatching-2.20-py3-none-any.whl
Algorithm Hash digest
SHA256 47f40bdcafc7b51bc08688efe43a2c590b296e10ba9456469f5950bc0cbc9b79
MD5 c03738dacf38758c52a4e9d848c225a1
BLAKE2b-256 62e2dc6162d1eae930b1d91b6ded61cde6d2c585dbf7d411ae41b679e5cf9553

See more details on using hashes here.

Release history Release notifications | RSS feed

3.0.0

2 files

This release

2.20 This release

2 files

2.3.0

2 files

2.1.0

2 files

2.0.0

2 files

1.0.64

2 files

1.0.63

2 files

1.0.62

2 files

1.0.61

2 files

1.0.60

2 files

1.0.59

2 files

1.0.58

2 files

1.0.57

2 files

1.0.53

2 files

1.0.52

2 files

1.0.51

2 files

1.0.50

2 files

1.0.49

2 files

1.0.48

2 files

1.0.47

2 files

1.0.46

2 files

1.0.42

2 files

1.0.41

2 files

1.0.40

2 files

1.0.39

2 files

1.0.37

2 files

1.0.36

2 files

1.0.35

2 files

1.0.34

2 files

1.0.33

2 files

1.0.32

2 files

1.0.31

2 files

1.0.30

2 files

1.0.28

2 files

1.0.27

2 files

1.0.26

2 files

1.0.25

2 files

1.0.24

2 files

1.0.23

2 files

1.0.22

2 files

1.0.21

2 files

1.0.20

2 files

1.0.19

2 files

1.0.18

2 files

1.0.17

2 files

1.0.16

2 files

1.0.15

2 files

1.0.14

2 files

1.0.13

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.0.1

2 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