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

    Interface GetPhysicianLicensesResponse

    GET/PUT /v1/physicians/{id}/licenses response.

    interface GetPhysicianLicensesResponse {
        physicianId: string;
        licenses: {
            state: string;
            country?: string;
            licenseNumber?: string;
            expiresAt?: string;
            active?: boolean;
        }[];
        expiringSoon: {
            state: string;
            country?: string;
            licenseNumber?: string;
            expiresAt?: string;
            active?: boolean;
        }[];
        licenseEnforcement: boolean;
    }
    Index
    physicianId licenses expiringSoon licenseEnforcement
    physicianId: string
    licenses: {
        state: string;
        country?: string;
        licenseNumber?: string;
        expiresAt?: string;
        active?: boolean;
    }[]

    Type Declaration

    • state: string
    • Optionalcountry?: string
    • OptionallicenseNumber?: string
    • OptionalexpiresAt?: string

      Local date, YYYY-MM-DD. A lapsed licence stops routing automatically.

    • Optionalactive?: boolean

      Absent/true = usable. False keeps the record but stops routing on it.

    expiringSoon: {
        state: string;
        country?: string;
        licenseNumber?: string;
        expiresAt?: string;
        active?: boolean;
    }[]

    Licences lapsing within 60 days. Surface these: an expired licence removes a physician from the rota with no error anywhere, and the first symptom is a patient being told nobody can see them.

    Type Declaration

    • state: string
    • Optionalcountry?: string
    • OptionallicenseNumber?: string
    • OptionalexpiresAt?: string

      Local date, YYYY-MM-DD. A lapsed licence stops routing automatically.

    • Optionalactive?: boolean

      Absent/true = usable. False keeps the record but stops routing on it.

    licenseEnforcement: boolean

    Whether this tenant actually enforces licensure. False = recorded only.

    Settings
    Member Visibility

    On This Page
    Properties