POST

/medical/v1/patient

x-api-key*
curl --request POST \
  --url https://api.sandbox.metriport.com/medical/v1/patient \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "firstName": "<firstname>",
  "lastName": "<lastname>",
  "dob": "<dob>",
  "genderAtBirth": "<genderatbirth>",
  "address": "<address>"
}'

Query Params

facilityIdrequired
string

The ID of the Facility where the Patient is receiving care.

Body

The more demographic info you can provide about a Patient, the higher chances Metriport will be able to find a match. 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"].

firstNamerequired
string

The Patient’s first name(s).

lastNamerequired
string

The Patient’s last name(s).

dobrequired
string

The Patient’s date of birth (DOB), formatted YYYY-MM-DD as per ISO 8601.

genderAtBirthrequired
string

The Patient’s gender at birth, can be one of M or F.

personalIdentifiers
PersonalIdentifier[]

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

addressrequired
Address[]

An array of Address objects, representing the Patient’s current and/or previous addresses. May be empty.

contact
Contact[]

An array of Contact objects, representing the Patient’s current and/or previous contact information. May be empty.

Response

idrequired
string

The ID assigned to this Patient. This ID will be used to uniquely identify this Patient in medical documents.

firstNamerequired
string[]

The Patient’s first name(s).

lastNamerequired
string[]

The Patient’s last name(s).

dobrequired
string

The Patient’s date of birth (DOB), formatted YYYY-MM-DD as per ISO 8601.

genderAtBirthrequired
string

The Patient’s gender at birth, can be one of M or F.

personalIdentifiers
PersonalIdentifier[]

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

addressrequired
Address[]
contact
Contact[]
facilityIdsrequired
string[]

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.createPatient(
  {
    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: "jose@domain.com",
      },
    ],
  },
  "2.16.840.1.113883.3.666.5.2004.4.2005"
);
{
  "id": "2.16.840.1.113883.3.666.777",
  "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"
  }],
  "facilityIds": [
    "2.16.840.1.113883.3.666.5.2004.4.2005"
  ]
}