# Public API – Procedures & Treatment

Operations related to patients, appointments, providers and so on.

Version: 191.0.3

## Servers

Sandbox
```
https://test.hs1api.com/ascend-gateway/api
```

Prod
```
https://prod.hs1api.com/ascend-gateway/api
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

### oAuthSandbox

OAuth 2.0 client credentials (Sandbox)

Type: oauth2
Token URL: https://test.hs1api.com/oauth/client_credential/accesstoken?grant_type=client_credentials
Scopes:

## Download OpenAPI description

 - [Public API – Procedures & Treatment](https://papidocs.hs1api.com/_bundle/PublicAPI/api-procedures-and-treatment.yaml)

 - [GET /v1/globalproceduremappingrules](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/getglobalproceduremappingrulesv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [GET /v1/globalproceduremappingrules/{globalProcedureMappingRuleId}](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/getglobalproceduremappingrulesbyglobalproceduremappingruleidv1.md): Returns the Global Procedure Mapping Rule identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [GET /v1/globalprocedures](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/getglobalproceduresv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [GET /v1/globalprocedures/{procedureId}](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/getglobalproceduresbyprocedureidv1.md): Returns the GlobalProcedure identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [GET /v1/practiceprocedures](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/getpracticeproceduresv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [POST /v1/practiceprocedures](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/postpracticeproceduresv1.md): Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`.
 - [GET /v1/practiceprocedures/{procedureId}](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/getpracticeproceduresbyprocedureidv1.md): Returns the PracticeProcedure identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [PUT /v1/practiceprocedures/{procedureId}](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/putpracticeproceduresbyprocedureidv1.md): Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing.
 - [DELETE /v1/practiceprocedures/{procedureId}](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/deletepracticeproceduresbyprocedureidv1.md): Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted.
 - [GET /v1/procedurecategories](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/getprocedurecategoriesv1.md): **Query shape:** Use the documented query parameters to scope the request. Unscoped queries can **408** (timeout) on large tenants. **Empty results:** **200** with `data: []` means no procedure catego
 - [GET /v1/txcases](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/gettxcasesv1.md): **Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tena
 - [POST /v1/txcases](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/posttxcasesv1.md): Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`.
 - [GET /v1/txcases/calculated](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/gettxcasescalculatedv1.md): **Required:** `filter` selecting cases (for example `ids->[id1,id2]`) and `responseFields` including allowed fields such as `isCompleted`. Empty or invalid selection typically returns **400**.
 - [GET /v1/txcases/{txCaseId}](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/gettxcasesbytxcaseidv1.md): Returns the TxCaseV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.
 - [PUT /v1/txcases/{txCaseId}](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/puttxcasesbytxcaseidv1.md): Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing.
 - [DELETE /v1/txcases/{txCaseId}](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/deletetxcasesbytxcaseidv1.md): Deletes the treatment case. **404** when the resource is missing or already deleted. **Query `deleteType` (required):** `DELETE` soft-cancels contained patient procedures and hard-deletes visits and t
 - [GET /v1/txcases/{txCaseId}/calculated](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/gettxcasesbytxcaseidcalculatedv1.md): **Required:** `responseFields` listing allowed calculated fields (for example `isCompleted`). **404** if `txCaseId` does not exist. **MCP (first successful call):** path `txCaseId` must exist; query `
 - [GET /v1/txcases/{txCaseId}/amount](https://papidocs.hs1api.com/publicapi/api-procedures-and-treatment/other/gettxcasesbytxcaseidamountv1.md): Returns the the total amount for TxCaseV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context.