Match Demographics

POST /mpi/v1/match

Finds all persons and their associated records that match the provided demographics. This operation is read-only, and will not create or update any person records.

Body Data

firstName string
middleName string
lastName string
maidenName string
gender string

A HL7 administrative gender category code (i.e., male, female, other, unknown).

race string

A HL7 race category code (e.g., 2054-5 means “Black or African American”).

homePhoneNumber string
cellPhoneNumber string
email string
dob string

Date of birth in yyyy/mm/dd or yyyy-mm-dd format.

street string

Street address.

city string
state string

Two-letter state abbreviation.

zipCode string

Postal or Zip code.

mrn string

A medical record number, often used by electronic medical record systems.

hcid string

A Health Card Identifier, such as an enrollee ID on an insurance plan.

ssn string

Either the full 9 or last 4 digits of a Social Security Number.

medicaidId string

The Medicaid ID number.

Response Data

matchingPersons collection

List of matched persons. string

The stable identifier for this person used across records (“Person ID”).

matchingPersons.records collection

The constituent records that represent this person.

matchingPersons.records.source string

A source system with an internal means of identifying individuals.

matchingPersons.records.identifier string

The unique identifier of the record within the source. This will be stored directly in the Identity service (not hashed or encrypted), so consider what kind of identifiers are suitable to your use case.

matchingPersons.version integer

As records are added or removed, this version number will be incremented.

matchingPersons.status object
matchingPersons.status.code string

One of: Active or Retired. A record is retired when the original record has been superceded by new record(s).

matchingPersons.status.supercededBy collection<string

If the person’s constituent records were merged into another person, this will contain the id for that person.

If the person’s constituent records were split into two or more persons, this will contain the ids for those persons.

advisories object

Contains advisory messages about the operation.

advisories.invalidDemographicFields collection

A list of demographic field names that were not used for matching because they contained invalid values.