Learn · PatientNow Pro

Guides & concepts — PatientNow Pro

The conventions that hold across every PNP resource. Learn these once and the whole API becomes predictable.

Request basics

• Protocol: REST over HTTPS.
• Base URL: https://backend-production.patientnow.net/backend/patientnowpro
• Format: JSON request and response bodies. Send Content-Type: application/json on POST and PUT.
• Verbs: GET reads, POST creates, PUT updates.
• Auth: a single Authorization: YOUR_TOKEN header on every request — no gateway apikey parameter. See Authentication — PatientNow Pro.
• Field naming: JSON properties are camelCase (e.g. firstName, patientId, apptDate). This differs from PNE/VISH which use PascalCase.
• Path scoping: every endpoint is prefixed with /practices/{practiceId}/ — see Practice scoping.

Pagination

All list endpoints use two query parameters:

Walk a collection by incrementing Page until a page returns fewer records than Limit (or an empty data array):

def iter_patients(session, base, practice_id, limit=50, **filters):
    page = 1
    while True:
        res = session.get(
            f"{base}/practices/{practice_id}/patients",
            params={"Page": page, "Limit": limit, **filters},
        )
        res.raise_for_status()
        batch = res.json().get("data", [])
        if not batch:
            return
        yield from batch
        if len(batch) < limit:
            return
        page += 1

async function* iterPatients(base, headers, practiceId, limit = 50, filters = {}) {
  let page = 1;
  for (;;) {
    const qs = new URLSearchParams({ Page: page, Limit: limit, ...filters });
    const res = await fetch(`${base}/practices/${practiceId}/patients?${qs}`, { headers });
    const { data = [] } = await res.json();
    if (!data.length) return;
    yield* data;
    if (data.length < limit) return;
    page++;
  }
}

Filtering & search

Common filter parameters available on list endpoints:

Resource IDs

PNP returns plain integer IDs for all resources — patients, appointments, providers, event types, and so on. They appear directly in path parameters and response bodies:

// A patient response — IDs are integers:
{ "patientId": 12345, "firstName": "Jane", "lastName": "Smith", ... }

// Use the integer directly in the next call:
GET /practices/YOUR_PRACTICE_ID/patients/12345/appointments

• Store them as integers in your system — no need to treat them as opaque strings.
• They're stable for a given record and safe to use as foreign keys.

Dates & times

• Date and date-time fields are ISO 8601 strings. Filter parameters that accept dates (e.g. ApptDate, Start, End) accept YYYY-MM-DD or a full datetime string.
• Nullable date fields may be null when unset — guard for that in your client.
• The LastModified filter accepts an ISO datetime with optional timezone offset; pass UTC for consistent results across environments.

Practice scoping

Every PNP endpoint is rooted under a practice:

https://backend-production.patientnow.net/backend/patientnowpro/practices/{practiceId}/...

Your practiceId is a fixed integer assigned to your practice. All data — patients, appointments, providers, event types — is scoped to it. There is no cross-practice access from a single token.

Errors & status codes

PNP uses standard HTTP status codes. The status line is the primary signal; a JSON problem-details body may accompany errors.