{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-PublicAPI/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Async Endpoints 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":"async-endpoints-v1--developer-guide","__idx":0},"children":["Async Endpoints V1 — Developer Guide"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These endpoints retrieve records ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["asynchronously"]},". When called, they return the first 10 matching results immediately in the HTTP response body, while simultaneously streaming all matching records to the Streaming API using a routing key."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Async requests are limited to a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," of 10 for the immediate response. All async endpoints require an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Organization-ID"]}," header."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following async endpoints are available:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get--v1patients-async"},"children":["GET /v1/patients/async"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get--v1events-async"},"children":["GET /v1/events/async"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get--v1appointments-async"},"children":["GET /v1/appointments/async"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get--v1imageattachments-async"},"children":["GET /v1/imageattachments/async"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get--v1locationproductionnetschedule-async"},"children":["GET /v1/locationproductionnetschedule/async"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get--v1patientsasync","__idx":1},"children":["GET — /v1/patients/async"]},{"$$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":"p","attributes":{},"children":["Retrieves patients asynchronously. Returns the first 10 results immediately and streams all matching records to the Streaming API."]},{"$$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":["Your organization identifier"]}]},{"$$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 expression. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#patients-filter-keys"},"children":["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 return. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}," for all fields"]}]},{"$$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":["The largest ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientId"]}," from the previous page — used for cursor-based pagination"]}]},{"$$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 offset-based pagination"]}]},{"$$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":["Page size — limited to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["10"]}," for async requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"patients-filter-keys","__idx":3},"children":["Patients 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":"Supported Operators"},"children":["Supported Operators"]}]}]},{"$$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":[{"$$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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patientStatus"]}," valid values: ",{"$$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":"code","attributes":{},"children":["gender"]}," valid values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["M"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["F"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["O"]},"."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ordering:"]}," Results on this async endpoint are returned in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["descending"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," order (newest first). The synchronous ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/patients"]}]}," bulk endpoint pages by ascending ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},". See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/endpoints/patients-v1"},"children":["Patients V1 — Developer Guide"]}," for the full bulk GET filter list (including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id->[…]"]},", which is documented on sync bulk GET but not listed here)."]}]},{"$$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 it currently defaults to all locations."]}]},{"$$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":"Heading","attributes":{"level":3,"id":"example-requests","__idx":4},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch all patients modified after a date:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients/async?filter=lastModified>=2025-01-01T00:00:00Z,preferredLocation.id->[64000000000004]\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Paginate using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients/async?lastId=22000012345678&filter=lastModified>=2025-01-01T00:00:00Z,preferredLocation.id->[64000000000004]\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get--v1eventsasync","__idx":5},"children":["GET — /v1/events/async"]},{"$$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-appointment-management/events-(v1)"},"children":["Events (V1) Endpoint Documentation"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves events asynchronously. Returns the first 10 results immediately and streams all matching records to the Streaming API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For full Events V1 documentation — including all filter keys, create/update/delete semantics, recurrence, and field reference — see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/endpoints/events-v1"},"children":["Events V1 — Developer Guide"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-1","__idx":6},"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":["Your organization identifier"]}]},{"$$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 expression. Same keys as ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/endpoints/events-v1#filter-keys"},"children":["GET /v1/events"]}]}]},{"$$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 return. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}," for all fields"]}]},{"$$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":["The largest ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventId"]}," from the previous page — used for cursor-based pagination"]}]},{"$$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 offset-based pagination"]}]},{"$$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":["Page size — limited to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["10"]}," for async requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-requests-1","__idx":7},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch events modified after a date at a specific location:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/events/async?filter=lastModified>=2025-01-01T00:00:00Z,location.id->[64000000000004]\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Paginate using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/events/async?lastId=500&filter=lastModified>=2025-01-01T00:00:00Z,location.id->[64000000000004]\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get--v1appointmentsasync","__idx":8},"children":["GET — /v1/appointments/async"]},{"$$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-appointment-management/appointments-(v1)"},"children":["Appointments (V1) Endpoint Documentation"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves appointments asynchronously. Returns the first 10 results immediately and streams all matching records to the Streaming API."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-2","__idx":9},"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":["Your organization identifier"]}]},{"$$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 expression. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#appointments-filter-keys"},"children":["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 return. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}," for all fields"]}]},{"$$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":["The largest ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["appointmentId"]}," from the previous page — used for cursor-based pagination"]}]},{"$$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 offset-based pagination"]}]},{"$$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":["Page size — limited to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["10"]}," for async requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"appointments-filter-keys","__idx":10},"children":["Appointments 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":"Supported Operators"},"children":["Supported Operators"]}]}]},{"$$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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["needsFollowUp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["operatory.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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["location.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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provider.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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["asap"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]}]},{"$$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":"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":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Upcoming Breaking Change:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["location.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 it currently defaults to all locations."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," valid values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LATE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HERE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["READY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CHAIR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPLETED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONFIRMED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNCONFIRMED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NO_SHOW"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BROKEN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LEFT_MESSAGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CHECKOUT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WILL_CALL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNREACHABLE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CANCELLEDBYOFFICE"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-requests-2","__idx":11},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch appointments modified after a date at a specific location:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/appointments/async?filter=lastModified>=2025-01-01T00:00:00Z,location.id->[64000000000004]\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Paginate using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/appointments/async?lastId=8000052360370&filter=lastModified>=2025-01-01T00:00:00Z,location.id->[64000000000004]\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get--v1imageattachmentsasync","__idx":12},"children":["GET — /v1/imageattachments/async"]},{"$$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-document-management/imageattachments-(v1)"},"children":["ImageAttachments (V1) Endpoint Documentation"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a list of image attachments with async support via the Streaming API."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," Async retrieval for image attachments is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["only"]}," available via this ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/async"]}," endpoint. The regular ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/imageattachments"]}," endpoint does not support async or streaming."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-3","__idx":13},"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":["Your organization identifier"]}]},{"$$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 expression. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#imageattachments-filter-keys"},"children":["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 return. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}," for all fields"]}]},{"$$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":["The largest image attachment ID from the previous page — used for cursor-based pagination"]}]},{"$$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 offset-based pagination"]}]},{"$$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":["Page size — limited to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["10"]}," for async requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"imageattachments-filter-keys","__idx":14},"children":["ImageAttachments 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":"Supported Operators"},"children":["Supported Operators"]}]}]},{"$$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":"code","attributes":{},"children":["->"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insuranceClaim.id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-requests-3","__idx":15},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch image attachments by insurance claim:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/imageattachments/async?filter=insuranceClaim.id==456\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch a specific set of attachments by ID:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/imageattachments/async?filter=id->[123,124,125]\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get--v1locationproductionnetscheduleasync","__idx":16},"children":["GET — /v1/locationproductionnetschedule/async"]},{"$$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-reports-and-analytics/locationproductionnetschedule-(v1)"},"children":["Production Net Schedule Report (V1) Endpoint Documentation"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns production total net schedule reports asynchronously based on filter criteria."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-4","__idx":17},"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":["Your organization identifier"]}]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Filter expression. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fromDate"]}," is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]},". See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#locationproductionnetschedule-filter-keys"},"children":["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 return. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}," for all fields"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"locationproductionnetschedule-filter-keys","__idx":18},"children":["LocationProductionNetSchedule 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":"Supported Operators"},"children":["Supported Operators"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Notes"},"children":["Notes"]}]}]},{"$$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":["fromDate"]}]},{"$$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":"strong","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Start date for the report (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2025-01-14"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["location.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":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Filter by location. Defaults to all locations. Will become required in a future release"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provider.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":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Mutually exclusive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["appointment.id"]}]}]},{"$$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":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Mutually exclusive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provider.id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["appointment.id"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["appointment.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":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Mutually exclusive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provider.id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.id"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["range"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Number of days for the report window. Maximum ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["31"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timezone"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Timezone for the report (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["America/New_York"]},"). Defaults to organization timezone"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isPrimaryWriteOff"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Deprecated"]}," — do not use in new implementations"]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provider.id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.id"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["appointment.id"]}," are mutually exclusive — only one may be used per request."]}]},{"$$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":["location.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 it currently defaults to all locations."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-requests-4","__idx":19},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch production net schedule report for a date range at a location:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/locationproductionnetschedule/async?filter=fromDate==2025-01-14,range==7,location.id->[64000000000004]\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch report for a specific provider:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/locationproductionnetschedule/async?filter=fromDate==2025-01-14,provider.id==789\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-structure","__idx":20},"children":["Response Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All async endpoints return a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response with the following top-level structure:"]},{"$$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":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The first 10 matching records. All remaining records are streamed via the Streaming API"]}]},{"$$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 (operation still succeeded)"]}]},{"$$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":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"paginating-with-lastid","__idx":21},"children":["Paginating with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}," is the recommended approach for iterating through large result sets on async endpoints. It uses the record's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," as a cursor rather than an offset."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-1--initial-request","__idx":22},"children":["Step 1 — Initial Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send your first request without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients/async?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":23},"children":["Step 2 — Subsequent Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Take the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," of the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["last record"]}," in the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," array and pass it as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}," in the next request:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/patients/async?lastId=22000012345678&filter=lastModified>=2025-01-01T00:00:00Z,preferredLocation.id->[64000000000004]\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-3--repeat","__idx":24},"children":["Step 3 — Repeat"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Continue until the response returns an empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," array or no-more-data indicator."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"streaming-api","__idx":25},"children":["Streaming API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Async endpoints deliver the complete result set to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Streaming API"]}," in parallel with the immediate HTTP response. To consume the streamed data, your application must be subscribed to the Streaming API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/streamapi-webhooks-setup"},"children":["Streaming API Webhooks Setup Guide"]}," for full setup instructions."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"errors--warnings-reference","__idx":26},"children":["Errors & Warnings Reference"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$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 Async V1 endpoints."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"400--bad-request","__idx":27},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," — Bad Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The request query parameters are invalid or cannot be processed. Check that all required filters are provided and values are the correct type."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"401--unauthorized","__idx":28},"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":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No valid auth token was sent, the token is expired, or the token is malformed."]}]},{"$$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":29},"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":["The authenticated token does not have the required scope. Read operations require ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model:read"]},"."]}]},{"$$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 a token that includes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model:read"]}," scope."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"404--not-found","__idx":30},"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 records matching the provided filters exist within your organization."]}]},{"$$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 your filter values are correct and belong to your organization."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"408--request-timeout","__idx":31},"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":["The server took too long to respond, often due to high server load."]}]},{"$$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 the request. If the issue persists, contact support with the request details and timestamp."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"429--too-many-requests","__idx":32},"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":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Your client has made too many requests in a short period of time."]}]},{"$$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 and retry logic. Reduce request frequency. 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":33},"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":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["An unhandled server-side 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 the request. If the issue persists, contact support with the request details and timestamp."]}]}]}]}]}]}]},"headings":[{"value":"Async Endpoints V1 — Developer Guide","id":"async-endpoints-v1--developer-guide","depth":1},{"value":"GET — /v1/patients/async","id":"get--v1patientsasync","depth":2},{"value":"Parameters","id":"parameters","depth":3},{"value":"Patients Filter Keys","id":"patients-filter-keys","depth":4},{"value":"Example Requests","id":"example-requests","depth":3},{"value":"GET — /v1/events/async","id":"get--v1eventsasync","depth":2},{"value":"Parameters","id":"parameters-1","depth":3},{"value":"Example Requests","id":"example-requests-1","depth":3},{"value":"GET — /v1/appointments/async","id":"get--v1appointmentsasync","depth":2},{"value":"Parameters","id":"parameters-2","depth":3},{"value":"Appointments Filter Keys","id":"appointments-filter-keys","depth":4},{"value":"Example Requests","id":"example-requests-2","depth":3},{"value":"GET — /v1/imageattachments/async","id":"get--v1imageattachmentsasync","depth":2},{"value":"Parameters","id":"parameters-3","depth":3},{"value":"ImageAttachments Filter Keys","id":"imageattachments-filter-keys","depth":4},{"value":"Example Requests","id":"example-requests-3","depth":3},{"value":"GET — /v1/locationproductionnetschedule/async","id":"get--v1locationproductionnetscheduleasync","depth":2},{"value":"Parameters","id":"parameters-4","depth":3},{"value":"LocationProductionNetSchedule Filter Keys","id":"locationproductionnetschedule-filter-keys","depth":4},{"value":"Example Requests","id":"example-requests-4","depth":3},{"value":"Response Structure","id":"response-structure","depth":2},{"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":"Streaming API","id":"streaming-api","depth":2},{"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":"Async Endpoints","toc":true,"description":"Guide to the async endpoints — returns the first 10 results immediately and streams all matching records to the Streaming API","seo":{"title":"Async Endpoints V1 — Developer Guide"}},"lastModified":"2026-08-06T21:50:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/publicapi/endpoints/async-v1","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}