Get Patient by External ID

GET

medical

patient

external-id

curl --request GET \
  --url https://api.sandbox.metriport.com/medical/v1/patient/external-id \
  --header 'x-api-key: <api-key>'

import { MetriportMedicalApi, USState } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const patient = await metriport.getPatientByExternalId("1234567890");

Query Params

externalId

string

The exact external identifier you're trying to find. For Athena external identifiers, it must include the practice prefix (e.g. a-12345.E-6789).

source

string

If not included, Metriport will search along the custom external identifier submitted at patient create as externalId. If included, it must be athenahealth, elation, or canvas, and will filter along the respective EHR patient identifiers of Metriport patients.

Response

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.

Show AdditionalIdentifiers properties

athenahealth

string[]

Athena patient ID. If more than one patient in Athena maps to a Metriport patient, they will all be included.

canvas

string[]

Canvas patient ID. If more than one patient in Canvas maps to a Metriport patient, they will all be included.

elation

string[]

Elation Patient ID. If more than one patient in Elation maps to a Metriport patient, they will all be included.

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.

Show PersonalIdentifier properties

type

string

required

The ID type - currently driversLicense is supported.

state

string

required

The 2 letter state acronym where this ID was issued, for example: CA.

value

string

required

The ID number.

address

Address[]

required

Show properties

addressLine1

string

The address.

addressLine2

string

The address details, for example: #4451.

city

string

The city.

state

string

The 2 letter state acronym, for example: CA.

zip

string

required

5 digit zip code.

country

string

required

Always "USA".

contact

Contact[]

Show properties

phone

string

The Patient's 10 digit phone number, formatted 1234567899.

string

The Patient's email address.

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.getPatientByExternalId("1234567890");

{
  "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": "jose@domain.com"
    }
  ],
}

curl --request GET \
  --url https://api.sandbox.metriport.com/medical/v1/patient/external-id \
  --header 'x-api-key: <api-key>'

import { MetriportMedicalApi, USState } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const patient = await metriport.getPatientByExternalId("1234567890");

GET

medical

patient

external-id

curl --request GET \
  --url https://api.sandbox.metriport.com/medical/v1/patient/external-id \
  --header 'x-api-key: <api-key>'

import { MetriportMedicalApi, USState } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const patient = await metriport.getPatientByExternalId("1234567890");

Query Params

externalId

string

The exact external identifier you're trying to find. For Athena external identifiers, it must include the practice prefix (e.g. a-12345.E-6789).

source

string

Response

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

Show AdditionalIdentifiers properties

athenahealth

string[]

Athena patient ID. If more than one patient in Athena maps to a Metriport patient, they will all be included.

canvas

string[]

Canvas patient ID. If more than one patient in Canvas maps to a Metriport patient, they will all be included.

elation

string[]

Elation Patient ID. If more than one patient in Elation maps to a Metriport patient, they will all be included.

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

personalIdentifiers

PersonalIdentifier[]

An array of the Patient's personal IDs, such as a driver's license. May be empty.

Show PersonalIdentifier properties

type

string

required

The ID type - currently driversLicense is supported.

state

string

required

The 2 letter state acronym where this ID was issued, for example: CA.

value

string

required

The ID number.

address

Address[]

required

Show properties

addressLine1

string

The address.

addressLine2

string

The address details, for example: #4451.

city

string

The city.

state

string

The 2 letter state acronym, for example: CA.

zip

string

required

5 digit zip code.

country

string

required

Always "USA".

contact

Contact[]

Show properties

phone

string

The Patient's 10 digit phone number, formatted 1234567899.

string

The Patient's email address.

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.getPatientByExternalId("1234567890");

{
  "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": "jose@domain.com"
    }
  ],
}

curl --request GET \
  --url https://api.sandbox.metriport.com/medical/v1/patient/external-id \
  --header 'x-api-key: <api-key>'

import { MetriportMedicalApi, USState } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const patient = await metriport.getPatientByExternalId("1234567890");

Get Patient by External ID

Query Params

Response

Getting Started

API Reference

Get Patient by External ID

Query Params

Response

​Query Params

​Response

Getting Started

API Reference

​Query Params

​Response

Query Params

Response

Query Params

Response