Patient Type

Patient type represents demographic and identification information. The code snippet below shows how to use the Patient type to create a patient object.

JavaScript

type Patient = {
  identifier: string; // max 36 characters
  kind?: string;
  name: {
    use: string;
    family: string;
    given: string[];
    suffix: string[];
  };
  birthDate: string;
  gender: "MALE" | "FEMALE" | "UNKNOWN";
};

Properties

Hide properties

string

Optional - Date of birth in YYYY-MM-DD format.

MALE | FEMALE | UNKNOWN

Optional - Patient’s gender. Use “UNKNOWN” if gender information is not available.

string

required

Unique identifier for the patient. Must be a string at most 36 characters (), for example an EMR patient key.

string

Kind of patient (e.g., “human”, “animal”).

object

required

Patient name information.

string

required

Family name (last name).

string[]

required

Given names (first names).

string[]

required

Name suffixes.

string

required

Use of the name (e.g., “usual”, “official”, “nickname”).

Last modified on August 13, 2026

Get Started

Concepts & Feature Guides

API Reference

Resources

Patient Type

Properties

​Properties

Properties