Natzar Partner API Reference - v1.0.0
    Preparing search index...

    Interface PatientSummary

    The patient as a CLINICIAN'S screen needs them — the header of a queue row, an inbox thread, a call panel. Embedded on consult resources when the read is made with a physician credential, so a physician-facing UI can render a list of consults without one GET /v1/patients/{id} per row.

    Deliberately a subset of PatientResource: no phone, no email, no channel — a physician working a queue needs to know WHO is next, not how to reach them outside the consult. Every field but id is optional because the platform's own patients (those our agent opened consults for) are not always provisioned with the full record your POST /v1/patients requires.

    interface PatientSummary {
        id: string;
        externalId?: string;
        givenName?: string;
        familyName?: string;
        birthdate?: string;
        sex?: PatientSex;
        lang?: PatientLang;
        state?: string;
    }
    Index
    id externalId? givenName? familyName? birthdate? sex? lang? state?
    id: string

    Our id of the patient — the same value as patientId on the consult.

    externalId?: string

    Your id of the patient, when API-provisioned.

    givenName?: string

    Given (first) name, if known.

    familyName?: string

    Family (last) name, if known.

    birthdate?: string

    Date of birth, YYYY-MM-DD, if known.

    sex?: PatientSex

    Biological sex, if known.

    lang?: PatientLang

    Locale of the patient's messages and notices, if set.

    state?: string

    Where the patient is (ISO 3166-2 subdivision, no country prefix), if recorded — the jurisdiction licensure routing was decided against.

    Settings
    Member Visibility

    On This Page
    Properties