Skip to main content
POST
/
medical
/
v1
/
patient
/
match
Match Patient
curl --request POST \
  --url https://api.sandbox.metriport.com/medical/v1/patient/match \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "dob": "<string>",
  "genderAtBirth": "<string>",
  "personalIdentifiers": [
    {
      "type": "<string>",
      "state": "<string>",
      "value": "<string>"
    }
  ],
  "address": [
    {
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>"
    }
  ],
  "contact": [
    {
      "phone": "<string>",
      "email": "<string>"
    }
  ]
}
'
import { MetriportMedicalApi, USState } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const patient = await metriport.matchPatient(
  {
    firstName: "Jose",
    lastName: "Juarez",
    dob: "1951-05-05",
    genderAtBirth: "M",
    personalIdentifiers: [
      {
        type: "driversLicense",
        state: USState.CA,
        value: "51227265",
      },
    ],
    address: [
      {
        zip: "12345",
        city: "San Diego",
        state: USState.CA,
        country: "USA",
        addressLine1: "Guadalajara Street"
      },
    ],
    contact: [
      {
        phone: "1234567899",
        email: "[email protected]",
      },
    ],
  },
);

​
Body

The more demographic information you can provide about a Patient, the higher chances Metriport will be able to find a match previously created in Metriport. For example: nicknames, old addresses, multiple phone numbers, a pre-marital last name, etc.
You may provide a comma/space delimited string to specify multiple first and last names. For example, the following inputs would be equivalent: "John,Jonathan" & "John Jonathan" - these would translate to ["John", "Jonathan"].
​
firstName
string
required
The Patient's first name(s).
​
lastName
string
required
The Patient's last name(s).
​
dob
string
required
The Patient's date of birth (DOB), formatted YYYY-MM-DD as per ISO 8601.
​
genderAtBirth
string
required
The Patient's gender at birth, can be one of M or F or O or U. Use O (other) when the patient's gender is known but it is not M or F, i.e intersex or hermaphroditic. Use U (unknown) when the patient's gender is not known.
​
personalIdentifiers
PersonalIdentifier[]
An array of the Patient's personal IDs, such as a driver's license or SSN. May be empty.
​
address
Address[]
required
An array of Address objects, representing the Patient's current and/or previous addresses.
The first address in the array determines the primary address for the patient. The primary address is used for patient monitoring, specifically for ADT events. You can change which address is the primary address by simply re-ordering the address array using the PUT patient endpoint. Learn more about patient monitoring and cohorts.
​
contact
Contact[]
An array of Contact objects, representing the Patient's current and/or previous contact information. May be empty.

​
Response

​
id
string
required
The ID assigned to this Patient. This ID will be used to uniquely identify this Patient in medical documents.
​
externalId
string
The ID of the Patient on your internal system to associate to a Patient in Metriport.
​
additionalIds
AdditionalIdentifiers
A map containing additional external identifiers. If the patient is created or mapped in Metriport through one of our EHR apps - this property will be populated with the ID from the EHR, and included within the webhook payloads.
​
firstName
string[]
required
The Patient's first name(s).
​
lastName
string[]
required
The Patient's last name(s).
​
dob
string
required
The Patient's date of birth (DOB), formatted YYYY-MM-DD as per ISO 8601.
​
genderAtBirth
string
required
The Patient's gender at birth, can be one of M or F or O or U. Use O (other) when the patient's gender is known but it is not M or F, i.e intersex or hermaphroditic. Use U (unknown) when the patient's gender is not known.
​
personalIdentifiers
PersonalIdentifier[]
An array of the Patient's personal IDs, such as a driver's license. May be empty.
​
address
Address[]
required
​
contact
Contact[]
​
facilityIds
string[]
required
Array of the IDs of the Facilities where the Patient is receiving care.
import { MetriportMedicalApi, USState } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const patient = await metriport.matchPatient(
  {
    firstName: "Jose",
    lastName: "Juarez",
    dob: "1951-05-05",
    genderAtBirth: "M",
    personalIdentifiers: [
      {
        type: "driversLicense",
        state: USState.CA,
        value: "51227265",
      },
    ],
    address: [
      {
        zip: "12345",
        city: "San Diego",
        state: USState.CA,
        country: "USA",
        addressLine1: "Guadalajara Street"
      },
    ],
    contact: [
      {
        phone: "1234567899",
        email: "[email protected]",
      },
    ],
  },
);

{
  "id": "018a80c4-292a-7486-a1234-76yuhe23yu14",
  "externalId": "1234567890",
  "additionalIds": { 
    "athenahealth": ["43210"], 
    "canvas": ["1234567890"], 
    "elation": ["0987654321"] 
  },
  "facilityIds": ["018a80c4-292a-7486-a1234-9uiu76yhe234"],
  "firstName": "Jose",
  "lastName": "Juarez",
  "dob": "1951-05-05",
  "genderAtBirth": "M",
  "personalIdentifiers": [
    {
      "type": "driversLicense",
      "state": "CA",
      "value": "51227265"
    }
  ],
  "address": [
    {
      "zip": "12345",
      "city": "San Diego",
      "state": "CA",
      "country": "USA",
      "addressLine1": "Guadalajara St"
    }
  ],
  "contact": [
    {
      "phone": "1234567899",
      "email": "[email protected]"
    }
  ],
}