Using the API
Frequently Asked Questions
Tutorials
BMPI Operations
- Add or Update Record
- Add or Update Record (Blinded)
- Get Person by Record
- Get Person by ID
- Match Demographics
- Match Demographics (Blinded)
- Delete Record
- Add Match Guidance
- Remove Match Guidance
Local Hashing Service
Metrics
Add or Update Record
POST /mpi/v1/record/{source}/{identifier}
Adds a new record to the BMPI or updates a previously created one. Returns the record’s assigned person ID, along with any changes to the BMPI resulting from the addition or update.
Partial updates are not supported; an update will completely replace the existing record. See Understanding Matching for details.
Contents
Path Parameters
The system from which the record demographics were sourced.
The unique identifier of the record within the source. This will be stored directly in the BMPI (not hashed or encrypted), so consider what kind of identifiers are suitable to your use case.
Body Data
A HL7 administrative gender category code (i.e., male, female, other, unknown).
A HL7 race category code (e.g., 2054-5 means “Black or African American”).
Date of birth in yyyy/mm/dd format.
Street address.
Two-letter state abbreviation.
Postal or Zip code.
A medical record number, often used by electronic medical record systems.
A Health Card Identifier, such as an enrollee ID on an insurance plan.
Either the full 9 or last 4 digits of a Social Security Number.
The Medicaid ID number.
Response Data
The primary person matched in this operation.
The stable identifier for this person used across records (“Person ID”).
The constituent records that represent this person.
A source system with an internal means of identifying individuals.
The unique identifier of the record within the source. This will be stored directly in the BMPI (not hashed or encrypted), so consider what kind of identifiers are suitable to your use case.
The BMPI version of the person. As records are added or removed, this number will be incremented.
One of: Active or Retired. A record is retired when the original record has been superceded by new record(s).
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.
Other persons that were changed in the process of adding/updating this record.
The stable identifier for this person used across records (“Person ID”).
The constituent records that represent this person.
A source system with an internal means of identifying individuals.
The unique identifier of the record within the source. This will be stored directly in the BMPI (not hashed or encrypted), so consider what kind of identifiers are suitable to your use case.
The BMPI version of the person. As records are added or removed, this number will be incremented.
One of: Active or Retired. A record is retired when the original record has been superceded by new record(s).
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.
Contains advisory messages about the operation.
A list of demographic field names that were not used for matching because they contained invalid values.
