{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-PublicAPI/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Patients V1 — Developer Guide","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"patients-v1--developer-guide","__idx":0},"children":["Patients V1 — Developer Guide"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://papidocs.hs1api.com/publicapi/api-patient-management/patients-(v1)"},"children":["Patients (V1) Endpoint Documentation"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Patient records are the core identity for scheduling, clinical, and billing integrations. This guide covers the published ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Patients V1"]}," operations: bulk list, get by id, create, update, calculated fields, and total count."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/patients/async"]}]},", see ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/endpoints/async-v1"},"children":["Async Endpoints V1 — Developer Guide"]}]},". Async returns the first 10 results immediately and streams the full result set to the Streaming API. Results on the async endpoint are ordered by ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," descending"]}," (newest first), unlike the synchronous bulk GET which pages by ascending ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get--bulk-list-patients","__idx":1},"children":["GET — Bulk List Patients"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a paginated list of patients matching the filter criteria."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["⚠️ Rate Limited:"]}," This endpoint is rate limited. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://papidocs.hs1api.com/publicapi/api-consumer-guide#rate-limiting"},"children":["rate limiting guide"]}," for details."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters","__idx":2},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Organization-ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The organization ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Filter criteria (see filter keys below)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["URL-encoded comma-delimited list of fields to include, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Page number for pagination (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["deprecated"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Number of records per page (max ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Largest ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientId"]}," from the previous page — used for cursor-based pagination"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"filter-keys","__idx":3},"children":["Filter Keys"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Filter Key"},"children":["Filter Key"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Operators"},"children":["Operators"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=id->[12000006542062,12000006542063]"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["~="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<>="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=firstName~=Smi"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["~="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<>="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=lastName==Doe"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gender"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=gender==M"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preferredName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["~="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<>="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=preferredName~=John"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateOfBirth"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=dateOfBirth==1985-08-25"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=patientStatus==ACTIVE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phones.number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=phones.number==5551234567"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["emailAddress"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=emailAddress==john.doe@example.com"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["chartNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".absent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".present"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=chartNumber==CH10023456"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preferredLocation.id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=preferredLocation.id->[64000000000004]"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["primaryGuarantor.id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=primaryGuarantor.id==12000006542062"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["duplicateOfPatient.id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=duplicateOfPatient.id==12000006542062"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["primaryContact.id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=primaryContact.id==12000006542062"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstVisitDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[">"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[">="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=firstVisitDate>=2024-01-01"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModified"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":[">"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[">="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=lastModified>=2025-01-01T00:00:00Z"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referredByPatient.id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=referredByPatient.id==12000006542062"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referredByReferral.id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=referredByReferral.id==500"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"patientstatus-values","__idx":4},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientStatus"]}," Values"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NEW"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NON-PATIENT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INACTIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DUPLICATE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DISMISSED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DECEASED"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"gender-values","__idx":5},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gender"]}," Values"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["M"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["F"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["O"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"preferredlocationid--all-locations","__idx":6},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preferredLocation.id"]}," — All Locations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use a specific location id, a list via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->"]},", or all locations with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->[\"ALL\"]"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->[\"*\"]"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"important-notes","__idx":7},"children":["Important Notes"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["⚠️ Upcoming Breaking Change:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preferredLocation.id"]}," (as a list of IDs or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"ALL\"]"]},") will become a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}," filter. Omitting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preferredLocation.id"]}," currently defaults to all locations during a transitional period."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["⚠️ Date-limiting filters:"]}," If you do not supply a date-limiting filter, one may be applied automatically using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModified"]},". Supply your own date bound for predictable results. The following filter keys count as date-limiting: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModified"]}]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdDate"]}]},", and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedDate"]}]},"."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["⚠️ Narrow your query:"]}," A very wide ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModified"]}," range with no other scoping can return ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["408"]}," (timeout) on large tenants. Combine name, chart, contact, or location filters with a date bound, or use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}," pagination."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["⚠️ Not Recommended:"]}," Do ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," paginate large data sets using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," parameter. Use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}]}," cursor pagination instead."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Empty results:"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["200"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data: []"]}," means no patients matched; it does not indicate invalid filter values."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-requests","__idx":8},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch patients modified after a date at specific locations:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients?pageSize=500&filter=lastModified>=2025-01-01T00:00:00Z,preferredLocation.id->[64000000000004]\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch patients for a primary guarantor:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients?filter=primaryGuarantor.id==12000006542062,lastModified>=2025-01-01T00:00:00Z\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"paginating-with-lastid","__idx":9},"children":["Paginating with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}," uses the patient's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," as a cursor. When filtering by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModified"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstVisitDate"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateOfBirth"]},", combine those filters with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}," for stable pagination. Results are ordered by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," for paging."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-1--initial-request","__idx":10},"children":["Step 1 — Initial request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients?pageSize=500&filter=lastModified>=2025-01-01T00:00:00Z,preferredLocation.id->[64000000000004]\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-2--subsequent-requests","__idx":11},"children":["Step 2 — Subsequent requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pass the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," of the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["last"]}," record in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients?lastId=22000012345678&pageSize=500&filter=lastModified>=2025-01-01T00:00:00Z,preferredLocation.id->[64000000000004]\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-3--repeat","__idx":12},"children":["Step 3 — Repeat"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Continue until ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," is empty."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For how ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["meta.pagination.total"]}," behaves (including when it is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]}," or omitted), see ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/bulk-get-total-count"},"children":["Bulk GET — Total Count Behavior"]}]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get--patient-by-id","__idx":13},"children":["GET — Patient by ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a single patient by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientId"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-1","__idx":14},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["path"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The patient ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Organization-ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The organization ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Comma-delimited list of fields to include, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":15},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients/12000006542062?responseFields=firstName,lastName,chartNumber\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"post--create-patient","__idx":16},"children":["POST — Create Patient"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a new patient. Returns ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["201"]}," with the created resource in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"required-fields","__idx":17},"children":["Required Fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["1–25 characters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["1–25 characters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contactMethod"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Call me"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Text me"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Email me"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["languageType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["See schema enum (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["English"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Spanish"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#patientstatus-values"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientStatus"]}," values"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gender"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["M"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["F"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["O"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateOfBirth"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["ISO date ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preferredLocation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Linked model reference to a location"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["1–50 characters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["city"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["1–30 characters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["US state/territory code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postalCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["5–10 characters"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"conditional-fields","__idx":18},"children":["Conditional Fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Condition"},"children":["Condition"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Required"},"children":["Required"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discountType: BASIC"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discountPlan"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discountType: SLIDING_FEES"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["income"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["familySize"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-body","__idx":19},"children":["Example Request Body"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Smith\",\n  \"contactMethod\": \"Email me\",\n  \"languageType\": \"English\",\n  \"patientStatus\": \"ACTIVE\",\n  \"gender\": \"F\",\n  \"dateOfBirth\": \"1990-03-15\",\n  \"preferredLocation\": { \"id\": \"64000000000004\" },\n  \"address1\": \"123 Maple Street\",\n  \"city\": \"Anytown\",\n  \"state\": \"CA\",\n  \"postalCode\": \"90210\",\n  \"emailAddress\": \"jane.smith@example.com\",\n  \"phones\": [\n    {\n      \"phoneType\": \"MOBILE\",\n      \"number\": \"5551234567\",\n      \"sequence\": 1\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"put--update-patient","__idx":20},"children":["PUT — Update Patient"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updates an existing patient. Only fields included in the request body are changed; omitted fields are unchanged."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-2","__idx":21},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["path"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The patient ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Organization-ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The organization ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Comma-delimited list of fields to include in the response, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-1","__idx":22},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"PUT /api/v1/patients/12000006542062\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"patientStatus\": \"INACTIVE\",\n  \"emailAddress\": \"jane.smith.new@example.com\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get--calculated-fields","__idx":23},"children":["GET — Calculated Fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/patients/calculated"]}," returns computed fields per patient row."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]}]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}]}," are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"filter-keys-1","__idx":24},"children":["Filter Keys"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Filter Key"},"children":["Filter Key"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Operators"},"children":["Operators"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=patient.id==12000006542062"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"supported-calculated-fields","__idx":25},"children":["Supported Calculated Fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastVisitDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Most recent visit date derived from appointments and patient procedures"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-2","__idx":26},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients/calculated?filter=patient.id->[12000006542062]&responseFields=lastVisitDate\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get--total-count","__idx":27},"children":["GET — Total Count"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients/totalcount\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Uses the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["same filter syntax and filter keys"]}," as bulk GET. See ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/bulk-get-total-count"},"children":["Bulk GET — Total Count Behavior"]}]}," for how ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pagination.total"]}," behaves on bulk GET responses."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-3","__idx":28},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients/totalcount?filter=lastModified>=2025-01-01,preferredLocation.id==64000000000004\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"patient-billing-types","__idx":29},"children":["Patient Billing Types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Patient billing types are managed on a nested path under the patient:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/patients/{patientId}/billingtypes"]}]}," — list billing types for a patient"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v1/patients/{patientId}/billingtypes"]}]}," — replace all billing types for the patient (existing types are removed and replaced by the request body)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the official API reference under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Patient Billing Types"]}," for schema details."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"streaming-api","__idx":30},"children":["Streaming API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For real-time patient creates and updates, use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Streaming API"]}," instead of polling bulk GET on a fixed schedule. Setup is covered in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/streamapi-webhooks-setup"},"children":["Creating and Setting Up Webhooks for the StreamAPI"]}]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Patients are streamable under domain type ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PatientV1"]}]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-structure","__idx":31},"children":["Response Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]}," response returns:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["object or array"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Patient record(s)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warnings"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Non-fatal warnings"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Field-level or structural errors"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For bulk GET, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," is an array and includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["meta.pagination"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"metapagination","__idx":32},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["meta.pagination"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Page size used for this request"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Record offset applied"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Present only on plain bulk GET without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," — typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]}," (see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/bulk-get-total-count"},"children":["Bulk GET — Total Count Behavior"]},")"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"patientv1-object-summary","__idx":33},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PatientV1"]}," Object (summary)"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Access"},"children":["Access"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read-only"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Unique patient identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preferredName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read/write"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Name fields"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gender"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateOfBirth"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read/write"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Demographics and status"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["chartNumber"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["emailAddress"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read/write"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Chart and contact"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phones"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read/write"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Array of phone records"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["preferredLocation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read/write"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Linked location"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["primaryGuarantor"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["secondaryGuarantor"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read/write"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Linked patient guarantors"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["primaryContact"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["secondaryContact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read/write"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Linked patient contacts"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address1"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address2"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["city"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postalCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read/write"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstVisitDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModified"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read-only"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Timestamps"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referredByPatient"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referredByReferral"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read/write"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Referral links"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referredPatients"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["read-only"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Patients referred by this patient"]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the authoritative field list, enums, and validation rules, use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PatientV1"]}]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PatientUpdateV1"]}]}," schemas in the official API reference."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"errors--warnings-reference","__idx":34},"children":["Errors & Warnings Reference"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Status Code Errors"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These apply to all Patients V1 endpoints."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"400--bad-request","__idx":35},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," — Bad Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The request body or query parameters are invalid or cannot be processed. Common causes include invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]}," syntax, missing required fields on POST, or missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/calculated"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"401--unauthorized","__idx":36},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}," — Unauthorized"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Authentication is required and has failed or has not been provided."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Provide a valid Bearer token in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"403--forbidden","__idx":37},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," — Forbidden"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The request is understood, but it has been refused or access is not allowed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Token lacks ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model:read"]}," (GET) or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model:write"]}," (POST/PUT) scope."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Request the appropriate scope for the operation."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"404--not-found","__idx":38},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}," — Not Found"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The requested resource is either missing or does not exist."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No patient exists for the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientId"]}," in your organization, or the id is invalid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Confirm the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientId"]}," and organization context."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"408--request-timeout","__idx":39},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["408"]}," — Request Timeout"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The server timed out while processing the request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Query too broad — often a wide date range without location or name scoping."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retry with a narrower ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]}," or smaller ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"429--too-many-requests","__idx":40},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]}," — Too Many Requests"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Rate limit exceeded."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Implement exponential backoff. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://papidocs.hs1api.com/publicapi/api-consumer-guide#rate-limiting"},"children":["rate limiting guide"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"500--internal-server-error","__idx":41},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}," — Internal Server Error"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["An unexpected error occurred."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retry. If the issue persists, contact support."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Field-Level Validation"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Validation errors are returned in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]}," array on ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]}," responses. Common cases on create/update include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Missing required fields (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gender"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateOfBirth"]},", address fields, etc.)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientStatus"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gender"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contactMethod"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["languageType"]}," enum values"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discountType: BASIC"]}," without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discountPlan"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discountType: SLIDING_FEES"]}," without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["income"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["familySize"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Duplicate phone ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sequence"]}," values within the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phoneType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateOfBirth"]}," format (must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]},")"]}]}]}]},"headings":[{"value":"Patients V1 — Developer Guide","id":"patients-v1--developer-guide","depth":1},{"value":"GET — Bulk List Patients","id":"get--bulk-list-patients","depth":2},{"value":"Parameters","id":"parameters","depth":3},{"value":"Filter Keys","id":"filter-keys","depth":3},{"value":"patientStatus Values","id":"patientstatus-values","depth":4},{"value":"gender Values","id":"gender-values","depth":4},{"value":"preferredLocation.id — All Locations","id":"preferredlocationid--all-locations","depth":4},{"value":"Important Notes","id":"important-notes","depth":3},{"value":"Example Requests","id":"example-requests","depth":3},{"value":"Paginating with lastId","id":"paginating-with-lastid","depth":2},{"value":"Step 1 — Initial request","id":"step-1--initial-request","depth":3},{"value":"Step 2 — Subsequent requests","id":"step-2--subsequent-requests","depth":3},{"value":"Step 3 — Repeat","id":"step-3--repeat","depth":3},{"value":"GET — Patient by ID","id":"get--patient-by-id","depth":2},{"value":"Parameters","id":"parameters-1","depth":3},{"value":"Example Request","id":"example-request","depth":3},{"value":"POST — Create Patient","id":"post--create-patient","depth":2},{"value":"Required Fields","id":"required-fields","depth":3},{"value":"Conditional Fields","id":"conditional-fields","depth":3},{"value":"Example Request Body","id":"example-request-body","depth":3},{"value":"PUT — Update Patient","id":"put--update-patient","depth":2},{"value":"Parameters","id":"parameters-2","depth":3},{"value":"Example Request","id":"example-request-1","depth":3},{"value":"GET — Calculated Fields","id":"get--calculated-fields","depth":2},{"value":"Filter Keys","id":"filter-keys-1","depth":3},{"value":"Supported Calculated Fields","id":"supported-calculated-fields","depth":3},{"value":"Example Request","id":"example-request-2","depth":3},{"value":"GET — Total Count","id":"get--total-count","depth":2},{"value":"Example Request","id":"example-request-3","depth":3},{"value":"Patient Billing Types","id":"patient-billing-types","depth":2},{"value":"Streaming API","id":"streaming-api","depth":2},{"value":"Response Structure","id":"response-structure","depth":2},{"value":"meta.pagination","id":"metapagination","depth":3},{"value":"PatientV1 Object (summary)","id":"patientv1-object-summary","depth":3},{"value":"Errors & Warnings Reference","id":"errors--warnings-reference","depth":2},{"value":"400 — Bad Request","id":"400--bad-request","depth":4},{"value":"401 — Unauthorized","id":"401--unauthorized","depth":4},{"value":"403 — Forbidden","id":"403--forbidden","depth":4},{"value":"404 — Not Found","id":"404--not-found","depth":4},{"value":"408 — Request Timeout","id":"408--request-timeout","depth":4},{"value":"429 — Too Many Requests","id":"429--too-many-requests","depth":4},{"value":"500 — Internal Server Error","id":"500--internal-server-error","depth":4}],"frontmatter":{"title":"PatientsV1","toc":true,"description":"Guide to Patients V1 — bulk list, get by id, create, update, calculated fields, total count, and integration recommendations","seo":{"title":"Patients V1 — Developer Guide"}},"lastModified":"2026-07-22T20:47:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/publicapi/endpoints/patients-v1","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}