openapi: 3.0.0 info: title: Public API description: Operations related to patients, appointments, providers and so on. version: 185.0.9 servers: - url: https://test.hs1api.com/ascend-gateway/api description: Sandbox - url: https://prod.hs1api.com/ascend-gateway/api description: Prod security: - bearerAuth: [] - oAuthSandbox: [] paths: /oauth/client_credential/accesstoken: servers: - url: https://test.hs1api.com description: Sandbox - url: https://prod.hs1api.com description: Production post: summary: Get Access Token (Client Credentials) description: | Exchanges Client ID and Client Secret for an access token using OAuth 2.0 client credentials flow. This endpoint implements server-side token caching to avoid exposing client secrets to frontend applications. Tokens are automatically refreshed when near expiry. **Environment URLs:** - Sandbox: https://test.hs1api.com - Production: https://prod.hs1api.com **Note**: Sandbox and Production use different base URLs and credentials. tags: - AccessToken (V1) security: [] parameters: - name: grant_type in: query required: true description: Must be "client_credentials" schema: type: string enum: - client_credentials example: client_credentials requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object required: - client_id - client_secret properties: client_id: type: string description: OAuth client ID provided by HS1 Support example: YOUR_CLIENT_ID client_secret: type: string description: OAuth client secret provided by HS1 Support example: YOUR_CLIENT_SECRET examples: sandbox: summary: Sandbox credentials example value: client_id: YOUR_CLIENT_ID client_secret: YOUR_CLIENT_SECRET responses: '200': description: Token issued successfully content: application/json: schema: type: object properties: access_token: type: string description: Bearer token for API authentication example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... token_type: type: string description: Token type (always "Bearer") example: Bearer expires_in: type: integer description: Token lifetime in seconds example: 3600 scope: type: string description: Granted scopes (if requested) example: publicapi.read publicapi.write organizationid: type: string description: >- Organization ID (if provided in request). Note lowercase 'd' is intentional for legacy API compatibility example: '1006' examples: success: summary: Successful token response value: access_token: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... token_type: Bearer expires_in: 3600 '400': description: The request was invalid or cannot be processed content: application/json: schema: type: object properties: error: type: string example: invalid_request message: type: string example: client_id and client_secret are required '401': description: Authentication is required and has failed or has not been provided content: application/json: schema: type: object properties: error: type: string example: invalid_client message: type: string example: Invalid client credentials '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded content: application/json: schema: type: object properties: error: type: string example: rate_limit_exceeded message: type: string example: Too many requests. Please try again later. '500': description: An unexpected error occurred content: application/json: schema: type: object properties: error: type: string example: server_error message: type: string example: An unexpected error occurred '502': description: Upstream token service unavailable content: application/json: schema: type: object properties: error: type: string example: upstream_error message: type: string example: Token service unavailable operationId: PostOauthClientCredentialAccesstokenV1 /orgmapper/LinkedOrgs: servers: - url: https://test.hs1api.com description: Sandbox - url: https://prod.hs1api.com description: Production get: summary: List linked OrgMapper organization IDs for the caller. description: > **OrgMapper** discovery endpoint (not implemented by the Ascend Public API Node application). Call **HTTPS GET** on `{server}/orgmapper/LinkedOrgs` using the same **Bearer** access token you use for Public API requests. Choose the server for your environment (Sandbox vs Production) using the **Servers** selector in the documentation. Returns OrgMapper organization identifiers (MongoDB-style strings) your `client_id` may access—useful before choosing an `Organization-ID` header on other routes. Response body shape matches OrgMapper (plain JSON, not the Ascend `statusCode` / `data` envelope). tags: - Organizations (V1) responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/LinkedOrgsV1' example: organizations: - organizations examples: default: value: organizations: - organizations '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred parameters: - $ref: '#/components/parameters/OrganizationId' operationId: GetOrgmapperLinkedOrgsV1 /v1/agingbalances: get: summary: Returns AgingBalanceV1 for patient. tags: - Agingbalances (V1) parameters: - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: patientId required: true description: Patient ID to get the patient aging balance model. schema: type: integer format: int64 minimum: 1 example: 1 - in: query name: ownership required: false description: Ownership to get the patient aging balance model. schema: type: string enum: - GUARANTOR - PATIENT - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AgingBalanceResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAgingbalancesV1 /v1/agingbalances/report: get: summary: >- Returns AgingBalanceV1 for patient. This endpoint requires either patient.id or page filters be present in the request, see "filter" details below for more info on how to use them properly. description: >- Returns `AgingBalanceReportV1`: rolled-up bucket totals for the location (or for the requested guarantor patients), plus `patientReports` with one `AgingReceivableV1` per guarantor row. **Filter requirement:** Provide either `filter=patient.id->[...]` (with `location.id`) **or** `filter=page==n` (with `location.id`) for the paginated location report—not both. See the `filter` parameter for operators and notes on `meta.pagination`. **Note:** If `responseFields` is supplied, it is validated against an internal allowlist but the report JSON is not filtered by those names (the payload shape is always the full `AgingBalanceReportV1`). **Rate limiting:** Documented on this operation (not on `AgingBalanceReportV1` / `AgingReceivableV1` schemas). Subject to standard Public API rate limits; on HTTP 429 use `Retry-After` and `Rate-Limiting-Remaining` as documented for the API. Overview: https://portal.hs1api.com/guide **MCP (first successful call):** use a real `location.id` from `GET /v1/locations`, e.g. `filter=location.id==12345678901234,page==1` (paginated location report). `location.id` alone is not sufficient. **MCP (when `page==1` fails):** A **400** validation response whose message is **"No more data was found"** has been observed when the **paginated** location report has no guarantor rows to return (for example an empty or sparse dataset). That is distinct from “invalid filter syntax.” In those cases, call again with `filter=location.id==…,patient.id->[guarantorPatientId,…]` (guarantor patient IDs, up to 50) instead of relying on `page` alone, or confirm the organization has aging balances for that location. tags: - Agingbalances (V1) parameters: - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: filter in: query required: true description: >- Filter clauses for aging balance reports. General grammar and operators: the Public API filter documentation. Use comma-separated `key==value` or `key->[...]` clauses; URL-encode the full filter string. **Keys and operators (this endpoint)** - `location.id` (`==`) — **Required.** Example: `location.id==123`. - `patient.id` (`->`) — Optional; use with `location.id` for specific guarantor patients (IDs must be guarantors, max **50**). **Do not** combine with `page`. Example: `patient.id->[456,789]`. - `page` (`==`) — Optional; use with `location.id` to paginate the location-wide report. **Do not** combine with `patient.id`. Examples: `page==1`, `page==2`. - `balance` (`==`, `!=`, `>`, `>=`, `<`, `<=`) — Total balance (dollars). Examples: `balance>=1` (at least $1; useful to exclude zero-balance rows), `balance>100`, `balance==0`. - `thirtyDays` (`==`, `!=`, `>`, `>=`, `<`, `<=`) — 31–60 day bucket (dollars). Examples: `thirtyDays>0`, `thirtyDays>=100`, `thirtyDays==0`. - `sixtyDays` (`==`, `!=`, `>`, `>=`, `<`, `<=`) — 61–90 day bucket (dollars). Examples: `sixtyDays>0`, `sixtyDays>=100`, `sixtyDays==0`. - `ninetyDays` (`==`, `!=`, `>`, `>=`, `<`, `<=`) — 90+ day bucket (dollars). Examples: `ninetyDays>0`, `ninetyDays>=500` (collections prioritization), `ninetyDays==0`. Examples: `location.id==12345678901234,page==1`, `location.id==12345678901234,patient.id->[456,789]`, `balance>=1`. **Pagination notes** - When using the `page` filter you get pagination metadata on the **first** page only (`meta.pagination`), including how much to request per call and totals to walk through. - Paginate through all pages and **aggregate** values to match full-report totals; do **not** double-count **pending insurance claims** per patient when summing. - On the first page, `meta.pagination.limit` and `meta.pagination.total` refer to **transactions searched / remaining**, not the number of objects in `data`; this limits work per request and reduces timeouts. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AgingBalanceRptResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAgingbalancesReportV1 /v1/appointmentcolors: get: summary: Returns a list of AppointmentColors (V1) description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no AppointmentColors matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - AppointmentColor (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for appointmentcolors. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`==`, `!=`) Examples: `location.id==12`. schema: type: string style: form explode: false - name: page in: query required: false description: Page number for pagination control schema: type: string example: '1' - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: '10' - name: lastId in: query required: false description: the biggest appointmentColorId from previous page schema: type: string example: '500' responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentColorBulkResponseWrapperV1' example: data: - id: 1000000001027 mainArea: PROVIDER_COLOR additionalArea: ADDITIONAL_PROVIDER_COLOR warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: 1000000001027 mainArea: PROVIDER_COLOR additionalArea: ADDITIONAL_PROVIDER_COLOR warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmentcolorsV1 /v1/appointmentcolors/{appointmentColorId}: get: summary: Returns an AppointmentColor (V1) by ID. description: >- Returns the AppointmentColor (V1) identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - AppointmentColor (V1) parameters: - name: appointmentColorId in: path required: true description: ID of the appointment color to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentColorResponseWrapperV1' example: data: id: 1000000001027 mainArea: PROVIDER_COLOR additionalArea: ADDITIONAL_PROVIDER_COLOR warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 1000000001027 mainArea: PROVIDER_COLOR additionalArea: ADDITIONAL_PROVIDER_COLOR warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmentcolorsByAppointmentColorIdV1 put: summary: Returns the updated AppointmentColor (V1). description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - AppointmentColor (V1) parameters: - in: path name: appointmentColorId required: true description: ID of the appointment color to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Appointment Color identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/AppointmentColorV1' example: id: 12445 mainArea: PROVIDER_COLOR examples: default: value: id: 12445 mainArea: PROVIDER_COLOR responses: '200': description: AppointmentColor was updated content: application/json: schema: $ref: '#/components/schemas/AppointmentColorResponseWrapperV1' example: data: id: 1000000001027 mainArea: PROVIDER_COLOR additionalArea: ADDITIONAL_PROVIDER_COLOR warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 1000000001027 mainArea: PROVIDER_COLOR additionalArea: ADDITIONAL_PROVIDER_COLOR warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutAppointmentcolorsByAppointmentColorIdV1 /v1/appointmentcolors/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmentcolorsTotalcountV1 /v1/appointmenthistories: get: summary: Returns a list of AppointmentHistory (V1) based on filter criteria description: >- **Query shape:** Prefer a **narrow** filter. Required filter keys must be supplied where documented below. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window. **Empty results:** **200** with `data: []` means no AppointmentHistory matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - AppointmentHistory (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for appointmenthistory. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `appointment.id` (`==`, `->`) - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `appointment.id==789`, `lastModified>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 10 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 responses: '200': description: The request is successful content: application/json: schema: $ref: '#/components/schemas/AppointmentHistoryBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmenthistoriesV1 /v1/appointmenthistories/{appointmentHistoryId}: get: summary: Returns an AppointmentHistoryV1 by ID. description: >- Returns the AppointmentHistoryV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - AppointmentHistory (V1) parameters: - in: path name: appointmentHistoryId required: true description: ID of the appointment history to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentHistoryResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmenthistoriesByAppointmentHistoryIdV1 /v1/appointmenthistories/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmenthistoriesTotalcountV1 /v1/appointmentstatushistories: get: summary: Returns a list of AppointmentStatusHistory (V1) based on filter criteria description: >- **Query shape:** Prefer a **narrow** filter. Required filter keys must be supplied where documented below. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window. **Empty results:** **200** with `data: []` means no AppointmentStatusHistory matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - AppointmentStatusHistory (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for appointmentstatushistory. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `appointment.id` (`==`, `->`) - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `appointment.id==789`, `lastModified>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 10 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 responses: '200': description: The request is successful content: application/json: schema: $ref: '#/components/schemas/AppointmentSHBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmentstatushistoriesV1 /v1/appointmentstatushistories/{appointmentStatusHistoryId}: get: summary: Returns an AppointmentStatusHistoryV1 by ID. description: >- Returns the AppointmentStatusHistoryV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - AppointmentStatusHistory (V1) parameters: - in: path name: appointmentStatusHistoryId required: true description: ID of the appointment status history to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentSHResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmentstatushistoriesByAppointmentStatusHistoryIdV1 /v1/appointmentstatushistories/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmentstatushistoriesTotalcountV1 /v1/appointments: get: summary: Returns a list of Appointments (V1) based on filter criteria description: >- **Query shape:** Prefer a **narrow** filter—combine `patient.id`, `provider.id`, or `location.id` with `lastModified` or date bounds where possible. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no appointments matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated; **`lastModified` / `lastId`** style pagination is preferred. tags: - Appointments (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for appointments (V1). General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `needsFollowUp` (`==`, `!=`) - `status` (`==`, `!=`) — values include `LATE`, `HERE`, `READY`, `CHAIR`, `COMPLETED`, `CONFIRMED`, `UNCONFIRMED`, `NO_SHOW`, `BROKEN`, `LEFT_MESSAGE`, `CHECKOUT`, `WILL_CALL`, `UNREACHABLE`, `CANCELLEDBYOFFICE` - `patient.id` (`==`, `!=`) - `operatory.id` (`==`, `!=`, `->`) - `location.id` (`==`, `!=`, `->`) — use `ALL` or `*` for all locations; `->["ALL"]` or `->["*"]` for explicit all-locations. Omitting `location.id` may default to all locations during a transitional period; it may become required (IDs or `["ALL"]`). - `provider.id` (`==`, `!=`, `->`) - `asap` (`==`) - `start` (`>`, `<`, `>=`, `<=`) - `lastModified` (`>`, `<`, `>=`, `<=`) **Ordering:** When filtering by `start` or `lastModified`, use `lastId` with those filters for stable pagination; result order follows server rules for the chosen filters. Examples: `patient.id==12345`, `provider.id==7`, `location.id==12`, `start>=2022-01-01`, `operatory.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 20 - name: lastId in: query required: false description: the biggest appointmentId from previous page schema: type: string example: 500 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentBulkResponseWrapperV1' example: data: - id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmentsV1 post: summary: Returns AppointmentV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Appointments (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: >- **Purpose:** Schedule an appointment on an operatory. **Required fields:** `start`, `operatory`, `patient`, and at least one scheduling reason: `other`, `practiceProcedures`, `patientProcedures`, or `visits`. **Defaults:** Duration defaults to the location's `defaultAppointmentLength` when omitted. `start` and computed `end` must fall on the same calendar day (location time zone). **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/AppointmentV1' example: {} examples: default: value: {} responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/AppointmentResponseWrapperV1' example: data: id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostAppointmentsV1 /v1/appointments/async: get: summary: Returns a list of Appointments (V1) asynchronously based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no Appointments matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Appointments (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string example: id, name, created, patient.id style: form explode: false - name: filter in: query required: false description: >- Filter clauses for appointments (v1) asynchronously. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `needsFollowUp` (`==`, `!=`) - `status` (`==`) - `patient.id` (`==`, `!=`) - `operatory.id` (`==`, `!=`, `->`) - `location.id` (`==`, `!=`, `->`) - `provider.id` (`==`, `!=`, `->`) - `asap` (`==`) - `start` (`>`, `<`, `>=`, `<=`) - `lastModified` (`>`, `<`, `>=`, `<=`) **Ordering:** When filtering by `start`, `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `provider.id==7`, `location.id==12`, `start>=2022-01-01`, `operatory.id==12`. schema: type: string example: id==123, patient.id==456 - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 20 - name: lastId in: query required: false description: the biggest appointmentId from previous page schema: type: string example: 500 responses: '200': description: > Success response. Returns the first 10 results immediately and streams all matching records to the Streaming API. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/AppointmentV1' description: Array of appointments warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmentsAsyncV1 /v1/appointments/{appointmentId}: get: summary: Returns an AppointmentV1 by ID. description: >- Returns the appointment identified by the path parameter. **404** when the appointment is missing or not accessible in the organization context. tags: - Appointments (V1) parameters: - in: path name: appointmentId required: true description: ID of the appointment to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentResponseWrapperV1' example: data: id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmentsByAppointmentIdV1 put: summary: Returns the updated AppointmentV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Appointments (V1) parameters: - in: path name: appointmentId required: true description: ID of the appointment to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: >- **Purpose:** Update appointment fields and linked scheduling data. **Linked-model arrays (`patientProcedures`, `practiceProcedures`, `visits`):** Included arrays **replace** current values entirely. To append, resend existing IDs plus new ones. A procedure cannot appear both on a linked visit and directly on the appointment. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/AppointmentUpdateV1' example: confirmed: '2024-05-02T16:30:00.000Z' needsFollowUp: true examples: default: value: confirmed: '2024-05-02T16:30:00.000Z' needsFollowUp: true responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentResponseWrapperV1' example: data: id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutAppointmentsByAppointmentIdV1 delete: summary: Delete specific AppointmentV1 by ID description: >- Permanently deletes the appointment and cascades related tasks, history, and recare links. **404** when the resource is missing or already deleted. tags: - Appointments (V1) parameters: - name: appointmentId in: path required: true description: ID of the appointment to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteAppointmentsByAppointmentIdV1 /v1/appointments/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmentsTotalcountV1 /beta/appointments: get: summary: Returns a list of Appointments based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no Appointments matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Appointments (beta) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for appointments. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `needsFollowUp` (`==`) - `status` (`==`, `!=`) - `patient.id` (`==`, `!=`) - `operatory.id` (`==`, `!=`, `->`) - `location.id` (`==`, `!=`, `->`) - `provider.id` (`==`, `!=`, `->`) - `asap` (`==`) - `start` (`>`, `<`, `>=`, `<=`) **Ordering:** When filtering by `start`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `provider.id==7`, `location.id==12`, `start>=2022-01-01`, `operatory.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest appointmentId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentBulkResponseWrapperV2' example: data: - id: 9000000903582 version: 5 created: 1730733795640 startDateTime: 1730910600000 endDateTime: 1730915100000 status: READY title: Appointment reason: ArthrSDsc, PerMaint duration: 75 needsFollowup: true ASAP: true needsPremedicate: true note: this is a test note other: null bookedOnline: false patient: id: 9000000082518 patientLite: id: 9000000082518 location: id: 9000000000010 provider: id: 9000000000393 operatory: id: 9000000000333 secondaryProvider: id: 9000000000398 confirmed: 1730733785665 followedUp: null reminded: null insuranceEligibilityVerified: null productionAmount: 144 leftMessage: null visits: [] patientProcedures: [] procedures: - id: 9000000050597 procedure: id: 9000000005520 adaCode: D7876 description: Arthroscopy Discectomy abbreviatedDescription: ArthrSDsc - id: 9000000050598 procedure: id: 9000000005807 adaCode: D4910 description: Periodontal Maintenance abbreviatedDescription: PerMaint communications: [] dueDates: [] missedAppointments: [] labCase: id: 9000000000002 dentalLab: id: 9000000000001 name: asdf phone: '1112223333' status: OUTSTANDING dueDate: 1730959199000 note: this is a test lab note warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: 9000000903582 version: 5 created: 1730733795640 startDateTime: 1730910600000 endDateTime: 1730915100000 status: READY title: Appointment reason: ArthrSDsc, PerMaint duration: 75 needsFollowup: true ASAP: true needsPremedicate: true note: this is a test note other: null bookedOnline: false patient: id: 9000000082518 patientLite: id: 9000000082518 location: id: 9000000000010 provider: id: 9000000000393 operatory: id: 9000000000333 secondaryProvider: id: 9000000000398 confirmed: 1730733785665 followedUp: null reminded: null insuranceEligibilityVerified: null productionAmount: 144 leftMessage: null visits: [] patientProcedures: [] procedures: - id: 9000000050597 procedure: id: 9000000005520 adaCode: D7876 description: Arthroscopy Discectomy abbreviatedDescription: ArthrSDsc - id: 9000000050598 procedure: id: 9000000005807 adaCode: D4910 description: Periodontal Maintenance abbreviatedDescription: PerMaint communications: [] dueDates: [] missedAppointments: [] labCase: id: 9000000000002 dentalLab: id: 9000000000001 name: asdf phone: '1112223333' status: OUTSTANDING dueDate: 1730959199000 note: this is a test lab note warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetBetaAppointments post: summary: Returns Appointment which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Appointments (beta) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: >- **Purpose:** Schedule an appointment on an operatory. **Required fields:** `start`, `operatory`, `patient`, and at least one scheduling reason: `other`, `practiceProcedures`, `patientProcedures`, or `visits`. **Defaults:** Duration defaults to the location's `defaultAppointmentLength` when omitted. `start` and computed `end` must fall on the same calendar day (location time zone). **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/AppointmentV2' example: {} examples: default: value: {} responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/AppointmentResponseWrapperV2' example: data: id: 9000000903582 version: 5 created: 1730733795640 startDateTime: 1730910600000 endDateTime: 1730915100000 status: READY title: Appointment reason: ArthrSDsc, PerMaint duration: 75 needsFollowup: true ASAP: true needsPremedicate: true note: this is a test note other: null bookedOnline: false patient: id: 9000000082518 patientLite: id: 9000000082518 location: id: 9000000000010 provider: id: 9000000000393 operatory: id: 9000000000333 secondaryProvider: id: 9000000000398 confirmed: 1730733785665 followedUp: null reminded: null insuranceEligibilityVerified: null productionAmount: 144 leftMessage: null visits: [] patientProcedures: [] procedures: - id: 9000000050597 procedure: id: 9000000005520 adaCode: D7876 description: Arthroscopy Discectomy abbreviatedDescription: ArthrSDsc - id: 9000000050598 procedure: id: 9000000005807 adaCode: D4910 description: Periodontal Maintenance abbreviatedDescription: PerMaint communications: [] dueDates: [] missedAppointments: [] labCase: id: 9000000000002 dentalLab: id: 9000000000001 name: asdf phone: '1112223333' status: OUTSTANDING dueDate: 1730959199000 note: this is a test lab note warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 9000000903582 version: 5 created: 1730733795640 startDateTime: 1730910600000 endDateTime: 1730915100000 status: READY title: Appointment reason: ArthrSDsc, PerMaint duration: 75 needsFollowup: true ASAP: true needsPremedicate: true note: this is a test note other: null bookedOnline: false patient: id: 9000000082518 patientLite: id: 9000000082518 location: id: 9000000000010 provider: id: 9000000000393 operatory: id: 9000000000333 secondaryProvider: id: 9000000000398 confirmed: 1730733785665 followedUp: null reminded: null insuranceEligibilityVerified: null productionAmount: 144 leftMessage: null visits: [] patientProcedures: [] procedures: - id: 9000000050597 procedure: id: 9000000005520 adaCode: D7876 description: Arthroscopy Discectomy abbreviatedDescription: ArthrSDsc - id: 9000000050598 procedure: id: 9000000005807 adaCode: D4910 description: Periodontal Maintenance abbreviatedDescription: PerMaint communications: [] dueDates: [] missedAppointments: [] labCase: id: 9000000000002 dentalLab: id: 9000000000001 name: asdf phone: '1112223333' status: OUTSTANDING dueDate: 1730959199000 note: this is a test lab note warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostBetaAppointments /beta/appointments/{appointmentId}: get: summary: Returns an Appointment by ID. description: >- Returns the Appointment identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Appointments (beta) parameters: - in: path name: appointmentId required: true description: ID of the appointment to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentResponseWrapperV2' example: data: id: 9000000903582 version: 5 created: 1730733795640 startDateTime: 1730910600000 endDateTime: 1730915100000 status: READY title: Appointment reason: ArthrSDsc, PerMaint duration: 75 needsFollowup: true ASAP: true needsPremedicate: true note: this is a test note other: null bookedOnline: false patient: id: 9000000082518 patientLite: id: 9000000082518 location: id: 9000000000010 provider: id: 9000000000393 operatory: id: 9000000000333 secondaryProvider: id: 9000000000398 confirmed: 1730733785665 followedUp: null reminded: null insuranceEligibilityVerified: null productionAmount: 144 leftMessage: null visits: [] patientProcedures: [] procedures: - id: 9000000050597 procedure: id: 9000000005520 adaCode: D7876 description: Arthroscopy Discectomy abbreviatedDescription: ArthrSDsc - id: 9000000050598 procedure: id: 9000000005807 adaCode: D4910 description: Periodontal Maintenance abbreviatedDescription: PerMaint communications: [] dueDates: [] missedAppointments: [] labCase: id: 9000000000002 dentalLab: id: 9000000000001 name: asdf phone: '1112223333' status: OUTSTANDING dueDate: 1730959199000 note: this is a test lab note warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 9000000903582 version: 5 created: 1730733795640 startDateTime: 1730910600000 endDateTime: 1730915100000 status: READY title: Appointment reason: ArthrSDsc, PerMaint duration: 75 needsFollowup: true ASAP: true needsPremedicate: true note: this is a test note other: null bookedOnline: false patient: id: 9000000082518 patientLite: id: 9000000082518 location: id: 9000000000010 provider: id: 9000000000393 operatory: id: 9000000000333 secondaryProvider: id: 9000000000398 confirmed: 1730733785665 followedUp: null reminded: null insuranceEligibilityVerified: null productionAmount: 144 leftMessage: null visits: [] patientProcedures: [] procedures: - id: 9000000050597 procedure: id: 9000000005520 adaCode: D7876 description: Arthroscopy Discectomy abbreviatedDescription: ArthrSDsc - id: 9000000050598 procedure: id: 9000000005807 adaCode: D4910 description: Periodontal Maintenance abbreviatedDescription: PerMaint communications: [] dueDates: [] missedAppointments: [] labCase: id: 9000000000002 dentalLab: id: 9000000000001 name: asdf phone: '1112223333' status: OUTSTANDING dueDate: 1730959199000 note: this is a test lab note warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetBetaAppointmentsByAppointmentId put: summary: Returns the updated Appointment. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Appointments (beta) parameters: - in: path name: appointmentId required: true description: ID of the appointment to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: >- **Purpose:** Update appointment fields and linked scheduling data. **Linked-model arrays (`patientProcedures`, `practiceProcedures`, `visits`):** Included arrays **replace** current values entirely. To append, resend existing IDs plus new ones. A procedure cannot appear both on a linked visit and directly on the appointment. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/AppointmentUpdateV2' example: confirmed: '2024-05-02T16:30:00.000Z' needsFollowUp: true examples: default: value: confirmed: '2024-05-02T16:30:00.000Z' needsFollowUp: true responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentResponseWrapperV2' example: data: id: 9000000903582 version: 5 created: 1730733795640 startDateTime: 1730910600000 endDateTime: 1730915100000 status: READY title: Appointment reason: ArthrSDsc, PerMaint duration: 75 needsFollowup: true ASAP: true needsPremedicate: true note: this is a test note other: null bookedOnline: false patient: id: 9000000082518 patientLite: id: 9000000082518 location: id: 9000000000010 provider: id: 9000000000393 operatory: id: 9000000000333 secondaryProvider: id: 9000000000398 confirmed: 1730733785665 followedUp: null reminded: null insuranceEligibilityVerified: null productionAmount: 144 leftMessage: null visits: [] patientProcedures: [] procedures: - id: 9000000050597 procedure: id: 9000000005520 adaCode: D7876 description: Arthroscopy Discectomy abbreviatedDescription: ArthrSDsc - id: 9000000050598 procedure: id: 9000000005807 adaCode: D4910 description: Periodontal Maintenance abbreviatedDescription: PerMaint communications: [] dueDates: [] missedAppointments: [] labCase: id: 9000000000002 dentalLab: id: 9000000000001 name: asdf phone: '1112223333' status: OUTSTANDING dueDate: 1730959199000 note: this is a test lab note warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 9000000903582 version: 5 created: 1730733795640 startDateTime: 1730910600000 endDateTime: 1730915100000 status: READY title: Appointment reason: ArthrSDsc, PerMaint duration: 75 needsFollowup: true ASAP: true needsPremedicate: true note: this is a test note other: null bookedOnline: false patient: id: 9000000082518 patientLite: id: 9000000082518 location: id: 9000000000010 provider: id: 9000000000393 operatory: id: 9000000000333 secondaryProvider: id: 9000000000398 confirmed: 1730733785665 followedUp: null reminded: null insuranceEligibilityVerified: null productionAmount: 144 leftMessage: null visits: [] patientProcedures: [] procedures: - id: 9000000050597 procedure: id: 9000000005520 adaCode: D7876 description: Arthroscopy Discectomy abbreviatedDescription: ArthrSDsc - id: 9000000050598 procedure: id: 9000000005807 adaCode: D4910 description: Periodontal Maintenance abbreviatedDescription: PerMaint communications: [] dueDates: [] missedAppointments: [] labCase: id: 9000000000002 dentalLab: id: 9000000000001 name: asdf phone: '1112223333' status: OUTSTANDING dueDate: 1730959199000 note: this is a test lab note warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutBetaAppointmentsByAppointmentId delete: summary: Delete specific Appointment by ID description: >- Permanently deletes the appointment and cascades related tasks, history, and recare links. **404** when the resource is missing or already deleted. tags: - Appointments (beta) parameters: - name: appointmentId in: path required: true description: ID of the appointment to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteBetaAppointmentsByAppointmentId /v1/appointmenttasks: get: summary: Returns a list of AppointmentTasks (V1) based on filter criteria description: >- **Query shape:** Prefer a **narrow** filter—combine `appointment.id` or `id` with other scoping keys where possible. A very wide query with no scoping can **408** (timeout) on large tenants; retry with a smaller window or use cursor pagination (`lastId`—see parameter descriptions). **Empty results:** **200** with `data: []` means no appointment tasks matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated; **`lastId`** style pagination is preferred. See the Public API pagination documentation. tags: - AppointmentTasks (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for appointment tasks. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `!=`, `->`) - `appointment.id` (`==`, `!=`, `->`) Examples: `appointment.id==789`, `id==123`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 20 - name: lastId in: query required: false description: the biggest appointmentTaskId from previous page schema: type: string example: 500 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentTaskBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmenttasksV1 post: summary: Returns AppointmentTaskV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - AppointmentTasks (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Appointment Task. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/AppointmentTaskV1' example: {} examples: default: value: {} responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/AppointmentTaskResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostAppointmenttasksV1 /v1/appointmenttasks/{appointmentTaskId}: get: summary: Returns an AppointmentTaskV1 by appointment task ID. description: >- Returns the AppointmentTaskV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - AppointmentTasks (V1) parameters: - in: path name: appointmentTaskId required: true description: ID of the appointment task to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AppointmentTaskResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmenttasksByAppointmentTaskIdV1 put: summary: Returns the updated AppointmentTaskV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - AppointmentTasks (V1) parameters: - in: path name: appointmentTaskId required: true description: ID of the appointment task to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Appointment Task Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/AppointmentTaskUpdateV1' example: appointment: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType examples: default: value: appointment: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType responses: '200': description: AppointmentTask was updated content: application/json: schema: $ref: '#/components/schemas/AppointmentTaskResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutAppointmenttasksByAppointmentTaskIdV1 delete: summary: Delete specific AppointmentTaskV1 by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - AppointmentTasks (V1) parameters: - name: appointmentTaskId in: path required: true description: ID of the appointment task to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: AppointmentTask was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteAppointmenttasksByAppointmentTaskIdV1 /v1/appointmenttasks/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAppointmenttasksTotalcountV1 /v1/audits: get: summary: Returns a list of audits based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no audits matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Audits (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for audits. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `location.id` (`->`) - `onlineUser.id` (`==`) - `patient.id` (`==`) - `date` (`>`, `<`, `>=`, `<=`) - `description` (`~=`) - `auditType` (`->`) - `action` (`->`) Examples: `patient.id==12345`, `location.id==12`, `onlineUser.id==12`, `description~=Smith`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest auditId from previous page schema: type: string example: 500 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/AuditBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAuditsV1 /v1/audits/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetAuditsTotalcountV1 /v1/bulkinsurancepayments: get: summary: Returns a list of bulk insurance payments based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no bulk insurance payments matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - BulkInsurancePayments (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for bulk insurance payments. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `location.id` (`==`, `->`) - `insuranceCarrier.id` (`==`, `->`) - `insuranceClaim.id` (`==`) Examples: `location.id==12`, `insuranceCarrier.id==12`, `insuranceClaim.id==12`, `id->[123,124]`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest bulk insurance payment ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/BulkInsurancePaymentBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetBulkinsurancepaymentsV1 /v1/bulkinsurancepayments/{bulkInsurancePaymentId}: get: summary: Returns a bulk insurance payment by entry ID. description: >- Returns the bulk insurance payment identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - BulkInsurancePayments (V1) parameters: - in: path name: bulkInsurancePaymentId required: true description: ID of the bulk insurance payment to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/BulkInsurancePaymentResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetBulkinsurancepaymentsByBulkInsurancePaymentIdV1 /v1/bulkinsurancepayments/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetBulkinsurancepaymentsTotalcountV1 /v1/carrierinsuranceplancoordinationofbenefits: get: summary: Returns a list of carrier insurance plan coordination of benefits based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no carrier insurance plan coordination of benefits matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - CarrierInsurancePlanCoordinationOfBenefits (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for carrier insurance plan coordination of benefits. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `carrierInsurancePlan.id` (`==`, `->`) Examples: `carrierInsurancePlan.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest carrier insurance plan ID from previous page schema: type: string example: 500 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CarrierInsurPlanCoordOfBenefBulkResWrapV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierinsuranceplancoordinationofbenefitsV1 /v1/carrierinsuranceplancoordinationofbenefits/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierinsuranceplancoordinationofbenefitsTotalcountV1 /v1/carrierinsuranceplans: get: summary: Returns a list of carrier insurance plans based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no carrier insurance plans matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - CarrierInsurancePlans (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for carrier insurance plans. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `insuranceCarrier.id` (`==`, `->`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `insuranceCarrier.id==12`, `id==123`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest carrier insurance plan ID from previous page schema: type: string example: 500 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CarrierInsurancePlanBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierinsuranceplansV1 /v1/carrierinsuranceplans/{carrierInsurancePlanId}: get: summary: Returns a carrier insurance plan by entry ID. description: >- Returns the carrier insurance plan identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - CarrierInsurancePlans (V1) parameters: - name: carrierInsurancePlanId in: path required: true description: ID of the carrier insurance plan to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CarrierInsurancePlanResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierinsuranceplansByCarrierInsurancePlanIdV1 /v1/carrierinsuranceplans/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierinsuranceplansTotalcountV1 /v1/carrierplancopayexceptions: get: summary: Returns a list of carrier plan copay exceptions based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no carrier plan copay exceptions matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - CarrierPlanCopayExceptions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for carrier plan copay exceptions. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `carrierInsurancePlan.id` (`==`) Examples: `id==12`, `id->[12,13]`, `carrierInsurancePlan.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest carrier plan copay exception ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CarrierPlanCopayExceptBulkRespWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierplancopayexceptionsV1 /v1/carrierplancopayexceptions/{carrierPlanCopayExceptionId}: get: summary: Returns a carrier insurance plan copay exception by entry ID. description: >- Returns the carrier insurance plan copay exception identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - CarrierPlanCopayExceptions (V1) parameters: - in: path name: carrierPlanCopayExceptionId required: true description: ID of the carrier plan copay exception to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CarrierPlanCopayExceptionRespWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierplancopayexceptionsByCarrierPlanCopayExceptionIdV1 /v1/carrierplancopayexceptions/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierplancopayexceptionsTotalcountV1 /v1/carrierplancoverageexceptions: get: summary: Returns a list of carrier plan coverage exceptions based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no carrier plan coverage exceptions matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - CarrierPlanCoverageExceptions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for carrier plan coverage exceptions. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `carrierInsurancePlan.id` (`==`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first). Examples: `carrierInsurancePlan.id==12`, `id->[12,13]`, `lastModified>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest carrier plan coverage exception ID from previous page schema: type: string example: 200 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CarrierPlanCovExceptBulkRespWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierplancoverageexceptionsV1 /v1/carrierplancoverageexceptions/{carrierPlanCoverageExceptionId}: get: summary: Returns a carrier insurance plan coverage exception by entry ID. description: >- Returns the carrier insurance plan coverage exception identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - CarrierPlanCoverageExceptions (V1) parameters: - in: path name: carrierPlanCoverageExceptionId required: true description: ID of the carrier plan coverage exception to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CarrierPlanCovExceptionRespWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierplancoverageexceptionsByCarrierPlanCoverageExceptionIdV1 /v1/carrierplancoverageexceptions/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierplancoverageexceptionsTotalcountV1 /beta/carrierplancoverageexceptions/bulkasync: post: summary: Bulk create carrier plan coverage exceptions (async) tags: - CarrierPlanCoverageExceptions (beta) operationId: bulkCreateCarrierPlanCoverageExceptionsAsync description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: '400000000' requestBody: description: Carrier insurance plan IDs and exception templates to apply to each coverage exception required: true content: application/json: schema: $ref: '#/components/schemas/CarrierPlanCoverageExceptionBulkCreate' example: carrierInsurancePlanIds: - 8000000519037 - 8000000248147 exceptions: - exceptionProcedureCode: id: 12745 exceptionType: AGE_LIMIT downgradeProcedureCode: id: 12745 reason: reason examples: default: value: carrierInsurancePlanIds: - 8000000519037 - 8000000248147 exceptions: - exceptionProcedureCode: id: 12745 exceptionType: AGE_LIMIT downgradeProcedureCode: id: 12745 reason: reason responses: '200': description: Request accepted. Processing runs in the background; results will be sent to the Streaming API. content: application/json: schema: $ref: '#/components/schemas/CarrierPlanCovExceptBulkAsyncRespV2' example: data: correlationId: 550e8400-e29b-41d4-a716-446655440000 routingKey: 40000000000001.-1.CarrierPlanCoverageExceptionBulk.ASYNC-POST message: >- Request received, once it has finished processing the requested data will be sent to the StreamingAPI statusCode: 200 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body errors: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: correlationId: 550e8400-e29b-41d4-a716-446655440000 routingKey: 40000000000001.-1.CarrierPlanCoverageExceptionBulk.ASYNC-POST message: >- Request received, once it has finished processing the requested data will be sent to the StreamingAPI statusCode: 200 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body errors: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred /v1/carrierplandeductibles: get: summary: Returns a list of carrier plan deductibles based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no carrier plan deductibles matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - CarrierPlanDeductibles (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for carrier plan deductibles. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first). Examples: `id==12`, `id->[12,13]`, `lastModified>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest carrier plan deductible ID from previous page schema: type: string example: 200 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CarrierPlanDeductBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierplandeductiblesV1 /v1/carrierplandeductibles/{carrierPlanDeductibleId}: get: summary: Returns carrier plan deductible by entry ID. description: >- Returns the carrier plan deductible identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - CarrierPlanDeductibles (V1) parameters: - in: path name: carrierPlanDeductibleId required: true description: ID of the carrier plan deductible to retrieve schema: type: integer format: int64 minimum: 1 example: 3 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CarrierPlanDeductibleResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierplandeductiblesByCarrierPlanDeductibleIdV1 /v1/carrierplandeductibles/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCarrierplandeductiblesTotalcountV1 /v1/clinicalnoteprompts: get: summary: Returns a list of clinicalNoteprompts based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no clinicalNoteprompts matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - ClinicalNotePrompts (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string - name: filter in: query required: false description: >- Filter clauses for clinical note prompts. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - Compound `id` and `location.id` (`==`) — join with `;` in one filter string, e.g. `id==12;location.id==5`. Use `location.id==ALL`, `location.id==*`, or `location.id->["ALL"]` / `->["*"]` for all locations. - Compound `id` and `name` (`->`) — e.g. `id->[12,13];name->[John,Doe]`. Examples: `id==12;location.id==5`, `id->[12,13];name->[John,Doe]`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest promptId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ClinicalNotePromptBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotepromptsV1 post: summary: Returns clinicalNotePrompt which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - ClinicalNotePrompts (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Clinical Note Prompt. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ClinicalNotePromptV1' example: {} examples: default: value: {} responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/ClinicalNotePromptResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostClinicalnotepromptsV1 /v1/clinicalnoteprompts/{promptId}: get: summary: Returns a clinicalNotePrompt by Id. description: >- Returns the clinicalNotePrompt identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ClinicalNotePrompts (V1) parameters: - name: promptId in: path required: true description: ID of the prompt to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ClinicalNotePromptResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotepromptsByPromptIdV1 put: summary: Returns the updated clinicalNotePrompt. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - ClinicalNotePrompts (V1) parameters: - in: path name: promptId required: true description: ID of the prompt to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Clinical Note Prompt Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ClinicalNotePromptUpdateV1' example: name: Example Name promptType: SELECT_QUADRANT examples: default: value: name: Example Name promptType: SELECT_QUADRANT responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/ClinicalNotePromptResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutClinicalnotepromptsByPromptIdV1 delete: summary: Delete desired clinicalNotePrompt by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - ClinicalNotePrompts (V1) parameters: - name: promptId in: path required: true description: ID of the prompt to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: ClinicalNotePromptV1 was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteClinicalnotepromptsByPromptIdV1 /v1/clinicalnoteprompts/globals: get: summary: Returns all of globalClinicalNotePrompts description: >- **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 resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - ClinicalNotePrompts (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/GlobalCNPromptBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotepromptsGlobalsV1 /v1/clinicalnoteprompts/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotepromptsTotalcountV1 /v1/clinicalnotes: get: summary: Returns a list of clinicalNotes based on filter criteria description: >- **Query shape:** Prefer a **narrow** filter—combine `patient.id` or `provider.id` with `lastModified` or `datedAs` bounds. A very wide `lastModified` range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no notes matched; it does not indicate a bad patient or provider id. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Dotted pseudo-paths such as `patient.id` are rejected; use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated; **`lastModified` / `lastId`** style pagination is preferred. See the Public API pagination documentation. tags: - ClinicalNotes (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string - name: filter in: query required: false description: >- Filter clauses for clinical notes. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `patient.id` (`==`) - `provider.id` (`==`) - `primarySignature.id` (`==`, `!=`) - `additionalSignature.id` (`==`, `!=`) - `datedAs` (`<`, `<=`, `>`, `>=`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `datedAs` or `lastModified`, results are returned in **descending** order (newest first). Examples: `patient.id==12345`, `provider.id==7`, `datedAs>=2022-01-01`, `additionalSignature.id==12`, `primarySignature.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest clinicalNoteId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteBulkResponseWrapperV1' example: data: - datedAs: '2019-07-18' text: Tester provider note patient: id: 1000000020701 provider: id: 1000000002089 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - datedAs: '2019-07-18' text: Tester provider note patient: id: 1000000020701 provider: id: 1000000002089 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotesV1 post: summary: Returns clinicalNote which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - ClinicalNotes (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Clinical Note. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteV1' example: {} examples: default: value: {} responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteResponseWrapperV1' example: data: datedAs: '2019-07-18' text: Tester provider note patient: id: 1000000020701 provider: id: 1000000002089 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: datedAs: '2019-07-18' text: Tester provider note patient: id: 1000000020701 provider: id: 1000000002089 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostClinicalnotesV1 /v1/clinicalnotes/{clinicalNoteId}: get: summary: Returns a clinicalNote by clinicalNoteId. description: >- Returns the clinicalNote identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ClinicalNotes (V1) parameters: - name: clinicalNoteId in: path required: true description: ID of the clinical note to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteResponseWrapperV1' example: data: datedAs: '2019-07-18' text: Tester provider note patient: id: 1000000020701 provider: id: 1000000002089 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: datedAs: '2019-07-18' text: Tester provider note patient: id: 1000000020701 provider: id: 1000000002089 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotesByClinicalNoteIdV1 put: summary: Returns the updated clinicalNote. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - ClinicalNotes (V1) parameters: - in: path name: clinicalNoteId required: true description: ID of the clinical note to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Clinical Note Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteUpdateV1' example: datedAs: '2020-04-09T00:00:00.000Z' signedDate: '2020-04-09T00:00:00.000Z' examples: default: value: datedAs: '2020-04-09T00:00:00.000Z' signedDate: '2020-04-09T00:00:00.000Z' responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteResponseWrapperV1' example: data: datedAs: '2019-07-18' text: Tester provider note patient: id: 1000000020701 provider: id: 1000000002089 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: datedAs: '2019-07-18' text: Tester provider note patient: id: 1000000020701 provider: id: 1000000002089 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutClinicalnotesByClinicalNoteIdV1 delete: summary: Delete desired clinicalNote by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - ClinicalNotes (V1) parameters: - name: clinicalNoteId in: path required: true description: ID of the clinical note to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: ClinicalNoteV1 was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteClinicalnotesByClinicalNoteIdV1 /v1/clinicalnotes/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotesTotalcountV1 /v1/clinicalnotetemplates: get: summary: Returns a list of clinicalNoteTemplates based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no clinicalNoteTemplates matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - ClinicalNoteTemplates (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string - name: filter in: query required: false description: >- Filter clauses for clinical note templates. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) and `location.id` (`==`, `->`) — combine in one filter string with `;` between clauses. `location.id` supports `ALL`, `*`, and `->["ALL"]` / `->["*"]` for all locations. Examples: `id->[12,13];location.id==5`, `location.id==ALL`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest clinicalNoteTemplateId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteTemplateBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotetemplatesV1 post: summary: Returns clinicalNoteTemplate which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - ClinicalNoteTemplates (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Clinical Note Template. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteTemplateV1' example: {} examples: default: value: {} responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostClinicalnotetemplatesV1 /v1/clinicalnotetemplates/{templateId}: get: summary: Returns a clinicalNoteTemplate by clinicalNoteTemplateId. description: >- Returns the clinicalNoteTemplate identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ClinicalNoteTemplates (V1) parameters: - name: templateId in: path required: true description: ID of the template to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotetemplatesByTemplateIdV1 put: summary: Returns the updated clinicalNoteTemplate. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - ClinicalNoteTemplates (V1) parameters: - in: path name: templateId required: true description: ID of the template to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Clinical Note Template Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteTemplateUpdateV1' example: category: ADMINISTRATIVE name: Example Name examples: default: value: category: ADMINISTRATIVE name: Example Name responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutClinicalnotetemplatesByTemplateIdV1 delete: summary: Delete desired clinicalNoteTemplate by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - ClinicalNoteTemplates (V1) parameters: - name: templateId in: path required: true description: ID of the template to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: ClinicalNoteTemplateV1 was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteClinicalnotetemplatesByTemplateIdV1 /v1/clinicalnotetemplates/globals: get: summary: Returns a list of globalClinicalNoteTemplates based on filter criteria description: >- **Query shape:** Prefer a **narrow** filter. Required filter keys must be supplied where documented below. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window. **Empty results:** **200** with `data: []` means no globalClinicalNoteTemplates matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - ClinicalNoteTemplates (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string - name: filter in: query required: false description: >- Filter clauses for global clinical note templates. General grammar and operators: the Public API filter documentation. **Keys and operators (this endpoint)** - `name` (`==`, `~=`) Examples: `name==MonthlyRecall`. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/GlobalCNTemplateBulkResponseWrapper' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotetemplatesGlobalsV1 /v1/clinicalnotetemplates/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotetemplatesTotalcountV1 /v1/clinicalnotetemplateuserfavorites: get: summary: Returns list of user and clinicalNoteTemplate pair description: >- **Query shape:** Prefer a **narrow** filter. Required filter keys must be supplied where documented below. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window. **Empty results:** **200** with `data: []` means no user and clinicalNoteTemplate pair matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - ClinicalNoteTemplateUserFavorites (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for resources. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `user.id` (`->`) - `clinicalNoteTemplate.id` (`->`) Examples: `clinicalNoteTemplate.id->[12,13]`, `user.id->[12,13]`. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/UserFavoriteBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClinicalnotetemplateuserfavoritesV1 post: summary: Returns user and clinicalNoteTemplate map description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - ClinicalNoteTemplateUserFavorites (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Clinical Note Template User Favorite. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ClinicalNoteTemplateUserFavoriteV1' example: user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType clinicalNoteTemplate: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType examples: default: value: user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType clinicalNoteTemplate: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/UserFavoriteResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostClinicalnotetemplateuserfavoritesV1 delete: summary: Return deleted user and clinicalNoteTemplate favorite map description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - ClinicalNoteTemplateUserFavorites (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: user in: query required: true description: | Id of user. Required parameter schema: type: string example: 90000123006 - name: clinicalNoteTemplate in: query required: true description: | Id of clinical note template. Required parameter schema: type: string example: 90000180600 responses: '200': description: ClinicalNoteTemplateUserFavoriteV1 was deleted content: application/json: schema: $ref: '#/components/schemas/UserFavoriteResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteClinicalnotetemplateuserfavoritesV1 /v1/colorcategories: get: summary: Returns a list of ColorCategories (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no ColorCategories matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - ColorCategories (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for colorcategories. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`==`, `->`) - `isDefault` (`==`) Examples: `location.id==12`, `isDefault==value`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest colorCategoryId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ColorCategoryBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetColorcategoriesV1 post: summary: Return ColorCategory (V1) which have been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - ColorCategories (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Color Category. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ColorCategoryV1' example: name: string sequence: 0 color: 24802E location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 12445 isDefault: true examples: default: value: name: string sequence: 0 color: 24802E location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 12445 isDefault: true responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/ColorCategoryResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostColorcategoriesV1 /v1/colorcategories/{colorCategoryId}: get: summary: Return ColorCategory (V1) by ID. description: >- Returns the resource identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ColorCategories (V1) parameters: - name: colorCategoryId in: path required: true description: ID of the color category to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ColorCategoryResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetColorcategoriesByColorCategoryIdV1 put: summary: Returns the updated ColorCategory (V1). description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - ColorCategories (V1) parameters: - in: path name: colorCategoryId required: true description: ID of the color category to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Color Category identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ColorCategoryV1' example: name: string sequence: 0 color: 24802E location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 12445 isDefault: true examples: default: value: name: string sequence: 0 color: 24802E location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 12445 isDefault: true responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/ColorCategoryResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutColorcategoriesByColorCategoryIdV1 delete: summary: Delete desired ColorCategory (V1) by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - ColorCategories (V1) parameters: - name: colorCategoryId in: path required: true description: ID of the color category to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: ColorCategoryV1 was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteColorcategoriesByColorCategoryIdV1 /v1/colorcategories/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetColorcategoriesTotalcountV1 /v1/coverageprocedurecopays: get: summary: Returns a list of coverage procedure copays based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no coverage procedure copays matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - CoverageProcedureCopays (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for coverage procedure copays. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `practiceProcedure.id` (`==`, `->`) - `carrierInsurancePlan.id` (`==`) Examples: `carrierInsurancePlan.id==12`, `practiceProcedure.id==12`, `id==123`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest coverageProcedureCopayId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CoverageProcedureCopayBulkRespWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCoverageprocedurecopaysV1 /v1/coverageprocedurecopays/{coverageProcedureCopayId}: get: summary: Returns an coverage procedure copay by ID. description: >- Returns the coverage procedure copay identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - CoverageProcedureCopays (V1) parameters: - in: path name: coverageProcedureCopayId required: true description: ID of the coverage procedure copay to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CoverageProcedureCopayResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCoverageprocedurecopaysByCoverageProcedureCopayIdV1 /v1/coverageprocedurecopays/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCoverageprocedurecopaysTotalcountV1 /v1/coverageprocedureranges: get: summary: Returns a list of coverage procedure ranges based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no coverage procedure ranges matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - CoverageProcedureRanges (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for coverage procedure ranges. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `rangeStart` (`==`) - `rangeEnd` (`==`) - `carrierInsurancePlan.id` (`==`) - `lastModified` (`>`, `<`, `>=`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `carrierInsurancePlan.id==12`, `rangeEnd==value`, `rangeStart==value`, `id->[123,124]`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest coverageProcedureRangeId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CoverageProcedureRangeBulkRespWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCoverageprocedurerangesV1 /v1/coverageprocedureranges/{coverageProcedureRangeId}: get: summary: Returns an coverage procedure range by ID. description: >- Returns the coverage procedure range identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - CoverageProcedureRanges (V1) parameters: - in: path name: coverageProcedureRangeId required: true description: ID of the coverage procedure range to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CoverageProcedureRangeResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCoverageprocedurerangesByCoverageProcedureRangeIdV1 /v1/coverageprocedureranges/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCoverageprocedurerangesTotalcountV1 /v1/coverageprocedurerangetemplates: get: summary: Returns a list of coverage procedure ranges based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no coverage procedure ranges matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - CoverageProcedureRangeTemplates (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for coverage procedure range templates. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) Examples: `id->[123,124]`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest coverageProcedureRangeTemplateId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CoverageProcedRangeTemplBulkRespWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCoverageprocedurerangetemplatesV1 /v1/coverageprocedurerangetemplates/{coverageProcedureRangeTemplateId}: get: summary: Returns an coverage procedure range by ID. description: >- Returns the coverage procedure range identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - CoverageProcedureRangeTemplates (V1) parameters: - in: path name: coverageProcedureRangeTemplateId required: true description: ID of the coverage procedure range template to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/CoverageProcedRangeTemplateRespWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCoverageprocedurerangetemplatesByCoverageProcedureRangeTemplateIdV1 /v1/coverageprocedurerangetemplates/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetCoverageprocedurerangetemplatesTotalcountV1 /v1/daynotes: get: summary: Returns a list of day notes based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no day notes matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - DayNotes (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for day notes. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `date` (`>`, `<`, `>=`, `<=`) - `location.id` (`==`, `!=`, `->`) Examples: `location.id==12`, `date==value`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest day note Id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DayNoteBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDaynotesV1 post: summary: Returns day note which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - DayNotes (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Day Note. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/DayNoteV1' example: {} examples: default: value: {} responses: '201': description: DayNote was created content: application/json: schema: $ref: '#/components/schemas/DayNoteResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostDaynotesV1 /v1/daynotes/{dayNoteId}: get: summary: Returns a day note by day note ID. description: >- Returns the day note identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - DayNotes (V1) parameters: - name: dayNoteId in: path required: true description: ID of the day note to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DayNoteResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDaynotesByDayNoteIdV1 put: summary: Returns the updated day note. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - DayNotes (V1) parameters: - in: path name: dayNoteId required: true description: ID of the day note to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Day Note Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/DayNoteUpdateV1' example: note: note date: '2024-05-10T00:00:00.000Z' examples: default: value: note: note date: '2024-05-10T00:00:00.000Z' responses: '200': description: DayNote was updated content: application/json: schema: $ref: '#/components/schemas/DayNoteResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutDaynotesByDayNoteIdV1 /v1/daynotes/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDaynotesTotalcountV1 /v1/defaultplancoverages: get: summary: Returns a list of default plan coverages based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no default plan coverages matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - DefaultPlanCoverages (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for default plan coverages. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `name` (`==`, `~=`) Examples: `name==MonthlyRecall`, `id==123`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest defaultPlanCoverageId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DefaultPlanCoverageBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDefaultplancoveragesV1 /v1/defaultplancoverages/{defaultPlanCoverageId}: get: summary: Returns a default plan coverage by ID. description: >- Returns the default plan coverage identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - DefaultPlanCoverages (V1) parameters: - in: path name: defaultPlanCoverageId required: true description: ID of the default plan coverage to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DefaultPlanCoverageResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDefaultplancoveragesByDefaultPlanCoverageIdV1 /v1/defaultplancoverages/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDefaultplancoveragesTotalcountV1 /v1/dentallabs: get: summary: Returns a list of dental labs based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no dental labs matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Dental Labs (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for dental labs. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `name` (`==`, `!=`, `~=`, `<>=`) - `id` (`->`) Examples: `name==MonthlyRecall`, `id->[123,124]`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest dentalLabId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DentalLabBulkResponseWrapperV1' example: data: - id: 9000000000001 name: asdf phone: '1112223333' warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: 9000000000001 name: asdf phone: '1112223333' warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDentallabsV1 post: summary: Returns dental lab which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Dental Labs (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Dental Lab. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/DentalLabV1' example: {} examples: default: value: {} responses: '201': description: DentalLab was created content: application/json: schema: $ref: '#/components/schemas/DentalLabResponseWrapperV1' example: data: id: 9000000000001 name: asdf phone: '1112223333' warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 9000000000001 name: asdf phone: '1112223333' warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostDentallabsV1 /v1/dentallabs/{dentalLabId}: get: summary: Returns a dental lab by dental lab ID. description: >- Returns the dental lab identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Dental Labs (V1) parameters: - name: dentalLabId in: path required: true description: ID of the dental lab to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DentalLabResponseWrapperV1' example: data: id: 9000000000001 name: asdf phone: '1112223333' warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 9000000000001 name: asdf phone: '1112223333' warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDentallabsByDentalLabIdV1 put: summary: Returns the updated dental lab. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Dental Labs (V1) parameters: - in: path name: dentalLabId required: true description: ID of the dental lab to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Dental Lab Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/DentalLabUpdateV1' example: name: Example Name phone: '3245672323' examples: default: value: name: Example Name phone: '3245672323' responses: '200': description: DentalLab was updated content: application/json: schema: $ref: '#/components/schemas/DentalLabResponseWrapperV1' example: data: id: 9000000000001 name: asdf phone: '1112223333' warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 9000000000001 name: asdf phone: '1112223333' warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutDentallabsByDentalLabIdV1 /v1/dentallabs/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDentallabsTotalcountV1 /v1/documents: get: summary: Returns a list of documents based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no documents matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Documents (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for documents. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `ownerOrganization.id` (`==`) - `ownerPatient.id` (`==`) - `ownerPerioExam.id` (`==`) - `tags` (`->`) Examples: `ownerOrganization.id==12`, `ownerPatient.id==12`, `ownerPerioExam.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest documentId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DocumentBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDocumentsV1 post: summary: Returns document which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. S3 storage failures return **500**. tags: - Documents (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: | Document metadata and file content which is base64 format. For further image processing request, operations implied in file field: - fromX, fromY, width, height and ratio for cropping image operation. - width, height and ratio for resize image operation. required: true content: application/json: schema: $ref: '#/components/schemas/DocumentV1' example: {} examples: default: value: {} responses: '201': description: Document was created content: application/json: schema: $ref: '#/components/schemas/DocumentResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred, including S3 storage upload or signed URL generation failures operationId: PostDocumentsV1 /v1/documents/{documentId}: get: summary: Returns a document by documentId. description: >- Returns the document identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Documents (V1) parameters: - name: documentId in: path required: true description: ID of the document to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DocumentResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDocumentsByDocumentIdV1 put: summary: Returns the updated document. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Documents (V1) parameters: - in: path name: documentId required: true description: ID of the document to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Document Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/DocumentUpdateV1' example: id: 1234 name: Example Name examples: default: value: id: 1234 name: Example Name responses: '200': description: Document was updated content: application/json: schema: $ref: '#/components/schemas/DocumentResponseUpdateWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutDocumentsByDocumentIdV1 delete: summary: Delete desired document by ID description: >- Permanently deletes the document, its tags, and stored file content. **404** when the resource is missing or already deleted. tags: - Documents (V1) parameters: - name: documentId in: path required: true description: ID of the document to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: Document was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteDocumentsByDocumentIdV1 /v1/documents/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDocumentsTotalcountV1 /v1/documenttags: get: summary: Returns a list of documentTags based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no documentTags matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - DocumentTags (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for documenttags. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `name` (`==`, `~=`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `name==MonthlyRecall`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest documentId from previous page schema: type: string example: 100 - name: patient.id in: query required: false description: Search document tags by patient.id. For this usecase, filter and pagination will be ignored. schema: type: string example: 1 - name: perioExam.id in: query required: false description: Search document tags by perioExam.id. For this usecase, filter and pagination will be ignored. schema: type: string example: 1 - name: organization.id in: query required: false description: Search document tags by organization.id. For this usecase, filter and pagination will be ignored. schema: type: string example: 1 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DocumentTagBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetDocumenttagsV1 /v1/events: post: summary: Returns the created EventV1 tags: - Events (V1) operationId: createEvent description: | Creates a new event. Supports recurring events with weekly or monthly patterns. parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Event. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/EventV1' example: title: Team Meeting description: Weekly team sync start: '2025-01-15T10:00:00.000Z' end: '2025-01-15T11:00:00.000Z' location: id: '9000000000010' operatory: id: '9000000000338' allDay: false color: ff0000 responses: '201': description: Event created successfully content: application/json: schema: $ref: '#/components/schemas/EventResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred get: summary: Returns a list of Events (V1) based on filter criteria tags: - Events (V1) operationId: getAllEvents description: | Retrieves events based on filter criteria. Supports pagination and various filtering options. parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string example: id, title, start, end, duration style: form explode: false - name: filter in: query required: false description: >- Filter clauses for events. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `title` (`==`, `!=`, `~=`, `<>=`) - `start` (`>`, `<`, `>=`, `<=`) - `operatory.id` (`==`, `!=`, `->`) - `location.id` (`==`, `!=`, `->`) - `lastModified` (`>=`, `>`, `<=`, `<`) - `groupId` (`==`) **Ordering:** When filtering by `start`, `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `location.id==12`, `start>=2022-01-01`, `operatory.id==12`, `groupId==value`, `title~=Smith`. schema: type: string example: lastModified>=2019-12-18T20:31:38Z, location.id!=90000023 - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest eventId from previous page schema: type: string example: 500 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/EventBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred /v1/events/async: get: summary: Returns a list of Events (V1) asynchronously based on filter criteria tags: - Events (V1) operationId: getAllEventsAsync description: > Retrieves events asynchronously. Returns the first 10 results immediately and streams all matching records to the Streaming API. parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string example: id, title, start, end style: form explode: false - name: filter in: query required: false description: >- Filter clauses for events (v1) asynchronously. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `title` (`==`, `!=`, `~=`, `<>=`) - `start` (`>`, `<`, `>=`, `<=`) - `operatory.id` (`==`, `!=`, `->`) - `location.id` (`==`, `!=`, `->`) - `lastModified` (`>=`, `>`, `<=`, `<`) - `groupId` (`==`) **Ordering:** When filtering by `start`, `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `location.id==12`, `start>=2022-01-01`, `operatory.id==12`, `groupId==value`, `title~=Smith`. schema: type: string example: lastModified>=2019-12-18T20:31:38Z,location.id!=90000023 - name: lastId in: query required: false description: the biggest eventId from previous page schema: type: string example: 500 - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control (limited to 10 for async requests). schema: type: string example: 10 responses: '200': description: > Success response. Returns the first 10 results immediately and streams all matching records to the Streaming API. content: application/json: schema: $ref: '#/components/schemas/EventBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred /v1/events/{eventId}: get: summary: Returns an Event (V1) by ID tags: - Events (V1) operationId: getEventById description: > Retrieves a specific event by its ID. Returns detailed event information including location, operatory, and recurrence settings if applicable. parameters: - name: eventId in: path required: true description: ID of the event to retrieve schema: type: integer format: int64 minimum: 1 example: 9000000903375 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string example: id, title, start, end, duration style: form explode: false responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/EventResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred put: summary: Updates an Event (V1) by ID tags: - Events (V1) operationId: updateEvent description: > Updates an existing event. Supports updating single occurrences or entire recurring series based on the recurrenceTarget parameter. parameters: - name: eventId in: path required: true description: ID of the event to update schema: type: integer format: int64 minimum: 1 example: 9000000903375 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: recurrenceTarget in: query required: true schema: type: string enum: - SERIES - OCCURRENCE example: SERIES description: | This parameter defines whether the series of events will be updated or just a single occurrence. - **SERIES**: Updates the entire recurring series - **OCCURRENCE**: Updates only the single occurrence - name: responseFields in: query required: false description: | A URL-encoded, comma-delimited list of field names to include in the response data. Supported values: - **ALL**: Returns all field names. - Example: id, title, start, end, duration schema: type: string example: id, title, start, end, duration style: form explode: false requestBody: description: |- **Purpose:** Update the Event identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/EventV1' example: title: Updated Team Meeting description: Updated weekly team sync start: '2025-01-15T11:00:00.000Z' end: '2025-01-15T12:00:00.000Z' color: 00ff00 responses: '200': description: Event updated successfully content: application/json: schema: $ref: '#/components/schemas/EventResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred delete: summary: Deletes an Event (V1) by ID tags: - Events (V1) operationId: deleteEvent description: > Deletes an event by its ID. For recurring events, you can specify whether to delete the entire series or just a single occurrence using the recurrenceTarget parameter. parameters: - name: eventId in: path required: true description: ID of the event to delete schema: type: integer format: int64 minimum: 1 example: 9000000903375 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: recurrenceTarget in: query required: false schema: type: string enum: - SERIES - OCCURRENCE example: OCCURRENCE description: | This parameter defines whether the series of events will be deleted or just a single occurrence. - **SERIES**: Deletes the entire recurring series - **OCCURRENCE**: Deletes only the single occurrence responses: '200': description: Event deleted successfully '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred /v1/events/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetEventsTotalcountV1 /v1/exams: get: summary: Returns a list of exams description: >- **Query shape:** Prefer a **narrow** filter—**patient.id** is required (`filter=patient.id==…`). Queries without proper patient scoping can **408** (timeout) on large tenants. **Empty results:** **200** with `data: []` means no exams matched; it does not indicate an invalid patient id. tags: - Exam (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: filter in: query required: true description: >- Filter clauses for exams. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `patient.id` (`==`) Examples: `patient.id==12345`. schema: type: string example: /api/v1/exams?filter=patient.id==900000256 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ExamBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetExamsV1 post: summary: Returns the exam which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Exam (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Exam. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ExamV1' example: procedures: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: '213' isProcedureNotEditable: true examples: default: value: procedures: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: '213' isProcedureNotEditable: true responses: '201': description: Exam Created content: application/json: schema: $ref: '#/components/schemas/ExamResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostExamsV1 /v1/exams/{examId}: get: summary: Returns a exam by entry ID. description: >- Returns the exam identified by the path parameter. **404** when the exam is missing or not accessible in the organization context. tags: - Exam (V1) parameters: - in: path name: examId required: true description: ID of the exam to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ExamResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetExamsByExamIdV1 delete: summary: Delete specific exam by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - Exam (V1) parameters: - name: examId in: path required: true description: ID of the exam to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: The request was successful '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteExamsByExamIdV1 /v1/exams/reassign/{examId}: put: summary: Returns the reassigned exam for new patient. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Exam (V1) parameters: - in: path name: examId required: true description: ID of the exam to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Update the Exam identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ExamV1' example: procedures: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: '213' isProcedureNotEditable: true examples: default: value: procedures: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: '213' isProcedureNotEditable: true responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ExamResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutExamsReassignByExamIdV1 /v1/exams/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetExamsTotalcountV1 /v1/feescheduleassociations: get: summary: Returns FeeScheduleAssociations based on id of FeeSchedule description: >- **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 resources matched; it does not indicate invalid filter values. tags: - FeeScheduleAssociations (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: feeScheduleId in: query required: true description: ID of FeeSchedule. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/FeeScheduleAssociationsV1' example: locations: - id: 1234 name: Example Name patients: - id: 1234 name: Example Name examples: default: value: locations: - id: 1234 name: Example Name patients: - id: 1234 name: Example Name '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetFeescheduleassociationsV1 /v1/feescheduleranges: get: summary: Returns a list of FeeScheduleRanges based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no FeeScheduleRanges matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - FeeScheduleRanges (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for feescheduleranges. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `feeSchedule.id` (`==`, `!=`, `->`) - `startDate` (`>=`, `>`, `<=`, `<`) - `endDate` (`>=`, `>`, `<=`, `<`) Examples: `startDate>=2022-01-01`, `feeSchedule.id==12`. schema: type: string example: /api/v1/feescheduleranges?filter=feeSchedule.id=9000002389 - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest feeScheduleRangeId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/FeeScheduleRangeBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetFeeschedulerangesV1 post: summary: Returns created FeeScheduleRange description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - FeeScheduleRanges (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Fee Schedule Range. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/FeeScheduleRangeV1' example: {} examples: default: value: {} responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FeeScheduleRangeResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostFeeschedulerangesV1 /v1/feescheduleranges/{feeScheduleRangeId}: get: summary: Returns FeeScheduleRange by ID. description: >- Returns the FeeScheduleRange identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - FeeScheduleRanges (V1) parameters: - in: path name: feeScheduleRangeId required: true description: ID of the fee schedule range to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/FeeScheduleRangeResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetFeeschedulerangesByFeeScheduleRangeIdV1 put: summary: Returns updated FeeScheduleRange description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - FeeScheduleRanges (V1) parameters: - name: feeScheduleRangeId in: path required: true description: ID of the fee schedule range to update schema: type: string example: '1000000000001' - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Fee Schedule Range Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/FeeScheduleRangeUpdateV1' example: startDate: '2024-04-01T00:00:00.000Z' items: (practiceProcedureId): 9999999.99 examples: default: value: startDate: '2024-04-01T00:00:00.000Z' items: (practiceProcedureId): 9999999.99 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/FeeScheduleRangeResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutFeeschedulerangesByFeeScheduleRangeIdV1 delete: summary: Delete specific FeeScheduleRange by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - FeeScheduleRanges (V1) parameters: - name: feeScheduleRangeId in: path required: true description: ID of the fee schedule range to delete schema: type: string example: '1000000000001' - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteFeeschedulerangesByFeeScheduleRangeIdV1 /v1/feescheduleranges/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetFeeschedulerangesTotalcountV1 /v1/feeschedules: get: summary: Returns a list of FeeSchedules based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no FeeSchedules matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - FeeSchedules (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for feeschedules. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `id->[123,124]`. schema: type: string example: /api/v1/feeschedules?filter=lastModified>=2019-09-25T20:41:38.163Z - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest feeScheduleId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/FeeScheduleBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetFeeschedulesV1 post: summary: Returns created FeeSchedule description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - FeeSchedules (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Fee Schedule. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/FeeScheduleV1' example: name: Example Name id: 324324 lastModified: '2018-07-09T19:00:00.000Z' examples: default: value: name: Example Name id: 324324 lastModified: '2018-07-09T19:00:00.000Z' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FeeScheduleResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostFeeschedulesV1 /v1/feeschedules/{feeScheduleId}: get: summary: Returns FeeSchedule by ID. description: >- Returns the FeeSchedule identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - FeeSchedules (V1) parameters: - in: path name: feeScheduleId required: true description: ID of the fee schedule to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/FeeScheduleResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetFeeschedulesByFeeScheduleIdV1 put: summary: Returns updated FeeSchedule description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - FeeSchedules (V1) parameters: - in: path name: feeScheduleId required: true description: ID of the fee schedule to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Fee Schedule identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/FeeScheduleV1' example: name: Example Name id: 324324 lastModified: '2018-07-09T19:00:00.000Z' examples: default: value: name: Example Name id: 324324 lastModified: '2018-07-09T19:00:00.000Z' responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/FeeScheduleResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutFeeschedulesByFeeScheduleIdV1 delete: summary: Delete specific FeeSchedule by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - FeeSchedules (V1) parameters: - name: feeScheduleId in: path required: true description: ID of the fee schedule to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteFeeschedulesByFeeScheduleIdV1 /v1/feeschedules/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetFeeschedulesTotalcountV1 /v1/globalinsurancecarriers: get: summary: Returns a list of GlobalInsuranceCarriers based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no GlobalInsuranceCarriers matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - GlobalInsuranceCarriers (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for globalinsurancecarriers. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `name` (`==`, `~=`) - `payorId` (`==`, `~=`) Examples: `name==MonthlyRecall`, `payorId~=Smith`, `id->[123,124]`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest global insurance carrier ID from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/GlobalInsuranceCarrierBulkResponWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetGlobalinsurancecarriersV1 /v1/globalinsurancecarriers/{carrierId}: get: summary: Returns an GlobalInsuranceCarrier by GlobalInsuranceCarrierID. description: >- Returns the GlobalInsuranceCarrier identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - GlobalInsuranceCarriers (V1) parameters: - name: carrierId in: path required: true description: ID of the carrier to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/GlobalInsuranceCarrierResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetGlobalinsurancecarriersByCarrierIdV1 /v1/globalinsurancecarriers/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetGlobalinsurancecarriersTotalcountV1 /v1/globalproceduremappingrules: get: summary: Returns a list of Global Procedure Mapping Rules based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no Global Procedure Mapping Rules matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. See the Public API pagination documentation. tags: - GlobalProcedureMappingRules (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest globalProcedureMappingRuleId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/GlobalProcMappingRuleBulkResWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetGlobalproceduremappingrulesV1 /v1/globalproceduremappingrules/{globalProcedureMappingRuleId}: get: summary: Returns an Global Procedure Mapping Rule by Global Procedure Mapping Rule ID. description: >- Returns the Global Procedure Mapping Rule identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - GlobalProcedureMappingRules (V1) parameters: - name: globalProcedureMappingRuleId in: path required: true description: ID of the global procedure mapping rule to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/GlobalProcMappingRuleResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetGlobalproceduremappingrulesByGlobalProcedureMappingRuleIdV1 /v1/globalproceduremappingrules/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetGlobalproceduremappingrulesTotalcountV1 /v1/globalprocedures: get: summary: Returns a list of GlobalProcedures based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no GlobalProcedures matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - GlobalProcedures (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for globalprocedures. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `adaCode` (`==`, `~=`) Examples: `adaCode==D0120`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest globalProcedureId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/GlobalProcedureBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetGlobalproceduresV1 /v1/globalprocedures/{procedureId}: get: summary: Returns an GlobalProcedure by GlobalProcedure ID. description: >- Returns the GlobalProcedure identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - GlobalProcedures (V1) parameters: - name: procedureId in: path required: true description: ID of the procedure to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/GlobalProcedureResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetGlobalproceduresByProcedureIdV1 /v1/globalprocedures/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetGlobalproceduresTotalcountV1 /v1/insurancecarrierexcludedprocedures: get: summary: Returns a list of Insurance carriers with ExcludedProcedures based on filter criteria description: >- **Query shape:** Prefer a **narrow** filter. Required filter keys must be supplied where documented below. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window. **Empty results:** **200** with `data: []` means no Insurance carriers with ExcludedProcedures matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - InsuranceCarrierWithExcludedProcedure (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for insurance carriers with excludedprocedures. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `insurancecarrier.id` (`==`, `->`) Examples: `insurancecarrier.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/InsCarrierExcludedProcBulkResWrapV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetInsurancecarrierexcludedproceduresV1 post: summary: Returns Insurance Carrier with excludedProcedures which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - InsuranceCarrierWithExcludedProcedure (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Insurance Carrier With Excluded Procedure. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/InsuranceCarrierWithExcludedProcedureV1' example: insuranceCarrier: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType practiceProcedures: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType examples: default: value: insuranceCarrier: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType practiceProcedures: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType responses: '201': description: InsuranceCarrierWithExcludedProcedure creation successful content: application/json: schema: $ref: '#/components/schemas/InsCarrierExcludedProcResWrapV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostInsurancecarrierexcludedproceduresV1 /v1/insurancecarrierexcludedprocedures/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetInsurancecarrierexcludedproceduresTotalcountV1 /v1/insurancecarriers: get: summary: Returns a list of InsuranceCarriers based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no InsuranceCarriers matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - InsuranceCarriers (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for insurancecarriers. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `name` (`==`, `~=`) - `globalInsuranceCarrier.id` (`==`, `->`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `globalInsuranceCarrier.id==12`, `name==MonthlyRecall`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest insurance carrier ID from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/InsuranceCarrierBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetInsurancecarriersV1 post: summary: Returns InsuranceCarrier which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - InsuranceCarriers (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Insurance Carrier. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/InsuranceCarrierV1' example: {} examples: default: value: {} responses: '201': description: InsuranceCarrier creation successful content: application/json: schema: $ref: '#/components/schemas/InsuranceCarrierResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostInsurancecarriersV1 /v1/insurancecarriers/{carrierId}: get: summary: Returns an InsuranceCarrier by InsuranceCarrierID. description: >- Returns the InsuranceCarrier identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - InsuranceCarriers (V1) parameters: - name: carrierId in: path required: true description: ID of the carrier to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/InsuranceCarrierResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetInsurancecarriersByCarrierIdV1 put: summary: Returns the updated InsuranceCarrier. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - InsuranceCarriers (V1) parameters: - in: path name: carrierId required: true description: ID of the carrier to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Insurance Carrier identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/InsuranceCarrierV1' example: {} examples: default: value: {} responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/InsuranceCarrierResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutInsurancecarriersByCarrierIdV1 delete: summary: Delete specific InsuranceCarrier by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - InsuranceCarriers (V1) parameters: - name: carrierId in: path required: true description: ID of the carrier to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: InsuranceCarriers was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteInsurancecarriersByCarrierIdV1 /v1/insurancecarriers/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetInsurancecarriersTotalcountV1 /v1/insuranceclaims: get: summary: Returns a list of InsuranceClaims based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no InsuranceClaims matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - InsuranceClaims (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for insurance claims. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `location.id` (`==`, `->`) — use `ALL` or `*` for all locations; `->["ALL"]` or `->["*"]` for explicit all-locations. Omitting `location.id` may default to all locations during a transitional period; it may become required (IDs or `["ALL"]`). - `patient.id` (`==`, `->`) - `subscriber.id` (`==`, `->`) - `renderingProvider.id` (`==`, `->`) - `insuranceCarrier.id` (`==`, `->`) - `carrierInsurancePlan.id` (`==`, `->`) - `sentDate` (`>=`, `>`, `<=`, `<`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `sentDate` or `lastModified`, results are returned in **descending** order (newest first). Examples: `patient.id==12345`, `location.id==12`, `sentDate>=2022-01-01`, `carrierInsurancePlan.id==12`, `insuranceCarrier.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest insurance claim ID from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/InsuranceClaimBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetInsuranceclaimsV1 /v1/insuranceclaims/{claimId}: get: summary: Returns an InsuranceClaim by InsuranceClaimID. description: >- Returns the InsuranceClaim identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - InsuranceClaims (V1) parameters: - name: claimId in: path required: true description: ID of the claim to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/InsuranceClaimResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetInsuranceclaimsByClaimIdV1 /v1/insuranceclaims/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetInsuranceclaimsTotalcountV1 /v1/claimattachments: get: summary: Returns a list of ClaimAttachments V1 based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no ClaimAttachments V1 matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - ClaimAttachments (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for claimattachments v1. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `insuranceClaim.id` (`==`, `->`) Examples: `insuranceClaim.id==12`, `id==123`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest claim attachment ID from previous page schema: type: string example: 500 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ClaimAttachmentBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClaimattachmentsV1 /v1/claimattachments/{claimAttachmentId}: get: summary: Returns an ClaimAttachmentV1 by ClaimAttachmentID. description: >- Returns the ClaimAttachmentV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ClaimAttachments (V1) parameters: - name: claimAttachmentId in: path required: true description: ID of the claim attachment to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ClaimAttachmentResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClaimattachmentsByClaimAttachmentIdV1 /v1/claimattachments/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetClaimattachmentsTotalcountV1 /v1/imageattachments: get: summary: Returns a list of ImageAttachmentsV1 based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no ImageAttachmentsV1 matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - ImageAttachments (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for imageattachmentsv1. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `insuranceClaim.id` (`==`, `->`) Examples: `insuranceClaim.id==12`, `id==123`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest image attachment ID from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ImageAttachmentBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetImageattachmentsV1 /v1/imageattachments/async: get: summary: Returns a list of ImageAttachments (V1) with async support via streaming API description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no ImageAttachments matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. See the Public API pagination documentation. x-notes: > **Note:** Async retrieval is only available via the **/v1/imageattachments/async** endpoint. The regular endpoint does not support async or streaming. tags: - ImageAttachments (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string example: id, name, created, insuranceClaim.id style: form explode: false - name: filter in: query required: false description: >- Filter clauses for imageattachments. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `insuranceClaim.id` (`==`, `->`) Examples: `insuranceClaim.id==12`, `id==123`. schema: type: string example: id==123, insuranceClaim.id==456 - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 20 - name: lastId in: query required: false description: the biggest image attachment ID from previous page schema: type: string example: 12345 responses: '200': description: > Success response. Returns the first 10 results immediately and streams all matching records to the Streaming API. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/ImageAttachmentV1' description: Array of image attachments warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' examples: async_response: summary: Async mode response value: data: - id: 123 name: document.pdf created: '2024-01-15T10:30:00Z' insuranceClaim: id: 456 organizationId: '1006' - id: 124 name: image.jpg created: '2024-01-15T11:00:00Z' insuranceClaim: id: 456 organizationId: '1006' '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetImageattachmentsAsyncV1 /v1/imageattachments/{imageAttachmentId}: get: summary: Returns an ImageAttachment by ImageAttachmentID. description: >- Returns the ImageAttachment identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ImageAttachments (V1) parameters: - name: imageAttachmentId in: path required: true description: ID of the image attachment to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ImageAttachmentResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetImageattachmentsByImageAttachmentIdV1 /v1/icd10s: get: summary: Returns ICD10 codes based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - ICD10s (V1) parameters: - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for resources. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `code` (`==`, `~=`) Examples: `code==K02.9`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest icd10Id from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ICD10BulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetIcd10sV1 /v1/icd10s/{icd10Id}: get: summary: Returns an ICD10 code by entry ID. description: >- Returns the ICD10 code identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ICD10s (V1) parameters: - in: path name: icd10Id required: true description: ID of the icd10 to retrieve schema: type: integer format: int32 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ICD10ResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetIcd10sByIcd10IdV1 /v1/locationclaimdefaults: get: summary: Returns a list of Location Claim Defaults description: >- **Query shape:** Prefer a **narrow** filter. Required filter keys must be supplied where documented below. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window. **Empty results:** **200** with `data: []` means no Location Claim Defaults matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - LocationClaimDefaults (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for location claim defaults. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`==`, `!=`) Examples: `location.id==12`. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/LocationClaimDefaultBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationclaimdefaultsV1 /v1/locationclaimdefaults/{locationId}: get: summary: Returns a Location Claim Default by ID. description: >- Returns the Location Claim Default identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - LocationClaimDefaults (V1) parameters: - in: path name: locationId required: true description: ID of the location to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/LocationClaimDefaultsResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationclaimdefaultsByLocationIdV1 /v1/locatlocationclaimdefaultsons/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocatlocationclaimdefaultsonsTotalcountV1 /v1/locationexcludedprocedures: get: summary: Returns a list of Locations With ExcludedProcedures based on filter criteria description: >- **Query shape:** Prefer a **narrow** filter. Required filter keys must be supplied where documented below. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window. **Empty results:** **200** with `data: []` means no Locations With ExcludedProcedures matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - LocationWithExcludedProcedure (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for locations with excludedprocedures. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`==`, `->`) Examples: `location.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/LocationExcludedProcedureBulkResWrapV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationexcludedproceduresV1 post: summary: Returns Location with excludedProcedures which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - LocationWithExcludedProcedure (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Location With Excluded Procedure. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/LocationWithExcludedProcedureV1' example: location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType practiceProcedures: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType examples: default: value: location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType practiceProcedures: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType responses: '201': description: LocationWithExcludedProcedure creation successful content: application/json: schema: $ref: '#/components/schemas/LocationExcludedProcedureResWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostLocationexcludedproceduresV1 /v1/locationexcludedprocedures/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationexcludedproceduresTotalcountV1 /v1/locationhours: get: summary: Returns location hours (V1) which contains a list of location hours based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no location hours matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Location hours (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for resources. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`==`, `!=`, `->`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `location.id==12`, `lastModified>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest location hours ID from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/LocationHourBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationhoursV1 post: summary: Returns a location hour (V1) which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Location hours (V1) parameters: - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Location Hour. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/LocationHourV1' example: {} examples: default: value: {} responses: '201': description: LocationHour creation successful content: application/json: schema: $ref: '#/components/schemas/LocationHourResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostLocationhoursV1 /v1/locationhours/{locationHourId}: get: summary: Returns a location hour (V1) by location hour ID. description: >- Returns the location hour (V1) identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Location hours (V1) parameters: - in: path name: locationHourId required: true description: ID of the location hour to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/LocationHourResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationhoursByLocationHourIdV1 put: summary: Returns the updated location hour (V1). description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Location hours (V1) parameters: - in: path name: locationHourId required: true description: ID of the location hour to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Location Hour identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/LocationHourV1' example: {} examples: default: value: {} responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/LocationHourResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutLocationhoursByLocationHourIdV1 delete: summary: Delete specific location hour (V1) by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - Location hours (V1) parameters: - name: locationHourId in: path required: true description: ID of the location hour to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: LocationHour was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteLocationhoursByLocationHourIdV1 /v1/locationhours/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationhoursTotalcountV1 /v1/locationpovertylevels: get: summary: Returns a list of location poverty levels based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no location poverty levels matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - LocationPovertyLevels (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for location poverty levels. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`==`, `!=`, `->`) Examples: `location.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest location poverty level ID from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/LocationPovertyLevelBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationpovertylevelsV1 /v1/locationpovertylevelsV1/{locationPovertyLevelId}: get: summary: Returns a location poverty level by location poverty level ID. description: >- Returns the location poverty level identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - LocationPovertyLevels (V1) parameters: - name: locationPovertyLevelId in: path required: true description: ID of the location poverty level to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/LocationPovertyLevelResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationpovertylevelsV1ByLocationPovertyLevelIdV1 put: summary: Returns the updated location poverty level. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - LocationPovertyLevels (V1) parameters: - in: path name: locationPovertyLevelId required: true description: ID of the location poverty level to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Location Poverty Level identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/LocationPovertyLevelV1' example: id: 1234 onePerson: 99999 examples: default: value: id: 1234 onePerson: 99999 responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/LocationPovertyLevelResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutLocationpovertylevelsV1ByLocationPovertyLevelIdV1 /v1/locationpovertylevelsV1/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationpovertylevelsV1TotalcountV1 /v1/locationproductionnetactual: get: summary: Returns a list of production total net actual reports based on filter criteria description: >- Daily (or multi-day) net actual amounts by location. **Minimum valid `filter`:** `location.id`, `fromDate` (`YYYY-MM-DD`), `chargeAdjustments==true|false`, and `unappliedCredits==true|false` when neither `provider.id` nor `appointment.id` is set. Optional `range` is 1–7 days (default 1). Omitting a required key or combining `provider.id` with `appointment.id` yields **400**. **Amounts:** **actualAmount** is a net actual currency value from the API; confirm organizational scale (dollars vs cents, and so on) with product docs—zeros are normal when there is no activity for that day. **MCP (“my production”):** Add `provider.id==…` to the filter to restrict to one provider (do not combine with `appointment.id`). Omit both to get location-wide net actual. tags: - Production Net Actual Report (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: true description: >- Specifies the criteria used to calculate the report. Filters use comma-separated clauses (`key==value`, `key->[...]`); URL-encode the full string. **Required filters** - `location.id` (`==` or `->`) — Location ID, `ALL`, or `*` for all locations in the organization. - `fromDate` (`==`) — Start date in `YYYY-MM-DD` (UTC day boundary; combined with `range` to build the window). - `chargeAdjustments` (`==`) — `true` or `false`; whether to include charge-adjustment amounts in net actual. **Conditionally required** - `unappliedCredits` (`==`) — `true` or `false`. Required when **neither** `provider.id` nor `appointment.id` is set. When either `provider.id` or `appointment.id` is set, unapplied credits are not applied in the calculation (same behavior as passing `false`). **Optional filters** - `range` (`==`) — Number of consecutive days to include starting at `fromDate`. Integer **1–7**. If omitted, **defaults to 1** (single day). - `timezone` (`==`) — IANA timezone name (e.g. `America/Los_Angeles`). Used when adjusting dates; if omitted with a specific location, the location’s timezone is used; with `ALL`/`*` locations, the organization default timezone is used. - `provider.id` (`==`) — Restrict results to this provider. **Must not** be combined with `appointment.id`. - `appointment.id` (`==`) — Restrict results to this appointment. **Must not** be combined with `provider.id`. **Examples** - Single day, one location: `?filter=location.id==123,fromDate==2025-01-14,chargeAdjustments==true,unappliedCredits==false` - Seven days: `?filter=location.id==123,fromDate==2025-01-14,range==7,chargeAdjustments==true,unappliedCredits==false` - All locations: `?filter=location.id==ALL,fromDate==2025-01-14,chargeAdjustments==true,unappliedCredits==false` Examples: `location.id==123,fromDate==2025-01-14,chargeAdjustments==true,unappliedCredits==false`, `location.id==123,fromDate==2025-01-14,range==7,chargeAdjustments==true,unappliedCredits==false`, `location.id==ALL,fromDate==2025-01-14,chargeAdjustments==true,unappliedCredits==false`. **MCP (first successful call):** include `unappliedCredits==true` or `unappliedCredits==false` whenever `provider.id` and `appointment.id` are both omitted (conditionally required). schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProductionNetActualBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationproductionnetactualV1 /v1/locationproductionnetschedule: get: summary: Returns a list of production total net schedule reports based on filter criteria description: >- Location Production Net Schedule report: one row per calendar day in the `range` starting at `fromDate`, with `scheduledAmount` aggregated from the organization’s scheduled production data. **Access:** Requires `ascend:read`. If the Location Production Net Schedule API is disabled for the organization, the server responds with **403** (see `ProductionNetServiceV1` / feature `NET_SCHEDULE_API_ENABLED`). **Response shape:** `data` is always length `range` (default **1** day). There is no `meta.pagination`. **First call:** include at least `fromDate==YYYY-MM-DD` in `filter`; add `location.id` (or `ALL`/`*` where supported). At most one of `provider.id`, `patient.id`, or `appointment.id`. Invalid combinations return **400**. tags: - Production Net Schedule Report (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: true description: >- Specifies the criteria used to calculate the report. Filters use comma-separated clauses (`key==value`, `key->[...]`); URL-encode the full string. **Required filters** - `fromDate` (`==`) — Start date in `YYYY-MM-DD` (combined with `range` to build the window). **Optional filters** - `location.id` (`==`, `->`) — Location ID(s), `ALL`, or `*` for all locations in the organization. If omitted during the transitional period, all locations are used; this filter will become required in a future release. - `range` (`==`) — Number of consecutive days starting at `fromDate`. Integer **1–31**. If omitted, **defaults to 1**. - `timezone` (`==`) — IANA timezone name (e.g. `America/New_York`). Used when adjusting row dates; if omitted with a specific `location.id`, that location’s timezone is used; with `ALL`/`*` locations, the organization default timezone is used. **Mutually exclusive (use at most one)** - `provider.id` (`==`, `->`) - `patient.id` (`==`, `->`) - `appointment.id` (`==`, `->`) **Deprecated** - `isPrimaryWriteOff` (`==`) — Ignored by the server; may produce a **warning** in the response. **Examples** - Single day, one location: `?filter=location.id==123,fromDate==2025-01-14` - Seven days, all locations: `?filter=location.id==ALL,fromDate==2025-01-14,range==7` - By provider: `?filter=location.id==123,fromDate==2025-01-14,provider.id==456` Examples: `location.id==123,fromDate==2025-01-14`, `location.id==ALL,fromDate==2025-01-14,range==7`, `location.id==123,fromDate==2025-01-14,provider.id==456`. **MCP (first successful call):** `fromDate` is required. Do **not** pass `chargeAdjustments` or `unappliedCredits` (those apply to net *actual*, not this schedule report). schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProductionNetScheduleBulkResWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationproductionnetscheduleV1 /v1/locationproductionnetschedule/async: get: summary: Returns production total net schedule reports asynchronously based on filter criteria tags: - Production Net Schedule Report (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: true description: >- Filter clauses for resources. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `fromDate` (`==`) - `location.id` (`==`, `->`) - `provider.id` (`==`, `->`) - `patient.id` (`==`, `->`) - `appointment.id` (`==`, `->`) - `timezone` (`==`) - `isPrimaryWriteOff` (`==`) Examples: `patient.id==12345`, `appointment.id==789`, `provider.id==7`, `location.id==12`, `fromDate==value`. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProductionNetScheduleBulkResWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationproductionnetscheduleAsyncV1 /v1/locationproductiongross: get: summary: Returns a list of production total gross reports based on filter criteria description: >- Each row covers one calendar day in the requested window. **actualAmount** is gross production recognized for that day; **scheduledAmount** is production scheduled for that day. Both may be zero when there is no activity. **Amounts:** Treat numeric fields as the API’s currency values; confirm scale (for example dollars vs cents) with product documentation for your organization—do not infer units from the number of digits alone. **MCP (scoping):** This report is rolled up by **location** (and day). It does not accept `provider.id`. For provider-specific production, use `GET /v1/locationproductionnetactual` with `provider.id` in the filter. tags: - Production Gross Report (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: true description: >- Specifies the criteria used to calculate the report. Filters use comma-separated clauses (`key==value`, `key->[...]`); URL-encode the full string. **Required filters** - `location.id` (`==` or `->`) — Location ID, `ALL`, or `*` for all locations in the organization. - `fromDate` (`==`) — Start date in `YYYY-MM-DD` (UTC day boundary; combined with `range` to build the window). - `chargeAdjustments` (`==`) — `true` or `false`; passed to the actual-amount stored procedure as include-charges. **Optional filters** - `range` (`==`) — Number of consecutive days to include starting at `fromDate`. Integer **1–31**. If omitted, **defaults to 1** (single day). - `timezone` (`==`) — IANA timezone name (e.g. `America/Los_Angeles`). Used when adjusting dates; if omitted with a specific location, the location’s timezone is used; with `ALL`/`*` locations, the organization default timezone is used. **Examples** - Single day, one location: `?filter=location.id==123,fromDate==2025-01-14,chargeAdjustments==true` - Seven days: `?filter=location.id==123,fromDate==2025-01-14,range==7,chargeAdjustments==true` - All locations: `?filter=location.id==ALL,fromDate==2025-01-14,chargeAdjustments==true` Examples: `location.id==123,fromDate==2025-01-14,chargeAdjustments==true`, `location.id==123,fromDate==2025-01-14,range==7,chargeAdjustments==true`, `location.id==ALL,fromDate==2025-01-14,chargeAdjustments==true`. **MCP (first successful call):** include `location.id`, `fromDate`, and `chargeAdjustments` (same shape as net actual, but no `unappliedCredits`). schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProductionGrossBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationproductiongrossV1 /v1/locations: get: summary: Returns a list of Locations description: >- **Query shape:** Prefer a **narrow** filter. Required filter keys must be supplied where documented below. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window. **Empty results:** **200** with `data: []` means no Locations matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - Locations (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for locations. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `id->[123,124]`. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/LocationBulkResponseWrapperV1' example: data: - id: '1000000001027' type: LocationV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: '1000000001027' type: LocationV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationsV1 /v1/locations/{locationId}: get: summary: Returns a LocationV1 by ID. description: >- Returns the LocationV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Locations (V1) parameters: - in: path name: locationId required: true description: ID of the location to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/LocationResponseWrapperV1' example: data: id: '1000000001027' type: LocationV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000000001027' type: LocationV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationsByLocationIdV1 put: summary: Returns the updated LocationV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Locations (V1) parameters: - in: path name: locationId required: true description: ID of the location to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Location identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/LocationV1' example: id: 12445 name: string examples: default: value: id: 12445 name: string responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/LocationResponseWrapperV1' example: data: id: '1000000001027' type: LocationV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000000001027' type: LocationV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutLocationsByLocationIdV1 /v1/locations/{locationId}/practiceprofile: get: summary: Returns the Practice Profile for a location. description: >- Returns the practice profile for the location identified by the path parameter. **404** when the location or practice profile is missing or not accessible in the organization context. tags: - Practice Profiles (V1) parameters: - in: path name: locationId required: true description: ID of the location whose practice profile should be retrieved. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PracticeProfileResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationsByLocationIdPracticeprofileV1 post: summary: Returns the Practice Profile that has been created. description: >- Creates a practice profile for the location identified by the path parameter. Validation errors return **400**; **400** when a profile already exists for the location; a successful create returns **201** with the created resource in `data`. tags: - Practice Profiles (V1) parameters: - in: path name: locationId required: true description: ID of the location for which to create the practice profile. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create the practice profile for the location identified by the path parameter. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. A profile may only be created once per location. required: true content: application/json: schema: $ref: '#/components/schemas/PracticeProfileUpdateV1' example: version: 0 bannerColor: '173249' examples: default: value: version: 0 bannerColor: '173249' responses: '201': description: Practice Profile creation successful content: application/json: schema: $ref: '#/components/schemas/PracticeProfileResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostLocationsByLocationIdPracticeprofileV1 put: summary: Returns the updated Practice Profile. description: >- Updates the practice profile for the location identified by the path parameter. Validation errors return **400**; **404** when the location or practice profile is missing. tags: - Practice Profiles (V1) parameters: - in: path name: locationId required: true description: ID of the location whose practice profile should be updated. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the practice profile for the location identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PracticeProfileUpdateV1' example: version: 0 bannerColor: '173249' examples: default: value: version: 0 bannerColor: '173249' responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/PracticeProfileResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutLocationsByLocationIdPracticeprofileV1 delete: summary: Delete the Practice Profile for a location. description: >- Deletes the practice profile for the location identified by the path parameter. **404** when the location or practice profile is missing. tags: - Practice Profiles (V1) parameters: - name: locationId in: path required: true description: ID of the location whose practice profile should be deleted. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: Practice Profile was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteLocationsByLocationIdPracticeprofileV1 /v1/locations/{locationId}/logo: get: summary: Returns the logo document for a location practice profile. description: >- Returns the logo document linked to the practice profile for the location identified by the path parameter. **404** when the location, practice profile, or logo document is missing. tags: - Practice Logos (V1) parameters: - in: path name: locationId required: true description: ID of the location whose practice logo should be retrieved. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PracticeLogoResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationsByLocationIdLogoV1 post: summary: Returns the logo document which has been created. description: >- Creates a logo document for the practice profile of the location identified by the path parameter. A practice profile must already exist for the location. Validation errors return **400**; a successful create returns **201** with the created document in `data`. **Logo constraints:** Image width and height must not exceed 400px. Defaults to 200px when omitted. `ownerOrganization.id` must match the organization in the request header. tags: - Practice Logos (V1) parameters: - in: path name: locationId required: true description: ID of the location for which to create the practice logo. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: >- **Purpose:** Create a logo document for the practice profile of the location identified by the path parameter. **Required fields:** `name`, `mimeType`, `file`, and `ownerOrganization` with an `id` matching the organization context. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PracticeLogoV1' example: {} examples: default: value: {} responses: '201': description: Practice logo was created content: application/json: schema: $ref: '#/components/schemas/PracticeLogoResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostLocationsByLocationIdLogoV1 delete: summary: Delete the logo document for a location practice profile. description: >- Deletes the logo document linked to the practice profile for the location identified by the path parameter. **404** when the location, practice profile, or logo document is missing. tags: - Practice Logos (V1) parameters: - name: locationId in: path required: true description: ID of the location whose practice logo should be deleted. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: Practice logo was deleted content: application/json: schema: $ref: '#/components/schemas/PracticeProfileResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteLocationsByLocationIdLogoV1 /v1/locations/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetLocationsTotalcountV1 /v1/medicalalertcategories: get: summary: Returns a list of MedicalAlertCategories (V1) description: >- **Query shape:** Prefer a **narrow** filter. Required filter keys must be supplied where documented below. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window. **Empty results:** **200** with `data: []` means no MedicalAlertCategories matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - MedicalAlertCategories (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for medicalalertcategories. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/MedicalAlertCategoryBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertcategoriesV1 /v1/medicalalertcategories/{medicalAlertCategoryId}: get: summary: Returns a MedicalAlertCategoryV1 by ID. description: >- Returns the MedicalAlertCategoryV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - MedicalAlertCategories (V1) parameters: - in: path name: medicalAlertCategoryId required: true description: ID of the medical alert category to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/MedicalAlertCategoryResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertcategoriesByMedicalAlertCategoryIdV1 /v1/medicalalertcategories/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertcategoriesTotalcountV1 /v1/medicalalertreactions: get: summary: Returns a list of MedicalAlertReactions (V1) description: >- **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 MedicalAlertReactions matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - MedicalAlertReactions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/MedicalAlertReactionBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertreactionsV1 /v1/medicalalertreactions/{medicalAlertReactionId}: get: summary: Returns a MedicalAlertReaction(V1) by ID. description: >- Returns the MedicalAlertReaction(V1) identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - MedicalAlertReactions (V1) parameters: - in: path name: medicalAlertReactionId required: true description: ID of the medical alert reaction to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/MedicalAlertReactionResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertreactionsByMedicalAlertReactionIdV1 /v1/medicalalertreactions/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertreactionsTotalcountV1 /v1/medicalalerts: get: summary: Returns a list of MedicalAlerts (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no MedicalAlerts matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - MedicalAlerts (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for medical alerts. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first). Examples: `lastModified>=2022-01-01`, `lastModified<2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest medicalAlertId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/MedicalAlertBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertsV1 post: summary: Returns MedicalAlertV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - MedicalAlerts (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Medical Alert. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/MedicalAlertV1' example: {} examples: default: value: {} responses: '201': description: MedicalAlert creation successful content: application/json: schema: $ref: '#/components/schemas/MedicalAlertResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostMedicalalertsV1 /v1/medicalalerts/{medicalAlertId}: get: summary: Returns a MedicalAlertV1 by ID. description: >- Returns the MedicalAlertV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - MedicalAlerts (V1) parameters: - in: path name: medicalAlertId required: true description: ID of the medical alert to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/MedicalAlertResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertsByMedicalAlertIdV1 put: summary: Returns the updated MedicalAlertV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - MedicalAlerts (V1) parameters: - in: path name: medicalAlertId required: true description: ID of the medical alert to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Medical Alert Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/MedicalAlertUpdateV1' example: description: Example description for description visible: true examples: default: value: description: Example description for description visible: true responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/MedicalAlertResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutMedicalalertsByMedicalAlertIdV1 delete: summary: Delete desired MedicalAlertV1 by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - MedicalAlerts (V1) parameters: - name: medicalAlertId in: path required: true description: ID of the medical alert to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: MedicalAlertV1 was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteMedicalalertsByMedicalAlertIdV1 /v1/medicalalerts/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertsTotalcountV1 /v1/medicalalertseverities: get: summary: Returns a list of MedicalAlertSeverities (V1) description: >- **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 MedicalAlertSeverities matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - MedicalAlertSeverities (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/MedicalAlertSeverityBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertseveritiesV1 /v1/medicalalertseverities/{medicalAlertSeverityId}: get: summary: Returns a MedicalAlertSeverity (V1) by ID. description: >- Returns the MedicalAlertSeverity (V1) identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - MedicalAlertSeverities (V1) parameters: - in: path name: medicalAlertSeverityId required: true description: ID of the medical alert severity to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/MedicalAlertSeverityResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertseveritiesByMedicalAlertSeverityIdV1 /v1/medicalalertseverities/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMedicalalertseveritiesTotalcountV1 /v1/missedappointments: get: summary: Returns a list of missed appointments based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no missed appointments matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Missed Appointments (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for missed appointments. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`==`, `!=`, `->`) — use `ALL` or `*` for all locations; `->["ALL"]` or `->["*"]` for explicit all-locations. Omitting `location.id` may default to all locations during a transitional period; it may become required (IDs or `["ALL"]`). - `start` (`>`, `<`, `>=`, `<=`) - `patient.id` (`==`, `!=`) - `operatory.id` (`==`, `!=`, `->`) - `appointment.id` (`==`) **Ordering:** When filtering by `start`, use `lastId` for pagination where supported; result order follows server rules. Examples: `location.id==12`, `start>=2022-01-01`, `patient.id==12`, `appointment.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest missedAppointmentId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/MissedAppointmentBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMissedappointmentsV1 /v1/missedappointments/{missedAppointmentId}: get: summary: Returns a missed appointment by missed appointment ID. description: >- Returns the missed appointment identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Missed Appointments (V1) parameters: - in: path name: missedAppointmentId required: true description: ID of the missed appointment to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/MissedAppointmentResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMissedappointmentsByMissedAppointmentIdV1 put: summary: Returns the updated missed appointment. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Missed Appointments (V1) parameters: - in: path name: missedAppointmentId required: true description: ID of the missed appointment to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Missed Appointment Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/MissedAppointmentUpdateV1' example: cancelledOn: '2018-07-09T19:00:00.000Z' reasonCancelled: reason cancelled examples: default: value: cancelledOn: '2018-07-09T19:00:00.000Z' reasonCancelled: reason cancelled responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/MissedAppointmentResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutMissedappointmentsByMissedAppointmentIdV1 delete: summary: Delete specific missed appointment by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - Missed Appointments (V1) parameters: - name: missedAppointmentId in: path required: true description: ID of the missed appointment to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: MissedAppointment was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteMissedappointmentsByMissedAppointmentIdV1 /v1/missedappointments/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetMissedappointmentsTotalcountV1 /v1/onlinebookinglocations: get: summary: Returns a list of OnlineBookingLocation (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no OnlineBookingLocation matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. See the Public API pagination documentation. tags: - OnlineBookingLocations (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for onlinebookinglocation. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`->`) - `enabled` (`==`) Examples: `location.id==12`, `enabled==true`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest onlineBookingLocationId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OnBookLocationBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOnlinebookinglocationsV1 post: summary: Returns OnlineBookingLocationV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - OnlineBookingLocations (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Online Booking Location. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/OnlineBookingLocationV1' example: {} examples: default: value: {} responses: '201': description: OnlineBookingLocation creation successful content: application/json: schema: $ref: '#/components/schemas/OnlineBookingLocationResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostOnlinebookinglocationsV1 /v1/onlinebookinglocations/{locationId}: get: summary: Returns an OnlineBookingLocationV1 by locationId. description: >- Returns the OnlineBookingLocationV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - OnlineBookingLocations (V1) parameters: - name: locationId in: path required: true description: ID of the location to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OnlineBookingLocationResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOnlinebookinglocationsByLocationIdV1 put: summary: Returns the updated OnlineBookingLocationV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - OnlineBookingLocations (V1) parameters: - in: path name: locationId required: true description: ID of the location to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Online Booking Location Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/OnlineBookingLocationUpdateV1' example: enabled: true version: 1 examples: default: value: enabled: true version: 1 responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/OnlineBookingLocationResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutOnlinebookinglocationsByLocationIdV1 delete: summary: Delete desired OnlineBookingLocationV1 by locationId description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - OnlineBookingLocations (V1) parameters: - name: locationId in: path required: true description: ID of the location to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: OnlineBookingLocation was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteOnlinebookinglocationsByLocationIdV1 /v1/operatories: get: summary: Returns a list of Operatories (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no Operatories matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Operatories (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for operatories. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`==`, `!=`, `->`) - `id` (`->`) Examples: `location.id==12`, `id->[123,124]`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest operatoryId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OperatoryBulkResponseWrapperV1' example: data: - id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOperatoriesV1 post: summary: Returns OperatoryV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Operatories (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Operatory. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/OperatoryV1' example: {} examples: default: value: {} responses: '201': description: Operatory creation successful content: application/json: schema: $ref: '#/components/schemas/OperatoryResponseWrapperV1' example: data: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostOperatoriesV1 /v1/operatories/{operatoryId}: get: summary: Returns an OperatoryV1 by ID. description: >- Returns the OperatoryV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Operatories (V1) parameters: - name: operatoryId in: path required: true description: ID of the operatory to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OperatoryResponseWrapperV1' example: data: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOperatoriesByOperatoryIdV1 put: summary: Returns the updated OperatoryV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Operatories (V1) parameters: - in: path name: operatoryId required: true description: ID of the operatory to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Operatory Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/OperatoryUpdateV1' example: name: Example Name shortName: short name examples: default: value: name: Example Name shortName: short name responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/OperatoryResponseWrapperV1' example: data: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutOperatoriesByOperatoryIdV1 delete: summary: Delete desired OpeatoryV1 by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - Operatories (V1) parameters: - name: operatoryId in: path required: true description: ID of the operatory to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: Opeatory was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteOperatoriesByOperatoryIdV1 /v1/operatories/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOperatoriesTotalcountV1 /v1/organizationconditions: get: summary: Returns a list of organization condition entries based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no organization condition entries matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - OrganizationConditions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for organization condition entries. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `condition.id` (`==`, `->`) - `condition.snomedCode` (`==`, `~=`) - `condition.snodent.code` (`==`) - `condition.icd10.code` (`==`) - `condition.icd10.description` (`==`) - `description` (`==`, `~=`) - `lastModified` (`>`, `<`, `>=`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `condition.icd10.code==value`, `condition.icd10.description==value`, `condition.id==12`, `condition.snodent.code==value`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest organization condition ID from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OrgConditionBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOrganizationconditionsV1 /v1/organizationconditions/{organizationConditionId}: get: summary: Returns a organizationCondition entry by ID. description: >- Returns the organizationCondition entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - OrganizationConditions (V1) parameters: - in: path name: organizationConditionId required: true description: ID of the organization condition to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OrganizationConditionResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOrganizationconditionsByOrganizationConditionIdV1 put: summary: Returns the updated organizationCondition. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - OrganizationConditions (V1) parameters: - in: path name: organizationConditionId required: true description: ID of the organization condition to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Organization Condition Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/OrganizationConditionUpdateV1' example: favorite: true isActive: true examples: default: value: favorite: true isActive: true responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/OrganizationConditionResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutOrganizationconditionsByOrganizationConditionIdV1 /v1/organizationconditions/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOrganizationconditionsTotalcountV1 /v1/organizationledgerrules: get: summary: Returns a list of OrganizationLedgerRules description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no OrganizationLedgerRules matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - OrganizationLedgerRules (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: filter in: query required: false description: >- Filter clauses for organizationledgerrules. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`) Examples: `id==123`. schema: type: string - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest organizationLedgerRuleId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OrganizationLedgerRulesBulkResWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOrganizationledgerrulesV1 /v1/organizationledgerrules/{organizationLedgerRuleId}: put: summary: Returns the updated OrganizationLedgerRule. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - OrganizationLedgerRules (V1) parameters: - in: path name: organizationLedgerRuleId required: true description: ID of the organization ledger rule to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Organization Ledger Rules identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/OrganizationLedgerRulesV1' example: id: 324324 transactionLockTime: 999 examples: default: value: id: 324324 transactionLockTime: 999 responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/OrganizationLedgerRulesResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutOrganizationledgerrulesByOrganizationLedgerRuleIdV1 /v1/organizationledgerrules/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOrganizationledgerrulesTotalcountV1 /v1/organizationledgertypes: get: summary: Returns a list of organization ledger types based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no organization ledger types matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - OrganizationLedgerTypes (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for organization ledger types. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `description` (`==`, `~=`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `description~=Smith`, `id==123`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest organization ledger type ID from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OrganizationLedgerTypeBulkRespWrapperV1' example: data: - id: 9000000000001 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: 9000000000001 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOrganizationledgertypesV1 /v1/organizationledgertypes/{organizationLedgerTypeId}: get: summary: Returns a organizationLedgerType entry by ID. description: >- Returns the organizationLedgerType entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - OrganizationLedgerTypes (V1) parameters: - in: path name: organizationLedgerTypeId required: true description: ID of the organization ledger type to retrieve schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OrganizationLedgerTypeResponseWrapperV1' example: data: id: 9000000000001 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 9000000000001 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOrganizationledgertypesByOrganizationLedgerTypeIdV1 /v1/organizations/billingtypes: get: summary: Returns a list of Organization Billing Types based on filter criteria tags: - Organization Billing Types parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A url encoded comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: page in: query required: false description: Page number for pagination control schema: type: string - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest organizationBillingType id from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OrgBillingTypeBulkResponseWrapper' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOrganizationsBillingtypes post: summary: Returns Organization Billing Type which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Organization Billing Types parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Organization Billing Type. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/OrganizationBillingType' example: {} examples: default: value: {} responses: '201': description: Organization Billing Type creation successful content: application/json: schema: $ref: '#/components/schemas/OrganizationBillingTypeResponseWrapper' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostOrganizationsBillingtypes /v1/organizations/billingtypes/{billingTypeId}: get: summary: Returns an Organization Billing Type by ID. description: >- Returns the Organization Billing Type identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Organization Billing Types parameters: - name: billingTypeId in: path required: true description: ID for getting the Organization Billing Type. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A url encoded comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OrganizationBillingTypeResponseWrapper' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOrganizationsBillingtypesByBillingTypeId put: summary: Returns the updated Organization Billing Type. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Organization Billing Types parameters: - in: path name: billingTypeId required: true description: ID for which to update the Organization Billing Type. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true schema: type: string example: 1006 - in: query name: responseFields required: false description: > A url encoded comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Organization Billing Type identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/OrganizationBillingTypeUpdate' example: name: New Billing Type isDefault: true examples: default: value: name: New Billing Type isDefault: true responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/OrganizationBillingTypeResponseWrapper' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutOrganizationsBillingtypesByBillingTypeId delete: summary: Delete desired Organization Billing Type by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - Organization Billing Types parameters: - name: billingTypeId in: path required: true description: ID for deleting the Organization Billing Type. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true schema: type: string example: 1006 responses: '200': description: Opeatory was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteOrganizationsBillingtypesByBillingTypeId /v1/organizations/{organizationId}: get: summary: Returns an organization by organization ID. description: >- Returns the organization identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Organizations (V1) parameters: - name: organizationId in: path required: true description: ID of the organization to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/OrganizationResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOrganizationsByOrganizationIdV1 /v1/organizations/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetOrganizationsTotalcountV1 /v1/patientconditions: get: summary: Returns a list of patient condition entries based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no patient condition entries matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PatientConditions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for patient condition entries. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `patient.id` (`==`, `->`) - `serviceDate` (`>`, `<`, `>=`, `<=`) - `lastModified` (`>`, `<`, `>=`, `<=`) **Ordering:** When filtering by `serviceDate`, `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `serviceDate>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest patient condition ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientConditionBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientconditionsV1 post: summary: Returns patientCondition which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PatientConditions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Patient Condition. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientConditionV1' example: {} examples: default: value: {} responses: '201': description: PatientCondition was created content: application/json: schema: $ref: '#/components/schemas/PatientConditionResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPatientconditionsV1 /v1/patientconditions/{patientConditionId}: get: summary: Returns a patientCondition entry by ID. description: >- Returns the patientCondition entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PatientConditions (V1) parameters: - in: path name: patientConditionId required: true description: ID of the patient condition to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientConditionResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientconditionsByPatientConditionIdV1 put: summary: Returns the updated patientCondition. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PatientConditions (V1) parameters: - in: path name: patientConditionId required: true description: ID of the patient condition to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Patient Condition Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientConditionUpdateV1' example: status: ACTIVE state: CANCELLED examples: default: value: status: ACTIVE state: CANCELLED responses: '200': description: PatientCondition was updated content: application/json: schema: $ref: '#/components/schemas/PatientConditionResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPatientconditionsByPatientConditionIdV1 delete: summary: Delete desired patientCondition by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - PatientConditions (V1) parameters: - name: patientConditionId in: path required: true description: ID of the patient condition to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: PatientCondition was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeletePatientconditionsByPatientConditionIdV1 /v1/patientconditions/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientconditionsTotalcountV1 /v1/patientinsuranceplans: get: summary: Returns a list of patient insurance plans based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no patient insurance plans matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PatientInsurancePlans (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for patient insurance plans. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `patient.id` (`==`, `->`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `lastModified>=2022-01-01`, `id==123`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest patient insurance plan ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientInsurancePlanBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientinsuranceplansV1 /v1/patientinsuranceplans/{patientInsurancePlanId}: get: summary: Returns a patient insurance plan by entry ID. description: >- Returns the patient insurance plan identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PatientInsurancePlans (V1) parameters: - in: path name: patientInsurancePlanId required: true description: ID of the patient insurance plan to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientInsurancePlanResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientinsuranceplansByPatientInsurancePlanIdV1 /v1/patientinsuranceplans/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientinsuranceplansTotalcountV1 /v1/patientmedicalalerts: get: summary: Returns a list of PatientMedicalAlerts (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no PatientMedicalAlerts matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PatientMedicalAlerts (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for patientmedicalalerts. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `patient.id` (`==`, `!=`, `->`) - `medicalAlert.id` (`==`, `!=`, `->`) - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `lastModified>=2022-01-01`, `medicalAlert.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest patientMedicalAlertId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientMedicalAlertBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientmedicalalertsV1 post: summary: Returns PatientMedicalAlertV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PatientMedicalAlerts (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Patient Medical Alert. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientMedicalAlertV1' example: {} examples: default: value: {} responses: '201': description: PatientMedicalAlerts was created content: application/json: schema: $ref: '#/components/schemas/PatientMedicalAlertResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPatientmedicalalertsV1 /v1/patientmedicalalerts/{patientMedicalAlertId}: get: summary: Returns a PatientMedicalAlertV1 by ID. description: >- Returns the PatientMedicalAlertV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PatientMedicalAlerts (V1) parameters: - in: path name: patientMedicalAlertId required: true description: ID of the patient medical alert to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientMedicalAlertResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientmedicalalertsByPatientMedicalAlertIdV1 put: summary: Returns the updated PatientMedicalAlertV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PatientMedicalAlerts (V1) parameters: - in: path name: patientMedicalAlertId required: true description: ID of the patient medical alert to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Patient Medical Alert Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientMedicalAlertUpdateV1' example: visible: true effectiveDate: '2024-05-10T00:00:00.000Z' examples: default: value: visible: true effectiveDate: '2024-05-10T00:00:00.000Z' responses: '200': description: PatientMedicalAlerts was updated content: application/json: schema: $ref: '#/components/schemas/PatientMedicalAlertResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPatientmedicalalertsByPatientMedicalAlertIdV1 delete: summary: Delete desired PatientMedicalAlertV1 by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - PatientMedicalAlerts (V1) parameters: - name: patientMedicalAlertId in: path required: true description: ID of the patient medical alert to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: PatientMedicalAlerts was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeletePatientmedicalalertsByPatientMedicalAlertIdV1 /v1/patientmedicalalerts/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientmedicalalertsTotalcountV1 /v1/patientnotes: get: summary: Returns a list of patient note entries based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no patient note entries matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PatientNotes (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for patient note entries. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `noteDate` (`==`, `>`, `<`, `>=`, `<=`) - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `noteDate>=2022-01-01`, `noteDate==value`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest patient note ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientNoteBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientnotesV1 post: summary: Returns the created patient note object description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PatientNotes (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Patient Note. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientNoteV1' example: {} examples: default: value: {} responses: '201': description: PatientNote was created content: application/json: schema: $ref: '#/components/schemas/PatientNoteResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPatientnotesV1 /v1/patientnotes/{patientNoteId}: get: summary: Returns a patientNote entry by entry ID. description: >- Returns the patientNote entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PatientNotes (V1) parameters: - in: path name: patientNoteId required: true description: ID of the patient note to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientNoteResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientnotesByPatientNoteIdV1 put: summary: Returns the updated patient note. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PatientNotes (V1) parameters: - in: path name: patientNoteId required: true description: ID of the patient note to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Patient Note Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientNoteUpdateV1' example: text: text noteDate: '2024-05-10T00:00:00.000Z' examples: default: value: text: text noteDate: '2024-05-10T00:00:00.000Z' responses: '200': description: PatientNote was updated content: application/json: schema: $ref: '#/components/schemas/PatientNoteResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPatientnotesByPatientNoteIdV1 delete: summary: Delete specific patient note by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - PatientNotes (V1) parameters: - name: patientNoteId in: path required: true description: ID of the patient note to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: PatientNote was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeletePatientnotesByPatientNoteIdV1 /v1/patientnotes/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientnotesTotalcountV1 /v1/patientpaymentplans: get: summary: Returns a list of payment plans entries based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no payment plans entries matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PatientPaymentPlans (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for payment plans entries. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`) - `patient.id` (`==`, `->`) - `location.id` (`==`, `->`) - `provider.id` (`==`, `->`) Examples: `patient.id==12345`, `provider.id==7`, `location.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest patient ledger ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientPaymentPlanBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientpaymentplansV1 /v1/patientpaymentplans/{patientPaymentPlanId}: get: summary: Returns a payment plan by ID. description: >- Returns the payment plan identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PatientPaymentPlans (V1) parameters: - in: path name: patientPaymentPlanId required: true description: ID of the patient payment plan to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientPaymentPlanResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientpaymentplansByPatientPaymentPlanIdV1 /v1/patientpaymentplans/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientpaymentplansTotalcountV1 /v1/patientprescriptions: get: summary: Returns a list of PatientPrescriptions (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no PatientPrescriptions matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PatientPrescriptions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for patientprescriptions. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `patient.id` (`==`, `->`) - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `lastModified>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest patient prescription ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientPrescriptionBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientprescriptionsV1 post: summary: Returns PatientPrescriptionV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PatientPrescriptions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Patient Prescription. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientPrescriptionV1' example: drugCategoryName: name drug: drug sig: sig refills: 99 dispense: '999999' drugUnit: 500 mg consumingType: DISPENSE_AS_WRITTEN custom: true controlledSubstance: true provider: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType patient: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 32432 datePrescribed: '2018-07-09T19:00:00.000Z' examples: default: value: drugCategoryName: name drug: drug sig: sig refills: 99 dispense: '999999' drugUnit: 500 mg consumingType: DISPENSE_AS_WRITTEN custom: true controlledSubstance: true provider: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType patient: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 32432 datePrescribed: '2018-07-09T19:00:00.000Z' responses: '201': description: PatientPrescription was created content: application/json: schema: $ref: '#/components/schemas/PatientPrescriptionResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPatientprescriptionsV1 /v1/patientprescriptions/{patientPrescriptionId}: get: summary: Returns a PatientPrescriptionV1 by ID. description: >- Returns the PatientPrescriptionV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PatientPrescriptions (V1) parameters: - in: path name: patientPrescriptionId required: true description: ID of the patient prescription to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientPrescriptionResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientprescriptionsByPatientPrescriptionIdV1 put: summary: Returns the updated PatientPrescriptionV1 description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PatientPrescriptions (V1) parameters: - in: path name: patientPrescriptionId required: true description: ID of the patient prescription to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Patient Prescription Update Wrapper identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientPrescriptionUpdateWrapperV1' example: voidStatus: user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType voidReason: OTHER dateVoided: '2024-05-10T00:00:00.000Z' note: note id: 12445 examples: default: value: voidStatus: user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType voidReason: OTHER dateVoided: '2024-05-10T00:00:00.000Z' note: note id: 12445 responses: '200': description: PatientPrescription was updated content: application/json: schema: $ref: '#/components/schemas/PatientPrescriptionUpdateWrapperV1' example: voidStatus: user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType voidReason: OTHER dateVoided: '2024-05-10T00:00:00.000Z' note: note id: 12445 examples: default: value: voidStatus: user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType voidReason: OTHER dateVoided: '2024-05-10T00:00:00.000Z' note: note id: 12445 '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPatientprescriptionsByPatientPrescriptionIdV1 /v1/patientprescriptions/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientprescriptionsTotalcountV1 /v1/patientprocedures: get: summary: Returns a list of PatientProcedures based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no PatientProcedures matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PatientProcedures(V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for patientprocedures. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `serviceDate` (`>`, `<`, `>=`, `<=`) - `entryDate` (`>`, `<`, `>=`, `<=`) - `lastModified` (`>`, `<`, `>=`, `<=`) - `treatmentPlannedProvider.id` (`==`, `!=`) - `status` (`==`, `!=`) - `txCase.id` (`==`, `->`) - `location.id` (`==`, `!=`, `->`) - `patient.id` (`==`, `!=`, `->`) - `state` (`==`) - `referredOut` (`==`, `!=`) **Ordering:** When filtering by `serviceDate`, `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `location.id==12`, `serviceDate>=2022-01-01`, `treatmentPlannedProvider.id==12`, `txCase.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest patientProcedureId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientProcedureBulkResponseWrapperV1' example: data: - id: '9000003725942' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: '9000003725942' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientproceduresV1 post: summary: Returns PatientProcedure which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PatientProcedures(V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: coveredBy in: query required: false description: | Covered practice procedures by location | carrier (insurance) ?coveredBy=location schema: type: string example: location | carrier enum: - location - carrier requestBody: description: >- **Purpose:** Add a clinical procedure to a patient's chart. **Required fields:** See `PatientProcedureCreateV1` schema (`patient`, `location`, `practiceProcedure`, `status`, etc.). **Query `coveredBy`:** Optional `location` or `carrier` — controls fee/estimate coverage validation. **Status-specific rules:** `COMPLETED` requires `autoCalculateEstimateEnabled`. Treatment-info practice procedures also require `monthsRemaining` and `appliancePlacementDate`. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientProcedureCreateV1' example: {} examples: default: value: {} responses: '201': description: PatientProcedure was created content: application/json: schema: $ref: '#/components/schemas/PatientProcedureBulkResponseWrapperV1' example: data: - id: '9000003725942' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: '9000003725942' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPatientproceduresV1 /v1/patientprocedures/{procedureId}: get: summary: Returns an PatientProcedure by PatientProcedureID. description: >- Returns the PatientProcedure identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PatientProcedures(V1) parameters: - name: procedureId in: path required: true description: ID of the procedure to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientProcedureResponseWrapperV1' example: data: id: '9000003725942' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '9000003725942' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientproceduresByProcedureIdV1 put: summary: Returns the updated PatientProcedure. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PatientProcedures(V1) parameters: - in: path name: procedureId required: true description: ID of the procedure to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string - name: reason in: query required: false description: correct reason for credit and rebill case if organization ledger rule was set schema: type: string - name: coveredBy in: query required: false description: | Covered practice procedures by location | carrier (insurance) ?coveredBy=location schema: type: string example: location | carrier enum: - location - carrier requestBody: description: |- **Purpose:** Update the Patient Procedure Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/PatientProcedureUpdateV1' - $ref: '#/components/schemas/PatientProcedureVoidV1' responses: '200': description: PatientProcedure was updated content: application/json: schema: oneOf: - $ref: '#/components/schemas/PatientProcedureResponseWrapperV1' - $ref: '#/components/schemas/VoidPatientProcedureResponseWrapperV1' '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPatientproceduresByProcedureIdV1 delete: summary: Delete specific PatientProcedure by ID description: >- Cancels the patient procedure (soft delete: `state` → `CANCELLED`). **404** when the resource is missing or already cancelled. **Query `reason`:** Required when the organization's ledger rules mandate a delete reason. **Side effects:** May unlink visits, update linked appointments, and cancel associated tx-plan visits when this is the last procedure on a visit. tags: - PatientProcedures(V1) parameters: - name: procedureId in: path required: true description: ID of the procedure to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: reason in: query required: false description: delete reason if organization ledger rule was set schema: type: string responses: '200': description: PatientProcedure was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeletePatientproceduresByProcedureIdV1 /v1/patientprocedures/calculated: get: summary: Returns a list of objects with calculated fields for PatientProcedures based on filter criteria description: >- **Required:** `filter` must include `patientProcedure.id` (single or list). **Required:** `responseFields` must include both `isEditable` and `appointmentToBeDeleted` (comma-separated). Missing either typically returns **400**. tags: - PatientProcedures(V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: filter in: query required: true description: >- Filter clauses for objects with calculated fields for patientprocedures. General grammar and operators: the Public API filter documentation. **Keys and operators (this endpoint)** - `patientProcedure.id` (`==`, `->`) - `location.id` (`==`, `!=`, `->`) - `isEditable` (`==`) - `appointmentToBeDeleted` (`==`, `->`) Examples: `location.id==12`, `patientProcedure.id==12`, `appointmentToBeDeleted==value`, `isEditable==value`. schema: type: string - name: responseFields in: query required: true description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientProcedureCalcBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientproceduresCalculatedV1 /v1/patientprocedures/mapping: post: summary: Returns mapped practiceProcedure and fee amount description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PatientProcedures(V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: ProcedureMapping data required: true content: application/json: schema: $ref: '#/components/schemas/ProcedureMappingV1' example: patient: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType practiceProcedure: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType renderingProvider: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType serviceDate: '2018-07-09' procedureTeeth: - id: abc123 procedureId: 987654321 examples: default: value: patient: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType practiceProcedure: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType renderingProvider: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType serviceDate: '2018-07-09' procedureTeeth: - id: abc123 procedureId: 987654321 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProcedureMappingResponseWrapperV1' example: amount: 1 practiceProcedure: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType examples: default: value: amount: 1 practiceProcedure: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPatientproceduresMappingV1 /v1/patientprocedures/{procedureId}/appointments: get: summary: Returns a list of Visits and Appointments for PatientProcedures description: >- **MCP (first successful call):** path `procedureId` must be a real patient procedure ID in your organization (for example from `GET /v1/patientprocedures` or the patient chart). Unknown IDs yield **404**; malformed IDs yield **400**. tags: - PatientProcedures(V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: procedureId in: path required: true description: ID of the procedure to retrieve schema: type: string example: 1 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientProcedureApptResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientproceduresByProcedureIdAppointmentsV1 /v1/patientprocedures/{procedureId}/graph: get: summary: Returns an PatientProcedure graph data by PatientProcedureID. description: >- Returns the graph for one procedure. `procedureId` must exist; optional `responseFields` trims fields (or use `ALL`). **MCP (first successful call):** set path `procedureId` to a real patient procedure ID from your org (see `GET /v1/patientprocedures` or the patient chart). Example `procedureId` values are large integers, not `1`. tags: - PatientProcedures(V1) parameters: - name: procedureId in: path required: true description: ID of the procedure to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientProcedureGraphResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientproceduresByProcedureIdGraphV1 /v1/patientprocedures/patients/{patientId}/graph: get: summary: Returns an PatientProcedure graph data models by patientId. description: >- `patientId` must be a valid patient in the organization. Optional `responseFields` controls which graph fields are returned. **MCP (first successful call):** path `patientId` must be a real patient ID (for example from `GET /v1/patients` or a chart). tags: - PatientProcedures(V1) parameters: - name: patientId in: path required: true description: ID of the patient whose procedure graph to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientProcedureGraphBulkResponseV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientproceduresPatientsByPatientIdGraphV1 /v1/patientprocedures/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientproceduresTotalcountV1 /beta/patientprocedures: get: summary: >- Returns a generated routing key and a list of PatientProcedures which is based on filter criteria in the async streaming API message. description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no PatientProcedures which is based on filter criteria in the async streaming API message matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PatientProcedures (Beta) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for resources. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `serviceDate` (`>`, `<`, `>=`, `<=`) - `entryDate` (`>`, `<`, `>=`, `<=`) - `lastModified` (`>`, `<`, `>=`, `<=`) - `treatmentPlannedProvider.id` (`==`, `!=`) - `status` (`==`, `!=`) - `location.id` (`==`, `!=`) - `patient.id` (`==`, `!=`) - `state` (`==`) - `referredOut` (`==`, `!=`) **Ordering:** When filtering by `serviceDate`, `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `location.id==12`, `serviceDate>=2022-01-01`, `treatmentPlannedProvider.id==12`, `referredOut==value`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest patientProcedureId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientProcedureBulkResponseWrapperV2' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetBetaPatientprocedures /v1/patientrecares: get: summary: Returns a list of PatientRecares (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no PatientRecares matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PatientRecares (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for patientrecares. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `scheduledAppointment.id` (`==`, `->`) - `recareTemplate.id` (`==`, `->`) - `patient.id` (`==`, `->`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `lastModified>=2022-01-01`, `recareTemplate.id==12`, `scheduledAppointment.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest ID of PatientRecareV1 from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientRecareBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientrecaresV1 post: summary: Returns PatientRecareV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PatientRecares (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Patient Recare. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientRecareV1' example: {} examples: default: value: {} responses: '201': description: PatientRecare was created content: application/json: schema: $ref: '#/components/schemas/PatientRecareResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPatientrecaresV1 /v1/patientrecares/{patientRecareId}: get: summary: Returns a PatientRecareV1 by ID. description: >- Returns the PatientRecareV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PatientRecares (V1) parameters: - name: patientRecareId in: path required: true description: ID of the patient recare to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientRecareResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientrecaresByPatientRecareIdV1 put: summary: Returns the updated PatientRecareV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PatientRecares (V1) parameters: - in: path name: patientRecareId required: true description: ID of the patient recare to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Patient Recare Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientRecareUpdateV1' example: dueDate: '2024-05-02T00:00:00.000Z' intervalUnit: WEEK examples: default: value: dueDate: '2024-05-02T00:00:00.000Z' intervalUnit: WEEK responses: '200': description: PatientRecare was updated content: application/json: schema: $ref: '#/components/schemas/PatientRecareResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPatientrecaresByPatientRecareIdV1 delete: summary: Delete PatientRecareV1 by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - PatientRecares (V1) parameters: - name: patientRecareId in: path required: true description: ID of the patient recare to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: PatientRecare was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeletePatientrecaresByPatientRecareIdV1 /v1/patientrecares/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientrecaresTotalcountV1 /v1/patients: get: summary: Returns a list of patients (V1) based on filter criteria description: >- **Query shape:** Prefer a **narrow** filter—combine name, chart, or contact filters with `lastModified` or `dateOfBirth` bounds where possible. A very wide `lastModified` range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no patients matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated; **`lastModified` / `lastId`** style pagination is preferred. tags: - Patients (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string example: id, firstName, lastName, chartNumber style: form explode: false - name: filter in: query required: false description: >- Filter clauses for patients (V1). General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), one may be applied automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `firstName` (`==`, `!=`, `~=`, `<>=`) - `lastName` (`==`, `!=`, `~=`, `<>=`) - `gender` (`==`, `!=`) — values in `[M, F, O]` - `preferredName` (`==`, `!=`, `~=`, `<>=`) - `dateOfBirth` (`==`, `!=`) - `patientStatus` (`==`, `!=`) — values in `[NEW, ACTIVE, NON-PATIENT, INACTIVE, DUPLICATE, DISMISSED, DECEASED]` - `phones.number` (`==`, `!=`, `->`) - `emailAddress` (`==`) - `chartNumber` (`==`, `.absent`, `.present`) - `preferredLocation.id` (`==`, `!=`, `->`) — use `ALL` or `*` for all locations; `->["ALL"]` or `->["*"]` for explicit all-locations. Omitting `preferredLocation.id` may default to all locations during a transitional period; it may become required (IDs or `["ALL"]`). - `primaryGuarantor.id` (`==`) - `duplicateOfPatient.id` (`==`) - `primaryContact.id` (`==`) - `firstVisitDate` (`==`, `>=`, `>`, `<=`, `<`) - `lastModified` (`>=`, `>`, `<=`, `<`) - `referredByPatient.id` (`==`, `!=`, `->`) - `referredByReferral.id` (`==`, `!=`, `->`) **Ordering:** When filtering by `lastModified`, `firstVisitDate`, or `dateOfBirth`, use `lastId` with those filters for stable pagination; results are ordered by id for paging. Examples: `lastModified>=2022-01-01`, `duplicateOfPatient.id==12`, `phones.number==value`, `preferredLocation.id==12`, `primaryContact.id==12`. schema: type: string example: /api/v1/patients?filter=lastModified>=2019-09-25T20:41:38.163Z,firstVisitDate<2019-10-25 - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string - name: lastId in: query required: false description: the biggest patientId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientBulkResponseWrapperV1' example: data: - id: '1000000020701' type: PatientV1 firstName: John lastName: Smith preferredName: John gender: M dateOfBirth: '1990-05-07' patientStatus: NEW contactMethod: CALL ME languageType: English address1: Fake street 1 city: Fake City state: UT postalCode: '84062' chartNumber: A99999 title: Title middleInitial: M nameSuffix: Sr preferredLocation: id: 1000000001027 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: '1000000020701' type: PatientV1 firstName: John lastName: Smith preferredName: John gender: M dateOfBirth: '1990-05-07' patientStatus: NEW contactMethod: CALL ME languageType: English address1: Fake street 1 city: Fake City state: UT postalCode: '84062' chartNumber: A99999 title: Title middleInitial: M nameSuffix: Sr preferredLocation: id: 1000000001027 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: getAllPatients post: summary: Creates a new patient description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Patients (V1) operationId: createPatient parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: >- **Purpose:** Create a patient record for the organization. **Required fields:** Standard create requires the full `PatientV1` schema (see properties marked required). **Partial create (INTERNAL audience only):** Send exactly `firstName`, `lastName`, `dateOfBirth`, and `organizationId` — no other fields. **Conditional fields:** - `discountType: BASIC` requires `discountPlan` - `discountType: SLIDING_FEES` requires `income` and `familySize` **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientV1' example: {} examples: default: value: {} responses: '201': description: Patient successfully created content: application/json: schema: $ref: '#/components/schemas/PatientResponseWrapperV1' example: data: id: '1000000020701' type: PatientV1 firstName: John lastName: Smith preferredName: John gender: M dateOfBirth: '1990-05-07' patientStatus: NEW contactMethod: CALL ME languageType: English address1: Fake street 1 city: Fake City state: UT postalCode: '84062' chartNumber: A99999 title: Title middleInitial: M nameSuffix: Sr preferredLocation: id: 1000000001027 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000000020701' type: PatientV1 firstName: John lastName: Smith preferredName: John gender: M dateOfBirth: '1990-05-07' patientStatus: NEW contactMethod: CALL ME languageType: English address1: Fake street 1 city: Fake City state: UT postalCode: '84062' chartNumber: A99999 title: Title middleInitial: M nameSuffix: Sr preferredLocation: id: 1000000001027 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred /v1/patients/async: get: summary: Returns a list of patients (V1) asynchronously based on filter criteria tags: - Patients (V1) operationId: getAllPatientsAsync description: > Retrieves patients asynchronously. Returns the first 10 results immediately and streams all matching records to the Streaming API. parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string example: id, firstName, lastName, chartNumber style: form explode: false - name: filter in: query required: false description: >- Filter clauses for patients (v1) asynchronously. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), one may be applied automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `firstName` (`==`, `!=`, `~=`, `<>=`) - `lastName` (`==`, `!=`, `~=`, `<>=`) - `gender` (`==`, `!=`) - `preferredName` (`==`, `!=`, `~=`, `<>=`) - `dateOfBirth` (`==`, `!=`) - `patientStatus` (`==`, `!=`) - `phones.number` (`==`, `!=`, `->`) - `emailAddress` (`==`) - `chartNumber` (`==`, `.absent`, `.present`) - `preferredLocation.id` (`==`, `!=`, `->`) - `primaryGuarantor.id` (`==`) - `duplicateOfPatient.id` (`==`) - `primaryContact.id` (`==`) - `firstVisitDate` (`==`, `>=`, `>`, `<=`, `<`) - `lastModified` (`>=`, `>`, `<=`, `<`) - `referredByPatient.id` (`==`, `!=`, `->`) - `referredByReferral.id` (`==`, `!=`, `->`) **Ordering:** When filtering by `firstVisitDate`, `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `duplicateOfPatient.id==12`, `phones.number==value`, `preferredLocation.id==12`, `primaryContact.id==12`. schema: type: string example: lastModified>=2019-09-25T20:41:38.163Z,firstVisitDate<2019-10-25 - name: lastId in: query required: false description: the biggest patientId from previous page schema: type: string example: 500 - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control (limited to 10 for async requests). schema: type: string example: 10 responses: '200': description: > Success response. Returns the first 10 results immediately and streams all matching records to the Streaming API. content: application/json: schema: $ref: '#/components/schemas/PatientBulkResponseWrapperV1' example: data: - id: '1000000020701' type: PatientV1 firstName: John lastName: Smith preferredName: John gender: M dateOfBirth: '1990-05-07' patientStatus: NEW contactMethod: CALL ME languageType: English address1: Fake street 1 city: Fake City state: UT postalCode: '84062' chartNumber: A99999 title: Title middleInitial: M nameSuffix: Sr preferredLocation: id: 1000000001027 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: '1000000020701' type: PatientV1 firstName: John lastName: Smith preferredName: John gender: M dateOfBirth: '1990-05-07' patientStatus: NEW contactMethod: CALL ME languageType: English address1: Fake street 1 city: Fake City state: UT postalCode: '84062' chartNumber: A99999 title: Title middleInitial: M nameSuffix: Sr preferredLocation: id: 1000000001027 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred /v1/patients/{patientId}: get: summary: Returns a patient by patient ID description: >- Returns the patient identified by the path parameter. **404** when the patient is missing or not accessible in the organization context. tags: - Patients (V1) operationId: getPatientById parameters: - name: patientId in: path required: true description: ID of the patient to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string example: id, firstName, lastName, chartNumber responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientResponseWrapperV1' example: data: id: '1000000020701' type: PatientV1 firstName: John lastName: Smith preferredName: John gender: M dateOfBirth: '1990-05-07' patientStatus: NEW contactMethod: CALL ME languageType: English address1: Fake street 1 city: Fake City state: UT postalCode: '84062' chartNumber: A99999 title: Title middleInitial: M nameSuffix: Sr preferredLocation: id: 1000000001027 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000000020701' type: PatientV1 firstName: John lastName: Smith preferredName: John gender: M dateOfBirth: '1990-05-07' patientStatus: NEW contactMethod: CALL ME languageType: English address1: Fake street 1 city: Fake City state: UT postalCode: '84062' chartNumber: A99999 title: Title middleInitial: M nameSuffix: Sr preferredLocation: id: 1000000001027 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred put: summary: Updates an existing patient description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Patients (V1) operationId: updatePatient parameters: - name: patientId in: path required: true description: ID of the patient to update schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: | A URL-encoded, comma-delimited list of field names to include in the response data. Supported values: - **ALL**: Returns all field names. - Example: id, firstName, lastName, chartNumber schema: type: string example: id, firstName, lastName, chartNumber requestBody: description: |- **Purpose:** Update the Patient Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientUpdateV1' example: title: Dr. firstName: John examples: default: value: title: Dr. firstName: John responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientUpdateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred /v1/patients/{patientId}/billingtypes: get: summary: Returns a list of PatientBillingTypes based on filter criteria tags: - Patient Billing Types parameters: - name: patientId in: path required: true description: ID for getting the Patient Billing Types. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A url encoded comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientBillingTypeBulkResponseWrapper' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientsByPatientIdBillingtypes post: summary: Returns PatientBillingType or list of PatientBillingTypes which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Patient Billing Types parameters: - name: patientId in: path required: true schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: >- **Purpose:** Replace the patient's billing types with the provided list. **Behavior:** Existing patient billing types are removed and replaced by the request body (single object or array). **Required fields:** See schema — `organizationBillingType` must be present on each entry. **Idempotency:** Not supported. required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/PatientBillingType' - type: array items: $ref: '#/components/schemas/PatientBillingType' responses: '201': description: List of PatientBillingTypes was created content: application/json: schema: $ref: '#/components/schemas/PatientBillingTypeBulkResponseWrapper' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPatientsByPatientIdBillingtypes /v1/patients/calculated: get: summary: Returns a list of objects with calculated fields for Patient based on filter criteria description: >- Returns calculated fields per patient row. **Required:** `filter` (narrow with `patient.id==…` or `patient.id->[…]`) and `responseFields` listing at least one allowed field (for example `lastVisitDate`). Requests missing either or using unsupported field names typically return **400**. tags: - Patients (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: filter in: query required: true description: >- Filter clauses for objects with calculated fields for patient. General grammar and operators: the Public API filter documentation. **Keys and operators (this endpoint)** - `patient.id` (`==`, `->`) Examples: `patient.id==12345`. schema: type: string example: patient.id==123 - name: responseFields in: query required: true description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string example: lastVisitDate style: form explode: false responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientCalcBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: getPatientCalculatedFields /v1/patients/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientsTotalcountV1 /v1/patientstatements: get: summary: Returns a list of patientStatementsV1 based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no patientStatementsV1 matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PatientStatements (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for patientstatementsv1. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `patient.id` (`==`, `->`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `lastModified>=2022-01-01`, `id->[123,124]`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest patientId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientStatementBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientstatementsV1 /v1/patientstatements/{patientstatementId}: get: summary: Returns a PatientStatementV1 by PatientStatement ID. description: >- Returns the PatientStatementV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PatientStatements (V1) parameters: - name: patientstatementId in: path required: true description: ID of the patientstatement to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientStatementResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientstatementsByPatientstatementIdV1 /v1/patientstatements/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientstatementsTotalcountV1 /v1/patientteeth/globals: get: summary: Returns a list of Teeth description: >- Returns the resource identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PatientTeethV1 parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TeethBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientteethGlobals /v1/patientteeth: get: summary: >- Returns a list of PatientTooth for patient. if don't exists, PatientTeeth will be created based on patient's age. description: >- Returns all PatientToothV1 rows for the patient. If none exist, the server creates a mouth from the patient's age (same behavior as PatientTeethServiceV1.getOrCreatPatientTeeth). **Required:** `filter` must be exactly `patient.id=={numericId}` (pattern enforced). Any other filter shape returns **400**. **MCP (first successful call):** `filter=patient.id==` using a real patient ID for your org (pattern must match `patient.id==` per schema). tags: - PatientTeethV1 parameters: - name: filter in: query required: true description: >- Filter clauses for patient teeth. General grammar and operators: the Public API filter documentation. **Keys and operators (this endpoint)** - `patient.id` (`==`) — **required**; must be exactly `patient.id=={numericPatientId}`. Any other filter shape returns **400**. Examples: `patient.id==64000000000002`. schema: type: integer format: int64 minimum: 1 example: /api/v1/patientteeth?filter=patient.id==64000000000002 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientTeethWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientteeth put: summary: Returns the updated or created patientTooth list. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PatientTeethV1 parameters: - name: patient.id in: query required: true description: ID of the patient whose teeth records to update schema: type: integer format: int64 minimum: 1 example: 9000023397 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: PatientTeeth data - list of toothIndex-toothType pairs. required: true content: application/json: schema: $ref: '#/components/schemas/PatientTeethWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientTeethWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPatientteeth /v1/perioexams: get: summary: Returns a list of PerioExams based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no PerioExams matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PerioExams (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for perioexams. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `createdByUser.id` (`==`) - `patient.id` (`==`) - `lastModified` (`>`, `>=`, `<`, `<=`) - `serviceDate` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, `serviceDate`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `serviceDate>=2022-01-01`, `createdByUser.id==12`, `id->[123,124]`. schema: type: string example: /api/v1/perioexams?filter=patient.id==9002 - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest perioExamId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PerioExamBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPerioexamsV1 post: summary: Returns perioExam which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PerioExams (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: | PerioExam input data required: true content: application/json: schema: $ref: '#/components/schemas/PerioExamV1' example: {} examples: default: value: {} responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PerioExamResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPerioexamsV1 /v1/perioexams/bulk: post: summary: Returns list of perioExams which have been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PerioExams (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: | List of PerioExam input data. Maximum number of items is 64. required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/PerioExamV1' example: - {} examples: default: value: - {} responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PerioExamBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPerioexamsBulkV1 /v1/perioexams/{perioExamId}: get: summary: Returns a perioExam by perioExamId. description: >- Returns the perioExam identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PerioExams (V1) parameters: - name: perioExamId in: path required: true description: ID of the perio exam to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PerioExamResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPerioexamsByPerioExamIdV1 put: summary: Returns the updated perioExam. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PerioExams (V1) parameters: - in: path name: perioExamId required: true description: ID of the perio exam to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Perio Exam Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PerioExamUpdateV1' example: serviceDate: '2024-05-10' script: FIRST examples: default: value: serviceDate: '2024-05-10' script: FIRST responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PerioExamResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPerioexamsByPerioExamIdV1 delete: summary: Delete desired perioExam by ID description: >- Permanently deletes the perio exam and all nested probes. **404** when the resource is missing or already deleted. tags: - PerioExams (V1) parameters: - name: perioExamId in: path required: true description: ID of the perio exam to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: The request was successful '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeletePerioexamsByPerioExamIdV1 /v1/perioexams/{perioExamId}/probes: post: summary: Returns perioProbe which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PerioProbes (V1) parameters: - name: perioExamId in: path required: true description: ID of the perio exam to retrieve schema: type: string example: 10000440046 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: | PerioProbe input data required: true content: application/json: schema: $ref: '#/components/schemas/PerioProbeV1' example: {} examples: default: value: {} responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PerioProbeResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPerioexamsByPerioExamIdProbesV1 get: summary: Returns a list of PerioProbes based on filter criteria description: >- **Query shape:** Prefer a **narrow** filter. Required filter keys must be supplied where documented below. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window. **Empty results:** **200** with `data: []` means no PerioProbes matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - PerioProbes (V1) parameters: - name: perioExamId in: path required: true description: ID of the perio exam to retrieve schema: type: string example: 10000440046 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for perioprobes. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) Examples: `id==123`. schema: type: string example: /api/v1/perioexams/{perioExamId}/probes/90001?filter=id->[900001, 9000002] responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PerioProbeBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPerioexamsByPerioExamIdProbesV1 /v1/perioexams/{perioExamId}/probes/bulk: post: summary: Returns list of perioProbes which have been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PerioProbes (V1) parameters: - name: perioExamId in: path required: true description: ID of the perio exam to retrieve schema: type: string example: 10000440046 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: | List of PerioProbe input data. Maximum number of items is 64. required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/PerioProbeV1' example: - {} examples: default: value: - {} responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PerioProbeBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPerioexamsByPerioExamIdProbesBulkV1 /v1/perioexams/{perioExamId}/probes/{perioProbeId}: get: summary: Returns a perioProbe by perioProbeId. description: >- `perioExamId` (string) and `perioProbeId` (integer) must identify a probe that belongs to that exam. **404** when the probe or exam is missing; **400** for invalid IDs. **MCP (first successful call):** `perioExamId` and `perioProbeId` must exist on the exam (use `GET /v1/perioexams` / nested probes collection). `perioExamId` is a string identifier in the path. tags: - PerioProbes (V1) parameters: - name: perioExamId in: path required: true description: ID of the perio exam to retrieve schema: type: string example: 10000440046 - name: perioProbeId in: path required: true description: ID of the perio probe to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PerioProbeResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPerioexamsByPerioExamIdProbesByPerioProbeIdV1 put: summary: Returns the updated perioProbe. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PerioProbes (V1) parameters: - name: perioExamId in: path required: true description: ID of the perio exam to update schema: type: string example: 10000440046 - in: path name: perioProbeId required: true description: ID of the perio probe to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Perio Probe Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PerioProbeUpdateV1' example: toothSide: FACIAL tooth: 2 examples: default: value: toothSide: FACIAL tooth: 2 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PerioProbeResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPerioexamsByPerioExamIdProbesByPerioProbeIdV1 delete: summary: Delete desired perioProbe by ID description: Permanently deletes the perio probe. **404** when the resource is missing or already deleted. tags: - PerioProbes (V1) parameters: - name: perioExamId in: path required: true description: ID of the perio exam to delete schema: type: string example: 10000440046 - name: perioProbeId in: path required: true description: ID of the perio probe to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: The request was successful '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeletePerioexamsByPerioExamIdProbesByPerioProbeIdV1 /v1/perioexams/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPerioexamsTotalcountV1 /v1/practiceprocedures: get: summary: Returns a list of PracticeProcedures based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no PracticeProcedures matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PracticeProcedures (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for practiceprocedures. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `adaCode` (`==`, `~=`, `->`) - `aliasCode` (`==`, `~=`) - `recareTemplate.id` (`==`) - `category` (`==`, `->`) - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `recareTemplate.id==12`, `adaCode==D0120`, `aliasCode~=Smith`, `category==value`. schema: type: string example: /api/v1/practiceprocedures?filter=lastModified>=2019-09-25T20:41:38.163Z,adaCode->[D2951] - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest practiceProcedureId from previous page schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PracticeProcedureBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPracticeproceduresV1 post: summary: Returns PracticeProcedure which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PracticeProcedures (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Practice Procedure. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PracticeProcedureV1' example: {} examples: default: value: {} responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PracticeProcedureResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPracticeproceduresV1 /v1/practiceprocedures/{procedureId}: get: summary: Returns an PracticeProcedure by PracticeProcedure ID. description: >- Returns the PracticeProcedure identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PracticeProcedures (V1) parameters: - name: procedureId in: path required: true description: ID of the procedure to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PracticeProcedureResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPracticeproceduresByProcedureIdV1 put: summary: Returns the updated PracticeProcedure. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PracticeProcedures (V1) parameters: - in: path name: procedureId required: true description: ID of the procedure to update schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Practice Procedure Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: description: used for Single code, Standard or Bridge MULTICODES oneOf: - $ref: '#/components/schemas/PracticeProcedureUpdateV1' - $ref: '#/components/schemas/PracticeProcedureUpdateStandardV1' - $ref: '#/components/schemas/PracticeProcedureUpdateBridgeV1' responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PracticeProcedureResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPracticeproceduresByProcedureIdV1 delete: summary: Delete specific PracticeProcedure by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - PracticeProcedures (V1) parameters: - name: procedureId in: path required: true description: ID of the procedure to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: The request was successful '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeletePracticeproceduresByProcedureIdV1 /v1/practiceprocedures/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPracticeproceduresTotalcountV1 /v1/procedurecategories: get: summary: Returns a list of procedure categories based on filter criteria description: >- **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 categories matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. tags: - ProcedureCategories (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProcedureCategoryBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetProcedurecategoriesV1 /v1/prescriptiondrugcategories: get: summary: Returns a list of PrescriptionDrugCategories (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no PrescriptionDrugCategories matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PrescriptionDrugCategories (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for prescription drug categories. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first). Examples: `id==123`, `lastModified>=2022-01-01`. schema: type: string example: /api/v1/prescriptiondrugcategories?filter=id==123 - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest prescriptionDrugCategoryId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DrugCategoryBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPrescriptiondrugcategoriesV1 post: summary: Returns PrescriptionDrugCategoryV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PrescriptionDrugCategories (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Prescription Drug Category. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PrescriptionDrugCategoryV1' example: {} examples: default: value: {} responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PrescriptionDrugCategoryResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPrescriptiondrugcategoriesV1 /v1/prescriptiondrugcategories/{drugCategoryId}: get: summary: Returns an PrescriptionDrugCategoryV1 by ID. description: >- Returns the PrescriptionDrugCategoryV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PrescriptionDrugCategories (V1) parameters: - name: drugCategoryId in: path required: true description: ID of the drug category to retrieve schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PrescriptionDrugCategoryResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPrescriptiondrugcategoriesByDrugCategoryIdV1 put: summary: Returns the updated PrescriptionDrugCategoryV1 description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PrescriptionDrugCategories (V1) parameters: - name: drugCategoryId in: path required: true description: ID of the drug category to update schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Prescription Drug Category Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PrescriptionDrugCategoryUpdateV1' example: name: Example Name examples: default: value: name: Example Name responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PrescriptionDrugCategoryResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPrescriptiondrugcategoriesByDrugCategoryIdV1 delete: summary: Delete specific PrescriptionDrugCategoryV1 by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - PrescriptionDrugCategories (V1) parameters: - name: drugCategoryId in: path required: true description: ID of the drug category to delete schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: deleteType in: query required: true schema: type: string enum: - DELETE - MOVE_AND_DELETE description: > This parameter defines the type of delete. If you pass value 'DELETE' it will delete category and all of the prescription templates that are assigned to that category. If you pass value 'MOVE_AND_DELETE' it will remove category and move all of its prescription templates to the another category that is specified by another parameter 'newCategoryId' - name: newCategoryId in: query schema: type: integer format: int64 description: > This parameter specifies id of prescription category to which all of the prescription templates will be moved if you specify deleteType is equal 'MOVE_AND_DELETE' responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeletePrescriptiondrugcategoriesByDrugCategoryIdV1 /v1/prescriptiondrugcategories/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPrescriptiondrugcategoriesTotalcountV1 /v1/prescriptiondrugunits: get: summary: Returns a list of PrescriptionDrugUnits (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no PrescriptionDrugUnits matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PrescriptionDrugUnits (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for prescription drug units. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first). Examples: `id==123`, `lastModified>=2022-01-01`. schema: type: string example: filter1Value - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest prescriptionDrugUnitId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PrescriptionDrugUnitBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPrescriptiondrugunitsV1 post: summary: Returns PrescriptionDrugUnitV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PrescriptionDrugUnits (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Prescription Drug Unit. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PrescriptionDrugUnitV1' example: name: Example Name id: 324 lastModified: '2018-07-09T19:00:00.000Z' examples: default: value: name: Example Name id: 324 lastModified: '2018-07-09T19:00:00.000Z' responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/PrescriptionDrugUnitResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPrescriptiondrugunitsV1 /v1/prescriptiondrugunits/{drugUnitId}: get: summary: Returns PrescriptionDrugUnitV1 by ID. description: >- Returns the PrescriptionDrugUnitV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PrescriptionDrugUnits (V1) parameters: - name: drugUnitId in: path required: true description: ID of the drug unit to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PrescriptionDrugUnitResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPrescriptiondrugunitsByDrugUnitIdV1 /v1/prescriptiondrugunits/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPrescriptiondrugunitsTotalcountV1 /v1/prescriptiontemplates: get: summary: Returns a list of PrescriptionTemplates (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no PrescriptionTemplates matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PrescriptionTemplates (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for prescription templates. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - **`drugCategory.id` (`==`)**: Example - `?filter=drugCategory.id==123` (retrieves resources where `drugCategory.id` equals 123). Examples: `drugCategory.id==123`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest PrescriptionTemplate ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PrescriptionTemplateBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPrescriptiontemplatesV1 post: summary: Returns PrescriptionTemplateV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PrescriptionTemplates (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Prescription Template. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PrescriptionTemplateV1' example: {} examples: default: value: {} responses: '201': description: PrescriptionTemplate was created content: application/json: schema: $ref: '#/components/schemas/PrescriptionTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPrescriptiontemplatesV1 /v1/prescriptiontemplates/{prescriptionTemplateId}: get: summary: Returns the PrescriptionTemplateV1 by ID. description: >- Returns the the PrescriptionTemplateV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PrescriptionTemplates (V1) parameters: - in: path name: prescriptionTemplateId required: true description: ID of the prescription template to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PrescriptionTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPrescriptiontemplatesByPrescriptionTemplateIdV1 put: summary: Returns the updated PrescriptionTemplateV1 description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PrescriptionTemplates (V1) parameters: - in: path name: prescriptionTemplateId required: true description: ID of the prescription template to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Prescription Template Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PrescriptionTemplateUpdateV1' example: drug: drug sig: sig examples: default: value: drug: drug sig: sig responses: '200': description: PrescriptionTemplate was updated content: application/json: schema: $ref: '#/components/schemas/PrescriptionTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPrescriptiontemplatesByPrescriptionTemplateIdV1 delete: summary: Delete specific PrescriptionTemplateV1 by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - PrescriptionTemplates (V1) parameters: - name: prescriptionTemplateId in: path required: true description: ID of the prescription template to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: PrescriptionTemplate was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeletePrescriptiontemplatesByPrescriptionTemplateIdV1 /v1/prescriptiontemplates/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPrescriptiontemplatesTotalcountV1 /v1/providergroups: get: summary: Returns a provider groups which contains a list of provider groups based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no provider groups matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. See the Public API pagination documentation. tags: - ProviderGroups (V1) parameters: - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for resources. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest provider group ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProviderGroupBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetProvidergroupsV1 post: summary: Returns providerGroup which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - ProviderGroups (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - name: OrganizationId in: header required: true schema: type: string example: 1001 requestBody: description: |- **Purpose:** Create a Provider Group. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ProviderGroupV1' example: {} examples: default: value: {} responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/ProviderGroupResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostProvidergroupsV1 /v1/providergroups/{providerGroupId}: get: summary: returns a providerGroup by ProviderGroupId. description: >- Returns the providerGroup identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ProviderGroups (V1) parameters: - name: providerGroupId in: path required: true description: ID of the provider group to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProviderGroupResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetProvidergroupsByProviderGroupIdV1 put: summary: Returns the updated ProviderGroup. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - ProviderGroups (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - in: path name: providerGroupId required: true description: ID of the provider group to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: OrganizationId required: true schema: type: string example: 1001 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Provider Group Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ProviderGroupUpdateV1' example: groupName: Group Name providers: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType examples: default: value: groupName: Group Name providers: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/ProviderGroupResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutProvidergroupsByProviderGroupIdV1 delete: summary: Delete specified ProviderGroupV1 by Id description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - ProviderGroups (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - name: providerGroupId in: path required: true description: ID of the provider group to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: OrganizationId in: header required: true schema: type: string example: 1001 responses: '200': description: ProviderGroupId was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteProvidergroupsByProviderGroupIdV1 /v1/providerhours: get: summary: Returns a provider hours which contains a list of provider hours based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no provider hours matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - ProviderHours (V1) parameters: - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for resources. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest provider schedule ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProviderHourBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetProviderhoursV1 post: summary: Returns providerHour which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - ProviderHours (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - name: OrganizationId in: header required: true schema: type: string example: 1001 requestBody: description: |- **Purpose:** Create a Provider Hour. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ProviderHourV1' example: {} examples: default: value: {} responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/ProviderHourResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostProviderhoursV1 /v1/providerhours/{providerHourId}: get: summary: returns a providerHour by ProviderHour Id. description: >- Returns the providerHour identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ProviderHours (V1) parameters: - name: providerHourId in: path required: true description: ID of the provider hour to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProviderHourResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetProviderhoursByProviderHourIdV1 put: summary: Returns the updated ProviderHour. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - ProviderHours (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - in: path name: providerHourId required: true description: ID of the provider hour to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: OrganizationId required: true schema: type: string example: 1001 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Provider Hour Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ProviderHourUpdateV1' example: startDate: '2024-05-10' endDate: '2024-05-10' examples: default: value: startDate: '2024-05-10' endDate: '2024-05-10' responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/ProviderHourResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutProviderhoursByProviderHourIdV1 delete: summary: Delete specified ProviderHourV1 by Id description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - ProviderHours (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - name: providerHourId in: path required: true description: ID of the provider hour to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: OrganizationId in: header required: true schema: type: string example: 1001 responses: '200': description: ProviderHourId was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteProviderhoursByProviderHourIdV1 /v1/providerhours/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetProviderhoursTotalcountV1 /v1/providers: get: summary: Returns a list of providers based on filter criteria description: >- **Query shape:** Prefer a **narrow** filter—combine `location.id`, `user.id`, or `id` with `lastModified` bounds where possible. A very wide `lastModified` range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no providers matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated; **`lastModified` / `lastId`** style pagination is preferred. tags: - Providers (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for providers. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `location.id` (`==`, `->`) - `user.id` (`==`, `->`) - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `location.id==12`, `lastModified>=2022-01-01`, `user.id==12`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest providerId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProviderBulkResponseWrapperV1' example: data: - id: '1000000002089' type: ProviderV1 firstName: John lastName: Doe shortName: Short specialty: DENTIST isPrimaryProvider: true isNonPersonEntity: false color: ffffff dea: AA1234567 npi: '1234567893' active: true stateId: license number tin: '123456789' signatureOnFile: false address1: addr 1 address2: addr 2 city: city 1 state: CA postalCode: 11111-2222 title: Dr warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: '1000000002089' type: ProviderV1 firstName: John lastName: Doe shortName: Short specialty: DENTIST isPrimaryProvider: true isNonPersonEntity: false color: ffffff dea: AA1234567 npi: '1234567893' active: true stateId: license number tin: '123456789' signatureOnFile: false address1: addr 1 address2: addr 2 city: city 1 state: CA postalCode: 11111-2222 title: Dr warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetProvidersV1 post: summary: Returns providerV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Providers (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Provider. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ProviderV1' example: {} examples: default: value: {} responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/ProviderResponseWrapperV1' example: data: id: '1000000002089' type: ProviderV1 firstName: John lastName: Doe shortName: Short specialty: DENTIST isPrimaryProvider: true isNonPersonEntity: false color: ffffff dea: AA1234567 npi: '1234567893' active: true stateId: license number tin: '123456789' signatureOnFile: false address1: addr 1 address2: addr 2 city: city 1 state: CA postalCode: 11111-2222 title: Dr warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000000002089' type: ProviderV1 firstName: John lastName: Doe shortName: Short specialty: DENTIST isPrimaryProvider: true isNonPersonEntity: false color: ffffff dea: AA1234567 npi: '1234567893' active: true stateId: license number tin: '123456789' signatureOnFile: false address1: addr 1 address2: addr 2 city: city 1 state: CA postalCode: 11111-2222 title: Dr warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostProvidersV1 /v1/providers/{providerId}: get: summary: Returns a providerV1 by provider ID. description: >- Returns the provider identified by the path parameter. **404** when the provider is missing or not accessible in the organization context. tags: - Providers (V1) parameters: - name: providerId in: path required: true description: ID of the provider to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ProviderResponseWrapperV1' example: data: id: '1000000002089' type: ProviderV1 firstName: John lastName: Doe shortName: Short specialty: DENTIST isPrimaryProvider: true isNonPersonEntity: false color: ffffff dea: AA1234567 npi: '1234567893' active: true stateId: license number tin: '123456789' signatureOnFile: false address1: addr 1 address2: addr 2 city: city 1 state: CA postalCode: 11111-2222 title: Dr warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000000002089' type: ProviderV1 firstName: John lastName: Doe shortName: Short specialty: DENTIST isPrimaryProvider: true isNonPersonEntity: false color: ffffff dea: AA1234567 npi: '1234567893' active: true stateId: license number tin: '123456789' signatureOnFile: false address1: addr 1 address2: addr 2 city: city 1 state: CA postalCode: 11111-2222 title: Dr warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetProvidersByProviderIdV1 put: summary: Returns the updated providerV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Providers (V1) parameters: - in: path name: providerId required: true description: ID of the provider to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Provider Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ProviderUpdateV1' example: type: provider firstName: first examples: default: value: type: provider firstName: first responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/ProviderResponseWrapperV1' example: data: id: '1000000002089' type: ProviderV1 firstName: John lastName: Doe shortName: Short specialty: DENTIST isPrimaryProvider: true isNonPersonEntity: false color: ffffff dea: AA1234567 npi: '1234567893' active: true stateId: license number tin: '123456789' signatureOnFile: false address1: addr 1 address2: addr 2 city: city 1 state: CA postalCode: 11111-2222 title: Dr warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '1000000002089' type: ProviderV1 firstName: John lastName: Doe shortName: Short specialty: DENTIST isPrimaryProvider: true isNonPersonEntity: false color: ffffff dea: AA1234567 npi: '1234567893' active: true stateId: license number tin: '123456789' signatureOnFile: false address1: addr 1 address2: addr 2 city: city 1 state: CA postalCode: 11111-2222 title: Dr warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutProvidersByProviderIdV1 /v1/providers/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetProvidersTotalcountV1 /v1/recaretemplates: get: summary: Returns a list of RecareTemplates (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no RecareTemplates matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - RecareTemplates (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for recaretemplates. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest recareTemplateId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/RecareTemplateBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetRecaretemplatesV1 post: summary: Returns RecareTemplateV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - RecareTemplates (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Recare Template. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/RecareTemplateV1' example: {} examples: default: value: {} responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/RecareTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostRecaretemplatesV1 /v1/recaretemplates/{recareTemplateId}: get: summary: Returns a RecareTemplateV1 by recareTemplateId. description: >- Returns the RecareTemplateV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - RecareTemplates (V1) parameters: - name: recareTemplateId in: path required: true description: ID of the recare template to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/RecareTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetRecaretemplatesByRecareTemplateIdV1 put: summary: Returns the updated RecareTemplateV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - RecareTemplates (V1) parameters: - in: path name: recareTemplateId required: true description: ID of the recare template to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Recare Template Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/RecareTemplateUpdateV1' example: recareType: recare type description: Example description for description examples: default: value: recareType: recare type description: Example description for description responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/RecareTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutRecaretemplatesByRecareTemplateIdV1 delete: summary: Delete desired RecareTemplateV1 by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - RecareTemplates (V1) parameters: - name: recareTemplateId in: path required: true description: ID of the recare template to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: RecareTemplates was deleted content: application/json: schema: $ref: '#/components/schemas/DeletedResult' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteRecaretemplatesByRecareTemplateIdV1 /v1/recaretemplates/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetRecaretemplatesTotalcountV1 /v1/patientbookingavailabilities: get: summary: Returns a list of patient booking availabilities V1 based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no patient booking availabilities V1 matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - PatientBookingAvailabilities (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for patient booking availabilities v1. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`==`, `!=`, `->`) Examples: `location.id==12`. schema: type: string style: form explode: false - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest patient booking availability ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientBookingAvailabilityBlkResWrapV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientbookingavailabilitiesV1 post: summary: Returns patient booking availability V1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - PatientBookingAvailabilities (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Patient Booking Availability. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientBookingAvailabilityV1' example: {} examples: default: value: {} responses: '201': description: PatientBookingAvailabilities was created content: application/json: schema: $ref: '#/components/schemas/PatientBookingAvailabilityResWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostPatientbookingavailabilitiesV1 /v1/patientbookingavailabilities/{patientBookingAvailabilityId}: get: summary: Returns a patient booking availability V1 by patient booking availability ID. description: >- Returns the patient booking availability V1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - PatientBookingAvailabilities (V1) parameters: - name: patientBookingAvailabilityId in: path required: true description: ID of the patient booking availability to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/PatientBookingAvailabilityResWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientbookingavailabilitiesByPatientBookingAvailabilityIdV1 put: summary: Returns the updated patient booking availability V1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - PatientBookingAvailabilities (V1) parameters: - in: path name: patientBookingAvailabilityId required: true description: ID of the patient booking availability to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Patient Booking Availability Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/PatientBookingAvailabilityUpdateV1' example: id: 234234 title: A sample title examples: default: value: id: 234234 title: A sample title responses: '200': description: PatientBookingAvailabilities was updated content: application/json: schema: $ref: '#/components/schemas/PatientBookingAvailabilityResWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutPatientbookingavailabilitiesByPatientBookingAvailabilityIdV1 delete: summary: Delete specific patient booking availability V1 by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - PatientBookingAvailabilities (V1) parameters: - name: patientBookingAvailabilityId in: path required: true description: ID of the patient booking availability to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: PatientBookingAvailabilities was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeletePatientbookingavailabilitiesByPatientBookingAvailabilityIdV1 /v1/patientbookingavailabilities/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetPatientbookingavailabilitiesTotalcountV1 /v1/scheduletemplates: get: summary: Returns a list of schedule templates (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no schedule templates matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - ScheduleTemplates (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for schedule templates. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `operatory.id` (`==`, `->`) - `location.id` (`==`, `!=`, `->`) Examples: `location.id==12`, `operatory.id==12`, `id->[123,124]`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest schedule template Id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetScheduletemplatesV1 post: summary: Returns schedule template (V1) which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - ScheduleTemplates (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Schedule Template. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateV1' example: {} examples: default: value: {} responses: '201': description: ScheduleTemplate was created content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostScheduletemplatesV1 /v1/scheduletemplates/{scheduleTemplateId}: get: summary: Returns a schedule template (V1) by schedule template ID. description: >- Returns the schedule template (V1) identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ScheduleTemplates (V1) parameters: - name: scheduleTemplateId in: path required: true description: ID of the schedule template to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetScheduletemplatesByScheduleTemplateIdV1 put: summary: Returns the updated schedule template. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - ScheduleTemplates (V1) parameters: - in: path name: scheduleTemplateId required: true description: ID of the schedule template to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Schedule Template Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateUpdateV1' example: title: Example Title color: FFCA00 examples: default: value: title: Example Title color: FFCA00 responses: '200': description: ScheduleTemplate was updated content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutScheduletemplatesByScheduleTemplateIdV1 delete: summary: Delete specific schedule template (V1) by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - ScheduleTemplates (V1) parameters: - name: scheduleTemplateId in: path required: true description: ID of the schedule template to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: ScheduleTemplate was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteScheduletemplatesByScheduleTemplateIdV1 /v1/scheduletemplates/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetScheduletemplatesTotalcountV1 /v1/transferreasons: get: summary: Returns a list of transfer reasons based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no transfer reasons matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - TransferReasons (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for transfer reasons. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `tagText` (`==`, `!=`, `~=`, `<>=`) Examples: `tagText==Insurance`, `id->[123,124]`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest transferReasonId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransferReasonBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransferreasonsV1 post: summary: Returns TransferReasonV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - TransferReasons (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Transfer Reason. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/TransferReasonV1' example: tagText: tag text id: 324324 lastModified: '2018-07-09T19:00:00.000Z' examples: default: value: tagText: tag text id: 324324 lastModified: '2018-07-09T19:00:00.000Z' responses: '201': description: TransferReason was created content: application/json: schema: $ref: '#/components/schemas/TransferReasonResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostTransferreasonsV1 /v1/transferreasons/{transferReasonId}: get: summary: Returns a transfer reason by ID. description: >- Returns the transfer reason identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - TransferReasons (V1) parameters: - in: path name: transferReasonId required: true description: ID of the transfer reason to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransferReasonResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransferreasonsByTransferReasonIdV1 put: summary: Returns the updated TransferReasonV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - TransferReasons (V1) parameters: - in: path name: transferReasonId required: true description: ID of the transfer reason to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Transfer Reason identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/TransferReasonV1' example: tagText: tag text id: 324324 lastModified: '2018-07-09T19:00:00.000Z' examples: default: value: tagText: tag text id: 324324 lastModified: '2018-07-09T19:00:00.000Z' responses: '200': description: TransferReason was updated content: application/json: schema: $ref: '#/components/schemas/TransferReasonResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutTransferreasonsByTransferReasonIdV1 delete: summary: Delete specific TransferReason by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - TransferReasons (V1) parameters: - in: path name: transferReasonId required: true description: ID of the transfer reason to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: TransferReason was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteTransferreasonsByTransferReasonIdV1 /v1/referralsources: get: summary: Returns a list of ReferralSources based on filter criteria. description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no ReferralSources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - ReferralSources (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for referralsources. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `firstName` (`~=`) - `lastName` (`~=`) - `referralSourceType` (`==`, `!=`) - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `firstName~=Jane`, `lastName~=Smith`, `referralSourceType==value`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest ReferralSourceId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ReferralSourceBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetReferralsourcesV1 post: summary: Returns ReferralSource which has been created. description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - ReferralSources (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Referral Source. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ReferralSourceV1' example: {} examples: default: value: {} responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/ReferralSourceResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostReferralsourcesV1 /v1/referralsources/{referralSourceId}: get: summary: Returns a ReferralSource by ReferralSourceID. description: >- Returns the ReferralSource identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ReferralSources (V1) parameters: - name: referralSourceId in: path required: true description: ID of the referral source to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ReferralSourceResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetReferralsourcesByReferralSourceIdV1 put: summary: Returns the updated ReferralSource. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - ReferralSources (V1) parameters: - in: path name: referralSourceId required: true description: ID of the referral source to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Referral Source Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ReferralSourceUpdateV1' example: firstName: first middleInitial: m examples: default: value: firstName: first middleInitial: m responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/ReferralSourceResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutReferralsourcesByReferralSourceIdV1 /v1/referralsources/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetReferralsourcesTotalcountV1 /v1/scheduleopenings: get: summary: >- Returns a list of schedule openings based on filter criteria. But Provider Hours MUST be specified before calling this API. description: >- Returns available openings for a location and date range (provider hours, schedule items, templates). **Required in `filter`:** `location.id`, `startDate`, `endDate` (`YYYY-MM-DD`), span ≤ **14** days. Do not combine `scheduleTemplate.id` with `booking.type` or `reason.id`. Invalid mixes or missing keys return **400**. **MCP agents:** If you need a location id, call **`get_locations`** and choose from **`data`** (`id`, `name`). The response **`data`** array is one row per **provider** + **operatory** + **day**, each with **`slots`** (**`start`** / **`end`** in the location time zone; optional template metadata may appear). Omitting **provider** / **operatory** filters can return **many** rows—narrow with **`provider.id`** / **`operatory.id`** in **`filter`**, or pass **`responseFields`** to return fewer fields per row. Use **`ignoreProviderHours`** when you want **location hours** for every selected provider instead of provider-hour records (see that parameter). tags: - ScheduleOpenings (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: true description: >- Filter clauses for schedule openings. General grammar and operators: the Public API filter documentation. **Required:** `location.id`, `startDate`, and `endDate` (`YYYY-MM-DD`) with span ≤ **14** days. Do not combine `scheduleTemplate.id` with `booking.type` or `reason.id`. **Keys and operators (this endpoint)** - `location.id` (`==`) - `startDate` (`==`) - `endDate` (`==`) - `operatory.id` (`==`, `->`) - `provider.id` (`==`, `->`) - `minOpeningLength` (`==`) - `booking.type` (`==`, `->`) - `reason.id` (`==`, `->`) - `scheduleTemplate.id` (`==`, `->`) - `ignoreProviderHours` (`==`) **Ordering:** Results are grouped by provider, operatory, and day; use `responseFields` to trim payload when exploring wide queries. Examples: `location.id==123,startDate==2026-04-07,endDate==2026-04-08`, `provider.id->[1,2]`, `operatory.id==456`. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ScheduleOpeningResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetScheduleopeningsV1 /v1/scheduletemplateappointmentreasons: get: summary: Returns a list of schedule template appointment reasons (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no schedule template appointment reasons matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - ScheduleTemplateAppointmentReasons (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for schedule template appointment reasons. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`==`, `!=`, `->`) - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `location.id==12`, `lastModified>=2022-01-01`. schema: type: string style: form explode: false - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest schedule template appointment reason ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateApptReasonBlkResWrapV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetScheduletemplateappointmentreasonsV1 post: summary: Returns schedule template appointment reason V1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - ScheduleTemplateAppointmentReasons (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Schedule Template Appt Reason. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateApptReasonV1' example: {} examples: default: value: {} responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateApptReasonResWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostScheduletemplateappointmentreasonsV1 /v1/scheduletemplateappointmentreasons/{scheduleTemplateAppointmentReasonId}: get: summary: Returns a schedule template appointment reason V1 by schedule template appointment reason ID. description: >- Returns the schedule template appointment reason V1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ScheduleTemplateAppointmentReasons (V1) parameters: - name: scheduleTemplateAppointmentReasonId in: path required: true description: ID of the schedule template appointment reason to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateApptReasonResWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetScheduletemplateappointmentreasonsByScheduleTemplateAppointmentReasonIdV1 put: summary: Returns the updated schedule template appointment reason V1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - ScheduleTemplateAppointmentReasons (V1) parameters: - in: path name: scheduleTemplateAppointmentReasonId required: true description: ID of the schedule template appointment reason to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Schedule Template Appt Reason Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateApptReasonUpdateV1' example: id: 12445 reason: string examples: default: value: id: 12445 reason: string responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateApptReasonResWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutScheduletemplateappointmentreasonsByScheduleTemplateAppointmentReasonIdV1 delete: summary: Delete specific schedule template appointment reason V1 by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - ScheduleTemplateAppointmentReasons (V1) parameters: - name: scheduleTemplateAppointmentReasonId in: path required: true description: ID of the schedule template appointment reason to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: ScheduleTemplateAppointmentReasons was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteScheduletemplateappointmentreasonsByScheduleTemplateAppointmentReasonIdV1 /v1/scheduletemplateappointmentreasons/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetScheduletemplateappointmentreasonsTotalcountV1 /v1/scheduletemplatereasons: get: summary: Returns a list of schedule template reasons (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no schedule template reasons matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - ScheduleTemplateReasons (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for schedule template reasons. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `location.id` (`==`, `!=`, `->`) Examples: `location.id==12`. schema: type: string style: form explode: false - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest schedule template reason (V1) ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateReasonBulkResWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetScheduletemplatereasonsV1 post: summary: Returns schedule template reason (V1) which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - ScheduleTemplateReasons (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Schedule Template Reason. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateReasonV1' example: reason: reason durationMinutes: 600 location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 3243243 examples: default: value: reason: reason durationMinutes: 600 location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 3243243 responses: '201': description: The request was successful, record was created content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateReasonResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostScheduletemplatereasonsV1 /v1/scheduletemplatereasons/{scheduleTemplateReasonId}: get: summary: Returns a schedule template reason (V1) by schedule template reason ID. description: >- Returns the schedule template reason (V1) identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - ScheduleTemplateReasons (V1) parameters: - name: scheduleTemplateReasonId in: path required: true description: ID of the schedule template reason to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateReasonResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetScheduletemplatereasonsByScheduleTemplateReasonIdV1 put: summary: Returns the updated schedule template reason (V1). description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - ScheduleTemplateReasons (V1) parameters: - in: path name: scheduleTemplateReasonId required: true description: ID of the schedule template reason to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Schedule Template Reason identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateReasonV1' example: reason: reason durationMinutes: 600 location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 3243243 examples: default: value: reason: reason durationMinutes: 600 location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 3243243 responses: '200': description: The update was successful content: application/json: schema: $ref: '#/components/schemas/ScheduleTemplateReasonResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutScheduletemplatereasonsByScheduleTemplateReasonIdV1 delete: summary: Delete specific schedule template reason (V1) by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - ScheduleTemplateReasons (V1) parameters: - name: scheduleTemplateReasonId in: path required: true description: ID of the schedule template reason to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: ScheduleTemplateReasons was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteScheduletemplatereasonsByScheduleTemplateReasonIdV1 /v1/scheduletemplatereasons/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetScheduletemplatereasonsTotalcountV1 /v1/signatures: get: summary: Returns a list of user signatures based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no user signatures matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Signatures (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for user signatures. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `user.id` (`==`) Examples: `user.id==12`, `id==123`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest signatureId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/SignatureBulkResponseWrapperV1' example: data: - data: c2lnbmVkdGVzdGRhdGE= organizationId: 9007 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - data: c2lnbmVkdGVzdGRhdGE= organizationId: 9007 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetSignaturesV1 post: summary: Returns user signature which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Signatures (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Signature. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/SignatureV1' example: data: U29tZSBiYXNlNjQgc3RyaW5n user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 32432432 examples: default: value: data: U29tZSBiYXNlNjQgc3RyaW5n user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 32432432 responses: '201': description: Signature was created content: application/json: schema: $ref: '#/components/schemas/SignatureResponseWrapperV1' example: data: data: c2lnbmVkdGVzdGRhdGE= organizationId: 9007 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: data: c2lnbmVkdGVzdGRhdGE= organizationId: 9007 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostSignaturesV1 /v1/signatures/{signatureId}: get: summary: Returns a user by signatureId description: >- Returns the user identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Signatures (V1) parameters: - name: signatureId in: path required: true description: ID of the signature to retrieve schema: type: string example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/SignatureResponseWrapperV1' example: data: data: c2lnbmVkdGVzdGRhdGE= organizationId: 9007 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: data: c2lnbmVkdGVzdGRhdGE= organizationId: 9007 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetSignaturesBySignatureIdV1 /v1/signatures/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetSignaturesTotalcountV1 /v1/smsnumbers: get: summary: Returns a list of SMSNumbers based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no SMSNumbers matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - SMSNumber (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for smsnumbers. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `number` (`==`, `->`) - `location.id` (`==`, `->`) Examples: `location.id==12`, `number==5551234567`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest SmsNumberId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/SMSNumberBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetSmsnumbersV1 /v1/smsnumbers/{smsNumberId}: get: summary: Returns an SMSNumber by ID. description: >- Returns the SMSNumber identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - SMSNumber (V1) parameters: - name: smsNumberId in: path required: true description: ID of the sms number to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/SMSNumberResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetSmsnumbersBySmsNumberIdV1 /v1/smsnumbers/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetSmsnumbersTotalcountV1 /v1/streamapiusage: get: summary: Returns a list of StreamAPIUsage (V1) based on filter criteria description: >- Lists `StreamAPIUsageV1` usage records. Optional `filter` narrows rows when supported; when unsure, call without `filter` for the organization-level list. optional `filter`, or omit `filter` for the organization-level list. tags: - StreamAPIUsage (V1) responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/StreamAPIUsageBulkResponseWrapperV1' example: data: - {} meta: {} examples: default: value: data: - {} meta: {} '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred parameters: - $ref: '#/components/parameters/OrganizationId' operationId: GetStreamapiusageV1 /v1/streamapiusage/{queueName}: get: summary: Returns a list of StreamAPIUsage Queues (V1) based on filter criteria tags: - StreamAPIUsage (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - name: queueName in: path required: true description: The queue name you want more detailed information about. schema: type: string minimum: 1 example: 1 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/StreamAPIUsageQueueResponseWrapperV1' example: data: - {} meta: {} examples: default: value: data: - {} meta: {} '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetStreamapiusageByQueueNameV1 /v1/subscriberinsuranceplans: get: summary: Returns a list of subscriber insurance plans based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no subscriber insurance plans matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - SubscriberInsurancePlans (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for subscriber insurance plans. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`==`, `->`) - `patient.id` (`==`, `->`) - `lastModified` (`>=`, `>`, `<=`, `<`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `lastModified>=2022-01-01`, `id==123`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest subscriber insurance plan ID from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/SubscriberInsurancePlanBulkResWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetSubscriberinsuranceplansV1 /v1/subscriberinsuranceplans/{subscriberInsurancePlanId}: get: summary: Returns a subscriber insurance plan by entry ID. description: >- Returns the subscriber insurance plan identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - SubscriberInsurancePlans (V1) parameters: - in: path name: subscriberInsurancePlanId required: true description: ID of the subscriber insurance plan to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was completed content: application/json: schema: $ref: '#/components/schemas/SubscriberInsurancePlanResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetSubscriberinsuranceplansBySubscriberInsurancePlanIdV1 /v1/subscriberinsuranceplans/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetSubscriberinsuranceplansTotalcountV1 /v1/transactions: get: summary: Returns a list of transaction entries based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no transaction entries matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Transactions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: true description: >- Filter clauses for transaction entries. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `ledgerType` (`==`, `!=`) - `patient.id` (`==`, `->`) - `provider.id` (`==`) - `transactionDate` (`>`, `<`, `>=`, `<=`) - `location.id` (`==`, `!=`, `->`) - `lastModified` (`>`, `<`, `>=`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `provider.id==7`, `location.id==12`, `lastModified>=2022-01-01`, `ledgerType==value`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest transactionId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactionsV1 /v1/transactions/{transactionId}: get: summary: Returns a transaction entry by entry ID. description: >- Returns the transaction entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Transactions (V1) parameters: - in: path name: transactionId required: true description: ID of the transaction to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactionsByTransactionIdV1 /v1/transactions/adjustments: get: summary: Returns a list of adjustment transaction entries based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no adjustment transaction entries matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Adjustment Transactions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: true description: >- Filter clauses for adjustment transaction entries. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `patient.id` (`==`, `->`) - `provider.id` (`==`) - `ledgerType` (`==`, `!=`) - `transactionDate` (`>`, `<`, `>=`, `<=`) - `location.id` (`==`, `!=`, `->`) - `lastModified` (`>`, `<`, `>=`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `provider.id==7`, `location.id==12`, `lastModified>=2022-01-01`, `ledgerType==value`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest transactionId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionAdjustmentBulkResWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactionsAdjustmentsV1 /v1/transactions/adjustments/{transactionId}: get: summary: Returns an adjustment transaction entry by entry ID. description: >- Returns the adjustment transaction entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Adjustment Transactions (V1) parameters: - in: path name: transactionId required: true description: ID of the transaction to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionAdjustmentResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactionsAdjustmentsByTransactionIdV1 /v1/transactions/insurancepayments: get: summary: Returns a list of insurance payment transaction entries based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no insurance payment transaction entries matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Insurance Payment Transactions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: true description: >- Filter clauses for insurance payment transaction entries. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `patient.id` (`==`, `->`) - `transactionDate` (`>`, `<`, `>=`, `<=`) - `location.id` (`==`, `!=`, `->`) - `provider.id` (`==`) - `lastModified` (`>`, `<`, `>=`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `provider.id==7`, `location.id==12`, `lastModified>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest transactionId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionInsurPaymentBulkResWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactionsInsurancepaymentsV1 /v1/transactions/insurancepayments/{transactionId}: get: summary: Returns a insurance payment transaction entry by entry ID. description: >- Returns the insurance payment transaction entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Insurance Payment Transactions (V1) parameters: - in: path name: transactionId required: true description: ID of the transaction to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionInsurancePaymentResWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactionsInsurancepaymentsByTransactionIdV1 /v1/transactions/patientpayments: get: summary: Returns a list of patient payment transaction entries based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no patient payment transaction entries matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Patient Payment Transactions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: true description: >- Filter clauses for patient payment transaction entries. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `patient.id` (`==`, `->`) - `transactionDate` (`>`, `<`, `>=`, `<=`) - `location.id` (`==`, `!=`, `->`) - `lastModified` (`>`, `<`, `>=`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `location.id==12`, `lastModified>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest transactionId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionPatientPaymentBulkResWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactionsPatientpaymentsV1 /v1/transactions/patientpayments/{transactionId}: get: summary: Returns a patient payment transaction entry by entry ID. description: >- Returns the patient payment transaction entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Patient Payment Transactions (V1) parameters: - in: path name: transactionId required: true description: ID of the transaction to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionPatientPaymentResWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactionsPatientpaymentsByTransactionIdV1 /v1/transactions/procedures: get: summary: Returns a list of patient procedure transaction entries based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no patient procedure transaction entries matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Patient Procedure Transactions (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: true description: >- Filter clauses for patient procedure transaction entries. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `ledgerType` (`==`, `!=`) - `patient.id` (`==`, `->`) - `provider.id` (`==`) - `transactionDate` (`>`, `<`, `>=`, `<=`) - `location.id` (`==`, `!=`, `->`) - `lastModified` (`>`, `<`, `>=`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `provider.id==7`, `location.id==12`, `lastModified>=2022-01-01`, `ledgerType==value`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest transactionId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionProcedureBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactionsProceduresV1 /v1/transactions/procedures/{transactionId}: get: summary: Returns a patient procedure transaction entry by entry ID. description: >- Returns the patient procedure transaction entry identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Patient Procedure Transactions (V1) parameters: - in: path name: transactionId required: true description: ID of the transaction to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionProcedureResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactionsProceduresByTransactionIdV1 /v1/transactions/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactionsTotalcountV1 /v1/transactiontags: get: summary: Returns a list of transaction tags based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no transaction tags matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - TransactionTags (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for transaction tags. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `tagText` (`==`, `!=`, `~=`, `<>=`) - `tagType` (`==`, `!=`) - `id` (`->`) Examples: `tagText==Insurance`, `tagType==value`, `id->[123,124]`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest transactionTagId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionTagBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactiontagsV1 post: summary: Returns TransactionTag which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - TransactionTags (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Transaction Tag. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/TransactionTagV1' example: {} examples: default: value: {} responses: '201': description: TransactionTag was created content: application/json: schema: $ref: '#/components/schemas/TransactionTagResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostTransactiontagsV1 /v1/transactiontags/{transactionTagId}: get: summary: Returns a transaction tag by ID. description: >- Returns the transaction tag identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - TransactionTags (V1) parameters: - in: path name: transactionTagId required: true description: ID of the transaction tag to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TransactionTagResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTransactiontagsByTransactionTagIdV1 delete: summary: Delete specific TransactionTag by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - TransactionTags (V1) parameters: - in: path name: transactionTagId required: true description: ID of the transaction tag to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: TimeClocjk was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteTransactiontagsByTransactionTagIdV1 /v1/txcases: get: summary: Returns a list of TxCases (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no TxCases matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - TxCases (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: filter in: query required: false description: >- Filter clauses for txcases. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `patient.id` (`==`) - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `patient.id==12345`, `lastModified>=2022-01-01`. schema: type: string - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest txCaseId from previous page schema: type: string example: 100 responses: '200': description: The request is successful. content: application/json: schema: $ref: '#/components/schemas/TxCaseBulkResponseWrapperV1' example: data: - id: '9000000035908' type: TxCaseV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: '9000000035908' type: TxCaseV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTxcasesV1 post: summary: Returns TxCaseV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - TxCases (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: >- **Purpose:** Create a treatment-plan case with an initial visit. **Required fields:** `patient`, `name` (unique within the patient's treatment plan), and procedures via `__procedures`. **Side effects:** Auto-creates a `TxOption` and first `Visit` containing the supplied procedures. **Idempotency:** Not supported — duplicate `name` for the same patient returns **400**. required: true content: application/json: schema: $ref: '#/components/schemas/TxCaseCreateV1' example: {} examples: default: value: {} responses: '201': description: TxCase was created content: application/json: schema: $ref: '#/components/schemas/TxCaseResponseWrapperV1' example: data: id: '9000000035908' type: TxCaseV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '9000000035908' type: TxCaseV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostTxcasesV1 /v1/txcases/calculated: get: summary: Returns a list of objects with calculated fields for TxCases (V1) based on filter criteria description: >- **Required:** `filter` selecting cases (for example `ids->[id1,id2]`) and `responseFields` including allowed fields such as `isCompleted`. Empty or invalid selection typically returns **400**. tags: - TxCases (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: filter in: query required: true description: >- Filter clauses for objects with calculated fields for txcases. General grammar and operators: the Public API filter documentation. **Keys and operators (this endpoint)** - `ids` (`->`) Examples: `ids->[1001,1002]`. schema: type: string - name: responseFields in: query required: true description: |- A URL-encoded, comma-delimited list of field names to include in the response data. Available fields: - isCompleted schema: type: string style: form explode: false responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TxCaseCalcBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTxcasesCalculatedV1 /v1/txcases/{txCaseId}: get: summary: Returns a TxCaseV1 by ID. description: >- Returns the TxCaseV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - TxCases (V1) parameters: - name: txCaseId in: path required: true description: ID of the tx case to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TxCaseResponseWrapperV1' example: data: id: '9000000035908' type: TxCaseV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '9000000035908' type: TxCaseV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTxcasesByTxCaseIdV1 put: summary: Returns the updated TxCaseV1. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - TxCases (V1) parameters: - in: path name: txCaseId required: true description: ID of the tx case to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Tx Case Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/TxCaseUpdateV1' example: name: Example Name status: NEW examples: default: value: name: Example Name status: NEW responses: '200': description: TxCase was updated content: application/json: schema: $ref: '#/components/schemas/TxCaseResponseWrapperV1' example: data: id: '9000000035908' type: TxCaseV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '9000000035908' type: TxCaseV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutTxcasesByTxCaseIdV1 delete: summary: Delete desired TxCaseV1 by ID description: >- 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 the case; `MOVE_AND_DELETE` unassigns procedures in Treatment Planner then deletes the case. tags: - TxCases (V1) parameters: - name: txCaseId in: path required: true description: ID of the tx case to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: deleteType in: query required: true schema: type: string enum: - DELETE - MOVE_AND_DELETE description: | Defines how to delete TxCaseV1 - DELETE - removes TxCaseV1 and all of the PatientProcedures inside it - MOVE_AND_DELETE - removes TxCase and makes all of the PatientProcedures unassigned inside TreatmentPlanner responses: '200': description: TxCase was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteTxcasesByTxCaseIdV1 /v1/txcases/{txCaseId}/calculated: get: summary: Returns the calculated fields for TxCaseV1 by ID of TxCaseV1. description: >- **Required:** `responseFields` listing allowed calculated fields (for example `isCompleted`). **404** if `txCaseId` does not exist. **MCP (first successful call):** path `txCaseId` must exist; query `responseFields=isCompleted` (required). tags: - TxCases (V1) parameters: - name: txCaseId in: path required: true description: ID of the tx case to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: true description: |- A URL-encoded, comma-delimited list of field names to include in the response data. Available fields: - isCompleted schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TxCaseCalcResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTxcasesByTxCaseIdCalculatedV1 /v1/txcases/{txCaseId}/amount: get: summary: Returns the total amount for TxCaseV1 by ID of TxCaseV1. description: >- 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. tags: - TxCases (V1) parameters: - name: txCaseId in: path required: true description: ID of the treatment case whose total amount to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TxCaseAmountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTxcasesByTxCaseIdAmountV1 /v1/txcases/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTxcasesTotalcountV1 /v1/users: get: summary: Returns a list of users based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no users matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Users (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: filter in: query required: false description: >- Filter clauses for users. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `id` (`->`) - `roles.location.id` (`==`, `->`) — use `ALL` or `*` for all locations; `->["ALL"]` or `->["*"]` to request all locations explicitly. - `userName` (`==`, `~=`) - `email` (`==`, `~=`) - `roles.role` (`==`, `->`) - `enabled` (`==`, `!=`) **NOTE:** - For a transitional period, omitting `roles.location.id` defaults to ALL locations. - Soon, `roles.location.id` may become **required** (IDs list or `["ALL"]`). Examples: `id->[1000001,1000002]`, `roles.location.id==123`, `userName~=john`, `enabled==true`. schema: type: string - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest userId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/UserBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetUsersV1 /v1/users/{userId}: get: summary: Returns a user by userId description: >- Returns the user identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Users (V1) parameters: - name: userId in: path required: true description: ID of the user to retrieve schema: type: string - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/UserResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetUsersByUserIdV1 put: summary: Returns the updated user. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - Users (V1) parameters: - in: path name: userId required: true description: ID of the user to update schema: type: string example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the User Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/UserUpdateV1' example: email: example@email.com firstName: first examples: default: value: email: example@email.com firstName: first responses: '200': description: User was updated content: application/json: schema: $ref: '#/components/schemas/UserResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutUsersByUserIdV1 /v1/visits: get: summary: Returns a list of Visits (V1) based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no Visits matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Visits (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: filter in: query required: false description: >- Filter clauses for visits. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `txCase.id` (`==`) - `lastModified` (`>`, `>=`, `<`, `<=`) **Ordering:** When filtering by `lastModified`, results are returned in **descending** order (newest first) where applicable; use `lastId` with date filters for stable pagination. Examples: `lastModified>=2022-01-01`, `txCase.id==12`. schema: type: string - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 10 - name: lastId in: query required: false description: the biggest visitId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/VisitBulkResponseWrapperV1' example: data: - id: '9000000038237' type: VisitV1 lastModified: '2024-01-12T15:58:19.443Z' sequence: 0 duration: 60 visitProceduresOrderType: TEETH descProceduresOrder: false txCase: id: '9000000035908' type: TxCaseV1 procedures: - id: '9000003725942' type: PatientProcedureV1 - id: '9000003725946' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - id: '9000000038237' type: VisitV1 lastModified: '2024-01-12T15:58:19.443Z' sequence: 0 duration: 60 visitProceduresOrderType: TEETH descProceduresOrder: false txCase: id: '9000000035908' type: TxCaseV1 procedures: - id: '9000003725942' type: PatientProcedureV1 - id: '9000003725946' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetVisitsV1 post: summary: Returns VisitV1 which has been created description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - Visits (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a visit within a treatment case. **Required fields:** `txCase` and a non-empty `procedures` array. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/VisitV1' example: {} examples: default: value: {} responses: '201': description: Visit was created content: application/json: schema: $ref: '#/components/schemas/VisitResponseWrapperV1' example: data: id: '9000000038237' type: VisitV1 lastModified: '2024-01-12T15:58:19.443Z' sequence: 0 duration: 60 visitProceduresOrderType: TEETH descProceduresOrder: false txCase: id: '9000000035908' type: TxCaseV1 procedures: - id: '9000003725942' type: PatientProcedureV1 - id: '9000003725946' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '9000000038237' type: VisitV1 lastModified: '2024-01-12T15:58:19.443Z' sequence: 0 duration: 60 visitProceduresOrderType: TEETH descProceduresOrder: false txCase: id: '9000000035908' type: TxCaseV1 procedures: - id: '9000003725942' type: PatientProcedureV1 - id: '9000003725946' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostVisitsV1 /v1/visits/{visitId}: get: summary: Returns a VisitV1 by ID. description: >- Returns the VisitV1 identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - Visits (V1) parameters: - name: visitId in: path required: true description: ID of the visit to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/VisitResponseWrapperV1' example: data: id: '9000000038237' type: VisitV1 lastModified: '2024-01-12T15:58:19.443Z' sequence: 0 duration: 60 visitProceduresOrderType: TEETH descProceduresOrder: false txCase: id: '9000000035908' type: TxCaseV1 procedures: - id: '9000003725942' type: PatientProcedureV1 - id: '9000003725946' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '9000000038237' type: VisitV1 lastModified: '2024-01-12T15:58:19.443Z' sequence: 0 duration: 60 visitProceduresOrderType: TEETH descProceduresOrder: false txCase: id: '9000000035908' type: TxCaseV1 procedures: - id: '9000003725942' type: PatientProcedureV1 - id: '9000003725946' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetVisitsByVisitIdV1 put: summary: Returns the updated VisitV1. description: >- Updates the visit identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. **Delete via update:** Send `procedures: []` to delete the visit (and possibly an orphaned tx case). Returns `{ id }` rather than the full resource. tags: - Visits (V1) parameters: - in: path name: visitId required: true description: ID of the visit to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: >- **Purpose:** Update visit sequencing, duration, or assigned procedures. **Delete via update:** Send `procedures: []` to delete the visit. Cannot add procedures to visits in a completed tx case. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/VisitUpdateV1' example: duration: 240 sequence: 0 examples: default: value: duration: 240 sequence: 0 responses: '200': description: Visit was updated content: application/json: schema: $ref: '#/components/schemas/VisitResponseWrapperV1' example: data: id: '9000000038237' type: VisitV1 lastModified: '2024-01-12T15:58:19.443Z' sequence: 0 duration: 60 visitProceduresOrderType: TEETH descProceduresOrder: false txCase: id: '9000000035908' type: TxCaseV1 procedures: - id: '9000003725942' type: PatientProcedureV1 - id: '9000003725946' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: id: '9000000038237' type: VisitV1 lastModified: '2024-01-12T15:58:19.443Z' sequence: 0 duration: 60 visitProceduresOrderType: TEETH descProceduresOrder: false txCase: id: '9000000035908' type: TxCaseV1 procedures: - id: '9000003725942' type: PatientProcedureV1 - id: '9000003725946' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutVisitsByVisitIdV1 /v1/visits/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetVisitsTotalcountV1 /v1/timeclocks: get: summary: Returns a list of timeClocks based on filter criteria. Following Ascend rule, only 20 records maximum. description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no timeClocks based on filter criteria. Following Ascend rule, only 20 records maximum matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - TimeClockV1 parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for timeclocks. General grammar and operators: the Public API filter documentation. **Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment. **Keys and operators (this endpoint)** - `punchDateTime` (`>`, `<`, `>=`, `<=`) - `location.id` (`==`, `->`) Examples: `location.id==12`, `punchDateTime>=2022-01-01`. schema: type: string - name: page in: query required: false description: Page number for pagination control schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control schema: type: string example: 100 - name: lastId in: query required: false description: the biggest timeClockId from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TimeClockBulkResponseWrapperV1' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTimeclocks post: summary: Returns the created TimeClock description: >- Creates a resource from the request body. Validation errors return **400**; a successful create returns **201** with the created resource in `data`. tags: - TimeClockV1 parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 requestBody: description: |- **Purpose:** Create a Time Clock. **Required fields:** See schema — properties marked required must be present. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/TimeClockV1' example: {} examples: default: value: {} responses: '201': description: TimeClock was created content: application/json: schema: $ref: '#/components/schemas/TimeClockResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PostTimeclocks /v1/timeclocks/{timeClockId}: get: summary: Returns a timeClock by ID. description: >- Returns the timeClock identified by the path parameter. **404** when the resource is missing or not accessible in the organization context. tags: - TimeClockV1 parameters: - name: timeClockId in: path required: true description: ID of the time clock to retrieve schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TimeClockResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTimeclocksByTimeClockId put: summary: Returns the updated timeClock. description: >- Updates the resource identified by the path parameter. Validation errors return **400**; **404** when the resource is missing. tags: - TimeClockV1 parameters: - in: path name: timeClockId required: true description: ID of the time clock to update schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - in: query name: responseFields required: false description: > A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string requestBody: description: |- **Purpose:** Update the Time Clock Update identified by the path parameter. **Required fields:** Only included properties are updated; omitted fields are unchanged. **Idempotency:** Not supported. required: true content: application/json: schema: $ref: '#/components/schemas/TimeClockUpdateV1' example: punchDateTime: '2018-07-09T19:00:00.000Z' lastEditedBy: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType examples: default: value: punchDateTime: '2018-07-09T19:00:00.000Z' lastEditedBy: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType responses: '200': description: TimeClock was updated content: application/json: schema: $ref: '#/components/schemas/TimeClockResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: PutTimeclocksByTimeClockId delete: summary: Delete specific TimeClock by ID description: Deletes the resource identified by the path parameter. **404** when the resource is missing or already deleted. tags: - TimeClockV1 parameters: - in: path name: timeClockId required: true description: ID of the time clock to delete schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 responses: '200': description: TimeClock was deleted '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: DeleteTimeclocksByTimeClockId /v1/timeclocks/totalcount: get: summary: Returns the total count of records based on filter criteria description: >- **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 tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions). **Empty results:** **200** with `data: []` means no resources matched; it does not indicate invalid filter values. **responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list. **Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred. tags: - Total Count (V1) parameters: - name: Organization-ID in: header required: true description: Organization context for the request. Must match the organization authorized by the access token. schema: type: string example: 1006 - name: responseFields in: query required: false description: >- A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: >- Filter clauses for the requested domain (mirrors the corresponding bulk GET for that resource). General grammar and operators: the Public API filter documentation. **Important:** Filters are optional on Total Count. Allowed keys and operators match the bulk GET for the same resource—use that operation’s filter documentation as the source of truth. **Keys and operators (this endpoint)** - Varies by `domain` — see the bulk GET path for the same entity (for example `patients`, `appointments`, `documents`). Examples: `lastModified>=2022-01-01`, `patient.id==12345`, `fieldName->[a,b]` (syntax only; valid keys depend on `domain`). schema: type: string - name: page in: query required: false description: Page number for pagination. Must be used with a valid filter. schema: type: integer example: 1 - name: pageSize in: query required: false description: Page size for pagination. Must be used with a valid filter. schema: type: integer example: 100 - name: lastId in: query required: false description: the biggest id from previous page schema: type: string example: 100 responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/TotalCountResponseWrapperV1' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body examples: default: value: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetTimeclocksTotalcountV1 /v1/usagereport: get: summary: Returns a UsageReportV1 based on the time range and endpoint name. description: >- Endpoint usage statistics for an optional time window and endpoint name. **Quirk:** If you call this on the **first calendar day of the month**, the API returns **no statistics** (documented behavior). **Dates:** `startDate` and `endDate` use `YYYY-MM-DD`; they must not be equal; `endDate` cannot precede `startDate` or exceed today. `endpoint` is optional; when omitted, results are broken down by endpoint. Invalid combinations return **400**. tags: - Usage Report (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - name: filter in: query required: false description: >- Filter clauses for endpoint usage statistics. General grammar and operators: the Public API filter documentation. **Important!** This endpoint does not provide any statistics if called on the **first calendar day of the month** (documented behavior). **Keys and operators (this endpoint)** - `startDate` (`==`) — optional; if omitted, defaults to the first day of the current month. Must not equal `endDate`. Must not be earlier than the first day of the current month. Quoted date values are often required (see examples). - `endDate` (`==`) — optional; if omitted, defaults to the current date. Must not equal `startDate`, must not precede `startDate`, and must not be later than today. - `endpoint` (`==`) — optional; when omitted, statistics are returned broken down by endpoint. Must be a known endpoint name from the API documentation, without versioning or special characters. A `YYYY-MM-DD` value represents the start of that calendar day (for example `2025-03-01` is the start of March 1). Examples: `startDate=="2025-03-01",endDate=="2025-03-02",endpoint==""`. **MCP (first successful call):** do **not** use `location.id` filters here. Use `startDate` / `endDate` in `YYYY-MM-DD` form (quoted as in the examples), with `startDate` ≠ `endDate`, and avoid calling on the **first calendar day of the month** (no stats that day). schema: type: string responses: '200': description: The request was successful content: application/json: schema: $ref: '#/components/schemas/UsageReportResponseV1' example: statusCode: 200 data: usagePerEndpoint: - {} examples: default: value: statusCode: 200 data: usagePerEndpoint: - {} '400': description: The request was invalid or cannot be processed '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '408': description: The server timed out while processing the request '429': description: Rate limit exceeded '500': description: An unexpected error occurred operationId: GetUsagereportV1 components: schemas: DeletedResult: type: object description: Result of deleting the particular resource. Includes the id of deleted resource. properties: data: type: object properties: id: type: integer format: int64 warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: 12545 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body Token: type: object properties: access_token: type: string example: access token expires_in: type: string example: 60 days token_type: type: string example: token type example: access_token: access token expires_in: 60 days Error: type: object properties: code: type: string title: type: string description: type: string source: type: string example: code: ERR101 title: Example Title Pagination: type: object description: Pagination info properties: limit: type: integer format: int32 example: 10 offset: type: integer format: int32 example: 0 total: type: integer format: int32 example: 100 example: limit: 10 offset: 0 PatientResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: '1000000020701' type: PatientV1 firstName: John lastName: Smith preferredName: John gender: M dateOfBirth: '1990-05-07' patientStatus: NEW contactMethod: CALL ME languageType: English address1: Fake street 1 city: Fake City state: UT postalCode: '84062' chartNumber: A99999 title: Title middleInitial: M nameSuffix: Sr preferredLocation: id: 1000000001027 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientUpdateResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientUpdateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: '1000000020701' type: PatientV1 firstName: John lastName: Smith preferredName: John gender: M dateOfBirth: '1990-05-07' patientStatus: NEW contactMethod: CALL ME languageType: English address1: Fake street 1 city: Fake City state: UT postalCode: '84062' chartNumber: A99999 title: Title middleInitial: M nameSuffix: Sr preferredLocation: id: 1000000001027 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientV1: allOf: - $ref: '#/components/schemas/PatientUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - firstName - lastName - contactMethod - languageType - patientStatus - gender - dateOfBirth - preferredLocation - address1 - city - state - postalCode properties: id: type: integer format: int64 readOnly: true firstVisitDate: type: string format: date readOnly: true example: 2024-05-02T00:00:00.000Z emergencyContact: type: object readOnly: true properties: name: type: string example: Bob Barker relationship: type: string example: Father phoneType: type: string enum: - Home - Work - Mobile - Other example: Home phoneNumber: type: string example: 213-6745 phoneExtension: type: string example: '222' referredByPatient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true referredByReferral: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true primaryGuarantor: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true secondaryGuarantor: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true primaryContact: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true secondaryContact: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true preferredLocation: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true referredPatients: type: array readOnly: true items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time readOnly: true example: 2018-07-09T19:00:00.000Z example: {} PatientUpdateV1: type: object properties: title: type: string maxLength: 25 example: Dr. firstName: type: string minLength: 1 maxLength: 25 example: John middleInitial: type: string maxLength: 1 example: P lastName: type: string minLength: 1 maxLength: 25 example: Doe nameSuffix: type: string maxLength: 10 example: Jr. preferredName: type: string maxLength: 25 example: Johnny gender: type: string enum: - M - F - O example: M dateOfBirth: type: string format: date description: A date in the ISO format YYYY-MM-DD. Example - 2021-01-19 example: '1985-08-25' contactMethod: type: string enum: - Call me - Text me - Email me example: Email me languageType: type: string enum: - English - Spanish - Arabic - Armenian - Bengali - Bosnian - Cambodian - Chinese_Mandarin - Chinese_Cantonese - French - German - Greek - Hebrew - Hindi - Italian - Japanese - Korean - Laotian - Polish - Portuguese - Russian - Somali - Tagalog - Vietnamese example: English patientStatus: type: string enum: - NEW - ACTIVE - NON-PATIENT - INACTIVE - DUPLICATE - DISMISSED - DECEASED example: ACTIVE emailAddress: type: string maxLength: 60 format: email example: john.doe@example.com chartNumber: type: string maxLength: 10 example: CH10023456 preferredDays: type: array items: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY example: - MONDAY - TUESDAY - WEDNESDAY preferredTimes: type: array items: type: string enum: - EARLY_MORNING - LATE_MORNING - EARLY_AFTERNOON - LATE_AFTERNOON example: - EARLY_MORNING - LATE_MORNING address1: type: string minLength: 1 maxLength: 50 example: 123 Maple Street address2: type: string maxLength: 50 example: Apt 101 city: type: string minLength: 1 maxLength: 30 example: Anytown state: type: string enum: - AA - AE - AP - AL - AK - AS - AZ - AR - CA - CO - CNMI - CT - DE - DC - FM - FL - FSM - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MH - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY example: CA postalCode: type: string minLength: 5 maxLength: 10 example: '90210' income: type: number format: double minimum: 0 maximum: 99999.99 example: 45000.5 familySize: type: number format: int32 example: 3 discountType: type: string enum: - NONE - BASIC - SLIDING_FEES example: SLIDING_FEES discountPlan: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true discountPlanExpirationDate: type: string format: date-time example: '2018-07-09T19:00:00.000Z' isOrthoPatient: type: boolean example: true phones: type: array items: type: object required: - phoneType - number - sequence properties: id: type: integer format: int64 example: 1234 readOnly: true phoneType: type: string enum: - HOME - WORK - MOBILE - OTHER example: MOBILE number: type: string maxLength: 10 example: '5551234567' extension: type: string maxLength: 10 example: '1231234545' sequence: description: >- A number (1 or greater) representing the order of the phone within the phoneType. The combination of phoneType and sequence must be unique. type: integer format: int32 example: 1 primaryProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true duplicateOfPatient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: title: Dr. firstName: John PatientCalcV1: type: object properties: patientId: type: integer format: int64 readOnly: true lastVisitDate: type: string format: date-time readOnly: true example: 2024-05-02T19:00:00.000Z example: patientId: 12445 lastVisitDate: '2024-05-02T19:00:00.000Z' PatientCalcBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientCalcV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientBillingType: type: object required: - organizationBillingType properties: type: type: string example: PatientBillingType readOnly: true lastModified: type: string format: date-time example: 2019-09-09T19:00:00.000Z readOnly: true organizationBillingType: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: organizationBillingType: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType type: PatientBillingType lastModified: '2019-09-09T19:00:00.000Z' PatientBillingTypeBulkResponseWrapper: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientBillingType' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/AppointmentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/AppointmentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: '1000012109742' type: AppointmentV1 title: Appointment start: '2025-10-04T07:00:00.000Z' end: '2025-10-04T08:00:00.000Z' duration: 60 status: HERE statusId: 2 note: ~ 2025-10-04 ~ Test Notes !! heheh JEST TEST NOTE!! other: My Other Test Note needsFollowUp: true needsPremedicate: true bookedOnline: true asap: false created: '2025-10-03T16:56:56.510Z' lastModified: '2025-10-03T16:56:56.510Z' confirmed: '2025-10-03T16:56:56.420Z' followedUpOn: '2025-10-04T00:00:00.000Z' patient: id: '1000000020701' type: PatientV1 location: id: '1000000001027' type: LocationV1 provider: id: '1000000002089' type: ProviderV1 operatory: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentV1: allOf: - $ref: '#/components/schemas/AppointmentUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - start - provider - status - patient - operatory properties: id: type: integer format: int64 readOnly: true start: type: string format: date-time readOnly: false example: 2024-05-09T12:00:00.000Z end: type: string format: date-time readOnly: true example: 2024-05-09T13:00:00.000Z created: type: string format: date-time readOnly: true example: 2024-05-09T13:05:00.000Z duration: type: integer minimum: 5 maximum: 1440 readOnly: false example: 1440 status: type: string enum: - LATE - HERE - READY - CHAIR - COMPLETED - WILL_CALL - CONFIRMED - UNCONFIRMED - NO_SHOW - BROKEN - LEFT_MESSAGE - CHECKOUT - UNREACHABLE - CANCELLEDBYOFFICE example: COMPLETED statusId: type: number readOnly: true lastModified: type: string format: date-time readOnly: true example: 2024-05-09T13:30:00.000Z labCaseDentalLab: type: object description: >- A reference to a linked model. Includes the id, the type and url at which the model can be accessed. Setting this field to null is going to set all labCase fields to null (labCaseStatus, labCaseDueDate, labCaseNote) properties: id: type: integer format: int64 type: type: string example: string url: type: string format: url example: string timePattern: type: object description: Used to represent who is providing care to the patient during the appointment. readOnly: true properties: duration: type: integer minimum: 5 maximum: 1440 readOnly: true example: 1440 blocksPerHour: type: integer readOnly: true example: 6 rows: type: array items: type: object properties: activity: type: string enum: - assistant - provider - chair - none order: type: integer example: 1 labCaseDueDate: type: string format: date-time example: 2024-05-09T17:00:00.000Z labCaseNote: type: string example: string provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true otherProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true operatory: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} AppointmentUpdateV1: type: object properties: confirmed: type: string format: date-time example: 2024-05-02T16:30:00.000Z readOnly: true needsFollowUp: type: boolean example: true followedUpOn: type: string format: date-time example: 2024-05-09T17:00:00.000Z start: type: string format: date-time readOnly: false example: 2024-05-09T12:00:00.000Z bookingType: type: string enum: - TREATMENT - RECARE - NEW_PATIENT - EXISTING_PATIENT example: TREATMENT needsPremedicate: type: boolean example: true note: type: string example: string other: type: string maxLength: 90 example: string bookedOnline: type: boolean example: true leftMessage: type: string format: date example: 2024-05-02T00:00:00.000Z readOnly: true duration: type: integer minimum: 5 maximum: 1440 example: 60 asap: type: boolean example: true lastModified: type: string format: date-time example: 2024-05-09T17:00:00.000Z readOnly: true labCaseDentalLab: type: object description: >- A reference to a linked model. Includes the id, the type and url at which the model can be accessed. Setting this field to null is going to set all labCase fields to null (labCaseStatus, labCaseDueDate, labCaseNote) properties: id: type: integer format: int64 type: type: string example: string url: type: string format: url example: string labCaseStatus: type: string enum: - OUTSTANDING - RECEIVED example: OUTSTANDING labCaseDueDate: type: string format: date-time example: 2024-05-09T17:00:00.000Z labCaseNote: type: string example: string patientProcedures: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true practiceProcedures: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true visits: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: confirmed: '2024-05-02T16:30:00.000Z' needsFollowUp: true AppointmentResponseWrapperV2: type: object properties: data: $ref: '#/components/schemas/AppointmentV2' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: 9000000903582 version: 5 created: 1730733795640 startDateTime: 1730910600000 endDateTime: 1730915100000 status: READY title: Appointment reason: ArthrSDsc, PerMaint duration: 75 needsFollowup: true ASAP: true needsPremedicate: true note: this is a test note other: null bookedOnline: false patient: id: 9000000082518 patientLite: id: 9000000082518 location: id: 9000000000010 provider: id: 9000000000393 operatory: id: 9000000000333 secondaryProvider: id: 9000000000398 confirmed: 1730733785665 followedUp: null reminded: null insuranceEligibilityVerified: null productionAmount: 144 leftMessage: null visits: [] patientProcedures: [] procedures: - id: 9000000050597 procedure: id: 9000000005520 adaCode: D7876 description: Arthroscopy Discectomy abbreviatedDescription: ArthrSDsc - id: 9000000050598 procedure: id: 9000000005807 adaCode: D4910 description: Periodontal Maintenance abbreviatedDescription: PerMaint communications: [] dueDates: [] missedAppointments: [] labCase: id: 9000000000002 dentalLab: id: 9000000000001 name: asdf phone: '1112223333' status: OUTSTANDING dueDate: 1730959199000 note: this is a test lab note warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentBulkResponseWrapperV2: type: object properties: data: type: array items: $ref: '#/components/schemas/AppointmentV2' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: 9000000903582 version: 5 created: 1730733795640 startDateTime: 1730910600000 endDateTime: 1730915100000 status: READY title: Appointment reason: ArthrSDsc, PerMaint duration: 75 needsFollowup: true ASAP: true needsPremedicate: true note: this is a test note other: null bookedOnline: false patient: id: 9000000082518 patientLite: id: 9000000082518 location: id: 9000000000010 provider: id: 9000000000393 operatory: id: 9000000000333 secondaryProvider: id: 9000000000398 confirmed: 1730733785665 followedUp: null reminded: null insuranceEligibilityVerified: null productionAmount: 144 leftMessage: null visits: [] patientProcedures: [] procedures: - id: 9000000050597 procedure: id: 9000000005520 adaCode: D7876 description: Arthroscopy Discectomy abbreviatedDescription: ArthrSDsc - id: 9000000050598 procedure: id: 9000000005807 adaCode: D4910 description: Periodontal Maintenance abbreviatedDescription: PerMaint communications: [] dueDates: [] missedAppointments: [] labCase: id: 9000000000002 dentalLab: id: 9000000000001 name: asdf phone: '1112223333' status: OUTSTANDING dueDate: 1730959199000 note: this is a test lab note warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentV2: allOf: - $ref: '#/components/schemas/AppointmentUpdateV2' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - start - provider - status - patient - operatory properties: id: type: integer format: int64 readOnly: true start: type: string format: date-time readOnly: false example: 2024-05-09T12:00:00.000Z end: type: string format: date-time readOnly: true example: 2024-05-09T13:00:00.000Z created: type: string format: date-time readOnly: true example: 2024-05-09T13:05:00.000Z duration: type: integer minimum: 5 maximum: 1440 readOnly: false example: 1440 status: type: string enum: - LATE - HERE - READY - CHAIR - COMPLETED - WILL_CALL - CONFIRMED - UNCONFIRMED - NO_SHOW - BROKEN - LEFT_MESSAGE - CHECKOUT - UNREACHABLE - CANCELLEDBYOFFICE example: COMPLETED statusId: type: number readOnly: true lastModified: type: string format: date-time readOnly: true example: 2024-05-09T13:30:00.000Z labCaseDentalLab: type: object description: >- A reference to a linked model. Includes the id, the type and url at which the model can be accessed. Setting this field to null is going to set all labCase fields to null (labCaseStatus, labCaseDueDate, labCaseNote) properties: id: type: integer format: int64 type: type: string example: string url: type: string format: url example: string timePattern: type: object description: Used to represent who is providing care to the patient during the appointment. readOnly: true properties: duration: type: integer minimum: 5 maximum: 1440 readOnly: true example: 1440 blocksPerHour: type: integer readOnly: true example: 6 rows: type: array items: type: object properties: activity: type: string enum: - assistant - provider - chair - none order: type: integer example: 1 labCaseDueDate: type: string format: date-time example: 2024-05-09T17:00:00.000Z labCaseNote: type: string example: string provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true otherProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true operatory: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} AppointmentUpdateV2: type: object properties: confirmed: type: string format: date-time example: 2024-05-02T16:30:00.000Z readOnly: true needsFollowUp: type: boolean example: true followedUpOn: type: string format: date-time example: 2024-05-09T17:00:00.000Z start: type: string format: date-time readOnly: false example: 2024-05-09T12:00:00.000Z bookingType: type: string enum: - TREATMENT - RECARE - NEW_PATIENT - EXISTING_PATIENT example: TREATMENT needsPremedicate: type: boolean example: true note: type: string example: string other: type: string maxLength: 90 example: string bookedOnline: type: boolean example: true leftMessage: type: string format: date example: 2024-05-02T00:00:00.000Z readOnly: true duration: type: integer minimum: 5 maximum: 1440 example: 60 asap: type: boolean example: true lastModified: type: string format: date-time example: 2024-05-09T17:00:00.000Z readOnly: true labCaseDentalLab: type: object description: >- A reference to a linked model. Includes the id, the type and url at which the model can be accessed. Setting this field to null is going to set all labCase fields to null (labCaseStatus, labCaseDueDate, labCaseNote) properties: id: type: integer format: int64 type: type: string example: string url: type: string format: url example: string labCaseStatus: type: string enum: - OUTSTANDING - RECEIVED example: OUTSTANDING labCaseDueDate: type: string format: date-time example: 2024-05-09T17:00:00.000Z labCaseNote: type: string example: string patientProcedures: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true practiceProcedures: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true visits: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: confirmed: '2024-05-02T16:30:00.000Z' needsFollowUp: true AppointmentHistoryResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/AppointmentHistoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentHistoryBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/AppointmentHistoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentHistoryV1: type: object properties: id: type: integer format: int64 type: type: string lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true historyType: type: string enum: - BROKEN - NOSHOW - RESCHEDULED - CANCELED example: CANCELED originalDateTime: type: string format: date-time example: 2018-07-09T19:00:00.000Z rescheduledDateTime: type: string format: date-time example: 2018-08-09T19:00:00.000Z insertDateTime: type: string format: date-time example: 2018-08-09T19:00:00.000Z appointment: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: id: 12445 type: example_type AppointmentSHResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/AppointmentStatusHistoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentSHBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/AppointmentStatusHistoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentStatusHistoryV1: type: object properties: id: type: integer format: int64 example: 1234 type: type: string lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true appointmentStatus: type: string enum: - LATE - HERE - READY - CHAIR - COMPLETED - WILL_CALL - CONFIRMED - UNCONFIRMED - NO_SHOW - BROKEN - LEFT_MESSAGE - CHECKOUT - UNREACHABLE - CANCELLEDBYOFFICE example: - READY effectiveTime: type: string format: date-time example: 2018-07-09T19:00:00.000Z appointment: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: id: 1234 type: example_type AppointmentTaskUpdateV1: type: object properties: appointment: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: appointment: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType AppointmentTaskV1: allOf: - $ref: '#/components/schemas/AppointmentTaskUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - taskType properties: id: type: integer format: int64 readOnly: true taskType: type: string enum: - SCHEDULE_RECARE - COLLECT_PAYMENT - COLLECT_PHONE - COLLECT_EMAIL example: SCHEDULE_RECARE succeeded: readOnly: true type: boolean skippedReason: type: string enum: - WE_DID_NOT_ASK - PATIENT_DECLINED - PATIENT_WAS_UNABLE_TO_COMPLY - PATIENT_DEPARTED_WITHOUT_CHECKOUT - OTHER example: OTHER comment: type: string description: Can be provided only if skippedReason has value OTHER example: comments user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} AppointmentTaskResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/AppointmentTaskV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentTaskBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/AppointmentTaskV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProviderResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ProviderV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: '1000000002089' type: ProviderV1 firstName: John lastName: Doe shortName: Short specialty: DENTIST isPrimaryProvider: true isNonPersonEntity: false color: ffffff dea: AA1234567 npi: '1234567893' active: true stateId: license number tin: '123456789' signatureOnFile: false address1: addr 1 address2: addr 2 city: city 1 state: CA postalCode: 11111-2222 title: Dr warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProviderBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: '1000000002089' type: ProviderV1 firstName: John lastName: Doe shortName: Short specialty: DENTIST isPrimaryProvider: true isNonPersonEntity: false color: ffffff dea: AA1234567 npi: '1234567893' active: true stateId: license number tin: '123456789' signatureOnFile: false address1: addr 1 address2: addr 2 city: city 1 state: CA postalCode: 11111-2222 title: Dr warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProviderNumber: type: object required: - location properties: number: type: string maxLength: 20 example: '32131' location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType number: '32131' ProviderUpdateV1: type: object properties: type: type: string example: provider enum: - Provider firstName: type: string minLength: 1 maxLength: 25 example: first middleInitial: type: string maxLength: 1 example: m lastName: type: string minLength: 1 maxLength: 50 example: last shortName: type: string minLength: 3 maxLength: 6 example: short npi: type: string maxLength: 10 color: type: string maxLength: 6 active: type: boolean example: true stateId: type: string minLength: 1 maxLength: 20 example: s1234567890098765432 tin: type: string minLength: 9 maxLength: 9 specialty: type: string enum: - DENTALPUBLICHEALTH - DENTALSPECIALTY - DENTIST - DENTAL - ENDODONTICS - FEDERALLYQUALIFIEDHEALTHCENTER - GENERALPRACTICE - HYGIENIST - MULTISPECIALTY - ORTHODONTICS - ORALMAXILLOFACIALPATHOLOGY - ORALMAXILLOFACIALRADIOLOGY - ORALMAXILLOFACIALSURGERY - PEDIATRICDENTISTRY - PERIODONTICS - PROSTHODONTICS - SINGLESPECIALTY example: DENTIST isPrimaryProvider: type: boolean example: true title: type: string maxLength: 50 signatureOnFile: type: boolean example: true address1: type: string maxLength: 50 example: 123 example st address2: type: string maxLength: 50 example: 456 example st city: type: string maxLength: 30 state: type: string enum: - AA - AE - AP - AL - AK - AS - AZ - AR - CA - CO - CNMI - CT - DE - DC - FM - FL - FSM - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MH - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY example: AA postalCode: type: string minLength: 5 maxLength: 10 example: 2345670987 isLocumTenens: type: boolean stateIdExpiration: type: string format: date example: 2018-07-09T00:00:00.000Z providerNumbers: type: array items: $ref: '#/components/schemas/ProviderNumber' insuranceCarriers: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true feeSchedule: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: type: provider firstName: first ProviderV1: allOf: - $ref: '#/components/schemas/ProviderUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - firstName - lastName - shortName - specialty - isPrimaryProvider - address1 - city - state - postalCode properties: id: type: integer format: int64 example: 32432432 readOnly: true isNonPersonEntity: type: boolean example: false readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: {} ProviderGroupUpdateV1: type: object properties: groupName: type: string example: Group Name providers: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true version: type: integer format: int32 example: 1 example: groupName: Group Name providers: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType ProviderGroupV1: allOf: - $ref: '#/components/schemas/ProviderGroupUpdateV1' - type: object required: - groupName - providers properties: id: type: integer format: int64 example: 32424 readOnly: true providers: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: {} ProviderGroupBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderGroupV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProviderGroupResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ProviderGroupV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProviderHourUpdateV1: type: object properties: startDate: type: string format: date example: '2024-05-10' endDate: type: string format: date example: '2024-05-10' numberOfWeeks: type: integer format: int32 minimum: 1 maximum: 4 example: 4 startDayIndex: type: integer format: int32 minimum: 1 maximum: 31 example: 31 type: type: string enum: - ProviderHour example: ProviderHour days: type: object properties: SUNDAY: type: array items: type: object properties: weekNumber: type: integer format: int32 example: 5 hours: type: array items: type: object properties: startTime: type: string format: time example: '13:00' endTime: type: string format: time example: '15:00' MONDAY: type: array items: type: object properties: weekNumber: type: integer format: int32 example: 5 hours: type: array items: type: object properties: startTime: type: string format: time example: '13:00' endTime: type: string format: time example: '15:00' TUESDAY: type: array items: type: object properties: weekNumber: type: integer format: int32 example: 5 hours: type: array items: type: object properties: startTime: type: string format: time example: '13:00' endTime: type: string format: time example: '15:00' WEDNESDAY: type: array items: type: object properties: weekNumber: type: integer format: int32 example: 5 hours: type: array items: type: object properties: startTime: type: string format: time example: '13:00' endTime: type: string format: time example: '15:00' THURSDAY: type: array items: type: object properties: weekNumber: type: integer format: int32 example: 5 hours: type: array items: type: object properties: startTime: type: string format: time example: '13:00' endTime: type: string format: time example: '15:00' FRIDAY: type: array items: type: object properties: weekNumber: type: integer format: int32 example: 5 hours: type: array items: type: object properties: startTime: type: string format: time example: '13:00' endTime: type: string format: time example: '15:00' SATURDAY: type: array items: type: object properties: weekNumber: type: integer format: int32 example: 5 hours: type: array items: type: object properties: startTime: type: string format: time example: '13:00' endTime: type: string format: time example: '15:00' isDefaultSchedule: type: boolean example: true example: startDate: '2024-05-10' endDate: '2024-05-10' ProviderHourV1: allOf: - $ref: '#/components/schemas/ProviderHourUpdateV1' - type: object required: - startDate - numberOfWeeks - startDayIndex - provider - location properties: id: type: integer format: int64 example: 32424 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} ProviderHourBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ProviderHourV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProviderHourResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ProviderHourV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body FeeScheduleV1: type: object required: - name properties: id: type: integer format: int64 example: 324324 readOnly: true name: type: string minLength: 1 maxLength: 64 lastModified: type: string format: date-time readOnly: true example: 2018-07-09T19:00:00.000Z example: name: Example Name id: 324324 lastModified: '2018-07-09T19:00:00.000Z' FeeScheduleResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/FeeScheduleV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body FeeScheduleBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/FeeScheduleV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body FeeScheduleRangeUpdateV1: type: object properties: startDate: type: string format: date example: 2024-04-01T00:00:00.000Z description: | should be earlier than endDate
should not be earlier than the startDate of the previous range
should be null if it is the first range in fee schedule
field is recalculated on the update of the startDate of the next range
field should have value equal to the value of the endDate of the previous range + 1 day
items: type: object properties: (practiceProcedureId): type: number format: double maxLength: 10 maximum: 9999999.99 minimum: 0 example: 9999999.99 description: | supports partial update: you can provide only changed fees of procedures example: startDate: '2024-04-01T00:00:00.000Z' items: (practiceProcedureId): 9999999.99 FeeScheduleRangeV1: allOf: - $ref: '#/components/schemas/FeeScheduleRangeUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - feeSchedule - startDate properties: id: type: integer format: int64 example: 232133 readOnly: true feeScheduleVersion: type: integer example: 5 readOnly: true feeSchedule: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true endDate: type: string format: date example: 2024-05-10T00:00:00.000Z readOnly: true description: | should be later than startDate
should not be later than the endDate of the next range
should be null if it is the last range in fee schedule
field is recalculated on the update of the endDate of the previous range
field should have value equal to the value of the startDate of the next range - 1 day
lastModified: type: string format: date-time readOnly: true example: 2018-07-09T19:00:00.000Z example: {} FeeScheduleRangeResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/FeeScheduleRangeV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body FeeScheduleRangeBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/FeeScheduleRangeV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body FeeScheduleAssociationsV1: type: object properties: locations: type: array items: type: object properties: id: type: integer format: int64 example: 1234 name: type: string patients: type: array items: type: object properties: id: type: integer format: int64 example: 1234 name: type: string providers: type: array items: type: object properties: id: type: integer format: int64 example: 1234 name: type: string carrierInsurancePlans: type: array items: type: object properties: id: type: integer format: int64 example: 1234 name: type: string example: locations: - id: 1234 name: Example Name patients: - id: 1234 name: Example Name ReferralSourceResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ReferralSourceV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ReferralSourceBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ReferralSourceV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ReferralSourceUpdateV1: type: object properties: firstName: type: string maxLength: 25 example: first middleInitial: type: string maxLength: 1 example: m lastName: type: string minLength: 1 maxLength: 50 example: last title: type: string maxLength: 25 specialty: type: string enum: - DENTALPUBLICHEALTH - DENTALSPECIALTY - DENTIST - DENTAL - ENDODONTICS - FEDERALLYQUALIFIEDHEALTHCENTER - GENERALPRACTICE - HYGIENIST - MULTISPECIALTY - ORTHODONTICS - ORALMAXILLOFACIALPATHOLOGY - ORALMAXILLOFACIALRADIOLOGY - ORALMAXILLOFACIALSURGERY - PEDIATRICDENTISTRY - PERIODONTICS - PROSTHODONTICS - SINGLESPECIALTY example: DENTIST referralSourceType: type: string enum: - MARKETING - OTHER - PROFESSIONAL example: OTHER note: type: string maxLength: 512 npi: type: string maxLength: 10 minLength: 10 stateId: type: string maxLength: 15 address1: type: string maxLength: 50 example: 123 example st address2: type: string maxLength: 50 example: 456 example st city: type: string maxLength: 30 state: type: string enum: - AA - AE - AP - AL - AK - AS - AZ - AR - CA - CO - CNMI - CT - DE - DC - FM - FL - FSM - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MH - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY example: AA postalCode: type: string minLength: 5 maxLength: 10 example: '3445345678' phone1_number: type: string minLength: 10 maxLength: 10 example: '1236547685' phone1_type: type: string enum: - HOME - WORK - MOBILE - OTHER example: HOME phone1_extension: type: string maxLength: 10 example: '7654345645' phone2_number: type: string minLength: 10 maxLength: 10 example: '8654765869' phone2_type: type: string enum: - HOME - WORK - MOBILE - OTHER example: WORK phone2_extension: type: string maxLength: 10 example: '3248767678' phone3_number: type: string minLength: 10 maxLength: 10 example: '7876754353' phone3_type: type: string enum: - HOME - WORK - MOBILE - OTHER example: MOBILE phone3_extension: type: string maxLength: 10 example: '8765434345' email: type: string format: email maxLength: 60 example: example@email.com example: firstName: first middleInitial: m ReferralSourceV1: allOf: - $ref: '#/components/schemas/ReferralSourceUpdateV1' - type: object required: - lastName - referralSourceType properties: id: type: integer format: int64 example: 3423432 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: {} LocationResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/LocationV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: '1000000001027' type: LocationV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body LocationBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/LocationV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: '1000000001027' type: LocationV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body LocationV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide properties: id: type: integer format: int64 name: type: string maxLength: 50 example: string abbreviation: type: string maxLength: 5 example: strin taxPercentage: type: number format: double minimum: 0 maximum: 100 example: 100 timeZone: type: string readOnly: true example: string website: type: string maxLength: 100 example: string email: type: string format: email maxLength: 60 example: string phone: type: string maxLength: 10 minLength: 10 example: string address1: type: string maxLength: 50 example: string address2: type: string maxLength: 50 example: string city: type: string maxLength: 30 example: string state: type: string enum: - AA - AE - AP - AL - AK - AS - AZ - AR - CA - CO - CNMI - CT - DE - DC - FM - FL - FSM - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MH - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY example: AA postalCode: type: string minLength: 5 maxLength: 10 example: string billing_entityEnabled: type: boolean example: true billing_name: type: string maxLength: 50 example: string billing_address1: type: string maxLength: 50 example: string billing_address2: type: string maxLength: 50 example: string billing_city: type: string maxLength: 30 example: string billing_state: type: string enum: - AA - AE - AP - AL - AK - AS - AZ - AR - CA - CO - CNMI - CT - DE - DC - FM - FL - FSM - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MH - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY example: AA billing_postalCode: type: string minLength: 10 maxLength: 10 example: '##########' billing_phone: type: string maxLength: 10 minLength: 10 example: string image: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true feeSchedule: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: id: 12445 name: string OnlineBookingLocationResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/OnlineBookingLocationV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OnBookLocationBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/OnlineBookingLocationV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OnlineBookingLocationUpdateV1: type: object properties: enabled: type: boolean example: true version: type: integer format: int32 example: 1 example: enabled: true version: 1 OnlineBookingLocationV1: allOf: - $ref: '#/components/schemas/OnlineBookingLocationUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - locationId - enabled properties: lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} OperatoryResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/OperatoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OperatoryBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/OperatoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: '1000000002103' type: OperatoryV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OperatoryUpdateV1: type: object properties: name: type: string maxLength: 25 shortName: type: string minLength: 1 maxLength: 25 example: short name active: type: boolean example: true example: name: Example Name shortName: short name OperatoryV1: allOf: - $ref: '#/components/schemas/OperatoryUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - shortName - location properties: id: type: integer format: int64 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} OrganizationResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/OrganizationV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OrganizationV1: type: object required: - name - softwareType - customer - alias - allowAutoClaimSubmission - isTestingOrganization - isEnabled - writeOffAutoPostEnabled properties: id: type: integer format: int64 example: 32432432 name: type: string minLength: 1 maxLength: 255 customer: type: string minLength: 1 maxLength: 50 readOnly: true timeZone: type: string email: type: string example: example@email.com address1: type: string maxLength: 50 example: 123 example st address2: type: string maxLength: 50 example: 456 example st city: type: string maxLength: 30 state: type: string enum: - AA - AE - AP - AL - AK - AS - AZ - AR - CA - CO - CNMI - CT - DE - DC - FM - FL - FSM - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MH - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY example: AA postalCode: type: string minLength: 5 maxLength: 10 example: '2342387987' phone: type: string maxLength: 10 minLength: 10 example: '6788763232' lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: name: Example Name customer: customer id: 32432432 timeZone: timeZone PracticeProcedureBaseV1: type: object properties: description: type: string maxLength: 255 abbreviatedDescription: type: string maxLength: 255 example: abbreviated description favorite: type: boolean example: false active: type: boolean example: true example: description: Example description for description abbreviatedDescription: abbreviated description PracticeProcedureUpdateV1: allOf: - $ref: '#/components/schemas/PracticeProcedureBaseV1' - type: object properties: category: type: string enum: - DIAGNOSTIC - PREVENTIVE - RESTORATIVE - ENDODONTICS - PERIODONTICS - PROSTHREMOV - MAXILLOPROSTH - IMPLANTSERV - PROSTHOFIXED - ORALSURGERY - ORTHODONTICS - ADJUNCTSERV - MULTICODES - PRODUCTS - SLEEPAPNEASERV treatmentArea: type: string description: if MULTICODES, codeType must be set to either Standard or Bridge. enum: - TOOTH - MOUTH - SURFACE - QUADRANT - ROOT - MULTICODES - ARCH - SEXTANT chartingSymbol: type: string enum: - CROWN_3_4_HATCHED - CROWN_3_4_OUTLINE - CROWN_3_4_SOLID - ABSCESS - APICOECTOMY - BRIDGE_HATCHED - BRIDGE_OUTLINE - BRIDGE_RETAINER_CROWN_HATCHED - BRIDGE_RETAINER_CROWN_OUTLINE - CROWN_HATCHED - CROWN_OUTLINE - CROWN_SOLID - DENTURE_HATCHED - DENTURE_OUTLINE - DENTURE_SOLID - DRIFTING_DISTAL - DRIFTING_MESIAL - EXTRACTION - FRACTURED_CHIPPED_TOOTH - HYPERSENSITIVITY - IMPLANT_BLADE - IMPLANT_CYLINDER - NON_FUNCTIONAL_TOOTH - PINS - POSTS - RECESSION - ROOT_CANAL - SEALANT - SURFACE_RESTORATION_DOTTED - SURFACE_RESTORATION_HATCHED - SURFACE_RESTORATION_SOLID - UNERUPTED - WATCH_TOOTH - BRIDGE_SOLID - BRIDGE_RETAINER_CROWN_SOLID - RETAINED_ROOT_OUTLINE - IMPACTED_TOOTH - LACK_OF_INTERPROXIMAL_TOOTH_CONTACT billToInsurance: type: boolean fee: type: number format: double needsPredetermination: type: boolean isClinicalNoteRequired: type: boolean example: {} PracticeProcedureUpdateStandardV1: allOf: - $ref: '#/components/schemas/PracticeProcedureBaseV1' - type: object properties: procedures: type: array description: used for MULTICODES case if codeType field is Standard items: type: object properties: practiceProcedure: type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true multiCodeType: type: string enum: - Standard - Bridge occlusalIncisal: type: boolean mesial: type: boolean buccalFacial: type: boolean distal: type: boolean lingual: type: boolean classFive: type: boolean example: {} PracticeProcedureUpdateBridgeV1: allOf: - $ref: '#/components/schemas/PracticeProcedureBaseV1' - type: object description: ponticProcedure and retainerProcedure are ONLY used for MULTICODES case if codeType field is Bridge properties: ponticProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true retainerProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} PracticeProcedureResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PracticeProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PracticeProcedureBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PracticeProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PracticeProcedureV1: allOf: - $ref: '#/components/schemas/PracticeProcedureUpdateV1' - $ref: '#/components/schemas/PracticeProcedureUpdateStandardV1' - $ref: '#/components/schemas/PracticeProcedureUpdateBridgeV1' - type: object required: - adaCode - abbreviatedDescription - description - category - treatmentArea properties: id: type: integer format: int64 example: 1250 readOnly: true adaCode: type: string maxLength: 10 example: ada code isTreatmentInfoRequired: type: boolean example: true codeExtension: type: string minLength: 1 maxLength: 5 example: strin codeVersion: type: integer minimum: 0 format: int16 example: 1 defaultTeethRange: type: string enum: - D5110 - D5120 - D5130 - D5140 - D5863 - D5865 - D5511 - D5512 - D6118 - D6119 - D0365 - D0366 - D0381 - D0382 example: D5110 codeType: type: string description: >- procedures field is required if Standard. both ponticProcedure and retainerProcedure fields are required if Bridge. enum: - Standard - Bridge example: Standard hasProsthesis: type: boolean example: true recareTemplate: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: {} PracticeProfileUpdateV1: type: object properties: version: type: integer format: int32 example: 0 bannerColor: type: string example: '173249' menuTextColor: type: string example: 8EB5D2 logoIcon: type: string example: tooth facebook: type: string example: mypractice twitter: type: string example: mypractice yelp: type: string example: my-practice-utah document: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true name: type: string example: Main Street Dental hours: type: string example: Mon-Fri 8am-5pm address: type: string example: 123 Main St, American Fork, UT 84003 phone: type: string example: '8015551234' directions: type: string example: Turn left at the light on Main Street. mapOptions: type: string example: zoom=14 descriptionText: type: string example: Family dentistry serving the community since 1990. example: version: 0 bannerColor: '173249' PracticeProfileV1: allOf: - $ref: '#/components/schemas/PracticeProfileUpdateV1' - type: object properties: id: readOnly: true type: integer format: int64 example: 9000000001 location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time example: 2019-09-09T19:00:00.000Z readOnly: true example: {} PracticeProfileResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PracticeProfileV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PracticeLogoV1: allOf: - $ref: '#/components/schemas/DocumentUpdateV1' - type: object description: Logo document for a location practice profile. required: - name - mimeType - file - ownerOrganization properties: thumbNailId: type: string maxLength: 100 example: thumbNailId Number readOnly: true mimeType: type: string enum: - PDF - JPEG - PNG - GIF - DOC - DOCX - PPT - PPTX - XLS - XLSX - MSG - HTML example: JPEG guidName: type: string example: name readOnly: true ownerType: type: string enum: - Organization - PerioExam - Patient example: Organization readOnly: true storage: readOnly: true type: object properties: thumbnail: type: string original: type: string resized: type: string cropped: type: string userDefinedDate: type: string format: date example: '2021-09-29' ownerOrganization: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true file: type: object writeOnly: true required: - content properties: content: type: string format: byte maxLength: 10485760 example: U29tZSBiYXNlNjQgY29udGVudCBoZXJl fromX: type: integer format: int32 example: 0 fromY: type: integer format: int32 example: 0 width: description: Must not exceed 400px. Defaults to 200px when omitted. type: integer format: int32 example: 200 height: description: Must not exceed 400px. Defaults to 200px when omitted. type: integer format: int32 example: 200 ratio: type: number format: float example: 1 example: {} PracticeLogoResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PracticeLogoV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientProcedureResponseWrapper: type: object properties: data: $ref: '#/components/schemas/PatientProcedure' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientProcedureBulkResponseWrapper: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientProcedure' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientProcedure: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - practiceProcedure - renderingProvider - amount - state - status - patient - location - billToInsurance properties: id: type: integer format: int64 example: 32432 amount: type: number format: float example: 100 entryDate: type: string format: date example: '2021-09-29' serviceDate: type: string format: date example: '2021-09-29' startDate: type: string format: date example: '2018-07-09' endDate: type: string format: date example: '2018-07-09' treatmentPlannedDate: type: string format: date example: '2018-07-09' entryDateTime: type: string format: date-time example: 2018-07-09T19:00:00.000Z serviceDateTime: type: string format: date-time example: 2018-07-09T19:00:00.000Z startDateTime: type: string format: date-time example: 2018-07-09T19:00:00.000Z endDateTime: type: string format: date-time example: 2018-07-09T19:00:00.000Z treatmentPlannedDateTime: type: string format: date-time example: 2018-07-09T19:00:00.000Z status: type: string enum: - COMPLETED - EXISTING - TREATMENT_PLAN example: COMPLETED oralCavity: type: string enum: - UPPER_LEFT - UPPER_RIGHT - LOWER_LEFT - LOWER_RIGHT - ARCH_MAXILLARY - ARCH_MANDI_BULAR - UPPER_LEFT_SEXTANT - UPPER_ANTERIOR_SEXTANT - UPPER_RIGHT_SEXTANT - LOWER_LEFT_SEXTANT - LOWER_ANTERIOR_SEXTANT - LOWER_RIGHT_SEXTANT example: UPPER_LEFT notes: type: string maxLength: 255 example: note state: type: string enum: - ACTIVE - CANCELLED - INVALIDATED example: ACTIVE primaryInsuranceEstimateOverride: type: number format: double example: 100 secondaryInsuranceEstimateOverride: type: number format: double example: 100 billToInsurance: type: boolean example: true expirationDate: type: string format: date-time example: 2018-07-09T19:00:00.000Z lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true voidReason: type: string enum: - MISTAKE - OTHER - ALLERGIC_REACTION - OTHER_REACTION - INEFFECTIVE - MISTAKE_NOT_PRESCRIBED example: OTHER voidNote: type: string maxLength: 500 example: note voidDate: type: string format: date example: 2018-08-09T00:00:00.000Z readOnly: true autoCalculateEstimateEnabled: type: boolean example: true procedureTeeth: type: array items: type: object properties: id: type: string example: abc123 procedureId: type: integer format: int64 example: 987654321 mesial: type: boolean example: true incisal: type: boolean example: false occlusal: type: boolean example: true distal: type: boolean example: false lingual: type: boolean example: true facial: type: boolean example: true buccal: type: boolean example: false classFive: type: boolean example: true toothId: type: string example: T123 incisalOcclusal: type: boolean example: false facialBuccal: type: boolean example: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true practiceProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true renderingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true treatmentPlannedProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true insuranceClaims: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patientConditions: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true perioExams: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true replacedBy: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true primaryInsurance: type: number format: float example: 100 writeOnly: true secondaryInsurance: type: number format: float example: 200 writeOnly: true writeOff: type: number format: float example: 500 writeOnly: true guarantorPortion: type: number format: float example: 200 writeOnly: true example: amount: 100 status: COMPLETED state: ACTIVE billToInsurance: true patient: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType practiceProcedure: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType renderingProvider: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 32432 entryDate: '2021-09-29' PatientProcedureCalc: type: object properties: id: type: integer format: int64 example: 854228 isEditable: type: boolean example: true appointmentToBeDeleted: type: number example: 0 example: id: 854228 isEditable: true PatientProcedureCalcBulkResponseWrapper: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientProcedureCalc' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProcedureMappingResponseWrapper: type: object properties: amount: type: number format: float practiceProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: amount: 1 practiceProcedure: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType ProcedureMapping: type: object required: - practiceProcedure - renderingProvider - patient - location properties: serviceDate: type: string format: date example: '2018-07-09' procedureTeeth: type: array items: type: object properties: id: type: string example: abc123 procedureId: type: integer format: int64 example: 987654321 mesial: type: boolean example: true incisal: type: boolean example: false occlusal: type: boolean example: true distal: type: boolean example: false lingual: type: boolean example: true facial: type: boolean example: true buccal: type: boolean example: false classFive: type: boolean example: true toothId: type: string example: T123 incisalOcclusal: type: boolean example: false facialBuccal: type: boolean example: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true updatedProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true practiceProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true renderingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: patient: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType practiceProcedure: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType renderingProvider: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType serviceDate: '2018-07-09' procedureTeeth: - id: abc123 procedureId: 987654321 PatientProcedureUpdateV1: type: object properties: amount: type: number format: float example: 123.56 entryDate: type: string format: date example: 2021-09-29T00:00:00.000Z serviceDate: type: string format: date example: 2021-09-29T00:00:00.000Z startDate: type: string format: date example: 2018-07-09T00:00:00.000Z endDate: type: string format: date example: 2018-07-09T00:00:00.000Z treatmentPlannedDate: type: string format: date example: 2018-07-09T00:00:00.000Z expirationDate: type: string format: date-time example: 2018-07-09T19:00:00.000Z status: type: string enum: - COMPLETED - EXISTING - TREATMENT_PLAN - IN_PROCESS - REFERRED example: COMPLETED oralCavity: type: string enum: - UPPER_LEFT - UPPER_RIGHT - LOWER_LEFT - LOWER_RIGHT - ARCH_MAXILLARY - ARCH_MANDI_BULAR - UPPER_LEFT_SEXTANT - UPPER_ANTERIOR_SEXTANT - UPPER_RIGHT_SEXTANT - LOWER_LEFT_SEXTANT - LOWER_ANTERIOR_SEXTANT - LOWER_RIGHT_SEXTANT example: UPPER_LEFT notes: type: string maxLength: 255 exclusiveMaximum: false example: string state: type: string enum: - ACTIVE - CANCELLED - INVALIDATED example: ACTIVE primaryInsuranceEstimateOverride: type: number format: double example: 1.23456 secondaryInsuranceEstimateOverride: type: number format: double example: 1.23456 billToInsurance: type: boolean example: true autoCalculateEstimateEnabled: type: boolean description: Required if status field is COMPLETED example: true monthsRemaining: type: number format: int16 example: 0 referredOut: type: boolean example: true procedureTeeth: type: array description: Required if treatmentArea of practiceProcedure is in [TOOTH, SURFACE, ROOT] items: type: object properties: id: type: string example: abc123 procedureId: type: integer format: int64 example: 987654321 mesial: type: boolean example: true incisal: type: boolean example: false occlusal: type: boolean example: true distal: type: boolean example: false lingual: type: boolean example: true facial: type: boolean example: true buccal: type: boolean example: false classFive: type: boolean example: true toothId: type: string example: T123 incisalOcclusal: type: boolean example: false facialBuccal: type: boolean example: true practiceProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true renderingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true treatmentPlannedProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true insuranceClaims: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patientConditions: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true perioExams: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true primaryInsurance: type: number format: float writeOnly: true example: 1.23 secondaryInsurance: type: number format: float writeOnly: true example: 1.23 writeOff: type: number format: float writeOnly: true example: 1.23 guarantorPortion: type: number format: float writeOnly: true example: 1.23 replacedBy: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: amount: 123.56 entryDate: '2021-09-29T00:00:00.000Z' PatientProcedureVoidV1: type: object required: - voidReason - voidNote - user properties: voidReason: type: string enum: - MISTAKE - OTHER - ALLERGIC_REACTION - OTHER_REACTION - INEFFECTIVE - MISTAKE_NOT_PRESCRIBED example: OTHER voidNote: type: string maxLength: 500 example: string voidDate: type: string format: date readOnly: true example: '2024-05-02' user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: voidReason: OTHER voidNote: string user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType voidDate: '2024-05-02' PatientProcedureV1: allOf: - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - practiceProcedure - renderingProvider - amount - state - status - patient - location - billToInsurance properties: id: type: integer format: int64 readOnly: true unlock: type: boolean readOnly: true example: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true amount: type: number format: float example: 123.56 entryDate: type: string format: date example: 2021-09-29T00:00:00.000Z serviceDate: type: string format: date example: 2021-09-29T00:00:00.000Z startDate: type: string format: date example: 2018-07-09T00:00:00.000Z endDate: type: string format: date example: 2018-07-09T00:00:00.000Z treatmentPlannedDate: type: string format: date example: 2018-07-09T00:00:00.000Z expirationDate: type: string format: date-time example: 2018-07-09T19:00:00.000Z status: type: string enum: - COMPLETED - EXISTING - TREATMENT_PLAN - IN_PROCESS - REFERRED example: COMPLETED oralCavity: type: string enum: - UPPER_LEFT - UPPER_RIGHT - LOWER_LEFT - LOWER_RIGHT - ARCH_MAXILLARY - ARCH_MANDI_BULAR - UPPER_LEFT_SEXTANT - UPPER_ANTERIOR_SEXTANT - UPPER_RIGHT_SEXTANT - LOWER_LEFT_SEXTANT - LOWER_ANTERIOR_SEXTANT - LOWER_RIGHT_SEXTANT example: UPPER_LEFT notes: type: string maxLength: 255 exclusiveMaximum: false example: string state: type: string enum: - ACTIVE - CANCELLED - INVALIDATED example: ACTIVE primaryInsuranceEstimateOverride: type: number format: double example: 1.23456 secondaryInsuranceEstimateOverride: type: number format: double example: 1.23456 billToInsurance: type: boolean example: true autoCalculateEstimateEnabled: type: boolean description: Required if status field is COMPLETED example: true monthsRemaining: type: number format: int16 example: 0 procedureTeeth: type: array description: Required if treatmentArea of practiceProcedure is in [TOOTH, SURFACE, ROOT] items: type: object properties: id: type: string example: abc123 procedureId: type: integer format: int64 example: 987654321 mesial: type: boolean example: true incisal: type: boolean example: false occlusal: type: boolean example: true distal: type: boolean example: false lingual: type: boolean example: true facial: type: boolean example: true buccal: type: boolean example: false classFive: type: boolean example: true toothId: type: string example: T123 incisalOcclusal: type: boolean example: false facialBuccal: type: boolean example: true practiceProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true renderingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true treatmentPlannedProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true insuranceClaims: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patientConditions: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true perioExams: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true txCase: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} PatientProcedureCreateV1: allOf: - $ref: '#/components/schemas/PatientProcedureUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - practiceProcedure - renderingProvider - amount - state - status - patient - location - billToInsurance properties: id: type: integer format: int64 readOnly: true unlock: type: boolean readOnly: true example: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} PatientProcedureGraphV1: type: object properties: id: type: integer format: int64 amount: type: number format: float example: 153.25 entryDate: type: string format: date example: 2021-09-29T00:00:00.000Z serviceDate: type: string format: date example: 2021-09-29T00:00:00.000Z entryDateTime: type: string format: date-time example: 2018-07-09T19:00:00.000Z serviceDateTime: type: string format: date-time example: 2018-07-09T19:00:00.000Z status: type: string enum: - COMPLETED - EXISTING - TREATMENT_PLAN example: COMPLETED state: type: string enum: - ACTIVE - CANCELLED - INVALIDATED example: ACTIVE billToInsurance: type: boolean example: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true procedureTeeth: type: array items: type: object properties: tooth: type: integer description: toothIndex example: 0 toothId: type: integer description: global tooth ID universalCode: type: string example: string surfaces: description: Can be empty or null if treatmentArea is not SURFACE type: string example: string practiceProcedure: type: object properties: id: type: integer format: int64 adaCode: type: string example: string description: type: string example: string abbreviatedDescription: type: string example: string category: type: string enum: - DIAGNOSTIC - PREVENTIVE - RESTORATIVE - ENDODONTICS - PERIODONTICS - PROSTHREMOV - MAXILLOPROSTH - IMPLANTSERV - PROSTHOFIXED - ORALSURGERY - ORTHODONTICS - ADJUNCTSERV - MULTICODES - PRODUCTS - SLEEPAPNEASERV example: DIAGNOSTIC treatmentArea: type: string enum: - TOOTH - MOUTH - SURFACE - QUADRANT - ROOT - MULTICODES - ARCH - SEXTANT example: TOOTH provider: type: object properties: id: type: integer format: int64 npi: type: string example: string firstName: type: string example: string lastName: type: string example: string specialty: type: string enum: - DENTALPUBLICHEALTH - DENTALSPECIALTY - DENTIST - DENTAL - ENDODONTICS - FEDERALLYQUALIFIEDHEALTHCENTER - GENERALPRACTICE - HYGIENIST - MULTISPECIALTY - ORTHODONTICS - ORALMAXILLOFACIALPATHOLOGY - ORALMAXILLOFACIALRADIOLOGY - ORALMAXILLOFACIALSURGERY - PEDIATRICDENTISTRY - PERIODONTICS - PROSTHODONTICS - SINGLESPECIALTY example: DENTALPUBLICHEALTH patient: type: object properties: id: type: integer format: int64 firstName: type: string example: string lastName: type: string example: string location: type: object properties: id: type: integer format: int64 name: type: string example: string txCase: type: object properties: id: type: integer format: int64 name: type: string example: string note: type: string example: string status: type: string enum: - NEW - PRESENTED - ACCEPTED - REJECTED example: ACCEPTED example: id: 12445 amount: 153.25 PatientProcedureGraphResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientProcedureGraphV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body VoidPatientProcedureResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientProcedureVoidV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientProcedureResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: '9000003725942' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientProcedureBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: '9000003725942' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientProcedureGraphBulkResponseV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientProcedureGraphV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientProcedureCalcV1: type: object properties: id: type: integer format: int64 isEditable: type: boolean example: true appointmentToBeDeleted: type: number example: 0 example: id: 12445 isEditable: true PatientProcedureCalcResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientProcedureCalcV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientProcedureCalcBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientProcedureCalcV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProcedureMappingResponseWrapperV1: type: object properties: amount: type: number format: float practiceProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: amount: 1 practiceProcedure: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType ProcedureMappingV1: type: object required: - practiceProcedure - renderingProvider - patient - location properties: serviceDate: type: string format: date example: '2018-07-09' procedureTeeth: type: array items: type: object properties: id: type: string example: abc123 procedureId: type: integer format: int64 example: 987654321 mesial: type: boolean example: true incisal: type: boolean example: false occlusal: type: boolean example: true distal: type: boolean example: false lingual: type: boolean example: true facial: type: boolean example: true buccal: type: boolean example: false classFive: type: boolean example: true toothId: type: string example: T123 incisalOcclusal: type: boolean example: false facialBuccal: type: boolean example: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true updatedProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true practiceProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true renderingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: patient: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType practiceProcedure: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType renderingProvider: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType serviceDate: '2018-07-09' procedureTeeth: - id: abc123 procedureId: 987654321 PatientProcedureApptV1: type: object properties: visit: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true appointment: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: visit: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType appointment: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType PatientProcedureApptResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientProcedureApptV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientProcedureV2: allOf: - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - practiceProcedure - renderingProvider - amount - state - status - patient - location - billToInsurance properties: id: type: integer format: int64 readOnly: true placeOfTreatment: type: string readOnly: true example: string unlock: type: boolean readOnly: true example: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true amount: type: number format: float example: 123.56 entryDate: type: string format: date example: 2021-09-29T00:00:00.000Z serviceDate: type: string format: date example: 2021-09-29T00:00:00.000Z startDate: type: string format: date example: 2018-07-09T00:00:00.000Z endDate: type: string format: date example: 2018-07-09T00:00:00.000Z treatmentPlannedDate: type: string format: date example: 2018-07-09T00:00:00.000Z expirationDate: type: string format: date-time example: 2018-07-09T19:00:00.000Z status: type: string enum: - COMPLETED - EXISTING - TREATMENT_PLAN example: COMPLETED oralCavity: type: string enum: - UPPER_LEFT - UPPER_RIGHT - LOWER_LEFT - LOWER_RIGHT - ARCH_MAXILLARY - ARCH_MANDI_BULAR - UPPER_LEFT_SEXTANT - UPPER_ANTERIOR_SEXTANT - UPPER_RIGHT_SEXTANT - LOWER_LEFT_SEXTANT - LOWER_ANTERIOR_SEXTANT - LOWER_RIGHT_SEXTANT example: UPPER_LEFT notes: type: string maxLength: 255 exclusiveMaximum: false example: string state: type: string enum: - ACTIVE - CANCELLED - INVALIDATED example: ACTIVE primaryInsuranceEstimateOverride: type: number format: double example: 1.23456 secondaryInsuranceEstimateOverride: type: number format: double example: 1.23456 billToInsurance: type: boolean example: true autoCalculateEstimateEnabled: type: boolean description: Required if status field is COMPLETED example: true monthsRemaining: type: number format: int16 example: 0 procedureTeeth: type: array description: Required if treatmentArea of practiceProcedure is in [TOOTH, SURFACE, ROOT] items: type: object properties: id: type: string example: abc123 procedureId: type: integer format: int64 example: 987654321 mesial: type: boolean example: true incisal: type: boolean example: false occlusal: type: boolean example: true distal: type: boolean example: false lingual: type: boolean example: true facial: type: boolean example: true buccal: type: boolean example: false classFive: type: boolean example: true toothId: type: string example: T123 incisalOcclusal: type: boolean example: false facialBuccal: type: boolean example: true practiceProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true renderingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true treatmentPlannedProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true insuranceClaims: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patientConditions: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true perioExams: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true version: type: integer format: int32 example: 0 placementType: type: string enum: - INITIAL - REPLACEMENT - NOT_APPLICABLE example: INITAIL appliancePlacementDate: type: string format: date example: 2024-05-02T00:00:00.000Z isReplacement: type: boolean example: true replacementDate: type: string format: date example: 2024-05-02T00:00:00.000Z priorPlacementDateKnown: type: boolean example: true accidentType: type: string enum: - OCCUPATIONAL - AUTOMOTIVE - OTHER example: OCCUPATIONAL accidentDate: type: string format: date example: 2024-05-02T00:00:00.000Z accidentState: type: string example: string reasonForReplacement: type: string example: string priorPlacementDate: type: string format: date example: 2024-05-02T00:00:00.000Z orderedDate: type: string format: date example: 2024-05-02T00:00:00.000Z forceSave: type: boolean example: true doNotDisplayWarning: type: boolean example: true example: {} PatientProcedureBulkResponseWrapperV2: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientProcedureV2' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TxCaseResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/TxCaseV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: '9000000035908' type: TxCaseV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TxCaseBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/TxCaseV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: '9000000035908' type: TxCaseV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TxCaseUpdateV1: type: object properties: name: type: string minLength: 1 maxLength: 50 status: type: string enum: - NEW - PRESENTED - ACCEPTED - REJECTED example: NEW note: type: string maxLength: 250 expirationDate: type: string format: date example: 2024-05-10T00:00:00.000Z showExpirationDate: type: boolean example: true showNote: type: boolean example: true providerSignature: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true witnessSignature: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true providerSignatureDate: type: string format: date example: 2024-05-10T00:00:00.000Z witnessSignatureDate: type: string format: date example: 2024-05-10T00:00:00.000Z example: name: Example Name status: NEW TxCaseCreateV1: allOf: - $ref: '#/components/schemas/TxCaseUpdateV1' - type: object required: - user - name - patient - procedures properties: user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true procedures: type: array description: > These procedures will be added to the automatically created Visit after creation of TxCase and won't be returned back as a part of TxCase items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} TxCaseV1: allOf: - $ref: '#/components/schemas/TxCaseUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide properties: id: readOnly: true type: integer format: int64 example: 324324 lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: {} TxCaseCalcV1: type: object properties: id: type: integer format: int64 example: 324324 isCompleted: type: boolean example: true example: id: 324324 isCompleted: true TxCaseCalcResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/TxCaseCalcV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TxCaseCalcBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/TxCaseCalcV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TxCaseAmountV1: type: object properties: caseAmount: type: number format: double example: 10000 discount: type: number format: double example: 7500 guarantorPortion: type: number format: double example: 2500 visits: type: array items: type: object properties: visitId: type: integer format: int64 example: 32432432 code: type: string Th: type: string surface: type: string description: type: string provider: type: string amount: type: number format: double example: 1000 discount: type: number format: double example: 500 guarantorPortion: type: number format: double example: 500 example: caseAmount: 10000 discount: 7500 TxCaseAmountResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/TxCaseAmountV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body VisitResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/VisitV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: '9000000038237' type: VisitV1 lastModified: '2024-01-12T15:58:19.443Z' sequence: 0 duration: 60 visitProceduresOrderType: TEETH descProceduresOrder: false txCase: id: '9000000035908' type: TxCaseV1 procedures: - id: '9000003725942' type: PatientProcedureV1 - id: '9000003725946' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body VisitBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/VisitV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: '9000000038237' type: VisitV1 lastModified: '2024-01-12T15:58:19.443Z' sequence: 0 duration: 60 visitProceduresOrderType: TEETH descProceduresOrder: false txCase: id: '9000000035908' type: TxCaseV1 procedures: - id: '9000003725942' type: PatientProcedureV1 - id: '9000003725946' type: PatientProcedureV1 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body VisitUpdateV1: type: object properties: duration: type: integer format: int32 minimum: 0 maximum: 240 example: 240 sequence: type: integer format: int32 example: 0 visitProceduresOrderType: type: string enum: - TEETH - CREATED - CODE - SURFACES - DESCRIPTION - PROVIDER - AMOUNT - CUSTOM example: TEETH descProceduresOrder: type: boolean example: true procedures: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: duration: 240 sequence: 0 VisitV1: allOf: - $ref: '#/components/schemas/VisitUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - txCase - procedures - visitProceduresOrderType - descProceduresOrder properties: id: type: integer format: int64 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true txCase: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} EventResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/EventV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body EventV1: allOf: - $ref: '#/components/schemas/EventUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - start - location - title properties: id: type: integer format: int64 example: 32424423 readOnly: true duration: description: This is a field that returns the duration of the appointment in minutes. type: integer example: 30 lastModified: type: string format: date-time example: '2018-07-09T19:00:00.000Z' readOnly: true groupId: type: string maxLength: 50 readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true operatory: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true color: type: string pattern: ^[0-9A-Fa-f]{6}$ maxLength: 6 example: FF5733 description: 'Hexadecimal color code (6 characters, without # prefix)' example: {} EventUpdateV1: type: object properties: title: type: string maxLength: 60 description: type: string example: This is a detailed description of the event. start: type: string format: date-time example: '2018-07-09T19:00:00.000Z' end: type: string format: date-time example: '2018-07-09T20:00:00.000Z' allDay: type: boolean example: true recurrenceType: type: string enum: - WEEKLY - MONTHLY example: WEEKLY recurrenceStart: type: string format: date example: '2018-07-09' recurrenceEnd: type: string format: date example: '2018-07-09' recurrenceFrequency: type: integer minimum: 1 example: 1 recurrenceDays: type: array items: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY example: - MONDAY - WEDNESDAY - FRIDAY recurrenceWeek: type: string enum: - FIRST - SECOND - THIRD - FOURTH - LAST example: FIRST recurrenceDay: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY example: MONDAY color: type: string pattern: ^[0-9A-Fa-f]{6}$ maxLength: 6 example: FF5733 description: 'Hexadecimal color code (6 characters, without # prefix)' example: title: Example Title description: This is a detailed description of the event. EventBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/EventV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransactionResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/TransactionFullV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransactionBaseV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide properties: id: type: integer format: int64 readOnly: true type: type: string example: Transaction readOnly: true amount: type: number format: double example: 100 distributions: allOf: - $ref: '#/components/schemas/TransactionDistributionsBaseV1' note: type: string maxLength: 255 example: string transactionDate: type: string format: date example: 2018-07-09T00:00:00.000Z entryDate: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true modifiedDate: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true isAutomaticallyPosted: type: boolean readOnly: true example: true isActive: type: boolean readOnly: true example: true previousTransaction: allOf: - type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true replacedByTransaction: allOf: - type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: id: 12445 type: Transaction TransactionFullV1: allOf: - $ref: '#/components/schemas/TransactionBaseV1' - type: object properties: transactionDateTime: type: string format: date-time example: '2018-07-09 19:00:00.000' readOnly: true ledgerType: type: string enum: - PatientChargeAdjustment - InsuranceRefundAdjustment - PatientCreditCardRefund - PatientCreditCardVoid - PatientProcedureLedger - InsurancePayment - PatientCreditAdjustment - PatientProcedurePayment example: PatientChargeAdjustment readOnly: true ownership: type: string enum: - PATIENT - GUARANTOR example: PATIENT isPartialPayment: type: boolean example: true readOnly: true metBasic: type: number format: double example: 1000 metPreventive: type: number format: double example: 1000 metMajor: type: number format: double example: 1000 metOrtho: type: number format: double example: 1000 patientPaymentBilling: allOf: - $ref: '#/components/schemas/TransactionPatientPaymentBillingV1' transactionTags: type: object properties: (orderIndex): type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true reasonTags: type: object properties: (orderIndex): type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true organizationLedgerType: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patientProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true onlineUser: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true insuranceClaim: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true insurancePayment: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true ledgerEstimation: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} TransactionBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/TransactionFullV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransactionPatientPaymentResWrapperV1: type: object properties: data: $ref: '#/components/schemas/TransactionPatientPaymentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransactionPatientPaymentV1: allOf: - $ref: '#/components/schemas/TransactionPatientPaymentUpdateV1' - type: object required: - ownership - patient - location - transactionDate - amount - organizationLedgerType - paidAtVisit properties: patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true organizationLedgerType: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} TransactionPatientPaymentUpdateV1: allOf: - $ref: '#/components/schemas/TransactionBaseV1' - type: object properties: ledgerType: type: string enum: - PatientProcedurePayment - PatientProcedurePaymentRebill - PatientProcedurePaymentCancellation example: PatientProcedurePayment readOnly: true ownership: type: string enum: - PATIENT - GUARANTOR example: PATIENT paidAtVisit: type: boolean example: true patientPaymentBilling: allOf: - $ref: '#/components/schemas/TransactionPatientPaymentBillingV1' transactionTags: type: object properties: (orderIndex): type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true reasonTags: type: object properties: (orderIndex): type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} TransactionPatientPaymentBulkResWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/TransactionPatientPaymentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransactionDistributionsBaseV1: type: array items: description: '''chargeId'' and ''appliedAmount'' are only required if the distributions array is present in the request' type: object required: - chargeId - appliedAmount properties: chargeId: type: string example: string chargeLocationId: type: string example: string appliedAmount: type: number format: double example: 150 isActive: type: boolean readOnly: true example: true example: - chargeId: string appliedAmount: 150 chargeLocationId: string isActive: true TransactionPatientPaymentBillingV1: type: object properties: type: type: string example: PatientPaymentBilling readOnly: true checkNumber: type: string maxLength: 20 example: check number bankNumber: type: string maxLength: 20 example: bank number referenceNumber: type: string maxLength: 20 example: reference number example: type: PatientPaymentBilling checkNumber: check number TransactionInsurancePaymentResWrapperV1: type: object properties: data: $ref: '#/components/schemas/TransactionInsurancePaymentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransactionInsurancePaymentV1: allOf: - $ref: '#/components/schemas/TransactionInsurancePaymentUpdateV1' - type: object required: - patient - location - transactionDate - amount - organizationLedgerType - insuranceClaim - isPartialPayment - metBasic - metPreventive - metMajor - metOrtho - distributions properties: distributions: allOf: - $ref: '#/components/schemas/TransactionDistributionsBaseV1' - type: array items: type: object properties: allowedAmount: type: number format: double writeOnly: true example: 50 adjustment: type: number format: double writeOnly: true example: 25 insuranceEstimate: type: number format: double writeOnly: true example: 75 insuranceAdjustment: type: object properties: adjustmentVariant: type: string enum: - NONE - CHARGE - CREDIT example: CREDIT organizationLedgerTypeId: type: number format: int64 adjustmentAmount: type: number format: double example: 50 writeOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true organizationLedgerType: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true insuranceClaim: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true bulkInsurancePayment: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} TransactionInsurancePaymentUpdateV1: allOf: - $ref: '#/components/schemas/TransactionBaseV1' - type: object properties: ledgerType: type: string enum: - InsurancePayment - InsurancePaymentRebill - InsurancePaymentCancellation readOnly: true example: InsurancePayment ownership: type: string enum: - PATIENT readOnly: true example: PATIENT metBasic: type: number format: double example: 100 metPreventive: type: number format: double example: 100 metMajor: type: number format: double example: 100 metOrtho: type: number format: double example: 100 distributions: allOf: - $ref: '#/components/schemas/TransactionDistributionsBaseV1' - type: array items: type: object properties: adjustment: type: number format: double writeOnly: true example: 100 patientPaymentBilling: allOf: - $ref: '#/components/schemas/TransactionPatientPaymentBillingV1' transactionTags: type: object properties: (orderIndex): type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true reasonTags: type: object properties: (orderIndex): type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true isPartialPayment: type: boolean example: {} TransactionInsurPaymentBulkResWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/TransactionInsurancePaymentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransactionProcedureResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/TransactionProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransactionProcedureV1: allOf: - $ref: '#/components/schemas/TransactionBaseV1' - type: object properties: ownership: type: string enum: - PATIENT example: PATIENT readOnly: true ledgerType: type: string example: PatientProcedureLedger readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true organizationLedgerType: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patientProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true ledgerEstimation: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} TransactionProcedureBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/TransactionProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransactionAdjustmentResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/TransactionAdjustmentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransactionAdjustmentV1: allOf: - $ref: '#/components/schemas/TransactionAdjustmentUpdateV1' - type: object required: - ownership - patient - location - transactionDate - amount - organizationLedgerType - ledgerType properties: patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true organizationLedgerType: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} TransactionAdjustmentUpdateV1: allOf: - $ref: '#/components/schemas/TransactionBaseV1' - type: object properties: ledgerType: type: string enum: - PatientChargeAdjustment - PatientCreditAdjustment readOnly: true example: PatientChargeAdjustment ownership: type: string enum: - PATIENT - GUARANTOR example: PATIENT transactionTags: type: object properties: (orderIndex): type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true reasonTags: type: object properties: (orderIndex): type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patientProcedure: allOf: - type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true - type: object readOnly: true insuranceClaim: allOf: - type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true - type: object readOnly: true insurancePayment: allOf: - type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true - type: object readOnly: true patientPaymentTransaction: allOf: - type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true - type: object readOnly: true example: {} TransactionAdjustmentBulkResWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/TransactionAdjustmentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TotalCountV1: type: object properties: TotalCountV1: type: number example: TotalCountV1: 10 TotalCountResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/TotalCountV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body GlobalProcedureV1: type: object properties: id: type: integer format: int64 example: 324242 adaCode: type: string maxLength: 10 description: type: string maxLength: 255 abbreviatedDescription: type: string maxLength: 255 example: abbreviated description category: type: string enum: - DIAGNOSTIC - PREVENTIVE - RESTORATIVE - ENDODONTICS - PERIODONTICS - PROSTHREMOV - MAXILLOPROSTH - IMPLANTSERV - PROSTHOFIXED - ORALSURGERY - ORTHODONTICS - ADJUNCTSERV - MULTICODES - PRODUCTS - SLEEPAPNEASERV example: PREVENTIVE treatmentArea: type: string enum: - TOOTH - MOUTH - SURFACE - QUADRANT - ROOT - MULTICODES - ARCH example: TOOTH codeExtension: type: string example: code extension hasProthesis: type: boolean example: true example: id: 324242 adaCode: ERR101 GlobalProcedureResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/GlobalProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body GlobalProcedureBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/GlobalProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body GlobalInsuranceCarrierResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/GlobalInsuranceCarrierV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body GlobalInsuranceCarrierV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide properties: id: type: integer format: int64 example: 8797768 name: type: string payorId: type: string example: '2344' url: type: string example: example.com address1: type: string example: 123 example st address2: type: string example: 456 example st city: type: string state: type: string postalCode: type: string example: '21323' phonePrimary: type: string example: '1236540987' phonePrimaryExt: type: string example: '3248764343' phoneFax: type: string example: '1349872323' neaPayorId: type: string example: '432' acceptElectronicAttachments: type: boolean example: true acceptEligibilities: type: boolean example: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: id: 8797768 name: Example Name GlobalInsuranceCarrierBulkResponWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/GlobalInsuranceCarrierV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body InsuranceCarrierResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/InsuranceCarrierV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body InsuranceCarrierV1: allOf: - $ref: '#/components/schemas/InsuranceCarrierUpdateV1' - type: object properties: id: type: integer format: int64 example: 324325 readOnly: true globalInsuranceCarrier: type: object description: A reference to a linked model. Includes the id, the type and url at which the model can be accessed. properties: id: type: integer format: int64 description: Required when creating a new insurance carrier based on a Global Insurance Carrier example: 324325 type: type: string url: type: string format: uri example: example.com lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: {} InsuranceCarrierUpdateV1: properties: name: type: string minLength: 1 maxLength: 127 description: Required when creating a new insurance carrier not based on a Global Insurance Carrier phonePrimary: type: string maxLength: 10 example: 1233214545 phonePrimaryExt: type: string maxLength: 10 example: 4566543232 phoneFax: type: string maxLength: 10 example: 9877896565 url: type: string maxLength: 255 example: example.com payorId: type: string maxLength: 30 example: '233' acceptElectronicAttachments: type: boolean example: true acceptEligibilities: type: boolean example: true adaReportType: type: string enum: - ADA2012 - ADA2019 example: ADA2012 example: name: Example Name phonePrimary: 1233214545 InsuranceCarrierBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/InsuranceCarrierV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AuditV1: type: object properties: id: type: integer format: int64 date: type: string format: date-time example: 2024-05-09T12:00:00.000Z description: type: string additionalInfo: type: string example: additional info auditType: type: string enum: - USER_ROLES - REPORT - PATIENT - LEDGER - RECARE - CONDITION - PERIO_EXAM - PRESCRIPTION - APPOINTMENT - INSURANCE_CLAIM - USER_ACCOUNT - TX_PLAN_CASE - CLINICAL_NOTE - MEDICAL_ALERTS - LOCATION_INFORMATION - IMAGING - ORGANIZATION_INFORMATION - MISSED_APPOINTMENT - SETTINGS - PATIENT_NOTE example: PATIENT action: type: string enum: - UPDATE - DELETE - CREATE - REVIEW - PRINT - VOID - OVERRIDE example: UPDATE location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true onlineUser: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: id: 12445 date: '2024-05-09T12:00:00.000Z' AuditBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/AuditV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body LocationHourV1: allOf: - $ref: '#/components/schemas/LocationHourUpdateV1' - type: object required: - startTime - endTime - location properties: id: type: integer format: int64 example: 108756 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} LocationHourUpdateV1: type: object properties: startTime: type: string format: time example: '13:00' endTime: type: string format: time example: '15:00' days: type: array items: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY default: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY example: - MONDAY - WEDNESDAY - FRIDAY description: >- If the days array isn't present or is empty it will default to ['MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY']. example: startTime: '13:00' endTime: '15:00' LocationHourBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/LocationHourV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body LocationHourResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/LocationHourV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body MissedAppointmentResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/MissedAppointmentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body MissedAppointmentBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/MissedAppointmentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body MissedAppointmentV1: allOf: - $ref: '#/components/schemas/MissedAppointmentUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - start - duration - status - patient - provider - location - operatory properties: id: type: integer format: int64 example: 108756 readOnly: true start: type: string format: date-time example: 2018-07-09T19:00:00.000Z duration: type: integer format: int32 example: 60 status: type: string enum: - NO_SHOW - BROKEN example: NO_SHOW other: type: string procedures: type: string rescheduledOn: type: string format: date-time readOnly: true example: 2018-08-09T19:00:00.000Z note: type: string readOnly: true appointment: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true operatory: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} MissedAppointmentUpdateV1: type: object properties: cancelledOn: type: string format: date-time example: 2018-07-09T19:00:00.000Z reasonCancelled: type: string maxLength: 200 example: reason cancelled status: type: string description: | Missed-appointment status. If supplied on PUT, it is applied when valid. Values match MissedAppointmentV1. enum: - NO_SHOW - BROKEN example: BROKEN example: cancelledOn: '2018-07-09T19:00:00.000Z' reasonCancelled: reason cancelled AgingBalanceResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/AgingBalanceV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AgingBalanceV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide properties: current: type: number format: double description: 0-30 days balance currentInsurancePortion: type: number format: double description: 0-30 days Insurance Portion balance example: 100 currentPatientPortion: type: number format: double description: 0-30 days Patient Portion balance example: 25 currentWriteOff: type: number format: double description: 0-30 days Write Off balance example: 125 thirtyDays: type: number format: double description: 31-60 days balance example: 125 thirtyDaysInsurancePortion: type: number format: double description: 31-60 days Insurance Portion balance example: 100 thirtyDaysPatientPortion: type: number format: double description: 31-60 days Patient Portion balance example: 25 thirtyDaysWriteOff: type: number format: double description: 31-60 days Write Off balance example: 125 sixtyDays: type: number format: double description: 61-90 days balance example: 25 sixtyDaysInsurancePortion: type: number format: double description: 61-90 days Insurance Portion balance example: 100 sixtyDaysPatientPortion: type: number format: double description: 61-90 days Patient Portion balance example: 25 sixtyDaysWriteOff: type: number format: double description: 61-90 days Write Off balance example: 125 ninetyDays: type: number format: double description: 90+ days balance example: 125 ninetyDaysInsurancePortion: type: number format: double description: 90+ days Insurance Portion balance example: 100 ninetyDaysPatientPortion: type: number format: double description: 90+ days Patient Portion balance example: 25 ninetyDaysWriteOff: type: number format: double description: 90+ days Write Off balance example: 125 insurancePortion: type: number format: double description: Total insurance portion of the balance example: 100 writeOffAdjustments: type: number format: double description: Total adjustments written off example: 50 suspendedCredits: type: number format: double description: Credits suspended in the account example: 0 pleasePayAmount: type: number format: double description: Amount the patient is requested to pay example: 25 closeablePaymentPlanState: type: boolean description: Indicates if the payment plan can be closed example: true hasCoverageGap: type: boolean description: Indicates if there is a gap in coverage example: true balance: type: number format: double description: Total current balance example: 125 patientPortion: type: number format: double description: Total patient portion of the balance example: 25 example: current: 1 currentInsurancePortion: 100 AgingBalanceRptResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/AgingBalanceReportV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AgingBalanceReportV1: type: object properties: currentAmount: type: number format: double description: 0-30 days balance example: 215 currentPortion: type: object description: Current balance broken into portions properties: guarantorPortion: type: number format: double example: 25 insurancePortion: type: number format: double example: 190 writeOff: type: number format: double example: 215 thirtyDaysAmount: type: number format: double description: 31-60 days balance example: 215 thirtyDaysPortion: type: object description: Thirty days balance broken into portions properties: guarantorPortion: type: number format: double example: 25 insurancePortion: type: number format: double example: 190 writeOff: type: number format: double example: 215 sixtyDaysAmount: type: number format: double description: 61-90 days balance example: 215 sixtyDaysPortion: type: object description: Sixty days balance broken into portions properties: guarantorPortion: type: number format: double example: 25 insurancePortion: type: number format: double example: 190 writeOff: type: number format: double example: 215 ninetyDaysAmount: type: number format: double description: 90+ days balance example: 215 ninetyDaysPortion: type: object description: Ninety days balance broken into portions properties: guarantorPortion: type: number format: double example: 25 insurancePortion: type: number format: double example: 190 writeOff: type: number format: double example: 215 total: type: number format: double description: Aging total example: 215 totalPortions: type: object description: Total balance broken into portions properties: guarantorPortion: type: number format: double example: 25 insurancePortion: type: number format: double example: 190 writeOff: type: number format: double example: 215 unappliedCreditsAmount: type: number format: double description: Amount of credits not yet applied example: 0 balance: type: number format: double description: Total and unapplied credit combined example: 215 patientReports: type: array items: $ref: '#/components/schemas/AgingReceivableV1' example: currentAmount: 215 currentPortion: guarantorPortion: 25 insurancePortion: 190 AgingReceivableV1: type: object properties: firstName: type: string example: John middleInitial: type: string example: M lastName: type: string example: Doe id: type: integer format: int64 example: 2134 current: type: number format: double description: 0-30 days balance example: 125 currentPortion: type: object description: Breakdown of the current balance into portions properties: guarantorPortion: type: number format: double example: 25 insurancePortion: type: number format: double example: 190 writeOff: type: number format: double example: 215 thirtyDays: type: number format: double description: 31-60 days balance example: 215 thirtyDaysPortion: type: object description: Breakdown of the thirty days balance into portions properties: guarantorPortion: type: number format: double example: 25 insurancePortion: type: number format: double example: 190 writeOff: type: number format: double example: 215 sixtyDays: type: number format: double description: 61-90 days balance example: 215 sixtyDaysPortion: type: object description: Breakdown of the sixty days balance into portions properties: guarantorPortion: type: number format: double example: 25 insurancePortion: type: number format: double example: 190 writeOff: type: number format: double example: 215 ninetyDays: type: number format: double description: 90+ days balance example: 215 ninetyDaysPortion: type: object description: Breakdown of the ninety days balance into portions properties: guarantorPortion: type: number format: double example: 25 insurancePortion: type: number format: double example: 190 writeOff: type: number format: double example: 215 balance: type: number format: double example: 215 guarantorPortionBalance: type: number format: double example: 25 insurancePortionBalance: type: number format: double example: 190 writeOffBalance: type: number format: double example: 215 unAppliedCredits: type: number format: double example: 0 claimsPending: type: number format: double example: 1 example: firstName: John middleInitial: M PatientRecareResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientRecareV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientRecareBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientRecareV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientRecareUpdateV1: type: object properties: dueDate: type: string format: date example: 2024-05-02T00:00:00.000Z intervalUnit: type: string enum: - WEEK - MONTH - YEAR example: WEEK interval: type: integer format: int64 minimum: 1 maximum: 99 example: 99 note: type: string example: string example: dueDate: '2024-05-02T00:00:00.000Z' intervalUnit: WEEK PatientRecareV1: allOf: - $ref: '#/components/schemas/PatientRecareUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - dueDate - patient - recareTemplate - intervalUnit - interval - location properties: id: type: integer format: int64 readOnly: true serviceDate: type: string format: date example: 2024-05-02T00:00:00.000Z postedDate: type: string format: date example: 2024-05-02T00:00:00.000Z lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true status: type: string enum: - ADDED - WRONG - UPDATED readOnly: true example: UPDATED note: type: string example: string scheduledAppointment: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true recareTemplate: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true practiceProcedures: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} PatientRecareCreateWrapperV1: type: object required: - dueDate - patient - recareTemplate - status - intervalUnit - interval - location properties: id: type: integer format: int64 dueDate: type: string format: date example: '2024-05-02' serviceDate: type: string format: date example: '2024-05-02' postedDate: type: string format: date example: '2024-05-02' lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true status: type: string enum: - ADDED - WRONG - UPDATED example: UPDATED intervalUnit: type: string enum: - WEEK - MONTH - YEAR example: WEEK interval: type: integer format: int64 minimum: 1 maximum: 99 example: 99 scheduledAppointment: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true recareTemplate: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: dueDate: '2024-05-02' status: UPDATED intervalUnit: WEEK interval: 99 patient: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType recareTemplate: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 12445 serviceDate: '2024-05-02' PatientReportRowV1: type: object description: One row in the internal patients report (SQL-backed). properties: preferredLocationName: type: string nullable: true firstName: type: string lastName: type: string address1: type: string nullable: true address2: type: string nullable: true city: type: string nullable: true state: type: string nullable: true postalCode: type: string nullable: true phoneNumbers: type: string nullable: true description: Phone numbers as returned by the report query (format may vary). emailAddress: type: string nullable: true dateOfBirth: type: string format: date nullable: true description: Date only (YYYY-MM-DD). gender: type: string nullable: true patientStatus: type: string chartNumber: type: string nullable: true firstVisitDate: type: string format: date nullable: true description: Date only (YYYY-MM-DD). lastVisit: type: string format: date-time nullable: true nextVisit: type: string format: date-time nullable: true billingType: type: string nullable: true isOrthodontiaPatient: type: boolean raceNames: type: string nullable: true ethnicityNames: type: string nullable: true example: preferredLocationName: Example Name firstName: Example Name PatientsReportResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientReportRowV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object description: Present on successful JSON responses. Includes pagination for the list endpoint. properties: pagination: type: object properties: limit: type: integer description: Page size (capped at 500). offset: type: integer description: Zero-based row offset, computed as (page - 1) * pageSize. example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientStatementResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientStatementV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientStatementBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientStatementV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientStatementV1: type: object properties: id: type: integer format: int64 readOnly: true example: 108706 totalBalance: type: number format: double example: 1000 patientPortion: type: number format: double example: 200 pleasePay: type: number format: double example: 200 generatedDate: type: string format: date-time example: 2018-07-09T19:00:00.000Z statementType: type: string enum: - GUARANTOR - PATIENT example: PATIENT deliveryMethod: type: string enum: - PRINT - ELECTRONIC - PRINT_ELECTRONIC - THIRD_PARTY - MAIL_FOR_ME example: ELECTRONIC patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true document: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time readOnly: true example: 2018-07-09T19:00:00.000Z example: id: 108706 totalBalance: 1000 RecareTemplateResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/RecareTemplateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body RecareTemplateBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/RecareTemplateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body RecareTemplateUpdateV1: type: object properties: recareType: type: string minLength: 1 maxLength: 12 example: recare type description: type: string maxLength: 30 isPrimary: type: boolean example: true intervalUnit: type: string enum: - WEEK - MONTH - YEAR example: WEEK interval: type: integer format: int64 minimum: 1 maximum: 99 example: 99 practiceProcedures: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: recareType: recare type description: Example description for description RecareTemplateV1: allOf: - $ref: '#/components/schemas/RecareTemplateUpdateV1' - type: object required: - intervalUnit - interval - recareType - isPrimary properties: id: type: integer format: int64 example: 32324 readOnly: true isDefault: type: boolean example: true readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: {} PatientNoteResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientNoteV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientNoteBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientNoteV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientNoteUpdateV1: type: object properties: text: type: string minLength: 1 maxLength: 5000 noteDate: type: string format: date example: 2024-05-10T00:00:00.000Z example: text: text noteDate: '2024-05-10T00:00:00.000Z' PatientNoteV1: allOf: - $ref: '#/components/schemas/PatientNoteUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - noteDate - text - patient properties: id: type: integer format: int64 example: 71307 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time readOnly: true example: 2018-07-09T19:00:00.000Z example: {} TransactionTagV1: allOf: - $ref: '#/components/schemas/TransactionTagUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - tagText - isPredefined - tagType properties: id: type: integer format: int64 example: 32432423 readOnly: true example: {} TransactionTagUpdateV1: type: object properties: tagText: type: string minLength: 1 maxLength: 30 example: tag text isPredefined: type: boolean example: true tagType: type: string enum: - PAYMENT_TAG - ADJUSTMENT_TAG example: PAYMENT_TAG example: tagText: tag text isPredefined: true TransactionTagResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/TransactionTagV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransactionTagBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/TransactionTagV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body MedicalAlertUpdateV1: type: object properties: description: type: string minLength: 1 maxLength: 60 visible: type: boolean example: true active: type: boolean example: true effectiveDate: type: string format: date example: 2024-05-10T00:00:00.000Z permanentCondition: type: boolean example: true snomedCode: type: string minLength: 1 maxLength: 10 example: SNOMEDCode category: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: description: Example description for description visible: true MedicalAlertV1: allOf: - $ref: '#/components/schemas/MedicalAlertUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - description - active - permanentCondition properties: id: type: integer format: int64 example: 6960404 readOnly: true lastModified: type: string format: date-time readOnly: true example: 2018-07-09T19:00:00.000Z example: {} MedicalAlertBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/MedicalAlertV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body MedicalAlertResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/MedicalAlertV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body MedicalAlertCategoryV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - description - isCustom - active properties: id: type: integer format: int64 example: 234324 description: type: string minLength: 1 maxLength: 60 isCustom: type: boolean example: true active: type: boolean example: true effectiveDate: type: string format: date example: 2024-05-10T00:00:00.000Z lastModified: type: string format: date-time readOnly: true example: 2024-05-09T13:30:00.000Z example: description: Example description for description isCustom: true active: true id: 234324 effectiveDate: '2024-05-10T00:00:00.000Z' MedicalAlertCategoryResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/MedicalAlertCategoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body MedicalAlertCategoryBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/MedicalAlertCategoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body MedicalAlertReactionV1: type: object properties: id: type: integer format: int64 example: 324234 name: type: string minLength: 1 maxLength: 25 description: type: string minLength: 1 maxLength: 25 SNOMEDCode: type: string maxLength: 10 lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: id: 324234 name: Example Name MedicalAlertReactionResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/MedicalAlertReactionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body MedicalAlertReactionBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/MedicalAlertReactionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body MedicalAlertSeverityV1: type: object properties: id: type: integer format: int64 example: 324324 name: type: string minLength: 1 maxLength: 25 description: type: string minLength: 1 maxLength: 25 SNOMEDCode: type: string maxLength: 10 lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: id: 324324 name: Example Name MedicalAlertSeverityResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/MedicalAlertSeverityV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body MedicalAlertSeverityBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/MedicalAlertSeverityV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientMedicalAlertUpdateV1: type: object properties: visible: type: boolean example: true effectiveDate: type: string format: date example: 2024-05-10T00:00:00.000Z readOnly: true expiredDate: type: string format: date example: 2024-05-10T00:00:00.000Z permanentCondition: type: boolean example: true note: type: string reactionSeverities: type: array items: type: object properties: medicalAlertReaction: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true medicalAlertSeverity: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: visible: true effectiveDate: '2024-05-10T00:00:00.000Z' PatientMedicalAlertV1: allOf: - $ref: '#/components/schemas/PatientMedicalAlertUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - effectiveDate - medicalAlert - patient - permanentCondition properties: id: type: integer format: int64 example: 34324234 readOnly: true medicalAlert: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time readOnly: true example: 2018-07-09T19:00:00.000Z example: {} PatientMedicalAlertBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientMedicalAlertV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientMedicalAlertResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientMedicalAlertV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ToothV1: type: object properties: id: type: string example: 108756 dentalAnatomy: type: string example: dental anatomy toothType: type: string enum: - PERMANENT - PRIMARY - SUPERNUMERARY_PERMANENT - SUPERNUMERARY_PRIMARY example: PRIMARY toothIndex: type: integer format: int32 example: 2 isMixed: type: string example: ismixed universalCode: type: string example: universal code fdiCode: type: string example: fdi code palmerCode: type: string example: palmer code example: id: 108756 dentalAnatomy: dental anatomy TeethBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ToothV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientToothV1: type: object properties: toothId: type: string example: '16' readOnly: true toothIndex: type: integer format: int32 minimum: 1 maximum: 32 example: 32 toothType: type: string enum: - PERMANENT - PRIMARY - SUPERNUMERARY_PERMANENT - SUPERNUMERARY_PRIMARY example: PRIMARY visible: type: boolean example: true readOnly: true chartings: type: array readOnly: true items: type: object properties: symbol: type: string surface: type: string color: type: array items: type: number example: 2 lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: toothId: '16' toothIndex: 32 PatientTeethWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientToothV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientConditionUpdateV1: type: object properties: status: type: string enum: - ACTIVE - TREATED example: ACTIVE state: type: string enum: - ACTIVE - CANCELLED - INVALIDATED example: CANCELLED note: type: string minLength: 0 maxLength: 255 serviceDate: type: string format: date example: '2021-09-29' chartedDate: type: string format: date example: '2021-09-29' oralCavityType: type: string enum: - UL - UR - LL - LR - UA - LA example: UL conditionTooth: type: object required: - toothId properties: toothId: type: string example: '16' mesial: type: boolean example: true incisal: type: boolean example: true occlusal: type: boolean example: true distal: type: boolean example: true facial: type: boolean example: true buccal: type: boolean example: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true chartedProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true organizationCondition: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: status: ACTIVE state: CANCELLED PatientConditionV1: allOf: - $ref: '#/components/schemas/PatientConditionUpdateV1' - type: object required: - status - state - patient - provider - organizationCondition properties: id: type: integer format: int64 example: 108756 readOnly: true lastModified: type: string format: date-time example: 2019-09-09T19:00:00.000Z readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} PatientConditionBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientConditionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientConditionResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientConditionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientPrescriptionV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - dispense - drug - drugCategoryName - drugUnit - sig - patient - provider - consumingType - custom - refills - controlledSubstance properties: id: type: integer format: int64 example: 32432 readOnly: true datePrescribed: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true drugCategoryName: type: string minLength: 1 maxLength: 50 example: name drug: type: string minLength: 1 maxLength: 70 sig: type: string minLength: 1 maxLength: 150 refills: type: number minimum: 0 maximum: 99 example: 99 dispense: type: string minLength: 0 maxLength: 999999 example: '999999' note: type: string maxLength: 1000 drugUnit: type: string minLength: 1 maxLength: 20 example: 500 mg consumingType: type: string enum: - DISPENSE_AS_WRITTEN - GENERIC_SUBSTITUTION_PERMITTED example: DISPENSE_AS_WRITTEN custom: type: boolean example: true controlledSubstance: type: boolean example: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true voidStatus: type: object required: - user - voidReason properties: user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true dateVoided: type: string format: date example: 2024-05-10T00:00:00.000Z readOnly: true voidReason: type: string enum: - MISTAKE - OTHER - ALLERGIC_REACTION - OTHER_REACTION - INEFFECTIVE - MISTAKE_NOT_PRESCRIBED example: OTHER note: type: string maxLength: 250 lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: drugCategoryName: name drug: drug sig: sig refills: 99 dispense: '999999' drugUnit: 500 mg consumingType: DISPENSE_AS_WRITTEN custom: true controlledSubstance: true provider: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType patient: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 32432 datePrescribed: '2018-07-09T19:00:00.000Z' PatientPrescriptionBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientPrescriptionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientPrescriptionResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientPrescriptionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientPrescriptionUpdateWrapperV1: type: object required: - voidStatus properties: id: type: integer format: int64 voidStatus: type: object required: - user - voidReason properties: user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true dateVoided: type: string format: date example: 2024-05-10T00:00:00.000Z readOnly: true voidReason: type: string enum: - MISTAKE - OTHER - ALLERGIC_REACTION - OTHER_REACTION - INEFFECTIVE - MISTAKE_NOT_PRESCRIBED example: OTHER note: type: string maxLength: 250 example: voidStatus: user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType voidReason: OTHER dateVoided: '2024-05-10T00:00:00.000Z' note: note id: 12445 PrescriptionDrugCategoryUpdateV1: type: object properties: name: type: string minLength: 1 maxLength: 50 example: name: Example Name PrescriptionDrugCategoryV1: allOf: - $ref: '#/components/schemas/PrescriptionDrugCategoryUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - name properties: id: type: integer format: int64 example: 108756 readOnly: true lastModified: type: string format: date-time readOnly: true example: 2018-07-09T20:30:00.000Z example: {} DrugCategoryBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PrescriptionDrugCategoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PrescriptionDrugCategoryResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PrescriptionDrugCategoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PrescriptionDrugUnitV1: type: object required: - name properties: id: type: integer format: int64 example: 324 name: type: string minLength: 1 maxLength: 20 lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: name: Example Name id: 324 lastModified: '2018-07-09T19:00:00.000Z' PrescriptionDrugUnitBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PrescriptionDrugUnitV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PrescriptionDrugUnitResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PrescriptionDrugUnitV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PrescriptionTemplateUpdateV1: type: object properties: drug: type: string minLength: 1 maxLength: 70 sig: type: string minLength: 1 maxLength: 150 refills: type: number minimum: 0 maximum: 99 example: 99 dispense: type: number format: double minimum: 0 maximum: 999999.99 example: 999999.99 note: type: string maxLength: 1000 drugUnit: type: string minLength: 1 maxLength: 20 example: 250 mg consumingType: type: string enum: - DISPENSE_AS_WRITTEN - GENERIC_SUBSTITUTION_PERMITTED example: DISPENSE_AS_WRITTEN controlledSubstance: type: boolean example: true drugCategory: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: drug: drug sig: sig PrescriptionTemplateV1: allOf: - $ref: '#/components/schemas/PrescriptionTemplateUpdateV1' - type: object required: - dispense - drug - drugCategory - drugUnit - sig - consumingType - refills - controlledSubstance properties: id: type: integer format: int64 example: 23424 readOnly: true lastModified: type: string format: date-time readOnly: true example: 2018-07-09T20:30:00.000Z example: {} PrescriptionTemplateBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PrescriptionTemplateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PrescriptionTemplateResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PrescriptionTemplateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body SubscriberInsurancePlanV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - releaseOfInformation - assignmentOfBenefits - carrierInsurancePlan - planSubscriberId - patient properties: id: type: integer format: int64 readOnly: true releaseOfInformation: type: boolean example: true assignmentOfBenefits: type: boolean example: true planSubscriberId: type: string maxLength: 50 example: string previous_benefitYear: type: integer format: int16 example: 2024 previous_basicFamilyAnnualDeductibleMet: type: number format: double example: 1500 previous_preventiveFamilyAnnualDeductibleMet: type: number format: double example: 1500 previous_majorFamilyAnnualDeductibleMet: type: number format: double example: 1500 previous_maximumFamilyAnnualBenefitUsed: type: number format: double example: 1500 current_benefitYear: type: integer format: int16 example: 2024 current_basicFamilyAnnualDeductibleMet: type: number format: double example: 1500 current_preventiveFamilyAnnualDeductibleMet: type: number format: double example: 1500 current_majorFamilyAnnualDeductibleMet: type: number format: double example: 1500 current_maximumFamilyAnnualBenefitUsed: type: number format: double example: 1500 carrierInsurancePlan: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: releaseOfInformation: true assignmentOfBenefits: true planSubscriberId: string carrierInsurancePlan: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType patient: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 12445 previous_benefitYear: 2024 SubscriberInsurancePlanBulkResWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriberInsurancePlanV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body SubscriberInsurancePlanResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/SubscriberInsurancePlanV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CarrierInsurancePlanV1: allOf: - $ref: '#/components/schemas/CarrierInsurancePlanUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - planName - planType - renewalMonth - sourceOfPayment - insuranceCarrier - address1 - city - postalCode - state properties: id: type: integer format: int64 example: 34532 readOnly: true lastModified: type: string format: date-time example: '2018-07-09T19:00:00.000Z' readOnly: true insuranceCarrier: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true carrierPlanDeductible: type: object readOnly: true description: A reference to a linked model. Includes the id, the type and url at which the model can be accessed. properties: id: type: integer format: int64 example: 2134 type: type: string url: type: string format: uri example: example.com/resource example: {} CarrierInsurancePlanUpdateV1: type: object properties: planName: type: string maxLength: 50 renewalMonth: type: string enum: - January - February - March - April - May - June - July - August - September - October - November - December example: January sourceOfPayment: type: string enum: - BLUE_CROSS_BLUE_SHIELD - CHAMPUS - COMMERCIAL - MEDICARE_B - MEDICAID example: BLUE_CROSS_BLUE_SHIELD contactName: type: string maxLength: 127 example: name contactEmail: type: string maxLength: 60 example: email groupNumber: type: string maxLength: 30 example: group number phone: type: string maxLength: 10 example: 6353459876 phoneExt: type: string maxLength: 10 example: 1234567890 planType: type: string enum: - DENTAL - MEDICAL example: DENTAL faxNumber: type: string maxLength: 10 example: 987654321 planNote: type: string maxLength: 5000 example: notes address1: type: string maxLength: 50 example: 123 example st address2: type: string maxLength: 50 example: 456 example st city: type: string maxLength: 30 postalCode: type: string minLength: 5 maxLength: 10 example: '67865' state: type: string enum: - AA - AE - AP - AL - AK - AS - AZ - AR - CA - CO - CNMI - CT - DE - DC - FM - FL - FSM - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MH - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY example: AA locationPlans: type: object properties: (locationId): type: object properties: ppoFeeSchedule: type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: planName: Example Name renewalMonth: January CarrierInsurancePlanBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/CarrierInsurancePlanV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CarrierInsurancePlanResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/CarrierInsurancePlanV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CarrierInsurPlanCoordinationOfBenefitsV1: type: object properties: id: type: integer format: int64 example: 3244246 blue_cross_blue_shield: type: string enum: - TRADITIONAL - MAINTENANCE_OF_BENEFITS - CARVE_OUT example: TRADITIONAL champus: type: string enum: - TRADITIONAL - MAINTENANCE_OF_BENEFITS - CARVE_OUT example: TRADITIONAL commercial: type: string enum: - TRADITIONAL - MAINTENANCE_OF_BENEFITS - CARVE_OUT example: MAINTENANCE_OF_BENEFITS medicare_b: type: string enum: - TRADITIONAL - MAINTENANCE_OF_BENEFITS - CARVE_OUT example: CRAVE_OUT medicaid: type: string enum: - TRADITIONAL - MAINTENANCE_OF_BENEFITS - CARVE_OUT example: CRAVE_OUT commercial_ppo: type: string enum: - TRADITIONAL - MAINTENANCE_OF_BENEFITS - CARVE_OUT example: MAINTENCE_OF_BENFITS commercial_dhmo: type: string enum: - TRADITIONAL - MAINTENANCE_OF_BENEFITS - CARVE_OUT example: MAINTENANCE_OF_BENEFITS carrierInsurancePlan: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: id: 3244246 blue_cross_blue_shield: TRADITIONAL CarrierInsurPlanCoordOfBenefBulkResWrapV1: type: object properties: data: type: array items: $ref: '#/components/schemas/CarrierInsurPlanCoordinationOfBenefitsV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CarrierInsurPlanCoordOfBenefResWrapperV1: type: object properties: data: $ref: '#/components/schemas/CarrierInsurPlanCoordinationOfBenefitsV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientInsurancePlanV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide properties: id: type: integer format: int64 example: 32432432 startDate: type: string format: date example: '2024-05-10' endDate: type: string format: date example: '2024-05-11' relationshipToSubscriber: type: string enum: - SELF - SPOUSE - CHILD - OTHER example: SELF eligible: type: string maxLength: 10 example: 'Yes' confirmedDate: type: string format: date example: '2024-05-10' note: type: string maxLength: 1000 example: This is a detailed note about the eligibility status. eligibilityCheckType: type: string enum: - MANUAL - AUTOMATIC example: AUTOMATIC responsibilities: type: array items: type: object properties: startDate: type: string format: date example: '2024-05-10' endDate: type: string format: date example: '2024-05-11' paymentResponsibilityOrder: type: integer format: int16 example: 1 previous_benefitYear: type: integer format: int16 example: 2023 previous_basicIndividualLifetimeDeductibleMet: type: number format: double example: 1500 current_benefitYear: type: integer format: int16 example: 2024 current_basicIndividualLifetimeDeductibleMet: type: number format: double example: 200 subscriberInsurancePlan: type: object properties: id: type: string example: '1' type: type: string example: ModelExampleV1 url: type: string example: example.com/resource example: id: 32432432 startDate: '2024-05-10' PatientInsurancePlanUpdateV1: allOf: - $ref: '#/components/schemas/PatientInsurancePlanUpdateV1' type: object properties: startDate: type: string format: date example: '2024-05-10' endDate: type: string format: date example: '2024-05-11' relationshipToSubscriber: type: string enum: - SELF - SPOUSE - CHILD - OTHER example: SELF eligible: type: string maxLength: 10 confirmedDate: type: string format: date example: '2024-05-10' note: type: string maxLength: 1000 eligibilityCheckType: type: string enum: - MANUAL - AUTOMATIC example: AUTOMATIC responsibilities: type: array items: type: object properties: startDate: type: string format: date example: '2024-05-10' endDate: type: string format: date example: '2024-05-11' paymentResponsibilityOrder: type: integer format: int16 example: 50 benefitDetails: type: object properties: previous: type: object properties: benefitYear: type: integer format: int16 example: 2023 basicIndividualLifetimeDeductibleMet: type: number format: double example: 1500 basicIndividualAnnualDeductibleMet: type: number format: double example: 1500 preventiveIndividualLifetimeDeductibleMet: type: number format: double example: 1500 preventiveIndividualAnnualDeductibleMet: type: number format: double example: 1500 majorIndividualLifetimeDeductibleMet: type: number format: double example: 1500 majorIndividualAnnualDeductibleMet: type: number format: double example: 1500 orthoIndividualLifetimeDeductibleMet: type: number format: double example: 1500 orthoIndividualAnnualDeductibleMet: type: number format: double example: 1500 maximumIndividualAnnualBenefitUsed: type: number format: double example: 1500 maximumOrthoLifetimeBenefitUsed: type: number format: double example: 1500 current: type: object properties: benefitYear: type: integer format: int16 example: 2024 basicIndividualLifetimeDeductibleMet: type: number format: double example: 1500 basicIndividualAnnualDeductibleMet: type: number format: double example: 1500 preventiveIndividualLifetimeDeductibleMet: type: number format: double example: 1500 preventiveIndividualAnnualDeductibleMet: type: number format: double example: 1500 majorIndividualLifetimeDeductibleMet: type: number format: double example: 1500 majorIndividualAnnualDeductibleMet: type: number format: double example: 1500 orthoIndividualLifetimeDeductibleMet: type: number format: double example: 1500 orthoIndividualAnnualDeductibleMet: type: number format: double example: 1500 maximumIndividualAnnualBenefitUsed: type: number format: double example: 1500 maximumOrthoLifetimeBenefitUsed: type: number format: double example: 1500 example: {} PatientInsurancePlanBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientInsurancePlanV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientInsurancePlanResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientInsurancePlanV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OrganizationConditionUpdateV1: type: object properties: favorite: type: boolean example: true isActive: type: boolean example: true description: type: string minLength: 1 example: favorite: true isActive: true OrganizationBillingTypeUpdate: type: object properties: name: type: string maxLength: 50 example: New Billing Type isDefault: type: boolean example: true position: type: integer example: 1 example: name: New Billing Type isDefault: true OrganizationBillingType: allOf: - $ref: '#/components/schemas/OrganizationBillingTypeUpdate' - type: object properties: id: readOnly: true type: integer format: int64 example: 9000000001 type: type: string example: OrganizationBillingTypeV1 readOnly: true lastModified: type: string format: date-time example: 2019-09-09T19:00:00.000Z readOnly: true example: {} OrgBillingTypeBulkResponseWrapper: type: object properties: data: type: array items: $ref: '#/components/schemas/OrganizationBillingType' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OrganizationBillingTypeResponseWrapper: type: object properties: data: $ref: '#/components/schemas/OrganizationBillingType' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OrganizationConditionV1: allOf: - $ref: '#/components/schemas/OrganizationConditionUpdateV1' - type: object properties: id: readOnly: true type: integer format: int64 example: 108756 lastModified: type: string format: date-time example: 2019-09-09T19:00:00.000Z readOnly: true condition: type: object readOnly: true properties: id: type: integer format: int64 example: 4535 snomedCode: type: string maxLength: 20 example: SNOMEDCode snodent: type: object properties: id: type: integer format: int64 example: 116386 readOnly: true code: type: string description: type: string abbreviatedDescription: type: string maxLength: 50 example: abbreviated description treatmentArea: type: string enum: - TOOTH - MOUTH - SURFACE - QUADRANT - ROOT - MULTICODES - ARCH - RANGE example: MOUTH favorite: type: boolean example: true icd10: type: object properties: id: type: integer format: int64 example: 108756 readOnly: true code: type: string description: type: string restriction: type: object properties: id: type: integer format: int32 example: 2845 maxSelectedSurfacesCount: type: integer format: int32 example: 50 mesial: type: boolean example: true incisal: type: boolean example: true occlusal: type: boolean example: true distal: type: boolean example: true lingual: type: boolean example: true facial: type: boolean example: true buccal: type: boolean example: true example: {} OrgConditionBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/OrganizationConditionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OrganizationConditionResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/OrganizationConditionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body GlobalProcedureMappingRuleV1: type: object properties: id: type: integer format: int64 example: 23424 adaCodeSource: type: string minLength: 1 maxLength: 255 adaCodeTarget: type: string maxLength: 255 mappingFlag: type: string enum: - SURFACE_ONE - SURFACE_TWO - SURFACE_THREE - SURFACE_FOUR - TOOTH_ANTERIOR - TOOTH_BICUSPID - TOOTH_MOLAR - DENTITION_PRIMARY - DENTITION_PERMANENT - POSITION_ANTERIOR - POSITION_POSTERIOR - ARCH_MAXILLARY - ARCH_MANDI_BULAR - PRIMARY - ADDITIONAL - SURFACE_FIVE - SURFACE_OCCLUSAL - INCISAL_ANGLE example: SURFACE_TWO example: id: 23424 adaCodeSource: ERR101 GlobalProcMappingRuleBulkResWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/GlobalProcedureMappingRuleV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body GlobalProcMappingRuleResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/GlobalProcedureMappingRuleV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProcedureCategoryV1: type: object properties: id: type: integer format: int64 example: 32432 description: type: string maxLength: 50 name: type: string maxLength: 50 sequence: type: integer format: int32 example: 123456 example: id: 32432 description: Example description for description ProcedureCategoryBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ProcedureCategoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body DocumentResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/DocumentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body DocumentBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/DocumentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body DocumentUpdateV1: type: object properties: id: type: integer format: int64 example: 1234 readOnly: true name: type: string minLength: 1 maxLength: 100 tags: type: array items: type: string example: items example: id: 1234 name: Example Name DocumentV1: allOf: - $ref: '#/components/schemas/DocumentUpdateV1' - type: object required: - name - mimeType - file properties: thumbNailId: type: string maxLength: 100 example: thumbNailId Number readOnly: true mimeType: type: string enum: - PDF - JPEG - PNG - GIF - DOC - DOCX - PPT - PPTX - XLS - XLSX - MSG - HTML example: PDF guidName: type: string example: name readOnly: true ownerType: type: string enum: - Organization - PerioExam - Patient example: Organization readOnly: true storage: readOnly: true type: object properties: thumbnail: type: string original: type: string resized: type: string cropped: type: string userDefinedDate: type: string format: date example: '2021-09-29' ownerPatient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true ownerPerioExam: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true ownerOrganization: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true file: type: object writeOnly: true required: - content properties: content: type: string format: byte maxLength: 10485760 example: U29tZSBiYXNlNjQgY29udGVudCBoZXJl fromX: description: If mimeType in [JPEG, PNG, GIF] then field is required type: integer format: int32 example: 2048 fromY: description: If mimeType in [JPEG, PNG, GIF] then field is required type: integer format: int32 example: 2048 width: description: If mimeType in [JPEG, PNG, GIF] then field is required type: integer format: int32 example: 2048 height: description: If mimeType in [JPEG, PNG, GIF] then field is required type: integer format: int32 example: 2048 ratio: type: number format: float description: If mimeType in [JPEG, PNG, GIF] then field is required example: 2048 example: {} DocumentResponseUpdateWrapperV1: type: object properties: data: $ref: '#/components/schemas/DocumentUpdateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body DocumentTagBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/DocumentTagV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body DocumentTagV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - name properties: id: type: integer format: int64 example: 9087823 name: type: string minLength: 1 maxLength: 50 isDefault: type: boolean example: true readOnly: true lastModified: type: string format: date-time readOnly: true example: 2024-05-09T13:30:00.000Z example: name: Example Name id: 9087823 isDefault: true ClinicalNoteResponseWrapper: type: object properties: data: $ref: '#/components/schemas/ClinicalNote' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClinicalNoteBulkResponseWrapper: type: object properties: data: type: array items: $ref: '#/components/schemas/ClinicalNote' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClinicalNoteUpdate: type: object properties: datedAs: type: string format: date example: 2024-05-10T00:00:00.000Z signedDate: type: string format: date example: 2024-05-10T00:00:00.000Z signedAdditionalDate: type: string format: date example: 2024-05-10T00:00:00.000Z text: type: string minLength: 1 assignedTeeth: type: array items: type: object properties: toothId: type: string example: '16' isToothGrown: type: boolean example: true draftTemplateOptions: type: object properties: clinicalNoteTemplate: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true promptOptions: type: array items: type: object properties: clinicalNotePrompt: type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true choice: type: string example: string addendums: type: array items: type: object required: - text - provider properties: id: type: integer format: int64 readOnly: true example: '32423432' text: type: string minLength: 1 posted: type: string format: date-time example: 2024-05-09T12:00:00.000Z readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true additionalProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true primarySignature: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true additionalSignature: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: datedAs: '2024-05-10T00:00:00.000Z' signedDate: '2024-05-10T00:00:00.000Z' ClinicalNote: allOf: - $ref: '#/components/schemas/ClinicalNoteUpdate' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - datedAs - text - patient - provider properties: id: type: integer format: int64 example: '3242424' readOnly: true lastModified: type: string format: date-time example: 2019-09-09T19:00:00.000Z readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} ClinicalNoteResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ClinicalNoteV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: datedAs: '2019-07-18' text: Tester provider note patient: id: 1000000020701 provider: id: 1000000002089 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClinicalNoteBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ClinicalNoteV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - datedAs: '2019-07-18' text: Tester provider note patient: id: 1000000020701 provider: id: 1000000002089 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClinicalNoteV1: allOf: - $ref: '#/components/schemas/ClinicalNoteUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - datedAs - text - patient - provider properties: id: type: integer format: int64 example: 657575 readOnly: true lastModified: type: string format: date-time example: 2019-09-09T19:00:00.000Z readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} ClinicalNoteUpdateV1: type: object properties: datedAs: type: string format: date example: 2020-04-09T00:00:00.000Z signedDate: type: string format: date example: 2020-04-09T00:00:00.000Z signedAdditionalDate: type: string format: date example: 2020-04-09T00:00:00.000Z text: type: string minLength: 1 assignedTeeth: type: array items: type: object properties: toothId: type: string example: '2' isToothGrown: type: boolean example: true draftTemplateOptions: type: object properties: clinicalNoteTemplate: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true promptOptions: type: array items: type: object properties: clinicalNotePrompt: type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true choice: type: string example: string addendums: type: array items: type: object required: - text - provider properties: id: type: integer format: int64 example: 3324234 readOnly: true text: type: string minLength: 1 posted: type: string format: date-time readOnly: true example: 2020-04-09T19:00:00.000Z provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true additionalProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true primarySignature: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true additionalSignature: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: datedAs: '2020-04-09T00:00:00.000Z' signedDate: '2020-04-09T00:00:00.000Z' UserResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/UserV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body UserBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/UserV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body UserUpdateV1: type: object properties: email: type: string format: email maxLength: 60 example: example@email.com firstName: type: string minLength: 1 maxLength: 25 example: first middleInitial: type: string maxLength: 1 example: m lastName: type: string minLength: 1 maxLength: 50 example: last phone1: type: string minLength: 10 maxLength: 10 example: '3248765643' phone2: type: string minLength: 10 maxLength: 10 example: '2345675434' username: type: string minLength: 1 maxLength: 60 timeout: type: integer enum: - 10 - 30 - 60 - 120 - 240 - 480 example: 120 example: email: example@email.com firstName: first UserV1: allOf: - $ref: '#/components/schemas/UserUpdateV1' - type: object required: - username - email - firstName - lastName - phone1 - timeout - roles - currentLocation properties: id: type: string example: '324324' readOnly: true username: type: string minLength: 1 maxLength: 60 enabled: type: boolean example: true isProvider: type: boolean example: true readOnly: true roles: type: array items: type: object properties: role: type: string location: type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true currentLocation: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time readOnly: true example: 2018-07-09T19:00:00.000Z example: {} UserFavoriteResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ClinicalNoteTemplateUserFavoriteV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body UserFavoriteBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ClinicalNoteTemplateUserFavoriteV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClinicalNoteTemplateUserFavoriteV1: type: object required: - user - clinicalNoteTemplate properties: user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true clinicalNoteTemplate: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType clinicalNoteTemplate: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType OrganizationLedgerTypeV1: type: object properties: id: type: integer format: int64 example: 56435 description: type: string maxLength: 255 ledgerType: type: string enum: - PROCEDURE - CHARGE_ADJUSTMENT - CREDIT_ADJUSTMENT - PAYMENT - INSURANCE_PAYMENT - INSURANCE_CLAIM example: PROCEDURE constantDescription: type: string enum: - UNDEFINED - OFFSETTING_ADJUSTMENT - WRITEOFF_ADJUSTMENT - CREDIT_CARD_REFUND - CREDIT_CARD_PAYMENT - CREDIT_CARD_VOID - INSURANCE_CHECK_PAYMENT - INSURANCE_ELECTRONIC_PAYMENT - INSURANCE_CREDIT_CARD_PAYMENT - CHECK_PAYMENT - CASH_PAYMENT - DISCOUNT - INSURANCE_ADJUSTMENT - PATIENT_FINANCING_PAYMENT - ELECTRONIC_TRANSFER_PAYMENT example: DISCOUNT active: type: boolean example: true allocation: type: string enum: - COLLECTION - PRODUCTION example: COLLECTION isTagRestrictionEnabled: type: boolean example: true isTagCreationEnabled: type: boolean example: true optionalTags: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true mandatoryTags: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: 0 lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: id: 56435 description: Example description for description OrganizationLedgerTypeResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/OrganizationLedgerTypeV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: 9000000000001 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OrganizationLedgerTypeBulkRespWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/OrganizationLedgerTypeV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: 9000000000001 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CoverageProcedureRangeV1: allOf: - $ref: '#/components/schemas/CoverageProcedureRangeUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - rangeStart - rangeEnd - category - coveragePercentage - deductibleType properties: id: type: integer format: int64 example: 32490 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true carrierInsurancePlan: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} CoverageProcedureRangeUpdateV1: type: object properties: rangeStart: type: string minLength: 1 maxLength: 10 example: string rangeStartExtension: type: string maxLength: 5 example: string rangeEnd: type: string minLength: 1 maxLength: 10 example: string rangeEndExtension: type: string maxLength: 5 example: string category: type: string minLength: 1 maxLength: 255 example: string coveragePercentage: type: number format: double example: 40 deductibleType: type: string enum: - NONE - BASIC - PREVENTIVE - MAJOR - ORTHODONTIC example: BASIC example: rangeStart: string rangeStartExtension: string CoverageProcedureRangeResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/CoverageProcedureRangeV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CoverageProcedureRangeBulkRespWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/CoverageProcedureRangeV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CoverageProcedureRangeTemplateV1: type: object required: - rangeStart - rangeEnd - category - deductibleType properties: id: type: integer format: int64 example: 768990 rangeStart: type: string minLength: 5 maxLength: 15 example: string rangeEnd: type: string minLength: 5 maxLength: 15 example: string category: type: string minLength: 1 maxLength: 60 example: string coveragePercentage: type: number format: double example: 40 deductibleType: type: string enum: - NONE - BASIC - PREVENTIVE - MAJOR - ORTHODONTIC example: NONE example: rangeStart: string rangeEnd: string category: string deductibleType: NONE id: 768990 coveragePercentage: 40 CoverageProcedRangeTemplateRespWrapperV1: type: object properties: data: $ref: '#/components/schemas/CoverageProcedureRangeTemplateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CoverageProcedRangeTemplBulkRespWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/CoverageProcedureRangeTemplateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CoverageProcedureCopayV1: allOf: - $ref: '#/components/schemas/CoverageProcedureCopayUpdateV1' - type: object required: - practiceProcedure - copay - deductibleType - carrierInsurancePlan properties: id: type: integer format: int64 example: 376576 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true carrierInsurancePlan: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true practiceProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} CoverageProcedureCopayUpdateV1: type: object properties: copay: type: number format: double maxLength: 10 maximum: 9999999.99 minimum: 0 example: 9999999.99 deductibleType: type: string enum: - NONE - BASIC - PREVENTIVE - MAJOR - ORTHODONTIC example: BASIC example: copay: 9999999.99 deductibleType: BASIC CoverageProcedureCopayResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/CoverageProcedureCopayV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CoverageProcedureCopayBulkRespWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/CoverageProcedureCopayV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CarrierPlanDeductibleV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - coverageType - noDuplicationOfBenefitsClause properties: id: type: integer format: int64 coverageType: type: string enum: - PERCENTAGE - COPAY example: PERCENTAGE noDuplicationOfBenefitsClause: type: boolean example: true previous_benefitYear: type: integer format: int16 example: 2023 previous_basicIndividualLifetimeDeductible: type: number format: double example: 1000 previous_basicIndividualAnnualDeductible: type: number format: double example: 2000 previous_basicFamilyAnnualDeductible: type: number format: double example: 1000 previous_preventiveIndividualLifetimeDeductible: type: number format: double example: 2500 previous_preventiveIndividualAnnualDeductible: type: number format: double example: 2500 previous_preventiveFamilyAnnualDeductible: type: number format: double example: 2500 previous_majorIndividualLifetimeDeductible: type: number format: double example: 2500 previous_majorIndividualAnnualDeductible: type: number format: double example: 2500 previous_majorFamilyAnnualDeductible: type: number format: double example: 2500 previous_orthoIndividualLifetimeDeductible: type: number format: double example: 2500 previous_orthoIndividualAnnualDeductible: type: number format: double example: 2500 previous_maximumIndividualAnnualBenefit: type: number format: double example: 2500 previous_maximumFamilyAnnualBenefit: type: number format: double example: 2500 previous_maximumOrthoLifetimeBenefit: type: number format: double example: 2500 current_benefitYear: type: integer format: int16 example: 2024 current_basicIndividualLifetimeDeductible: type: number format: double example: 2500 current_basicIndividualAnnualDeductible: type: number format: double example: 2500 current_basicFamilyAnnualDeductible: type: number format: double example: 2500 current_preventiveIndividualLifetimeDeductible: type: number format: double example: 2500 current_preventiveIndividualAnnualDeductible: type: number format: double example: 2500 current_preventiveFamilyAnnualDeductible: type: number format: double example: 2500 current_majorIndividualLifetimeDeductible: type: number format: double example: 2500 current_majorIndividualAnnualDeductible: type: number format: double example: 2500 current_majorFamilyAnnualDeductible: type: number format: double example: 2500 current_orthoIndividualLifetimeDeductible: type: number format: double example: 2500 current_orthoIndividualAnnualDeductible: type: number format: double example: 2500 current_maximumIndividualAnnualBenefit: type: number format: double example: 2500 current_maximumFamilyAnnualBenefit: type: number format: double example: 2500 current_maximumOrthoLifetimeBenefit: type: number format: double example: 2500 lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: coverageType: PERCENTAGE noDuplicationOfBenefitsClause: true id: 12445 previous_benefitYear: 2023 CarrierPlanDeductibleResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/CarrierPlanDeductibleV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CarrierPlanDeductBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/CarrierPlanDeductibleV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CarrierPlanCoverageExceptionV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - exceptionProcedureCode - exceptionType - maxAgeLimit - minAgeLimit properties: id: type: integer format: int64 readOnly: true deductibleType: type: string enum: - NONE - BASIC - PREVENTIVE - MAJOR - ORTHODONTIC example: BASIC reason: type: string maxLength: 255 example: string coveragePercentage: type: number format: double example: 50 maxAgeLimit: type: integer format: int32 example: 0 minAgeLimit: type: integer format: int32 example: 0 maxAgeUnlimited: type: boolean example: true exceptionType: type: string enum: - AGE_LIMIT - NON_COVERED - DOWNGRADE - FREQUENCY_LIMIT example: NON_COVERED frequencyLimitFields: type: object description: fields required with exceptionType of FREQUENCY_LIMIT properties: times: type: number format: int32 amount: type: number format: int32 chronoUnit: type: string enum: - DAYS - MONTHS - YEARS example: DAYS lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true exceptionProcedureCode: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true downgradeProcedureCode: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true carrierInsurancePlan: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: maxAgeLimit: 0 minAgeLimit: 0 exceptionType: NON_COVERED exceptionProcedureCode: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 12445 deductibleType: BASIC CarrierPlanCovExceptionRespWrapperV1: type: object properties: data: $ref: '#/components/schemas/CarrierPlanCoverageExceptionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CarrierPlanCovExceptBulkRespWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/CarrierPlanCoverageExceptionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CarrierPlanCoverageExceptionBulkCreate: type: object required: - carrierInsurancePlanIds - exceptions properties: carrierInsurancePlanIds: type: array description: List of carrier insurance plan IDs to which the exception templates will be applied (max 100) minItems: 1 maxItems: 100 items: type: integer format: int64 minimum: 1 example: - 8000000519037 - 8000000248147 exceptions: type: array description: >- Exception templates to create on each plan (max 30). Each template must include exceptionProcedureCode and exceptionType; other fields depend on exception type. minItems: 1 maxItems: 30 items: type: object required: - exceptionProcedureCode - exceptionType properties: exceptionProcedureCode: type: object required: - id properties: id: type: integer format: int64 description: Practice procedure ID for the exception procedure code downgradeProcedureCode: type: object nullable: true properties: id: type: integer format: int64 description: Required when exceptionType is DOWNGRADE exceptionType: type: string enum: - AGE_LIMIT - NON_COVERED - DOWNGRADE - FREQUENCY_LIMIT reason: type: string maxLength: 255 deductibleType: type: string enum: - NONE - BASIC - PREVENTIVE - MAJOR - ORTHODONTIC coveragePercentage: type: number format: double maxAgeLimit: type: integer format: int32 minAgeLimit: type: integer format: int32 maxAgeUnlimited: type: boolean frequencyLimitFields: type: object description: Required when exceptionType is FREQUENCY_LIMIT properties: times: type: integer format: int32 amount: type: integer format: int32 chronoUnit: type: string enum: - DAYS - MONTHS - YEARS example: carrierInsurancePlanIds: - 8000000519037 - 8000000248147 exceptions: - exceptionProcedureCode: id: 12745 exceptionType: AGE_LIMIT downgradeProcedureCode: id: 12745 reason: reason CarrierPlanCovExceptBulkAsyncRespV2: type: object description: | Async response for the bulk create carrier plan coverage exceptions endpoint. This response is returned immediately when a bulk async request is accepted. The actual create operation runs in the background. When processing completes (or fails), results are delivered via the Streaming API using the provided routing key. required: - data - statusCode properties: data: type: object description: Async processing information for tracking and receiving results via Streaming API required: - correlationId - routingKey - message properties: correlationId: type: string description: Unique identifier to correlate this request with results delivered via Streaming API example: 550e8400-e29b-41d4-a716-446655440000 routingKey: type: string description: Streaming API routing key where the bulk result will be published when processing completes example: 40000000000001.-1.CarrierPlanCoverageExceptionBulk.ASYNC-POST message: type: string description: Confirmation that the request was accepted example: Request received, once it has finished processing the requested data will be sent to the StreamingAPI statusCode: type: integer description: HTTP status code example: 200 enum: - 200 warnings: type: array description: Optional warning messages items: $ref: '#/components/schemas/Error' errors: type: array description: Optional error messages items: $ref: '#/components/schemas/Error' example: data: correlationId: 550e8400-e29b-41d4-a716-446655440000 routingKey: 40000000000001.-1.CarrierPlanCoverageExceptionBulk.ASYNC-POST message: Request received, once it has finished processing the requested data will be sent to the StreamingAPI statusCode: 200 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body errors: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CarrierPlanCopayExceptionV1: allOf: - $ref: '#/components/schemas/CarrierPlanCopayExceptionUpdateV1' - type: object required: - carrierInsurancePlan - exceptionProcedureCode - exceptionType properties: id: type: integer format: int64 readOnly: true example: 2432424 lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true exceptionProcedureCode: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true downgradeProcedureCode: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true carrierInsurancePlan: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} CarrierPlanCopayExceptionUpdateV1: type: object properties: deductibleType: type: string enum: - NONE - BASIC - PREVENTIVE - MAJOR - ORTHODONTIC example: BASIC reason: type: string maxLength: 255 copay: type: number format: double example: 50 maxAgeLimit: type: integer format: int32 example: 65 minAgeLimit: type: integer format: int32 example: 0 maxAgeUnlimited: type: boolean example: false exceptionType: type: string enum: - AGE_LIMIT - NON_COVERED - DOWNGRADE - FREQUENCY_LIMIT example: AGE_LIMIT frequencyLimitFields: type: object description: fields required with exceptionType of FREQUENCY_LIMIT properties: times: type: number format: int32 example: 60 amount: type: number format: int32 example: 5 chronoUnit: type: string enum: - DAYS - MONTHS - YEARS example: DAYS example: deductibleType: BASIC reason: reason CarrierPlanCopayExceptionRespWrapperV1: type: object properties: data: $ref: '#/components/schemas/CarrierPlanCopayExceptionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body CarrierPlanCopayExceptBulkRespWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/CarrierPlanCopayExceptionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PerioExamResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PerioExamV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PerioExamBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PerioExamV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PerioExamUpdateV1: type: object properties: serviceDate: type: string format: date example: '2024-05-10' script: type: string enum: - FIRST - SECOND - THIRD - FOURTH - FIFTH - SIXTH example: FIRST finished: type: boolean example: true toothNavigationScript: type: string enum: - PD - GM - PD_GM example: PD lagging: type: integer format: int32 example: 0 hardPalate: type: boolean example: true skipOptions: type: array items: type: string enum: - CROWN - IMPACTED_DISTAL - IMPACTED_MESIAL - IMPLANT - IMPLANT_AND_CROWN - MISSING - PONTIC - UNERUPTED example: - CROWN - IMPLANT - IMPLANT_AND_CROWN voidStatus: type: object properties: id: type: integer format: int64 example: 13596 readOnly: true user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true dateVoided: type: string format: date example: '2018-07-09' voidReason: type: string enum: - MISTAKE - OTHER - ALLERGIC_REACTION - OTHER_REACTION - INEFFECTIVE - MISTAKE_NOT_PRESCRIBED example: MISTAKE note: type: string examCopy: allOf: - type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true readOnly: true lastEditedPerioProbe: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: serviceDate: '2024-05-10' script: FIRST PerioExamV1: allOf: - $ref: '#/components/schemas/PerioExamUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - createdByUser - serviceDate - toothNavigationScript - script - provider - patient - location - finished properties: id: type: integer format: int64 example: 100002 readOnly: true created: type: string format: date example: 2024-05-10T00:00:00.000Z readOnly: true lastModified: type: string format: date-time readOnly: true example: 2018-07-09T20:30:00.000Z createdByUser: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} PerioProbeResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PerioProbeV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PerioProbeBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PerioProbeV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PerioProbeUpdateV1: type: object properties: toothSide: type: string enum: - FACIAL - LINGUAL example: FACIAL tooth: type: integer format: int32 example: 2 toothIndex: type: integer format: int32 example: 2 centralPocketDepth: type: integer format: int32 example: 2 mesialPocketDepth: type: integer format: int32 example: 2 distalPocketDepth: type: integer format: int32 example: 2 centralGingivalMargin: type: integer format: int32 example: 2 mesialGingivalMargin: type: integer format: int32 example: 2 distalGingivalMargin: type: integer format: int32 example: 2 centralBleeding: type: boolean example: false mesialBleeding: type: boolean example: false distalBleeding: type: boolean example: false centralSuppuration: type: boolean example: false mesialSuppuration: type: boolean example: false distalSuppuration: type: boolean example: false centralFurcationGrade: type: integer format: int32 example: 5 mesialFurcationGrade: type: integer format: int32 example: 5 distalFurcationGrade: type: integer format: int32 example: 5 boneLoss: type: integer format: int32 minimum: 1 maximum: 3 example: 3 mobility: type: integer format: int32 minimum: 1 maximum: 3 example: 2 distalMucogingivalJunction: type: integer format: int32 example: 5 centralMucogingivalJunction: type: integer format: int32 example: 5 mesialMucogingivalJunction: type: integer format: int32 example: 5 skipped: type: string enum: - SKIPPED - NOT_SKIPPED - DEFAULT example: SKIPPED example: toothSide: FACIAL tooth: 2 PerioProbeV1: allOf: - $ref: '#/components/schemas/PerioProbeUpdateV1' - type: object required: - toothSide - tooth - centralBleeding - mesialBleeding - distalBleeding - centralSuppuration - mesialSuppuration - distalSuppuration properties: id: type: integer format: int64 example: 1700 readOnly: true centralCAL: type: integer format: int32 example: 0 readOnly: true mesialCAL: type: integer format: int32 example: 0 readOnly: true distalCAL: type: integer format: int32 example: 0 readOnly: true perioExam: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} DefaultPlanCoverageV1: allOf: - $ref: '#/components/schemas/DefaultPlanCoverageUpdateV1' - type: object type: object required: - name properties: id: type: integer format: int64 example: 343242432 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: {} DefaultPlanCoverageUpdateV1: type: object properties: name: type: string minLength: 1 maxLength: 30 coverageProcedureRanges: type: array items: type: object properties: deductibleType: type: string enum: - NONE - BASIC - PREVENTIVE - MAJOR - ORTHODONTIC example: BASIC category: type: string minLength: 1 maxLength: 255 example: catergory rangeStart: type: string minLength: 1 maxLength: 10 example: string rangeStartExtension: type: string maxLength: 5 example: strin rangeEnd: type: string minLength: 1 maxLength: 10 example: string rangeEndExtension: type: string maxLength: 5 example: strin coveragePercentage: type: number format: double example: 40 exceptions: type: array items: type: object properties: exceptionProcedureCode: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true downgradeProcedureCode: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true exceptionType: type: string enum: - AGE_LIMIT - NON_COVERED - DOWNGRADE example: DOWNGRADE deductibleType: type: string enum: - NONE - BASIC - PREVENTIVE - MAJOR - ORTHODONTIC example: BASIC reason: type: string minLength: 0 maxLength: 255 coveragePercentage: type: integer format: int16 example: 40 maxAgeLimit: type: integer format: int32 example: 65 minAgeLimit: type: integer format: int32 example: 0 maxAgeUnlimited: type: boolean example: false coverageProcedureCopay: type: array items: type: object properties: practiceProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true deductibleType: type: string enum: - NONE - BASIC - PREVENTIVE - MAJOR - ORTHODONTIC example: BASIC copay: type: number format: double example: 50 planCopayExceptions: type: array items: type: object properties: reason: type: string minLength: 0 maxLength: 255 copay: type: number format: double example: 50 maxAgeLimit: type: integer format: int32 example: 65 minAgeLimit: type: integer format: int32 example: 0 maxAgeUnlimited: type: boolean example: false exceptionType: type: string enum: - AGE_LIMIT - NON_COVERED - DOWNGRADE example: NON_COVERED deductibleType: type: string enum: - NONE - BASIC - PREVENTIVE - MAJOR - ORTHODONTIC example: BASIC exceptionProcedureCode: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true downgradeProcedureCode: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: name: Example Name coverageProcedureRanges: - deductibleType: BASIC category: catergory DefaultPlanCoverageResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/DefaultPlanCoverageV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body DefaultPlanCoverageBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/DefaultPlanCoverageV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClinicalNotePromptResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ClinicalNotePromptV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClinicalNotePromptBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ClinicalNotePromptV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClinicalNotePromptUpdateV1: type: object properties: name: type: string minLength: 1 maxLength: 45 promptType: type: string enum: - ONE_FROM_LIST - TEXT - CHECKBOX - SELECT_TOOTH - SELECT_MULTI_TEETH - NUMBER_AMOUNT - SELECT_QUADRANT - SELECT_MULTI_QUADRANTS example: SELECT_QUADRANT title: type: string minLength: 1 maxLength: 250 options: type: array items: type: string example: string example: name: Example Name promptType: SELECT_QUADRANT ClinicalNotePromptV1: allOf: - $ref: '#/components/schemas/ClinicalNotePromptUpdateV1' - type: object required: - name - title - promptType - options - location properties: id: type: integer format: int64 example: 2342432 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} ClinicalNoteTemplateResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ClinicalNoteTemplateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClinicalNoteTemplateBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ClinicalNoteTemplateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClinicalNoteTemplateUpdateV1: type: object properties: category: type: string enum: - ADMINISTRATIVE - ANESTHETICS - CLINICAL_EXAMS - ENDODONTICS - FIXED_PROSTHETICS - HYGIENE - MEDICAL_ALERTS - ORTHODONTICS - 'PATIENT_COMPLAINT ' - PEDODONTICS - PERIODONTICS - PRESCRIPTIONS - RECOMMENDATIONS - REMOVABLE_PROSTHETICS - RESTORATIVE - TREATMENT - X_RAYS example: ADMINISTRATIVE name: type: string minLength: 1 maxLength: 80 text: type: string minLength: 1 example: note example: category: ADMINISTRATIVE name: Example Name ClinicalNoteTemplateV1: allOf: - $ref: '#/components/schemas/ClinicalNoteTemplateUpdateV1' - type: object required: - name - category - text - location properties: id: type: integer format: int64 example: 1234 readOnly: true lastModified: type: string format: date-time example: 2020-04-09T19:00:00.000Z readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} GlobalClinicalNoteTemplate: type: object required: - name - category - text properties: category: type: string enum: - ADMINISTRATIVE - ANESTHETICS - CLINICAL_EXAMS - ENDODONTICS - FIXED_PROSTHETICS - HYGIENE - MEDICAL_ALERTS - ORTHODONTICS - 'PATIENT_COMPLAINT ' - PEDODONTICS - PERIODONTICS - PRESCRIPTIONS - RECOMMENDATIONS - REMOVABLE_PROSTHETICS - RESTORATIVE - TREATMENT - X_RAYS example: ADMINISTRATIVE name: type: string minLength: 1 maxLength: 80 text: type: string minLength: 1 example: category: ADMINISTRATIVE name: Example Name text: text GlobalCNTemplateBulkResponseWrapper: type: object properties: data: type: array items: $ref: '#/components/schemas/GlobalClinicalNoteTemplate' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body GlobalClinicalNotePromptV1: type: object required: - name - text - promptType properties: id: type: integer format: int64 example: 324324 name: type: string minLength: 1 maxLength: 45 promptType: type: string enum: - ONE_FROM_LIST - TEXT - CHECKBOX - SELECT_TOOTH - SELECT_MULTI_TEETH - NUMBER_AMOUNT - SELECT_QUADRANT - SELECT_MULTI_QUADRANTS example: TEXT text: type: string minLength: 1 maxLength: 250 options: type: array items: type: string example: items example: name: Example Name promptType: TEXT text: text id: 324324 options: - items GlobalCNPromptBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/GlobalClinicalNotePromptV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body DentalLabV1: allOf: - $ref: '#/components/schemas/DentalLabUpdateV1' - type: object required: - name properties: id: type: integer format: int64 example: 797987 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: {} DentalLabUpdateV1: type: object properties: name: type: string minLength: 1 maxLength: 52 phone: type: string maxLength: 10 minLength: 10 example: '3245672323' example: name: Example Name phone: '3245672323' DentalLabResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/DentalLabV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: 9000000000001 name: asdf phone: '1112223333' warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body DentalLabBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/DentalLabV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: 9000000000001 name: asdf phone: '1112223333' warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body DayNoteResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/DayNoteV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body DayNoteBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/DayNoteV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body DayNoteUpdateV1: type: object properties: note: type: string date: type: string format: date example: 2024-05-10T00:00:00.000Z example: note: note date: '2024-05-10T00:00:00.000Z' DayNoteV1: allOf: - $ref: '#/components/schemas/DayNoteUpdateV1' - type: object required: - date - note - location properties: id: type: integer format: int64 example: 39423 readOnly: true version: type: string example: string readOnly: true lastModified: type: string format: date-time readOnly: true example: 2018-07-09T19:00:00.000Z location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} SignatureV1: type: object required: - user - data properties: id: type: integer format: int64 example: 32432432 data: type: string format: byte example: U29tZSBiYXNlNjQgc3RyaW5n user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: data: U29tZSBiYXNlNjQgc3RyaW5n user: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 32432432 SignatureResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/SignatureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: data: c2lnbmVkdGVzdGRhdGE= organizationId: 9007 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body SignatureBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/SignatureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - data: c2lnbmVkdGVzdGRhdGE= organizationId: 9007 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientBookingAvailabilityResWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientBookingAvailabilityV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientBookingAvailabilityBlkResWrapV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientBookingAvailabilityV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientBookingAvailabilityUpdateV1: type: object properties: id: type: integer format: int64 example: 234234 title: type: string maxLength: 32 example: A sample title color: type: string maxLength: 6 example: FFCA00 start: type: string format: date-time example: '2018-07-09T19:00:00.000Z' end: type: string format: date-time example: '2018-07-09T20:00:00.000Z' bookOnline: type: boolean example: true dayOfWeek: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY example: MONDAY bookingTypes: type: array items: type: string enum: - TREATMENT - RECARE - NEW_PATIENT - EXISTING_PATIENT example: - TREATMENT - NEW_PATIENT location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true operatory: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true providers: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true appointmentReasons: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: id: 234234 title: A sample title PatientBookingAvailabilityV1: allOf: - $ref: '#/components/schemas/PatientBookingAvailabilityUpdateV1' - type: object required: - operatory - location - start - end - dayOfWeek - color - bookOnline - providers properties: id: type: integer format: int64 example: 108756 example: {} ScheduleTemplateResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ScheduleTemplateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ScheduleTemplateBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ScheduleTemplateV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ScheduleTemplateUpdateV1: type: object properties: title: type: string maxLength: 32 color: type: string example: FFCA00 maxLength: 6 start: type: string example: '09:00' end: type: string example: '14:00' bookOnline: type: boolean example: true dayOfWeek: type: string enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY example: MONDAY bookingTypes: type: array items: type: string enum: - TREATMENT - RECARE - NEW_PATIENT - EXISTING_PATIENT example: - TREATMENT - EXISTING_PATIENT reasons: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: title: Example Title color: FFCA00 ScheduleTemplateV1: allOf: - $ref: '#/components/schemas/ScheduleTemplateUpdateV1' - type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - operatory - location - start - end - dayOfWeek - color - bookOnline - title - providers properties: id: type: integer format: int64 example: 324324234 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true operatory: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true providers: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} ScheduleTemplateApptReasonV1: allOf: - $ref: '#/components/schemas/ScheduleTemplateApptReasonUpdateV1' - type: object required: - reason - location - durationMinutes properties: id: type: integer format: int64 example: {} ScheduleTemplateApptReasonUpdateV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide properties: id: type: integer format: int64 reason: type: string minLength: 3 maxLength: 50 example: string durationMinutes: type: integer format: int32 minimum: 5 maximum: 600 example: 600 location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: id: 12445 reason: string ScheduleTemplateApptReasonResWrapperV1: type: object properties: data: $ref: '#/components/schemas/ScheduleTemplateApptReasonV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ScheduleTemplateApptReasonBlkResWrapV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ScheduleTemplateApptReasonV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ScheduleTemplateReasonV1: type: object required: - reason - location - durationMinutes properties: id: type: integer format: int64 example: 3243243 readOnly: true reason: type: string minLength: 3 maxLength: 50 durationMinutes: type: integer format: int32 minimum: 5 maximum: 600 example: 600 location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: reason: reason durationMinutes: 600 location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 3243243 ScheduleTemplateReasonResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ScheduleTemplateReasonV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ScheduleTemplateReasonBulkResWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ScheduleTemplateReasonV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body InsuranceClaimV1: allOf: - $ref: '#/components/schemas/InsuranceClaimUpdateV1' - type: object required: - location - patient - isPredetermination - procedures - placeOfTreatment properties: totalCharges: readOnly: true type: number format: double example: 100 patientAmountPaid: readOnly: true type: number format: double example: 50 amountPaid: readOnly: true type: number format: double example: 50 appliancePlacementDate: type: string format: date example: 2024-05-10T00:00:00.000Z serviceDate: type: string format: date example: 2024-05-10T00:00:00.000Z serviceDates: readOnly: true type: array items: type: string format: date description: the set of the attached procedure serviceDates example: - '2024-05-10' - '2024-05-11' originalReferenceNumber: type: string maxLength: 50 example: '3243244' referralNumber: type: string maxLength: 50 example: '2345464353' payorName: type: string maxLength: 127 example: name payorId: type: string maxLength: 30 example: '344' groupPlanName: type: string maxLength: 50 example: name groupNumber: type: string maxLength: 30 example: '675765' subscriberNumber: type: string maxLength: 50 example: 978098 releaseOfInformation: type: boolean example: true assignmentOfBenefits: type: boolean example: true isPredetermination: type: boolean example: true paymentResponsibilityOrder: type: integer format: int32 example: 50 readOnly: true relationshipToSubscriber: type: string enum: - SELF - SPOUSE - CHILD - OTHER example: SELF readOnly: true claimState: type: string enum: - UNSENT - SENT - PAID - ZEROPAY - REJECTSV - REJECTED - UNPROCESS - ACCEPTED - ADDINFO - PENDING - DELETED - QUEUED - PRINTED - VOID - RESUB - PAYRECVD - EXTRACTED - SETTLED - ATTACHMENTHOLD - ATTACHMENTERROR - FAKE - TX_CASE example: SENT lastUpdateDate: type: string format: date example: 2024-05-10T00:00:00.000Z readOnly: true statusSource: type: string example: status source readOnly: true messageTxt: type: string example: text readOnly: true payerRequestedResubmit: type: boolean example: true payerRequestedVoid: type: boolean example: true created: readOnly: true type: string format: date example: true resubmitDate: type: string format: date example: 2024-05-10T00:00:00.000Z voidedDate: type: string format: date example: 2024-05-10T00:00:00.000Z sentDate: type: string format: date example: 2024-05-10T00:00:00.000Z orthoMonthsRemaining: type: integer format: int32 example: 6 orthoTotalMonths: type: integer format: int32 example: 24 followupDueDate: type: string format: date example: 2024-05-10T00:00:00.000Z claimFollowupAction: type: string enum: - CONTACT_CARRIER - CONTACT_PATIENT example: CONTACT_CARRIER attachmentReferenceNumber: type: string maxLength: 25 example: '00324342' isActive: type: boolean example: true readOnly: true eTransClaimId: type: string maxLength: 20 example: '000234324' payTo_address1: type: string example: 123 example st readOnly: true payTo_address2: type: string example: 456 example st readOnly: true payTo_city: type: string example: city readOnly: true payTo_state: type: string example: state readOnly: true payTo_postalCode: type: string example: '32452' readOnly: true rendering_address1: type: string example: 123 example st readOnly: true rendering_address2: type: string example: 456 example st readOnly: true rendering_city: type: string example: city readOnly: true rendering_state: type: string example: state readOnly: true rendering_postalCode: type: string example: '32421' readOnly: true payTo_phoneType: type: string enum: - HOME - WORK - MOBILE - OTHER example: HOME readOnly: true payTo_phoneNumber: type: string example: '2344325656' readOnly: true payTo_phoneExtension: type: string example: '4566542323' readOnly: true claimStatusHistory: type: array items: type: object properties: id: type: integer format: int64 example: 1234 claimState: type: string example: claim claimHistoryMessageTxt: type: string maxLength: 3000 example: message history statusDate: type: string format: date example: 2023-05-10T00:00:00.000Z amountPaid: type: number format: double example: 1000 payerReferenceNumber: type: string maxLength: 30 example: '123456789009876543215432167890' payerContactMethod: type: string maxLength: 2 example: EM payerContact: type: string maxLength: 80 example: John Doe payerContactNumber: type: string maxLength: 80 example: 123-456-7890 paymentDate: type: string format: date example: '2024-05-10' paymentSentDate: type: string format: date example: '2024-05-11' paymentTraceNumber: type: string maxLength: 16 example: TR1234567890 statusSource: type: string maxLength: 60 example: Insurance Company totalCharge: type: number format: double example: 150.75 id: type: integer format: int64 example: 1252 readOnly: true type: type: string example: InsuranceClaim readOnly: true insurancePayments: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true subscriber: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true payToProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true insuranceCarrier: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true carrierInsurancePlan: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patientInsurancePlan: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true claimDiagnosisCode: type: object properties: codeA: type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true codeB: type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true codeC: type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true codeD: type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: {} InsuranceClaimUpdateV1: type: object properties: placeOfTreatment: type: string enum: - OFFICE - HOSPITAL - SCHOOL - HOMELESSSHELTER - CORRECTIONAL - HOME - ASSISTEDLIVING - GROUPHOME - MOBILEUNIT - WALKINRETAIL - WORKSITE - INPATIENTHOSPITAL - EMERGENCYROOM - MILITARYFACILITY - SKILLEDNURSING - NURSINGFACILITY - INDEPENDENTCLINIC - FEDERALLYQUALIFIED - PUBLICHEALTHCLINIC - RURALHEALTHCLINIC - OTHER - AMBULATORYSURGICAL - TELEHEALTH example: OFFICE unusualServicesRemarks: type: string maxLength: 400 example: Remarks accidentType: type: string enum: - OCCUPATIONAL - AUTOMOTIVE - OTHER example: AUTOMOTIVE accidentState: type: string enum: - AA - AE - AP - AL - AK - AS - AZ - AR - CA - CO - CNMI - CT - DE - DC - FM - FL - FSM - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MH - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY example: MA accidentDate: type: string format: date example: 2024-05-10T00:00:00.000Z priorAuthorizationNumber: type: string maxLength: 50 example: '234324042' procedures: type: array items: type: object description: A reference to a linked estimation model. properties: id: type: integer format: int64 example: 1234 type: type: string readOnly: true url: type: string format: uri readOnly: true example: https://example.com/resource writeOff: type: number readOnly: true example: 150 primaryInsurancePortion: type: number readOnly: true example: 200 secondaryInsurancePortion: type: number readOnly: true example: 100 patientPortion: type: number readOnly: true example: 50 originalPrimaryInsurancePortion: type: number readOnly: true example: 120 originalSecondaryInsurancePortion: type: number readOnly: true example: 40 originalPatientPortion: type: number readOnly: true example: 75 referral: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true billingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true renderingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: placeOfTreatment: OFFICE unusualServicesRemarks: Remarks InsuranceClaimResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/InsuranceClaimV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body InsuranceClaimBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/InsuranceClaimV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClaimAttachmentV1: type: object required: - insuranceClaim - attachmentType properties: id: type: integer format: int64 example: 234324 attachmentType: type: string enum: - RADIOLOGY_FILMS - PERIODONTAL_CHART - EXPLANATION_OF_BENEFITS - RADIOLOGY_REPORTS - STUDENT_VERIFICATION - NARRATIVE - REPORT - DIAGNOSTIC_REPORT - FULL_MOUTH_SERIES - PANORAMIC_FILM - X_RAY_CREATION_DATE example: RADIOLOGY_FILMS attachedDate: type: string format: date example: 2024-05-09T00:00:00.000Z dateCreated: type: string format: date example: 2024-05-09T00:00:00.000Z neaNumber: type: string maxLength: 50 example: '435432' document: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true insuranceClaim: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: attachmentType: RADIOLOGY_FILMS insuranceClaim: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 234324 attachedDate: '2024-05-09T00:00:00.000Z' ClaimAttachmentResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ClaimAttachmentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ClaimAttachmentBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ClaimAttachmentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ImageAttachmentV1: type: object required: - insuranceClaim - attachmentType - examImageId - examName - examDate - examImageOutputFormat - examImageSizeInBytes properties: id: type: integer format: int64 example: 3246546 examId: type: integer format: int64 example: 654 examImageId: type: integer format: int64 example: 23 examName: type: string maxLength: 50 example: exam name examDate: type: string format: date example: 2024-05-10T00:00:00.000Z examImageOutputFormat: type: string maxLength: 10 example: format examImageSizeInBytes: type: integer format: int32 example: 2048 examImageTreatments: type: string maxLength: 500 example: image treatments attachmentType: type: string enum: - RADIOLOGY_FILMS - PERIODONTAL_CHART - EXPLANATION_OF_BENEFITS - RADIOLOGY_REPORTS - STUDENT_VERIFICATION - NARRATIVE - REPORT - DIAGNOSTIC_REPORT - FULL_MOUTH_SERIES - PANORAMIC_FILM - X_RAY_CREATION_DATE example: RADIOLOGY_FILMS attachedDate: type: string format: date example: 2024-05-10T00:00:00.000Z dateCreated: type: string format: date example: 2024-05-10T00:00:00.000Z neaNumber: type: string maxLength: 50 example: '324' insuranceClaim: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: examImageId: 23 examName: exam name examDate: '2024-05-10T00:00:00.000Z' examImageOutputFormat: format examImageSizeInBytes: 2048 attachmentType: RADIOLOGY_FILMS insuranceClaim: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 3246546 examId: 654 ImageAttachmentResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ImageAttachmentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ImageAttachmentBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ImageAttachmentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ICD10V1: type: object properties: id: type: integer format: int32 example: 324324 code: type: string description: type: string example: id: 324324 code: ERR101 ICD10BulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ICD10V1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ICD10ResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ICD10V1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body LinkedOrgsV1: type: object description: OrgMapper identifiers for organizations the authenticated API consumer may access. properties: organizations: type: array items: type: string required: - organizations example: organizations: - organizations SMSNumberResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/SMSNumberV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body SMSNumberBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/SMSNumberV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body SMSNumberV1: type: object required: - number - smsAuthorizationStatus - infoSent - location properties: id: type: integer format: int64 example: 23424 number: type: string maxLength: 30 example: max length 30 smsAuthorizationStatus: type: string enum: - OPT_IN - OPT_OUT - INVALID - ERROR example: INVALID statusChangedDate: type: string format: date example: 2024-05-10T00:00:00.000Z infoSent: type: boolean example: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: number: max length 30 smsAuthorizationStatus: INVALID infoSent: true location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 23424 statusChangedDate: '2024-05-10T00:00:00.000Z' ScheduleOpeningsV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide properties: provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true operatory: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true day: type: string format: date example: 2018-07-09T00:00:00.000Z slots: type: array items: type: object properties: start: type: string format: date-time example: 2018-07-09T19:00:00.000Z end: type: string format: date-time example: 2018-07-09T20:00:00.000Z scheduleTemplateBookingType: type: array items: type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true scheduleTemplateReason: type: array items: type: object description: >- A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: provider: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType operatory: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType ScheduleOpeningResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ScheduleOpeningsV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ColorCategoryResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ColorCategoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ColorCategoryBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ColorCategoryV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ColorCategoryV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide required: - name - color - sequence - location properties: id: type: integer format: int64 readOnly: true name: type: string minLength: 1 maxLength: 52 example: string sequence: type: number example: 0 color: type: string example: 24802E maxLength: 6 isDefault: type: boolean readOnly: true example: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true practiceProcedures: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: name: string sequence: 0 color: 24802E location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 12445 isDefault: true AppointmentColorResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/AppointmentColorV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: id: 1000000001027 mainArea: PROVIDER_COLOR additionalArea: ADDITIONAL_PROVIDER_COLOR warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentColorBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/AppointmentColorV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - id: 1000000001027 mainArea: PROVIDER_COLOR additionalArea: ADDITIONAL_PROVIDER_COLOR warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body AppointmentColorV1: type: object properties: id: type: integer format: int64 mainArea: type: string enum: - PROVIDER_COLOR - PROCEDURE_COLOR example: PROVIDER_COLOR additionalArea: type: string enum: - PROVIDER_COLOR - ADDITIONAL_PROVIDER_COLOR - PROCEDURE_COLOR example: ADDITIONAL_PROVIDER_COLOR location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: id: 12445 mainArea: PROVIDER_COLOR OrganizationLedgerRulesResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/OrganizationLedgerRulesV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OrganizationLedgerRulesBulkResWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/OrganizationLedgerRulesV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body OrganizationLedgerRulesV1: type: object properties: id: type: integer format: int64 example: 324324 transactionLockTime: type: number maximum: 999 minimum: 1 example: 999 transactionLockDate: type: string format: date example: 2018-07-09T00:00:00.000Z writeOffAutoPostEnabled: type: boolean example: true reasonForCorrectionRequired: type: boolean example: true expirationDateForDiscountPlansRequired: type: boolean example: true transactionLockType: type: string enum: - SLIDING_LOCK - USER_INITIATED example: SLIDING_LOCK example: id: 324324 transactionLockTime: 999 LocationPovertyLevelV1: type: object properties: id: type: integer format: int64 example: 1234 onePerson: type: integer format: int32 maximum: 99999 minimum: 0 example: 99999 twoPersons: type: integer format: int32 maximum: 99999 minimum: 0 example: 99999 threePersons: type: integer format: int32 maximum: 99999 minimum: 0 example: 99999 fourPersons: type: integer format: int32 maximum: 99999 minimum: 0 example: 99999 fivePersons: type: integer format: int32 maximum: 99999 minimum: 0 example: 99999 sixPersons: type: integer format: int32 maximum: 99999 minimum: 0 example: 99999 sevenPersons: type: integer format: int32 maximum: 99999 minimum: 0 example: 99999 eightPersons: type: integer format: int32 maximum: 99999 minimum: 0 example: 99999 eachAdditional: type: integer format: int32 maximum: 99999 minimum: 0 example: 99999 patientAmounts: type: array items: type: object properties: paymentUnit: type: string enum: - PERCENT - CURRENCY - CURRENCY_PER_VISIT example: PERCENT patientAmount: type: number format: double minimum: 0 example: 50 povertyLevel: type: integer format: int32 minimum: 100 maximum: 201 example: 201 location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true practiceProcedure: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: id: 1234 onePerson: 99999 LocationPovertyLevelBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/LocationPovertyLevelV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body LocationPovertyLevelResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/LocationPovertyLevelV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body LocationExcludedProcedureResWrapperV1: type: object properties: data: $ref: '#/components/schemas/LocationWithExcludedProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body LocationExcludedProcedureBulkResWrapV1: type: object properties: data: type: array items: $ref: '#/components/schemas/LocationWithExcludedProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body LocationWithExcludedProcedureV1: type: object properties: location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true practiceProcedures: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType practiceProcedures: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType LocationClaimDefaultsV1: type: object properties: id: type: integer format: int64 example: 123213 useNonContractedProviderWarning: type: boolean example: true usePatientRenderingProvider: type: boolean example: true defaultReleaseOfInformation: type: boolean example: true defaultAssignmentOfBenefits: type: boolean example: true defaultBillingProviderType: type: string example: Billing Provider Type readOnly: true defaultRenderingProviderType: type: string example: Rendering Provider Type readOnly: true defaultPayToAddressType: type: string enum: - LOCATION - ORGANIZATION - OTHER example: LOCATION address1: type: string maxLength: 50 example: 123 example st address2: type: string maxLength: 50 example: 456 example st city: type: string maxLength: 30 state: type: string enum: - AA - AE - AP - AL - AK - AS - AZ - AR - CA - CO - CNMI - CT - DE - DC - FM - FL - FSM - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MH - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY example: AA postalCode: type: string minLength: 5 maxLength: 10 example: '2343389878' location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true defaultBillingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true alternateBillingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true alternateRenderingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true defaultRenderingProvider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: id: 123213 useNonContractedProviderWarning: true LocationClaimDefaultsResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/LocationClaimDefaultsV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body LocationClaimDefaultBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/LocationClaimDefaultsV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body InsuranceCarrierWithExcludedProcedureV1: type: object properties: insuranceCarrier: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true practiceProcedures: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: insuranceCarrier: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType practiceProcedures: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType InsCarrierExcludedProcBulkResWrapV1: type: object properties: data: type: array items: $ref: '#/components/schemas/InsuranceCarrierWithExcludedProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body InsCarrierExcludedProcResWrapV1: type: object properties: data: $ref: '#/components/schemas/InsuranceCarrierWithExcludedProcedureV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body StreamAPIUsageV1: type: object properties: name: type: string auto_delete: type: boolean example: true exclusive: type: boolean example: true memory: type: integer format: int64 example: 2048 message_ram: type: integer format: int64 example: 2048 message_bytes: type: integer format: int64 example: 2 messages: type: integer format: int64 example: 5 node: type: string state: type: string consumers: type: integer format: int64 example: name: Example Name auto_delete: true StreamAPIUsageBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/StreamAPIUsageV1' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} meta: {} StreamAPIUsageQueueV1: type: object properties: source: type: string vhost: type: string destination: type: string destination_type: type: string example: string routing_key: type: string example: routing key arguments: type: string properties_key: type: string example: properties key example: source: source vhost: vhost StreamAPIUsageQueueResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/StreamAPIUsageQueueV1' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} meta: {} BulkInsurancePaymentV1: type: object required: - insuranceCarrier - transactionDate - amount - organizationLedgerType - location properties: id: type: integer format: int64 transactionDate: type: string format: date example: '2018-07-09' amount: type: number format: double example: 100 checkNumber: type: string maxLength: 20 example: '1232131335' bankNumber: type: string maxLength: 20 example: '34324242432' referenceNumber: type: string maxLength: 20 example: '567676' lastModified: type: string format: date-time readOnly: true example: 2018-07-09T19:00:00.000Z insuranceCarrier: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true organizationLedgerType: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true insuranceClaims: readOnly: true type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true insurancePayments: readOnly: true type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true creditCardTransaction: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: transactionDate: '2018-07-09' amount: 100 insuranceCarrier: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType organizationLedgerType: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType location: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: 12445 checkNumber: '1232131335' BulkInsurancePaymentResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/BulkInsurancePaymentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body BulkInsurancePaymentBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/BulkInsurancePaymentV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ExamV1: type: object required: - procedures - exam properties: id: type: string readOnly: true example: '213' isProcedureNotEditable: type: boolean example: true readOnly: true imagesAttached: type: boolean example: true readOnly: true version: type: string example: V1 type: type: string example: ExampleModelType procedures: type: array items: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: procedures: - id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType id: '213' isProcedureNotEditable: true ExamResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ExamV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ExamBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ExamV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProductionCollectionV1: type: object description: | This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide properties: locationId: type: integer format: int64 example: 3243242 locationName: type: string example: name serviceLocationId: type: integer format: int64 example: 3423 serviceLocationName: type: string example: name providerId: type: integer format: int64 example: 2342442 providerName: type: string example: name patientLedgerId: type: integer format: int64 example: 32424324 transactionId: type: integer format: int64 example: 323532523 transactionDate: type: string format: date example: '2018-07-09' serviceDate: type: string format: date example: '2018-07-09' modifiedDate: type: string format: date example: '2024-05-10' patientId: type: integer format: int64 example: 343243242 patientName: type: string example: name primaryGuarantorId: type: integer format: int64 example: 3523524242 primaryGuarantorName: type: string example: name chartNumber: type: string example: '5' primaryProvider: type: string example: primary provider transactionCategory: type: string example: transaction category transactionSubCategory: type: string example: transaction subcategory collection_production: type: string example: collection production procedureCategory: type: string example: procedure category procedureCode: type: string example: procedure code amount: type: number format: float example: 100 tags: type: string insuranceCarrier: type: string example: insurance carrier insurancePlan: type: string example: insurance plan example: locationId: 3243242 locationName: name ProductionCollectionBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ProductionCollectionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProductionCollectionResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/ProductionCollectionV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProductionGrossV1: type: object properties: scheduledAmount: type: integer format: int64 example: 10000 actualAmount: type: integer format: int64 example: 1000 date: type: string format: datetime example: '2022-02-26T00:00:00.000Z' example: scheduledAmount: 10000 actualAmount: 1000 ProductionGrossBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ProductionGrossV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProductionNetActualV1: type: object properties: actualAmount: type: integer format: int64 example: 1000 date: type: string format: datetime example: '2022-02-26T00:00:00.000Z' example: actualAmount: 1000 date: '2022-02-26T00:00:00.000Z' ProductionNetActualBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ProductionNetActualV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProductionNetScheduledV1: type: object properties: scheduledAmount: type: integer format: int64 example: 10000 date: type: string format: datetime example: '2022-02-26T00:00:00.000Z' example: scheduledAmount: 10000 date: '2022-02-26T00:00:00.000Z' ProductionNetScheduleBulkResWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/ProductionNetScheduledV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body ProductionNetScheduleAsyncResponseV1: type: object description: | Async data retrieval response for Production Net Schedule reports. This response is returned immediately when an async request is submitted. The actual report data will be delivered via the StreamingAPI using the provided routing key when processing completes. required: - data - statusCode properties: data: type: object description: Contains the async processing information required: - correlationId - routingKey - message properties: correlationId: type: string description: Unique identifier to correlate this async request with the results delivered via StreamingAPI example: 550e8400-e29b-41d4-a716-446655440000 routingKey: type: string description: StreamingAPI routing key where the final results will be published example: org123.456.ProductionNetSchedule.ASYNC-GET pattern: ^[a-zA-Z0-9]+\.[0-9-]+\.ProductionNetSchedule\.ASYNC-GET$ message: type: string description: Confirmation message indicating the request status example: Request received, once it has finished processing the requested data will be sent to the StreamingAPI statusCode: type: integer description: HTTP status code example: 200 enum: - 200 warnings: type: array description: Array of warning messages (optional) items: $ref: '#/components/schemas/Error' errors: type: array description: Array of error messages (optional) items: $ref: '#/components/schemas/Error' example: data: correlationId: 550e8400-e29b-41d4-a716-446655440000 routingKey: org123.456.ProductionNetSchedule.ASYNC-GET message: Request received, once it has finished processing the requested data will be sent to the StreamingAPI statusCode: 200 warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body errors: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientPaymentPlanV1: allOf: - $ref: '#/components/schemas/PatientPaymentPlanUpdateV1' - type: object required: - patient - location - provider - numberOfPayments - paymentIntervalType - charges - date properties: id: type: integer format: int64 example: 13587 readOnly: true currentBalance: type: number format: double example: 750 readOnly: true lastPayment: type: number format: double example: 100 readOnly: true lastPaymentDate: type: string format: date-time example: '2019-09-09T19:00:00.000Z' readOnly: true patient: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true provider: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: {} PatientPaymentPlanUpdateV1: type: object properties: date: type: string format: date example: 2018-12-31T00:00:00.000Z totalAmount: type: number format: double example: 750 interestRate: type: number format: double example: 1.5 numberOfPayments: type: number format: double example: 10 paymentAmount: type: number format: double example: 500 interestAmount: type: number format: double example: 250 appliedAmount: type: number format: double example: 0 paymentIntervalType: type: string enum: - BIWEEKLY - MONTHLY - QUARTERLY example: BIWEEKLY note: type: string active: type: boolean example: true readOnly: true patientPaymentPlanStatus: type: string enum: - ACTIVE - INACTIVE - DELETED example: ACTIVE pendingForReviewResolved: type: boolean example: true charges: type: object properties: charge: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true appliedAmount: type: number format: double example: 500 guarantorPortion: type: number format: double example: 250 balance: type: number format: double example: 250 example: date: '2018-12-31T00:00:00.000Z' totalAmount: 750 PatientPaymentPlanResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/PatientPaymentPlanV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body PatientPaymentPlanBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/PatientPaymentPlanV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransferReasonV1: type: object required: - tagText properties: id: type: integer format: int64 example: 324324 readOnly: true tagText: type: string minLength: 1 maxLength: 30 example: tag text lastModified: type: string format: date-time example: 2018-07-09T19:00:00.000Z readOnly: true example: tagText: tag text id: 324324 lastModified: '2018-07-09T19:00:00.000Z' TransferReasonResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/TransferReasonV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TransferReasonBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/TransferReasonV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TimeClockUpdateV1: type: object properties: punchDateTime: type: string format: date-time example: 2018-07-09T19:00:00.000Z lastEditedBy: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true example: punchDateTime: '2018-07-09T19:00:00.000Z' lastEditedBy: id: 12345 url: https://api.example.com/models/12345 type: ExampleModelType TimeClockV1: allOf: - $ref: '#/components/schemas/TimeClockUpdateV1' - type: object required: - punchDateTime - user - location properties: id: type: integer format: int64 example: 2342342 readOnly: true version: type: string readOnly: true example: V1 localPunchDateTime: type: object readOnly: true properties: timeZone: type: string example: timezone punchDate: type: string example: Aug 12 dayOfWeek: type: string enum: - SUN - MON - TUE - WED - THU - FRI - SAT example: MON punchHour: type: integer maximum: 12 minimum: 0 example: 12 punchMinute: type: integer maximum: 59 minimum: 0 example: 59 amPM: type: string enum: - AM - PM example: AM user: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true location: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true addedBy: type: object description: A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed. required: - id - url properties: id: type: integer format: int64 description: The unique identifier for the linked model. example: 12345 type: type: string description: The type of the linked model. This field is read-only. example: ExampleModelType readOnly: true url: type: string format: uri description: The URL at which the linked model can be accessed. This field is read-only. example: https://api.example.com/models/12345 readOnly: true lastModified: type: string format: date-time readOnly: true example: 2018-07-09T19:00:00.000Z example: {} TimeClockResponseWrapperV1: type: object properties: data: $ref: '#/components/schemas/TimeClockV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' example: warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body TimeClockBulkResponseWrapperV1: type: object properties: data: type: array items: $ref: '#/components/schemas/TimeClockV1' warnings: type: array items: $ref: '#/components/schemas/Error' errors: type: array items: $ref: '#/components/schemas/Error' meta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' example: data: - {} warnings: - code: VALIDATION_ERROR title: Validation Failed description: The provided data does not meet the required validation rules. source: request.body UsageReportResponseV1: type: object properties: statusCode: type: number example: 200 data: type: object properties: usagePerEndpoint: type: array items: $ref: '#/components/schemas/UsageReportItemV1' example: statusCode: 200 data: usagePerEndpoint: - {} UsageReportItemV1: type: object properties: endpoint: type: string requestCount: type: number example: 12345 example: endpoint: endpoint requestCount: 12345 VendorEnablementV1: type: object description: Represents a vendor's enablement status for an organization properties: id: type: integer description: ThirdPartySoftwareID - unique vendor identifier example: 1 name: type: string description: Display name of the vendor example: Weave description: type: string description: Brief description of the vendor's service example: Patient communication platform enabled: type: boolean description: Whether the vendor is currently enabled for this organization example: true enabledDate: type: string format: date-time nullable: true description: Timestamp when the vendor was enabled example: '2026-01-26T10:30:00.000Z' disabledDate: type: string format: date-time nullable: true description: Timestamp when the vendor was disabled (null if currently enabled) linkable: type: boolean description: > Whether this vendor can be enabled for OrgMapper API consumer linking. False when OrgMapper sync is on and the vendor has no ConsumerID (DB or config mapping). The MFE uses this to disable toggles for vendors that cannot be linked. example: true required: - id - name - enabled - linkable example: id: 1 name: Weave enabled: true linkable: true description: Patient communication platform enabledDate: '2026-01-26T10:30:00.000Z' VendorEnablementResponseWrapperV1: type: object description: Response wrapper for a single vendor enablement operation properties: success: type: boolean description: Whether the operation was successful example: true vendor: $ref: '#/components/schemas/VendorEnablementV1' error: type: string description: Error message if operation failed nullable: true required: - success example: success: true error: Example error message VendorEnablementBulkResponseWrapperV1: type: object description: Response wrapper for bulk vendor enablement retrieval properties: vendors: type: array items: $ref: '#/components/schemas/VendorEnablementV1' description: List of vendors with their enablement status required: - vendors example: vendors: - {} securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT oAuthSandbox: type: oauth2 description: OAuth 2.0 client credentials (Sandbox) flows: clientCredentials: tokenUrl: https://test.hs1api.com/oauth/client_credential/accesstoken?grant_type=client_credentials scopes: {} parameters: OrganizationId: name: Organization-ID in: header required: true schema: type: string example: '1006' tags: - name: Agingbalances (V1) description: Agingbalances endpoints - name: Appointmentcolors (V1) description: Appointmentcolors endpoints - name: Appointmenthistories (V1) description: Appointmenthistories endpoints - name: Appointments (V1) description: Appointments endpoints - name: Appointmentstatushistories (V1) description: Appointmentstatushistories endpoints - name: Appointmenttasks (V1) description: Appointmenttasks endpoints - name: Audits (V1) description: Audits endpoints - name: Bulkinsurancepayments (V1) description: Bulkinsurancepayments endpoints - name: Carrierinsuranceplancoordinationofbenefits (V1) description: Carrierinsuranceplancoordinationofbenefits endpoints - name: Carrierinsuranceplans (V1) description: Carrierinsuranceplans endpoints - name: Carrierplancopayexceptions (V1) description: Carrierplancopayexceptions endpoints - name: Carrierplancoverageexceptions (V1) description: Carrierplancoverageexceptions endpoints - name: Carrierplandeductibles (V1) description: Carrierplandeductibles endpoints - name: Claimattachments (V1) description: Claimattachments endpoints - name: ClientCredential (V1) description: ClientCredential endpoints - name: Clinicalnoteprompts (V1) description: Clinicalnoteprompts endpoints - name: Clinicalnotes (V1) description: Clinicalnotes endpoints - name: Clinicalnotetemplates (V1) description: Clinicalnotetemplates endpoints - name: Clinicalnotetemplateuserfavorites (V1) description: Clinicalnotetemplateuserfavorites endpoints - name: Colorcategories (V1) description: Colorcategories endpoints - name: Coverageprocedurecopays (V1) description: Coverageprocedurecopays endpoints - name: Coverageprocedureranges (V1) description: Coverageprocedureranges endpoints - name: Coverageprocedurerangetemplates (V1) description: Coverageprocedurerangetemplates endpoints - name: Daynotes (V1) description: Daynotes endpoints - name: Defaultplancoverages (V1) description: Defaultplancoverages endpoints - name: Dentallabs (V1) description: Dentallabs endpoints - name: Documents (V1) description: Documents endpoints - name: Documenttags (V1) description: Documenttags endpoints - name: Events (V1) description: Events endpoints - name: Exams (V1) description: Exams endpoints - name: Feescheduleassociations (V1) description: Feescheduleassociations endpoints - name: Feescheduleranges (V1) description: Feescheduleranges endpoints - name: Feeschedules (V1) description: Feeschedules endpoints - name: Globalinsurancecarriers (V1) description: Globalinsurancecarriers endpoints - name: Globalproceduremappingrules (V1) description: Globalproceduremappingrules endpoints - name: Globalprocedures (V1) description: Globalprocedures endpoints - name: Icd10s (V1) description: Icd10s endpoints - name: Imageattachments (V1) description: Imageattachments endpoints - name: Insurancecarrierexcludedprocedures (V1) description: Insurancecarrierexcludedprocedures endpoints - name: Insurancecarriers (V1) description: Insurancecarriers endpoints - name: Insuranceclaims (V1) description: Insuranceclaims endpoints - name: LinkedOrgs (V1) description: LinkedOrgs endpoints - name: Locationclaimdefaults (V1) description: Locationclaimdefaults endpoints - name: Locationexcludedprocedures (V1) description: Locationexcludedprocedures endpoints - name: Locationhours (V1) description: Locationhours endpoints - name: Locationpovertylevels (V1) description: Locationpovertylevels endpoints - name: LocationpovertylevelsV1 (V1) description: LocationpovertylevelsV1 endpoints - name: Locationproductiongross (V1) description: Locationproductiongross endpoints - name: Locationproductionnetactual (V1) description: Locationproductionnetactual endpoints - name: Locationproductionnetschedule (V1) description: Locationproductionnetschedule endpoints - name: Locations (V1) description: Locations endpoints - name: Locatlocationclaimdefaultsons (V1) description: Locatlocationclaimdefaultsons endpoints - name: Medicalalertcategories (V1) description: Medicalalertcategories endpoints - name: Medicalalertreactions (V1) description: Medicalalertreactions endpoints - name: Medicalalerts (V1) description: Medicalalerts endpoints - name: Medicalalertseverities (V1) description: Medicalalertseverities endpoints - name: Missedappointments (V1) description: Missedappointments endpoints - name: Onlinebookinglocations (V1) description: Onlinebookinglocations endpoints - name: Operatories (V1) description: Operatories endpoints - name: Organizationconditions (V1) description: Organizationconditions endpoints - name: Organizationledgerrules (V1) description: Organizationledgerrules endpoints - name: Organizationledgertypes (V1) description: Organizationledgertypes endpoints - name: Organizations (V1) description: Organizations endpoints - name: Patientbookingavailabilities (V1) description: Patientbookingavailabilities endpoints - name: Patientconditions (V1) description: Patientconditions endpoints - name: Patientinsuranceplans (V1) description: Patientinsuranceplans endpoints - name: Patientmedicalalerts (V1) description: Patientmedicalalerts endpoints - name: Patientnotes (V1) description: Patientnotes endpoints - name: Patientpaymentplans (V1) description: Patientpaymentplans endpoints - name: Patientprescriptions (V1) description: Patientprescriptions endpoints - name: Patientprocedures (V1) description: Patientprocedures endpoints - name: Patientrecares (V1) description: Patientrecares endpoints - name: Patients (V1) description: Patients endpoints - name: Patientstatements (V1) description: Patientstatements endpoints - name: Patientteeth (V1) description: Patientteeth endpoints - name: Perioexams (V1) description: Perioexams endpoints - name: Practiceprocedures (V1) description: Practiceprocedures endpoints - name: Prescriptiondrugcategories (V1) description: Prescriptiondrugcategories endpoints - name: Prescriptiondrugunits (V1) description: Prescriptiondrugunits endpoints - name: Prescriptiontemplates (V1) description: Prescriptiontemplates endpoints - name: Procedurecategories (V1) description: Procedurecategories endpoints - name: Providergroups (V1) description: Providergroups endpoints - name: Providerhours (V1) description: Providerhours endpoints - name: Providers (V1) description: Providers endpoints - name: Recaretemplates (V1) description: Recaretemplates endpoints - name: Referralsources (V1) description: Referralsources endpoints - name: Scheduleopenings (V1) description: Scheduleopenings endpoints - name: Scheduletemplateappointmentreasons (V1) description: Scheduletemplateappointmentreasons endpoints - name: Scheduletemplatereasons (V1) description: Scheduletemplatereasons endpoints - name: Scheduletemplates (V1) description: Scheduletemplates endpoints - name: Signatures (V1) description: Signatures endpoints - name: Smsnumbers (V1) description: Smsnumbers endpoints - name: Streamapiusage (V1) description: Streamapiusage endpoints - name: Subscriberinsuranceplans (V1) description: Subscriberinsuranceplans endpoints - name: Timeclocks (V1) description: Timeclocks endpoints - name: Transactions (V1) description: Transactions endpoints - name: Transactiontags (V1) description: Transactiontags endpoints - name: Transferreasons (V1) description: Transferreasons endpoints - name: Txcases (V1) description: Txcases endpoints - name: Usagereport (V1) description: Usagereport endpoints - name: Users (V1) description: Users endpoints - name: Visits (V1) description: Visits endpoints x-tagGroups: - name: Access Management tags: - AccessToken (V1) - name: Appointment Management tags: - Appointments (V1) - AppointmentColor (V1) - AppointmentHistory (V1) - AppointmentStatusHistory (V1) - AppointmentTasks (V1) - Events (V1) - Missed Appointments (V1) - ScheduleOpenings (V1) - ScheduleTemplates (V1) - ScheduleTemplateReasons (V1) - ScheduleTemplateAppointmentReasons (V1) - PatientBookingAvailabilities (V1) - name: Patient Management tags: - Patients (V1) - PatientConditions (V1) - PatientRecares (V1) - Patient Billing Types - name: Clinical & Medical Records tags: - PatientProcedures(V1) - PatientNotes (V1) - PatientMedicalAlerts (V1) - MedicalAlerts (V1) - ClinicalNoteTemplates (V1) - ClinicalNoteTemplateUserFavorites (V1) - PerioExams (V1) - PerioProbes (V1) - ClinicalNotePrompts (V1) - ClinicalNotes (V1) - DayNotes (V1) - name: Financial Management tags: - Agingbalances (V1) - PatientStatements (V1) - PatientPaymentPlans (V1) - FeeSchedules (V1) - FeeScheduleAssociations (V1) - FeeScheduleRanges (V1) - Adjustment Transactions (V1) - Patient Payment Transactions (V1) - Patient Procedure Transactions (V1) - Insurance Payment Transactions (V1) - name: Insurance Management tags: - PatientInsurancePlans (V1) - InsuranceCarriers (V1) - CarrierInsurancePlans (V1) - InsuranceClaims (V1) - BulkInsurancePayments (V1) - CarrierInsurancePlanCoordinationOfBenefits (V1) - CarrierPlanCopayExceptions (V1) - CarrierPlanCoverageExceptions (V1) - CarrierPlanDeductibles (V1) - ClaimAttachments (V1) - CoverageProcedureCopays (V1) - CoverageProcedureRanges (V1) - CoverageProcedureRangeTemplates (V1) - DefaultPlanCoverages (V1) - SubscriberInsurancePlans (V1) - LocationClaimDefaults (V1) - name: Practice & Location Management tags: - Locations (V1) - Location hours (V1) - Operatories (V1) - Providers (V1) - ProviderHours (V1) - TimeClockV1 - ProviderDaysExceptions (V1) - LocationPovertyLevels (V1) - Production Gross Report (V1) - Production Net Actual Report (V1) - Production Net Schedule Report (V1) - Production Collection (V1) - name: Procedures & Treatment tags: - PracticeProcedures (V1) - ProcedureCategories (V1) - TxCases (V1) - GlobalProcedures (V1) - GlobalProcedureMappingRules (V1) - name: Prescriptions & Pharmacy tags: - PrescriptionTemplates (V1) - PrescriptionDrugCategories (V1) - PrescriptionPrintSettings (V1) - PrescriptionDrugUnits (V1) - PrescriptionPrintSettingsTemplates (V1) - PatientPrescriptions (V1) - name: Reports & Analytics tags: - Usage Report (V1) - Audits (V1) - name: Document Management tags: - Documents (V1) - DocumentTags (V1) - ImageAttachments (V1) - Signatures (V1) - name: System Configuration tags: - AccessRights (V1) - Organizations (V1) - OrganizationConditions (V1) - OrganizationLedgerRules (V1) - OrganizationLedgerTypes (V1) - Organization Billing Types - SignedJWT (V1) - name: Notes & Communication tags: - SMSNumber (V1) - PatientNotes (V1) - ClinicalNotes (V1) - DayNotes (V1) - name: Specialized Services tags: - RecareTemplates (V1) - TransferReasons (V1) - ReferralSources (V1) - Dental Labs (V1) - MedicalAlertCategories (V1) - MedicalAlertReactions (V1) - MedicalAlertSeverities (V1) - ColorCategories (V1) - name: Excluded Procedures & Exceptions tags: - InsuranceCarrierWithExcludedProcedure (V1) - LocationWithExcludedProcedure (V1) - name: Utility & Count Endpoints tags: - Transactions (V1) - TransactionTags (V1) - ICD10s (V1) - PatientTeethV1 - Exams (V1) - Total Count (V1) - name: Miscellaneous tags: - GlobalInsuranceCarriers (V1) - Users (V1) - Visits (V1)