{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-PublicAPI/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"TxCases V1 — Developer Guide"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"txcases-v1--developer-guide","__idx":0},"children":["TxCases 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-procedures-and-treatment/txcases-(v1)"},"children":["TxCases (V1) Endpoint Documentation"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Treatment-plan ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["cases"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TxCaseV1"]},") group planned work for a patient. Creating a case also creates a treatment option and a first ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["visit"]}," that holds the supplied ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["patient procedures"]},". Procedures are not returned on the case itself — read them from ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/endpoints/visits-v1"},"children":["Visits V1"]}]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/endpoints/patientprocedures-v1"},"children":["PatientProcedures V1"]}]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide covers the published ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TxCases V1"]}," operations: bulk list, get by id, create, update, delete, calculated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isCompleted"]},", case amount, and total count."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There is no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/txcases/async"]}," endpoint."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All TxCases V1 endpoints require an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Organization-ID"]}," header."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["⚠️ Rate Limited:"]}," TxCases endpoints are 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":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{"id":"get-bulk-list-txcases"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET — Bulk List TxCases"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a paginated list of treatment cases matching the filter criteria."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters","__idx":1},"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":["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 (default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]},", maximum ",{"$$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 txCase ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from the previous page — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["preferred"]}," cursor"]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["✅ Recommended:"]}," Use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]},". Combine with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModified"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.id"]}," to keep queries narrow."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"filter-keys","__idx":2},"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":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=patient.id==12000006542062"]}]}]},{"$$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":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.id=="]}," resolves to cases on that patient's treatment plan. If the patient has no plan in the organization, the result is empty (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data: []"]},")."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["⚠️ Date-limiting filters:"]}," If you omit a date-limiting filter such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModified"]},", one may be applied automatically. Supply your own date bound for predictable results."]}]},{"$$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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.id"]}," can return ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["408"]}," on large tenants."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ordering:"]}," Bulk GET does not apply a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModified"]}," sort. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}," means ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id > previousId"]},". Pass the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["largest"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from the previous page."]}]},{"$$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 cases matched; it does not indicate invalid filter values."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}," is present, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["meta.pagination.total"]}," is omitted. Use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get--total-count"},"children":["total count"]}," when you need a count. 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":"Heading","attributes":{"level":3,"id":"example-requests","__idx":3},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cases for a patient modified after a date:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases?pageSize=100&filter=patient.id==12000006542062,lastModified>=2025-01-01T00:00:00Z\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cases for one patient only:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases?pageSize=100&filter=patient.id==12000006542062\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Subset of fields:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases?responseFields=name,status,patient&filter=patient.id==12000006542062\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Next page — send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}," as the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["largest"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from the previous ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," array (not the last row if that row is not the max ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"):"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases?pageSize=100&lastId=9000000000123&filter=patient.id==12000006542062,lastModified>=2025-01-01T00:00:00Z\n"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{"id":"get-txcase-by-id"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET — TxCase by ID"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a single treatment case. Missing or non-numeric ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["txCaseId"]}," → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["404"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-1","__idx":4},"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":["txCaseId"]}]},{"$$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 case ID (numeric, minimum ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]},")"]}]},{"$$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-requests-1","__idx":5},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full case:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases/9000000000123\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Subset of fields:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases/9000000000123?responseFields=name,status,patient\n"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{"id":"post-create-txcase"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST — Create TxCase"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a treatment case. Returns ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["201"]}," with the created resource in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Side effects:"]}," Creating a case also creates a treatment option and a first visit (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["duration"]}," 60) that contains the supplied patient procedures. Those procedures are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," returned on the TxCase body — list ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/endpoints/visits-v1"},"children":["visits"]}]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter=txCase.id==<id>"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Linked-model writes are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"id\": … }"]}," only. Do not send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"required-fields","__idx":6},"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":["user"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Linked user ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"id\": <userId> }"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Linked patient ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"id\": <patientId> }"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["1–50 characters. Unique per patient treatment plan"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["procedures"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Patient procedures ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"id\": <patientProcedureId> }"]}," to place on the first visit"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"optional-fields","__idx":7},"children":["Optional 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":["note"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Max 250 characters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["showNote"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Whether the note is shown in the planner"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expirationDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["date"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Must be a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["future"]}," date when set"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["showExpirationDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Whether the expiration date is shown"]}]},{"$$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":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NEW"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PRESENTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCEPTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]},". Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NEW"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerSignature"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Linked signature ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"id\": … }"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["witnessSignature"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Linked signature ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"id\": … }"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerSignatureDate"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["witnessSignatureDate"]}," are set when the matching signature is sent. Do not write those dates."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"conditional--scenario-notes","__idx":8},"children":["Conditional / scenario notes"]},{"$$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":"Scenario"},"children":["Scenario"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Extra rule"},"children":["Extra rule"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Duplicate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," for the same patient"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TxCase with name '…' already exists"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["procedures"]}," element missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," or wrong type"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]}," — each element must be a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PatientProcedureV1"]}," id"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Empty body"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--required-fields-only","__idx":9},"children":["Example — required fields only"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v1/txcases\nContent-Type: application/json\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"user\": { \"id\": 12000006542001 },\n  \"patient\": { \"id\": 12000006542062 },\n  \"name\": \"Recommended treatment\",\n  \"procedures\": [{ \"id\": 8000000000456 }]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--note-expiration-and-status","__idx":10},"children":["Example — note, expiration, and status"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v1/txcases\nContent-Type: application/json\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"user\": { \"id\": 12000006542001 },\n  \"patient\": { \"id\": 12000006542062 },\n  \"name\": \"Present at next recare\",\n  \"procedures\": [{ \"id\": 8000000000456 }],\n  \"note\": \"Discuss crown vs implant\",\n  \"showNote\": true,\n  \"expirationDate\": \"2026-12-31\",\n  \"showExpirationDate\": false,\n  \"status\": \"PRESENTED\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--signatures-on-create","__idx":11},"children":["Example — signatures on create"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v1/txcases\nContent-Type: application/json\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"user\": { \"id\": 12000006542001 },\n  \"patient\": { \"id\": 12000006542062 },\n  \"name\": \"Signed case\",\n  \"procedures\": [{ \"id\": 8000000000456 }],\n  \"providerSignature\": { \"id\": 7000000000100 },\n  \"witnessSignature\": { \"id\": 7000000000101 }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerSignatureDate"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["witnessSignatureDate"]},". Do not send those dates."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--duplicate-name-400","__idx":12},"children":["Example — duplicate name (400)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A second POST with the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," for the same patient:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v1/txcases\nContent-Type: application/json\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"user\": { \"id\": 12000006542001 },\n  \"patient\": { \"id\": 12000006542062 },\n  \"name\": \"Recommended treatment\",\n  \"procedures\": [{ \"id\": 8000000000457 }]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]}," with source ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--invalid-procedures-400","__idx":13},"children":["Example — invalid procedures (400)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Practice procedure ids (or a missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},") are rejected. Each element must be a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["patient"]}," procedure:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"user\": { \"id\": 12000006542001 },\n  \"patient\": { \"id\": 12000006542062 },\n  \"name\": \"Bad procedures\",\n  \"procedures\": [{ \"id\": \"a\" }]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]}," with source ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["procedures"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{"id":"put-update-txcase"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PUT — Update TxCase"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updates the case identified by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["txCaseId"]},". Only included properties change. Missing case → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["404"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user"]}," is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["frozen"]}," after create — omit it on PUT."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-2","__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":["txCaseId"]}]},{"$$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 case 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":"writable-properties","__idx":15},"children":["Writable properties"]},{"$$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":"Property"},"children":["Property"]},{"$$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":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["1–50 characters; uniqueness still applies"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["note"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["showNote"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Same rules as create"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expirationDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["showExpirationDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Future date when set"]}]},{"$$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":["NEW"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PRESENTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCEPTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerSignature"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["witnessSignature"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"id\": … }"]}," only"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sending the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["already saved"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is a no-op: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["200"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," may be omitted from the response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--note-and-status","__idx":16},"children":["Example — note and status"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"PUT /api/v1/txcases/9000000000123\nContent-Type: application/json\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"note\": \"Accepted at consult\",\n  \"status\": \"ACCEPTED\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--rename","__idx":17},"children":["Example — rename"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"PUT /api/v1/txcases/9000000000123\nContent-Type: application/json\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"name\": \"Accepted treatment plan\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Duplicate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," on the same patient plan → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--expiration","__idx":18},"children":["Example — expiration"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"PUT /api/v1/txcases/9000000000123\nContent-Type: application/json\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"expirationDate\": \"2026-12-31\",\n  \"showExpirationDate\": true\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--signatures","__idx":19},"children":["Example — signatures"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"PUT /api/v1/txcases/9000000000123\nContent-Type: application/json\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"providerSignature\": { \"id\": 7000000000100 },\n  \"witnessSignature\": { \"id\": 7000000000101 }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--same-status-no-op","__idx":20},"children":["Example — same status (no-op)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the case is already ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCEPTED"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"PUT /api/v1/txcases/9000000000123\nContent-Type: application/json\n"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"status\": \"ACCEPTED\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["200"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," may be omitted from the response."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{"id":"delete-txcase"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["DELETE — TxCase"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deletes the case. Query ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleteType"]}," is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]},". Missing or invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleteType"]}," → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]},". Missing case → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["404"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-3","__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":["txCaseId"]}]},{"$$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 case 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":["deleteType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$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":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MOVE_AND_DELETE"]}]}]}]}]}]},{"$$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":"deleteType"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleteType"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Behavior"},"children":["Behavior"]}]}]},{"$$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":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Soft-cancels patient procedures on the case’s visits and deletes the visits and case"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MOVE_AND_DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Unassigns those procedures in Treatment Planner, then deletes the case"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--cancel-procedures-and-delete","__idx":22},"children":["Example — cancel procedures and delete"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /api/v1/txcases/9000000000123?deleteType=DELETE\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--unassign-procedures-and-delete","__idx":23},"children":["Example — unassign procedures and delete"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /api/v1/txcases/9000000000123?deleteType=MOVE_AND_DELETE\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--missing-deletetype-400","__idx":24},"children":["Example — missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleteType"]}," (400)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /api/v1/txcases/9000000000123\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--invalid-deletetype-400","__idx":25},"children":["Example — invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleteType"]}," (400)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /api/v1/txcases/9000000000123?deleteType=INVALID_TYPE\n"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{"id":"get-calculated-txcases"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET — Calculated (bulk)"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isCompleted"]}," for one or more cases. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}," are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}," is not valid."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isCompleted"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," when the case’s patient procedures are completed."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-4","__idx":26},"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":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->"]}," (IN)"]}]},{"$$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":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Must include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isCompleted"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," is also allowed. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}," is not valid"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}," or an unknown name → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-requests-2","__idx":27},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases/calculated?filter=ids->[9000000000123,9000000000124]&responseFields=isCompleted\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}," → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases/calculated?filter=ids->[9000000000123]\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}," is not valid → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases/calculated?filter=ids->[9000000000123]&responseFields=ALL\n"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{"id":"get-calculated-txcase-by-id"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET — Calculated by ID"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Same calculated fields for one case. Missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["txCaseId"]}," → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["404"]},". Missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}," → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-requests-3","__idx":28},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases/9000000000123/calculated?responseFields=isCompleted\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}," → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases/9000000000123/calculated\n"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{"id":"get-txcase-amount"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET — Amount by ID"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns fee totals for the case and a row per visit. Missing case → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["404"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The case total field is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["caseTotal"]}]}," (not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["caseAmount"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-data-fields","__idx":29},"children":["Response ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," 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":["caseTotal"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Sum of visit amounts"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Sum of visit discounts"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["guarantorPortion"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Sum of visit guarantor portions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["visits"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Per-visit rows"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"visit-row-fields","__idx":30},"children":["Visit row fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["visitId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Th"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surface"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provider"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discount"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["guarantorPortion"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":31},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases/9000000000123/amount\n"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{"id":"get-total-count"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET — Total Count"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"totalCount\": <integer> }"]}," for cases matching the same filters as bulk GET (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModified"]},")."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Document only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Organization-ID"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]},". Pagination query parameters are not used on this path."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Count for one patient:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases/totalcount?filter=patient.id==12000006542062\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Count with a date bound:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/txcases/totalcount?filter=patient.id==12000006542062,lastModified>=2025-01-01T00:00:00Z\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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":"details","attributes":{"id":"streaming-txcases"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["StreamAPI Webhooks"]}," — click to expand"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For real-time case creates, updates, and deletes, use StreamAPI webhooks (SNS) instead of polling bulk GET. Setup: ",{"$$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":["Domain type ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TxCaseV1"]}]},". Operations: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CREATE"]}]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UPDATE"]}]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creating a case also creates a visit (see ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/endpoints/visits-v1"},"children":["Visits V1"]}]},"), which can emit a separate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VisitV1"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CREATE"]}," event."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{"id":"response-structure-txcases"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response Structure"]}," — click to expand"]},{"$$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":["TxCase record(s), calculated rows, amount object, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ totalCount }"]}]}]},{"$$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":["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":"code","attributes":{},"children":["limit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total"]}," when present)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"txcasev1-object-summary","__idx":32},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TxCaseV1"]}," 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":"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":["Case identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TxCaseV1"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Unique per patient plan"]}]},{"$$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":["NEW"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PRESENTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCEPTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["note"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["showNote"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Planner note"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expirationDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["showExpirationDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Optional expiration"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Required on create; omit on update"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Linked patient"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerSignature"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["witnessSignature"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Linked signatures"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerSignatureDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["witnessSignatureDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Set when the matching signature is sent; do not send on write"]}]},{"$$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":["Last modification timestamp"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"errors--warnings","__idx":33},"children":["Errors & Warnings"]},{"$$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":"Heading","attributes":{"level":4,"id":"400--bad-request","__idx":34},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," — Bad Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Invalid body or query. Common causes: missing required create fields, duplicate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["procedures"]}," linked models, missing or invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleteType"]},", empty or unknown calculated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}," (including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]},"), invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"401--unauthorized","__idx":35},"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":"Heading","attributes":{"level":4,"id":"403--forbidden","__idx":36},"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":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Confirm credentials and organization access with your integration administrator."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"404--not-found","__idx":37},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}," — Not Found"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No case for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["txCaseId"]}," in this organization, or the path id is not a valid numeric id."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"408--request-timeout","__idx":38},"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 request timed out."]}]},{"$$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. Narrow ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModified"]}," and add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.id"]}," on bulk GET."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"429--too-many-requests","__idx":39},"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":"Heading","attributes":{"level":4,"id":"500--unexpected-error","__idx":40},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}," — Unexpected 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":"Heading","attributes":{"level":3,"id":"name","__idx":41},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TxCase with name '…' already exists"]}]},{"$$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":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Another case on the same patient plan already uses that name."]}]},{"$$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":["Choose a unique ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"procedures","__idx":42},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["procedures"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error:"]}," Each element must be an object with an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PatientProcedureV1"]}]},{"$$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":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["A list entry is null, missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", or not a patient procedure."]}]},{"$$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":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"id\": <patientProcedureId> }"]}," for existing chart procedures — not practice procedure ids."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"deletetype","__idx":43},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleteType"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleteType must have a value in [DELETE,MOVE_AND_DELETE]"]}]},{"$$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":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The query is missing or not one of the two values."]}]},{"$$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":["Add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?deleteType=DELETE"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?deleteType=MOVE_AND_DELETE"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"calculated-responsefields","__idx":44},"children":["Calculated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error:"]}," List of calculated fields should not be empty / field does not exist"]},{"$$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":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}," was omitted or included a name other than ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isCompleted"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]}]},{"$$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":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields=isCompleted"]},". Do not send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"status","__idx":45},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status should not be empty"]}," / invalid enum"]},{"$$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":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," was ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," or not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NEW"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PRESENTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCEPTED"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]},"."]}]},{"$$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":["Omit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," to leave it unchanged, or send a valid enum value."]}]}]}]}]}]}]},"headings":[{"value":"TxCases V1 — Developer Guide","id":"txcases-v1--developer-guide","depth":1},{"value":"Parameters","id":"parameters","depth":3},{"value":"Filter Keys","id":"filter-keys","depth":3},{"value":"Example Requests","id":"example-requests","depth":3},{"value":"Parameters","id":"parameters-1","depth":3},{"value":"Example Requests","id":"example-requests-1","depth":3},{"value":"Required Fields","id":"required-fields","depth":3},{"value":"Optional Fields","id":"optional-fields","depth":3},{"value":"Conditional / scenario notes","id":"conditional--scenario-notes","depth":3},{"value":"Example — required fields only","id":"example--required-fields-only","depth":3},{"value":"Example — note, expiration, and status","id":"example--note-expiration-and-status","depth":3},{"value":"Example — signatures on create","id":"example--signatures-on-create","depth":3},{"value":"Example — duplicate name (400)","id":"example--duplicate-name-400","depth":3},{"value":"Example — invalid procedures (400)","id":"example--invalid-procedures-400","depth":3},{"value":"Parameters","id":"parameters-2","depth":3},{"value":"Writable properties","id":"writable-properties","depth":3},{"value":"Example — note and status","id":"example--note-and-status","depth":3},{"value":"Example — rename","id":"example--rename","depth":3},{"value":"Example — expiration","id":"example--expiration","depth":3},{"value":"Example — signatures","id":"example--signatures","depth":3},{"value":"Example — same status (no-op)","id":"example--same-status-no-op","depth":3},{"value":"Parameters","id":"parameters-3","depth":3},{"value":"Example — cancel procedures and delete","id":"example--cancel-procedures-and-delete","depth":3},{"value":"Example — unassign procedures and delete","id":"example--unassign-procedures-and-delete","depth":3},{"value":"Example — missing deleteType (400)","id":"example--missing-deletetype-400","depth":3},{"value":"Example — invalid deleteType (400)","id":"example--invalid-deletetype-400","depth":3},{"value":"Parameters","id":"parameters-4","depth":3},{"value":"Example Requests","id":"example-requests-2","depth":3},{"value":"Example Requests","id":"example-requests-3","depth":3},{"value":"Response data fields","id":"response-data-fields","depth":3},{"value":"Visit row fields","id":"visit-row-fields","depth":3},{"value":"Example Request","id":"example-request","depth":3},{"value":"TxCaseV1 object (summary)","id":"txcasev1-object-summary","depth":3},{"value":"Errors & Warnings","id":"errors--warnings","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 — Unexpected Error","id":"500--unexpected-error","depth":4},{"value":"name","id":"name","depth":3},{"value":"procedures","id":"procedures","depth":3},{"value":"deleteType","id":"deletetype","depth":3},{"value":"Calculated responseFields","id":"calculated-responsefields","depth":3},{"value":"status","id":"status","depth":3}],"frontmatter":{"title":"TxCasesV1","toc":true,"description":"Guide to TxCases V1 — bulk list, get by id, create, update, delete, calculated fields, amount, total count, and lastId recommendations","seo":{"title":"TxCases V1 — Developer Guide"}},"lastModified":"2026-09-14T23:40:20.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/publicapi/endpoints/txcases-v1","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}