Patient Type

Patient type represents demographic and identification information

Updated

The birthDate and gender properties are now optional in the Patient type of the Web SDK v2.1.1.

Overview

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;
  kind?: string;
  name: {
    use: string;
    family: string;
    given: string[];
    suffix: string[];
  };
  birthDate: string;
  gender: "MALE" | "FEMALE" | "UNKNOWN";
};

Properties

Hide properties

birthDate · string

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

gender · MALE | FEMALE | UNKNOWN

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

identifier · string · required

Unique identifier for the patient

kind · string

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

name · object · required

Patient name information

name.family · string · required

Family name (last name)

name.given · string[] · required

Given names (first names)

name.suffix · string[] · required

Name suffixes

name.use · string · required

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