openapi: 3.0.0 info: title: Public API description: Operations related to patients, appointments, providers and so on. version: 181.0.3 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: Invalid request (missing or invalid parameters) 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: Invalid client credentials content: application/json: schema: type: object properties: error: type: string example: invalid_client message: type: string example: Invalid client credentials '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: Server error 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: OK content: application/json: schema: $ref: '#/components/schemas/LinkedOrgsV1' example: organizations: - organizations examples: default: value: organizations: - organizations '400': description: Bad request '401': description: Unauthorized '403': description: Forbidden '429': description: Rate limit exceeded '500': description: Unexpected error 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 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 schema: type: string example: 1006 - name: filter in: query required: true description: >- Aging balance report filters (comma-separated clauses). Use comma-separated `key==value` or `key->[...]` clauses; URL-encode the full string. **Valid filter keys (this endpoint)** - **location.id (==):** REQUIRED - ?filter=location.id==123: Retrieves resources where location.id equals 123. - **patient.id (->):** Optional, but you need to use either patient.id or page. All patient.id must be guarantor patients. 50 Guarantors max. - ?filter=patient.id->[456,789]: Retrieves resources where patient.id is either 456 or 789. - **page (==):** Optional, but you need to use either patient.id or page. Page filter will allow you to get locations entire data through pagination. - ?filter=page==1: Retrieves page 1 of the results for the specified location data. - ?filter=page==2: Retrieves page 2 of the results for the specified location data. - **balance (==, !=, >, >=, <, <=):** Optional - Filters results based on total balance dollar amount. - ?filter=balance>=1: Retrieves patients where total balance is $1 or more (useful for excluding patients with zero balances). - ?filter=balance>100: Retrieves patients where total balance is greater than $100. - ?filter=balance==0: Retrieves patients with zero balance. - **thirtyDays (==, !=, >, >=, <, <=):** Optional - Filters results based on dollar amount in the 31-60 days aging bucket. - ?filter=thirtyDays>0: Retrieves patients with any dollar amount in their 31-60 day aging bucket. - ?filter=thirtyDays>=100: Retrieves patients with $100 or more in 31-60 day old charges. - ?filter=thirtyDays==0: Retrieves patients with no balance in the 31-60 day aging bucket. - **sixtyDays (==, !=, >, >=, <, <=):** Optional - Filters results based on dollar amount in the 61-90 days aging bucket. - ?filter=sixtyDays>0: Retrieves patients with any dollar amount in their 61-90 day aging bucket. - ?filter=sixtyDays>=100: Retrieves patients with $100 or more in 61-90 day old charges. - ?filter=sixtyDays==0: Retrieves patients with no balance in the 61-90 day aging bucket. - **ninetyDays (==, !=, >, >=, <, <=):** Optional - Filters results based on dollar amount in the 90+ days aging bucket. - ?filter=ninetyDays>0: Retrieves patients with any dollar amount in their 90+ day aging bucket. - ?filter=ninetyDays>=500: Retrieves patients with $500 or more in very old charges (useful for collections prioritization). - ?filter=ninetyDays==0: Retrieves patients with no balance in the 90+ day aging bucket. **Pagination Notes:** - When using Page filter you will get meta data only on the first page that will give you the limit for each request and the total you need to go through. - You need to paginate through all data and add everything up to get correct report numbers. The only piece of data you do not add up are the pending insurance claims for each patient. - "meta.pagination.limit" and "meta.pagination.total" in the response body of the first page refers to the number of transactions searched and remaining not the number of objects returned in response body "data" this is to prevent endpoint 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) tags: - AppointmentColor (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 - name: responseFields in: query required: false description: | - **ALL**: Returns all field names. schema: type: string style: form explode: false - name: filter in: query required: false description: > Specifies the criteria by which to filter the appointmentsColor. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2] **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), in (->), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), and less than equal to (<=). Equals operators check for exact match. Like operators perform text search for field values that start with the given value. Valid filter keys are: - **location.id (==, !=)**: - ?filter=location.id==123 (Retrieves resources where location.id equals 123) - ?filter=location.id!=123 (Retrieves resources where location.id does not equal 123) 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 ID of AppointmentColor (V1) from the 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. tags: - AppointmentColor (V1) parameters: - name: appointmentColorId in: path required: true description: ID for getting the AppointmentColor (V1). schema: type: integer format: int64 minimum: 1 example: 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/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). tags: - AppointmentColor (V1) parameters: - in: path name: appointmentColorId required: true description: ID for which to update the AppointmentColor (V1). schema: type: integer format: int64 minimum: 1 example: 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: AppointmentColor (V1) data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - AppointmentHistory (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the appointments (V1). Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2]. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), in (->), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: appointment.id (==, ->) - ?filter=appointment.id==456 (Retrieves resources where appointment.id equals 456.) ?filter=appointment.id->[123,456,789] (Retrieves resources where appointment.id includes 123, 456, or 789.) lastModified (>,>=,<,<=) - ?filter=lastModified>2025-01-01 (Retrieves resources where lastModified is after 2025-01-01.) ?filter=lastModified>=2025-01-01 (Retrieves resources where lastModified is on or after 2025-01-01.) ?filter=lastModified<2025-01-15 (Retrieves resources where lastModified is before 2025-01-15.) ?filter=lastModified<=2025-01-31 (Retrieves resources where lastModified is on or before 2025-01-31.) 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. tags: - AppointmentHistory (V1) parameters: - in: path name: appointmentHistoryId required: true description: ID for which to get the AppointmentHistoryV1. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - AppointmentStatusHistory (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the appointments (V1). Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2]. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), in (->), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: appointment.id (==, ->) - ?filter=appointment.id==456 (Retrieves resources where appointment.id equals 456.) ?filter=appointment.id->[123,456,789] (Retrieves resources where appointment.id includes 123, 456, or 789.) lastModified (>,>=,<,<=) - ?filter=lastModified>2025-01-01 (Retrieves resources where lastModified is after 2025-01-01.) ?filter=lastModified>=2025-01-01 (Retrieves resources where lastModified is on or after 2025-01-01.) ?filter=lastModified<2025-01-15 (Retrieves resources where lastModified is before 2025-01-15.) ?filter=lastModified<=2025-01-31 (Retrieves resources where lastModified is on or before 2025-01-31.) 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. tags: - AppointmentStatusHistory (V1) parameters: - in: path name: appointmentStatusHistoryId required: true description: ID for which to get the AppointmentStatusHistoryV1. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Appointments (V1) 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: filter in: query required: false description: > A url encoded comma-delimited list of field names to include in the response data. Additionally, the following values are also supported: ALL - Returns all field names. Specifies the criteria by which to filter the appointments (V1). Filters are of the form: **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. - ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2]. **Valid Filter Keys with Operators:** - **id (->):** - ?filter=id->[123, 124]: Retrieves resources where id is in the list [123, 124]. - **needsFollowUp (==, !=):** - ?filter=needsFollowUp==true: Retrieves resources where needsFollowUp is true. - ?filter=needsFollowUp==false: Retrieves resources where needsFollowUp is false. - **status (==):** - ?filter=status==LATE: Retrieves resources where status is LATE. - ?filter=status==HERE: Retrieves resources where status is HERE. - ?filter=status==READY: Retrieves resources where status is READY. - ?filter=status==CHAIR: Retrieves resources where status is CHAIR. - ?filter=status==COMPLETED: Retrieves resources where status is COMPLETED. - ?filter=status==CONFIRMED: Retrieves resources where status is CONFIRMED. - ?filter=status==UNCONFIRMED: Retrieves resources where status is UNCONFIRMED. - ?filter=status==NO_SHOW: Retrieves resources where status is NO_SHOW. - ?filter=status==BROKEN: Retrieves resources where status is BROKEN. - ?filter=status==LEFT_MESSAGE: Retrieves resources where status is LEFT_MESSAGE. - ?filter=status==CHECKOUT: Retrieves resources where status is CHECKOUT. - ?filter=status==WILL_CALL: Retrieves resources where status is WILL_CALL. - ?filter=status==UNREACHABLE: Retrieves resources where status is UNREACHABLE. - ?filter=status==CANCELLEDBYOFFICE: Retrieves resources where status is CANCELLEDBYOFFICE. - **status (!=):** - ?filter=status!=LATE: Retrieves resources where status is not LATE. - ?filter=status!=HERE: Retrieves resources where status is not HERE. - ?filter=status!=READY: Retrieves resources where status is not READY. - ?filter=status!=CHAIR: Retrieves resources where status is not CHAIR. - ?filter=status!=COMPLETED: Retrieves resources where status is not COMPLETED. - ?filter=status!=CONFIRMED: Retrieves resources where status is not CONFIRMED. - ?filter=status!=UNCONFIRMED: Retrieves resources where status is not UNCONFIRMED. - ?filter=status!=NO_SHOW: Retrieves resources where status is not NO_SHOW. - ?filter=status!=BROKEN: Retrieves resources where status is not BROKEN. - ?filter=status!=LEFT_MESSAGE: Retrieves resources where status is not LEFT_MESSAGE. - ?filter=status!=CHECKOUT: Retrieves resources where status is not CHECKOUT. - ?filter=status!=WILL_CALL: Retrieves resources where status is not WILL_CALL. - ?filter=status!=UNREACHABLE: Retrieves resources where status is not UNREACHABLE. - ?filter=status!=CANCELLEDBYOFFICE: Retrieves resources where status is not CANCELLEDBYOFFICE. - **patient.id (==, !=):** - ?filter=patient.id==789: Retrieves resources where patient.id equals 789. - ?filter=patient.id!=789: Retrieves resources where patient.id does not equal 789. - **operatory.id (==, !=, ->):** - ?filter=operatory.id==123: Retrieves resources where operatory.id equals 123. - ?filter=operatory.id!=123: Retrieves resources where operatory.id does not equal 123. - ?filter=operatory.id->[123, 456]: Retrieves resources where operatory.id is either 123 or 456. - **location.id (==, !=, ->):** - ?filter=location.id==456: Retrieves resources where location.id equals 456. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves resources across all locations. - ?filter=location.id!=456: Retrieves resources where location.id does not equal 456. - ?filter=location.id->[123, 456]: Retrieves resources where location.id is either 123 or 456. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests results across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **provider.id (==, !=, ->):** - ?filter=provider.id==789: Retrieves resources where provider.id equals 789. - ?filter=provider.id!=789: Retrieves resources where provider.id does not equal 789. - ?filter=provider.id->[789, 101]: Retrieves resources where provider.id is either 789 or 101. - **asap (==):** - ?filter=asap==true: Retrieves resources where asap is true. - ?filter=asap==false: Retrieves resources where asap is false. When filtering by dates (like lastModified), you should use the lastId parameter to cycle through records as they are sorted by id. start (>, <, >=, and <=) - ?filter=start>2025-01-01 (Retrieves resources where start is after 2025-01-01) ?filter=start<2025-01-01 (Retrieves resources where start is before 2025-01-01) ?filter=start>=2025-01-01 (Retrieves resources where start is on or after 2025-01-01) ?filter=start<=2025-01-01 (Retrieves resources where start is on or before 2025-01-01) - **start (>, <, >=, <=):** - ?filter=start>2025-01-01: Retrieves resources where start is after 2025-01-01. - ?filter=start<2025-01-01: Retrieves resources where start is before 2025-01-01. - ?filter=start>=2025-01-01: Retrieves resources where start is on or after 2025-01-01. - ?filter=start<=2025-01-01: Retrieves resources where start is on or before 2025-01-01. - **lastModified (>, <, >=, <=):** - ?filter=lastModified>2025-01-01: Retrieves resources where lastModified is after 2025-01-01. - ?filter=lastModified<2025-01-01: Retrieves resources where lastModified is before 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves resources where lastModified is on or after 2025-01-01. - ?filter=lastModified<=2025-01-01: Retrieves resources where lastModified is on or before 2025-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: 20 - name: lastId in: query required: false description: The biggest appointmentId from the 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 tags: - Appointments (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: AppointmentV1 data 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 tags: - Appointments (V1) 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. Supported values: - **ALL**: Returns all field names. - Example: id, name, created, patient.id schema: type: string example: id, name, created, patient.id style: form explode: false - name: filter in: query required: false description: > Specifies the criteria by which to filter the appointments. Filters are of the form: - filter=filter1==filter1Value, filter2>=filter2Value **Valid operators:** - equals (==) - not equals (!=) - like (~=) - not like (<>=) - greater than (>) - greater than or equal to (>=) - less than (<) - less than or equal to (<=) - in (->) Specifies the criteria by which to filter the appointments (V1). Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2]. **Valid Filter Keys with Operators:** - **id (->):** - ?filter=id->[123, 124]: Retrieves resources where id is in the list [123, 124]. - **needsFollowUp (==, !=):** - ?filter=needsFollowUp==true: Retrieves resources where needsFollowUp is true. - ?filter=needsFollowUp==false: Retrieves resources where needsFollowUp is false. - **status (==):** - ?filter=status==LATE: Retrieves resources where status is LATE. - ?filter=status==HERE: Retrieves resources where status is HERE. - ?filter=status==READY: Retrieves resources where status is READY. - ?filter=status==CHAIR: Retrieves resources where status is CHAIR. - ?filter=status==COMPLETED: Retrieves resources where status is COMPLETED. - ?filter=status==CONFIRMED: Retrieves resources where status is CONFIRMED. - ?filter=status==UNCONFIRMED: Retrieves resources where status is UNCONFIRMED. - ?filter=status==NO_SHOW: Retrieves resources where status is NO_SHOW. - ?filter=status==BROKEN: Retrieves resources where status is BROKEN. - ?filter=status==LEFT_MESSAGE: Retrieves resources where status is LEFT_MESSAGE. - ?filter=status==CHECKOUT: Retrieves resources where status is CHECKOUT. - ?filter=status==WILL_CALL: Retrieves resources where status is WILL_CALL. - ?filter=status==UNREACHABLE: Retrieves resources where status is UNREACHABLE. - ?filter=status==CANCELLEDBYOFFICE: Retrieves resources where status is CANCELLEDBYOFFICE. - **status (!=):** - ?filter=status!=LATE: Retrieves resources where status is not LATE. - ?filter=status!=HERE: Retrieves resources where status is not HERE. - ?filter=status!=READY: Retrieves resources where status is not READY. - ?filter=status!=CHAIR: Retrieves resources where status is not CHAIR. - ?filter=status!=COMPLETED: Retrieves resources where status is not COMPLETED. - ?filter=status!=CONFIRMED: Retrieves resources where status is not CONFIRMED. - ?filter=status!=UNCONFIRMED: Retrieves resources where status is not UNCONFIRMED. - ?filter=status!=NO_SHOW: Retrieves resources where status is not NO_SHOW. - ?filter=status!=BROKEN: Retrieves resources where status is not BROKEN. - ?filter=status!=LEFT_MESSAGE: Retrieves resources where status is not LEFT_MESSAGE. - ?filter=status!=CHECKOUT: Retrieves resources where status is not CHECKOUT. - ?filter=status!=WILL_CALL: Retrieves resources where status is not WILL_CALL. - ?filter=status!=UNREACHABLE: Retrieves resources where status is not UNREACHABLE. - ?filter=status!=CANCELLEDBYOFFICE: Retrieves resources where status is not CANCELLEDBYOFFICE. - **patient.id (==, !=):** - ?filter=patient.id==789: Retrieves resources where patient.id equals 789. - ?filter=patient.id!=789: Retrieves resources where patient.id does not equal 789. - **operatory.id (==, !=, ->):** - ?filter=operatory.id==123: Retrieves resources where operatory.id equals 123. - ?filter=operatory.id!=123: Retrieves resources where operatory.id does not equal 123. - ?filter=operatory.id->[123, 456]: Retrieves resources where operatory.id is either 123 or 456. - **location.id (==, !=, ->):** - ?filter=location.id==456: Retrieves resources where location.id equals 456. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves resources across all locations. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests results across all locations. - ?filter=location.id!=456: Retrieves resources where location.id does not equal 456. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **provider.id (==, !=, ->):** - ?filter=provider.id==789: Retrieves resources where provider.id equals 789. - ?filter=provider.id!=789: Retrieves resources where provider.id does not equal 789. - ?filter=provider.id->[789, 101]: Retrieves resources where provider.id is either 789 or 101. - **asap (==):** - ?filter=asap==true: Retrieves resources where asap is true. - ?filter=asap==false: Retrieves resources where asap is false. When filtering by dates (like lastModified), you should use the lastId parameter to cycle through records as they are sorted by id. start (>, <, >=, and <=) - ?filter=start>2025-01-01 (Retrieves resources where start is after 2025-01-01) ?filter=start<2025-01-01 (Retrieves resources where start is before 2025-01-01) ?filter=start>=2025-01-01 (Retrieves resources where start is on or after 2025-01-01) ?filter=start<=2025-01-01 (Retrieves resources where start is on or before 2025-01-01) - **start (>, <, >=, <=):** - ?filter=start>2025-01-01: Retrieves resources where start is after 2025-01-01. - ?filter=start<2025-01-01: Retrieves resources where start is before 2025-01-01. - ?filter=start>=2025-01-01: Retrieves resources where start is on or after 2025-01-01. - ?filter=start<=2025-01-01: Retrieves resources where start is on or before 2025-01-01. - **lastModified (>, <, >=, <=):** - ?filter=lastModified>2025-01-01: Retrieves resources where lastModified is after 2025-01-01. - ?filter=lastModified<2025-01-01: Retrieves resources where lastModified is before 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves resources where lastModified is on or after 2025-01-01. - ?filter=lastModified<=2025-01-01: Retrieves resources where lastModified is on or before 2025-01-01. 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 largest appointmentId from the 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. tags: - Appointments (V1) parameters: - in: path name: appointmentId required: true description: ID for which to get the AppointmentV1. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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. tags: - Appointments (V1) parameters: - in: path name: appointmentId required: true description: ID for which to update the AppointmentV1. schema: type: integer format: int64 minimum: 1 example: 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: >- Appointment data. If Linked Model Arrays (PatientProcedures, PracticeProcedures, and Visits) are included the current values will be removed and the new values inserted. To append a new Linked Model the existing values must be passed in along with the new value. 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 tags: - Appointments (V1) parameters: - name: appointmentId in: path required: true description: ID for which to delete the AppointmentV1. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Appointments (beta) 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: filter in: query required: false description: > When using Pagination one of the three filters is required. (lastId, lastModified, start) Specifies the criteria by which to filter the appointments (V1). Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2]. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), in (->), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (->) - ?filter=id->[123, 456] (Retrieves resources where id is either 123 or 456) needsFollowUp (==) - ?filter=needsFollowUp==true (Retrieves resources where needsFollowUp is true) ?filter=needsFollowUp==false (Retrieves resources where needsFollowUp is false) status (== and !=) - ?filter=status==ACTIVE (Retrieves resources where status is ACTIVE) ?filter=status!=INACTIVE (Retrieves resources where status is not INACTIVE) patient.id (== and !=) - ?filter=patient.id==789 (Retrieves resources where patient.id equals 789) ?filter=patient.id!=789 (Retrieves resources where patient.id does not equal 789) operatory.id (==, != and ->) - ?filter=operatory.id==123 (Retrieves resources where operatory.id equals 123) ?filter=operatory.id!=123 (Retrieves resources where operatory.id does not equal 123) ?filter=operatory.id->[123, 456] (Retrieves resources where operatory.id is either 123 or 456) location.id (== and != and ->) - ?filter=location.id==456 (Retrieves resources where location.id equals 456) ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) ?filter=location.id!=456 (Retrieves resources where location.id does not equal 456) ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). provider.id (==, != and ->) - ?filter=provider.id==789 (Retrieves resources where provider.id equals 789) ?filter=provider.id!=789 (Retrieves resources where provider.id does not equal 789) ?filter=provider.id->[789, 101] (Retrieves resources where provider.id is either 789 or 101) asap (==) - ?filter=asap==true (Retrieves resources where asap is true) ?filter=asap==false (Retrieves resources where asap is false) When filtering by start or lastModified, the results will be returned in descending order for greater performance. If combined with lastId for pagination in the request, the lastId will be ignored. In order to getting next page, please reset start or lastModified less than in the request filter. start (>, <, >=, and <=) - ?filter=start>2025-01-01 (Retrieves resources where start is after 2025-01-01) ?filter=start<2025-01-01 (Retrieves resources where start is before 2025-01-01) ?filter=start>=2025-01-01 (Retrieves resources where start is on or after 2025-01-01) ?filter=start<=2025-01-01 (Retrieves resources where start is on or before 2025-01-01) lastModified (>=, >, <=, and <) ?filter=lastModified>2025-01-01 (Retrieves resources where lastModified is after 2025-01-01) ?filter=lastModified<2025-01-01 (Retrieves resources where lastModified is before 2025-01-01) ?filter=lastModified>=2025-01-01 (Retrieves resources where lastModified is on or after 2025-01-01) ?filter=lastModified<=2025-01-01 (Retrieves resources where lastModified is on or before 2025-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 appointmentId from previous page schema: type: string responses: '200': description: OK 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 tags: - Appointments (beta) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Appointment data 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. tags: - Appointments (beta) parameters: - in: path name: appointmentId required: true description: ID for which to get the Appointment. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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: OK 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. tags: - Appointments (beta) parameters: - in: path name: appointmentId required: true description: ID for which to update the Appointment. 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: >- Appointment data. If Linked Model Arrays (PatientProcedures, PracticeProcedures, and Visits) are included the current values will be removed and the new values inserted. To append a new Linked Model the existing values must be passed in along with the new value. 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: OK 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 tags: - Appointments (beta) parameters: - name: appointmentId in: path required: true description: ID for which to delete the Appointment. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true schema: type: string example: 1006 responses: '200': description: OK 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 tags: - AppointmentTasks (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the appointment tasks (V1). Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), in (->), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (==, !=, ->) - ?filter=id==123 (Retrieves resources where id equals 123) ?filter=id!=123 (Retrieves resources where id does not equal 123) ?filter=id->[123, 456] (Retrieves resources where id is either 123 or 456) appointment.id (==, !=, ->) - ?filter=appointment.id==789 (Retrieves resources where appointment.id equals 789) ?filter=appointment.id!=789 (Retrieves resources where appointment.id does not equal 789) ?filter=appointment.id->[789, 101] (Retrieves resources where appointment.id is either 789 or 101) 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 tags: - AppointmentTasks (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: AppointmentTaskV1 data 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. tags: - AppointmentTasks (V1) parameters: - in: path name: appointmentTaskId required: true description: ID for which to get the AppointmentTaskV1. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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. tags: - AppointmentTasks (V1) parameters: - in: path name: appointmentTaskId required: true description: ID for which to update the AppointmentTaskV1. schema: type: integer format: int64 minimum: 1 example: 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: AppointmentTaskV1 data. 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 tags: - AppointmentTasks (V1) parameters: - name: appointmentTaskId in: path required: true description: ID for which to delete the AppointmentTaskV1. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Audits (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the audits. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (->) - ?filter=id->[1000000020702,1000000020703] (Retrieves resources where id is one of the provided values, e.g., 1000000020702 or 1000000020703) location.id (->) - ?filter=location.id->[123,124] (Retrieves resources where location.id is one of the provided values, e.g., 123 or 124) onlineUser.id (==) - ?filter=onlineUser.id==567 (Retrieves resources where onlineUser.id equals 567) patient.id (==) - ?filter=patient.id==890 (Retrieves resources where patient.id equals 890) date (>, <, >=, and <=) - ?filter=date>=2025-01-01 (Retrieves resources where date is greater than or equal to 2025-01-01) ?filter=date<=2025-01-15 (Retrieves resources where date is less than or equal to 2025-01-15) description (~=) - ?filter=description~=urgent (Retrieves resources where description contains the substring "urgent" - case insensitive) auditType (->) - ?filter=auditType->[CREATE, UPDATE] (Retrieves resources where auditType matches one or more values in the list, e.g., "CREATE" or "UPDATE") action (->) - ?filter=action->[CREATE, DELETE] (Retrieves resources where action matches one or more values in the list, e.g., "CREATE" or "DELETE") 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - BulkInsurancePayments (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the bulk insurance payments. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), and less than equal to (<=). Equals operators check for exact match. Like operators perform text search for field values that start with the given value. Valid filter keys are: - **id (==, ->)**: - ?filter=id==12 (Retrieves bulkInsurancePayment with id equal to 12) - ?filter=id->[12,13] (Retrieves bulkInsurancePayments with ids 12 and 13) - **location.id (==, ->)**: - ?filter=location.id==12 (Retrieves resources where location.id equals 12) - **insuranceCarrier.id (==, ->)**: - ?filter=insuranceCarrier.id==12 (Retrieves resources where insuranceCarrier.id equals 12) - **insuranceClaim.id (==)**: - ?filter=insuranceClaim.id==12 (Retrieves resources where insuranceClaim.id equals 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 bulk insurance payment ID from the 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. tags: - BulkInsurancePayments (V1) parameters: - in: path name: bulkInsurancePaymentId required: true description: the ID of Bulk Insurance Payment. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - CarrierInsurancePlanCoordinationOfBenefits (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the carrier insurance plan coordination of benefits. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), and less than equal to (<=). Equals operators check for exact match. Like operators perform text search for field values that start with the given value. Valid filter keys are: - **carrierInsurancePlan.id (==, ->)**: - ?filter=carrierInsurancePlan.id==12 (Retrieves resources where carrierInsurancePlan.id equals 12) - ?filter=carrierInsurancePlan.id->[12, 13] (Retrieves resources where carrierInsurancePlan.id is either 12 or 13) 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 the 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - CarrierInsurancePlans (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the carrier insurance plans. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), and less than equal to (<=). Equals operators check for exact match. Like operators perform text search for field values that start with the given value. Valid filter keys are: - **id (==, ->)**: - ?filter=id==12 (Retrieves carrierInsurancePlan with id equal to 12) - ?filter=id->[12,13] (Retrieves carrierInsurancePlans with ids 12 and 13) - **insuranceCarrier.id (==, ->)**: - ?filter=insuranceCarrier.id==12 (Retrieves resources where insuranceCarrier.id equals 12) - **lastModified (>=, >, <=, <)**: - ?filter=lastModified>=2022-01-01 (Retrieves resources where lastModified is greater than or equal to 2022-01-01) - ?filter=lastModified<2022-01-01 (Retrieves resources where lastModified is less than 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 insurance plan ID from the 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. tags: - CarrierInsurancePlans (V1) parameters: - name: carrierInsurancePlanId in: path required: true description: carrierInsurancePlanId for which to get the carrier insurance plan model. schema: type: integer format: int64 minimum: 1 example: 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - CarrierPlanCopayExceptions (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the carrier plan copay exceptions. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (== and ->) - Example: ?filter=id==12 (Retrieves carrierPlanCopayExceptionId with ids equal to 12), ?filter=id->[12,13] (Retrieves carrierPlanCopayExceptionId with ids containing 12 and 13) carrierInsurancePlan.id (==) - example: ?filter=carrierPlanCopayExceptionId.id==12 (Retrieves carrierInsurancePlanId with id of 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. tags: - CarrierPlanCopayExceptions (V1) parameters: - in: path name: carrierPlanCopayExceptionId required: true description: the ID of Carrier Plan Copay Exception. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - CarrierPlanCoverageExceptions (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the carrier plan coverage exceptions. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (== and ->) - Example: ?filter=id==12 (Retrieves carrierPlanCoverageExceptionId with ids equal to 12), ?filter=id->[12,13] (Retrieves carrierPlanCoverageExceptionId with ids containing 12 and 13) carrierInsurancePlan.id (==) - example: ?filter=carrierInsurancePlan.id==12 (Retrieves carrierInsurancePlan with id of 12) lastModified (>=, >, <=, and <) - Examples: ?filter=lastModified>=2022-01-01 (Retrieves carrierPlanCoverageExceptionId with lastModified date greater than or equal to "2022-01-01"), ?filter=lastModified<2022-01-01 (Retrieves carrierPlanCoverageExceptionId with lastModified date less than "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. tags: - CarrierPlanCoverageExceptions (V1) parameters: - in: path name: carrierPlanCoverageExceptionId required: true description: the ID of Carrier Plan Coverage Exception. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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: | Submits a request to create the same set of coverage exceptions on multiple carrier insurance plans. The operation runs asynchronously. This endpoint returns immediately with a correlation ID and routing key; when processing completes, the result is delivered via the Streaming API. **Limits:** - At most 100 carrier insurance plan IDs per request - At most 30 exception templates per request parameters: - name: Organization-ID in: header required: true schema: type: string example: '400000000' description: Organization identifier 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: Invalid request (e.g. invalid body, empty arrays, or validation errors) '401': description: Authentication is required and has failed or has not been provided '403': description: Forbidden. '404': description: The requested resource is missing or 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 tags: - CarrierPlanDeductibles (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the carrier plan deductibles. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (== and ->) - Example: ?filter=id==12 (Retrieves CarrierPlanDeductibles with ids equal to 12), ?filter=id->[12,13] (Retrieves CarrierPlanDeductibles with ids containing 12 and 13) lastModified (>=, >, <=, and <) - Examples: ?filter=lastModified>=2022-01-01 (Retrieves CarrierPlanDeductibles with lastModified date greater than or equal to "2022-01-01"), ?filter=lastModified<2022-01-01 (Retrieves CarrierPlanDeductibles with lastModified date less than "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. tags: - CarrierPlanDeductibles (V1) parameters: - in: path name: carrierPlanDeductibleId required: true description: the ID of Carrier Plan Deductible. schema: type: integer format: int64 minimum: 1 example: 3 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - ClinicalNotePrompts (V1) 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 - name: filter in: query required: false description: > Specifies the criteria by which to filter the clinicalNoteprompts. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), IN (->), greater than (>), greater than equal to (>=), less than (<), and less than equal to (<=). Equals operators check for exact match. Like operators perform text search for field values that start with the given value. Valid filter keys are: - **id and location.id (==)**: - ?filter=id==12;location.id==5 (Retrieves clinicalNotePrompt where id equals 12 and location.id equals 5) - ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves prompts across all locations) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **id and name (->)**: - ?filter=id->[12,13];name->[John,Doe] (Retrieves clinicalNotePrompt where id contains 12 or 13 and name contains John or 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 the 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 tags: - ClinicalNotePrompts (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: ClinicalNotePrompt data 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. tags: - ClinicalNotePrompts (V1) parameters: - name: promptId in: path required: true description: the promptId for getting clinicalNotePrompt model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - ClinicalNotePrompts (V1) parameters: - in: path name: promptId required: true description: ID of the clinicalNotePrompt for which to update the clinicalNotePrompt model. schema: type: integer format: int64 minimum: 1 example: 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: ClinicalNotePrompt data 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 tags: - ClinicalNotePrompts (V1) parameters: - name: promptId in: path required: true description: promptId for which to delete the clinicalNotePrompt model. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - ClinicalNotePrompts (V1) 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 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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. tags: - ClinicalNotes (V1) 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 - 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`, `lastModified>=2022-01-01`, `datedAs>=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 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 tags: - ClinicalNotes (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: ClinicalNote data 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. tags: - ClinicalNotes (V1) parameters: - name: clinicalNoteId in: path required: true description: the clinicalNoteId for getting clinicalNote model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - ClinicalNotes (V1) parameters: - in: path name: clinicalNoteId required: true description: ID of the clinicalNote for which to update the clinicalNote model. schema: type: integer format: int64 minimum: 1 example: 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: ClinicalNote data 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 tags: - ClinicalNotes (V1) parameters: - name: clinicalNoteId in: path required: true description: clinicalNoteId for which to delete the clinicalNote model. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - ClinicalNoteTemplates (V1) 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 - name: filter in: query required: false description: > Specifies the criteria by which to filter the clinicalNoteTemplates. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), IN (->), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (->) and location.id (== and ->) - ?filter=id->[12,13];location.id==5 (Retrieves resources where id contains 12 or 13 and location.id equals 5). You can also use ?filter=location.id==ALL or ?filter=location.id==\* to retrieve results across all locations. Or use ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] to explicitly request results across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["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 tags: - ClinicalNoteTemplates (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: ClinicalNoteTemplate data 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. tags: - ClinicalNoteTemplates (V1) parameters: - name: templateId in: path required: true description: the clinicalNoteTemplateId for getting clinicalNoteTemplate model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - ClinicalNoteTemplates (V1) parameters: - in: path name: templateId required: true description: ID of the clinicalNoteTemplate for which to update the clinicalNoteTemplate model. schema: type: integer format: int64 minimum: 1 example: 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: ClinicalNoteTemplate data 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 tags: - ClinicalNoteTemplates (V1) parameters: - name: templateId in: path required: true description: clinicalNoteTemplateId for which to delete the clinicalNoteTemplate model. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - ClinicalNoteTemplates (V1) 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 - name: filter in: query required: false description: > Specifies the criteria by which to filter the globalClinicalNoteTemplates. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. Valid operators are equals(==), not equals(!=), IN (->), like(~=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: name (== and ~=) - ?filter=name==John;name~=Jo (Retrieves resources where the name is exactly "John" and also contains "Jo" in other cases) 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - ClinicalNoteTemplateUserFavorites (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the recares. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), IN (->), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: user.id (->) - ?filter=user.id->[101,102] (Retrieves resources where user.id contains 101 or 102) clinicalNoteTemplate.id (->) - ?filter=clinicalNoteTemplateUserFavorite.id->[201,202] (Retrieves resources where clinicalNoteTemplateUserFavorite.id contains 201 or 202) 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 tags: - ClinicalNoteTemplateUserFavorites (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Create user favorite clinicalNoteTemplate 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 tags: - ClinicalNoteTemplateUserFavorites (V1) parameters: - name: Organization-ID in: header required: true 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 tags: - ColorCategories (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the colorCategories (V1). Filters are of the form ?filter=filter1==filter1Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators is equals (==). Equals operators check for exact match. Valid filter keys are: location.id ( == and -> ) - ?filter=location.id==123 (Retrieves resources where location.id equals 123). You can also use ?filter=location.id==ALL or ?filter=location.id==\* to retrieve results across all locations. You can also use ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations). - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). isDefault ( == ) - ?filter=isDefault==true (Retrieves resources where isDefault is true) ?filter=isDefault==false (Retrieves resources where isDefault is false) 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 ID of ColorCategory (V1) 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 tags: - ColorCategories (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: ColorCategoryV1 data 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. tags: - ColorCategories (V1) parameters: - name: colorCategoryId in: path required: true description: ID for getting the ColorCategory (V1). 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/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). tags: - ColorCategories (V1) parameters: - in: path name: colorCategoryId required: true description: ID for which to update the ColorCategory (V1). 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: ColorCategory (V1) data 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 tags: - ColorCategories (V1) parameters: - name: colorCategoryId in: path required: true description: ID for deleting the ColorCategory (V1). schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - CoverageProcedureCopays (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the procedure copays. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=) or contains (->). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (== and ->) - ?filter=id==1000000020702 (Retrieves resources where id equals 1000000020702) ?filter=id->[1000000020702,1000000020703] (Retrieves resources where id contains 1000000020702 or 1000000020703) practiceProcedure.id (==, ->) - ?filter=CoverageProcedureCopays.id==3001 (Retrieves resources where CoverageProcedureCopays.id equals 3001) ?filter=CoverageProcedureCopays.id->[3001,3002,3003] (Retrieves resources where CoverageProcedureCopays.id contains 3001, 3002, or 3003) carrierInsurancePlan.id (==) - ?filter=CoverageProcedureCopays.id==4005 (Retrieves resources where CoverageProcedureCopays.id equals 4005) 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. tags: - CoverageProcedureCopays (V1) parameters: - in: path name: coverageProcedureCopayId required: true description: ID of the coverage procedure copay for which to get the coverage procedure copay model. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - CoverageProcedureRanges (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the procedure ranges. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=) or contains (->). Equals operators check for exact match, like operators perform text search for field values that start with the given value. **Valid Filter Keys with Operators:** - **id (== and ->)**: - ?filter=id==1000000020702 (Retrieves resources where id equals 1000000020702) - ?filter=id->[1000000020702,1000000020703] (Retrieves resources where id is in the list) - **rangeStart (==)**: - ?filter=rangeStart==D3000 (Retrieves resources where rangeStart is exactly D3000) - **rangeEnd (==)**: - ?filter=rangeEnd==D3999 (Retrieves resources where rangeEnd is exactly D3999) - **carrierInsurancePlan.id (==)**: - ?filter=carrierInsurancePlan.id==4005 (Retrieves resources where carrierInsurancePlan.id equals 4005) - **lastModified (>, <, >=, and <=)**: - ?filter=lastModified>2025-01-01T00:00:00Z (After January 1, 2025) - ?filter=lastModified<2025-01-31T23:59:59Z (Before January 31, 2025) - ?filter=lastModified>=2025-01-01T00:00:00Z (On or after January 1, 2025) - ?filter=lastModified<=2025-01-31T23:59:59Z (On or before January 31, 2025) **Examples of Valid Filters:** - ?filter=rangeStart==D3000 - ?filter=id->[1000000020702,1000000020703] 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 the 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. tags: - CoverageProcedureRanges (V1) parameters: - in: path name: coverageProcedureRangeId required: true description: ID of the coverage procedure range for which to get the coverage procedure range model. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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. When filtering by lastModified, the results will be returned in descending order for greater performance, meaning the newest data will appear first. Previously, results were returned in ascending order, which displayed the oldest entries first. This query is indexed off of descending order. 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - CoverageProcedureRangeTemplates (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the procedure ranges. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=) or contains (->). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (->) - ?filter=id->[1000000020702,1000000020703] (Retrieves resources where id contains 1000000020702 or 1000000020703) 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: OK 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: uthentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does 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. tags: - CoverageProcedureRangeTemplates (V1) parameters: - in: path name: coverageProcedureRangeTemplateId required: true description: ID of the coverage procedure range for which to get the coverage procedure range model. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - DayNotes (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the day notes. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2]. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **date (>, <, >=, <=):** - ?filter=date>2025-01-01: Retrieves resources where the date is after 2025-01-01. - ?filter=date<2025-01-10: Retrieves resources where the date is before 2025-01-10. - ?filter=date>=2025-01-01: Retrieves resources where the date is on or after 2025-01-01. - ?filter=date<=2025-01-10: Retrieves resources where the date is on or before 2025-01-10. - **location.id (==, != and ->):** - ?filter=location.id==123: Retrieves resources where location.id equals 123. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves resources across all locations. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests results across all locations. - ?filter=location.id!=123: Retrieves resources where location.id does not equal 123. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["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 day note Id from the 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 tags: - DayNotes (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Day Note data 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. tags: - DayNotes (V1) parameters: - name: dayNoteId in: path required: true description: ID of the day note for which to get the day note model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - DayNotes (V1) parameters: - in: path name: dayNoteId required: true description: ID of the day note for which to update the day note model. schema: type: integer format: int64 minimum: 1 example: 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: Day Note data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - DefaultPlanCoverages (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the default plan coverages. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2]. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (==, ->):** - ?filter=id==1000000020702: Retrieves resources where id equals 1000000020702. - ?filter=id->[1000000020702,1000000020703]: Retrieves resources where id is either 1000000020702 or 1000000020703. - **name (==, ~=):** - ?filter=name==John: Retrieves resources where name equals 'John'. - ?filter=name~=Jo: Retrieves resources where name starts with 'Jo'. 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 the 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. tags: - DefaultPlanCoverages (V1) parameters: - in: path name: defaultPlanCoverageId required: true description: ID of the default plan coverage for which to get the default plan coverage model. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Dental Labs (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the dental labs. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2]. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **name (==, !=, ~=, <>=):** - ?filter=name==John: Retrieves resources where name equals 'John'. - ?filter=name!=John: Retrieves resources where name does not equal 'John'. - ?filter=name~=Jo: Retrieves resources where name starts with 'Jo'. - ?filter=name<>=Jo: Retrieves resources where name does not start with 'Jo'. - **id (->):** - ?filter=id->[1000000020702,1000000020703]: Retrieves resources where id is either 1000000020702 or 1000000020703. 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 the 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 tags: - Dental Labs (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Dental Lab data 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. tags: - Dental Labs (V1) parameters: - name: dentalLabId in: path required: true description: ID of the dental lab for which to get the dental lab model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - Dental Labs (V1) parameters: - in: path name: dentalLabId required: true description: ID of the dental lab for which to update the dental lab model. schema: type: integer format: int64 minimum: 1 example: 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: Dental Lab data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Documents (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the documents. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2]. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **ownerOrganization.id (==):** - ?filter=ownerOrganization.id==123: Retrieves resources where ownerOrganization.id equals 123. - **ownerPatient.id (==):** - ?filter=ownerPatient.id==456: Retrieves resources where ownerPatient.id equals 456. - **ownerPerioExam.id (==):** - ?filter=ownerPerioExam.id==789: Retrieves resources where ownerPerioExam.id equals 789. - **tags (->):** - ?filter=tags->[tag1, tag2, tag3]: Retrieves resources where tags match any of the provided values. 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 the 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 operationId: GetDocumentsV1 post: summary: Returns document which has been created tags: - Documents (V1) parameters: - name: Organization-ID in: header required: true 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 operationId: PostDocumentsV1 /v1/documents/{documentId}: get: summary: Returns a document by documentId. tags: - Documents (V1) parameters: - name: documentId in: path required: true description: the documentId for getting document model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - Documents (V1) parameters: - in: path name: documentId required: true description: ID of the document for which to update the document model. schema: type: integer format: int64 minimum: 1 example: 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: Document data 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 tags: - Documents (V1) parameters: - name: documentId in: path required: true description: documentId for which to delete the document model. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - DocumentTags (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the insurance claims. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **name (== and ~=):** - ?filter=name==John (Retrieves resources where name equals 'John') ?filter=name~=Jo (Retrieves resources where name starts with 'Jo') - **lastModified (>=, >, <=, <):** - ?filter=lastModified>=2022-01-01: Retrieves documentTag with lastModified date greater than or equal to 2022-01-01. - ?filter=lastModified>2022-01-01: Retrieves documentTag with lastModified date strictly greater than 2022-01-01. - ?filter=lastModified<=2022-01-01: Retrieves documentTag with lastModified date less than or equal to 2022-01-01. - ?filter=lastModified<2022-01-01: Retrieves documentTag with lastModified date strictly less than 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 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 schema: type: string example: 1006 requestBody: description: Event data to create 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 schema: type: string 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, title, start, end, duration schema: type: string example: id, title, start, end, duration style: form explode: false - name: filter in: query required: false description: > Specifies the criteria by which to filter the events. Filters are of the form: - filter=filter1==filter1Value, filter2>=filter2Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid operators:** - equals (==) - not equals (!=) - like (~=) - not like (<>=) - greater than (>) - greater than or equal to (>=) - less than (<) - less than or equal to (<=) - in (->) - absent (.absent) - present (.present) **Valid Filter Keys with Operators:** - **id (->):** - ?filter=id->[123, 456]: Retrieves resources where id is either 123 or 456. - **title (==, !=, ~=, <>=):** - ?filter=title==exactTitle: Retrieves resources where title equals exactTitle. - ?filter=title!=exactTitle: Retrieves resources where title is not equals exactTitle. - ?filter=title~=partialTitle: Retrieves resources where title likes partialTitle. - ?filter=title<>=partialTitle: Retrieves resources where title doesn't like partialTitle. - **start (>, <, >=, <=):** - ?filter=start>2025-01-01: Retrieves resources where start is after 2025-01-01. - ?filter=start<2025-01-01: Retrieves resources where start is before 2025-01-01. - ?filter=start>=2025-01-01: Retrieves resources where start is on or after 2025-01-01. - ?filter=start<=2025-01-01: Retrieves resources where start is on or before 2025-01-01. - **operatory.id (==, !=, ->):** - ?filter=operatory.id==123: Retrieves resources where operatory.id equals 123. - ?filter=operatory.id!=123: Retrieves resources where operatory.id does not equal 123. - ?filter=operatory.id->[123, 456]: Retrieves resources where operatory.id is either 123 or 456. - **location.id (==, !=, ->):** - ?filter=location.id==456: Retrieves resources where location.id equals 456. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves resources where location.id equals all locations. - ?filter=location.id!=456: Retrieves resources where location.id does not equal 456. - ?filter=location.id->[123,456]: Retrieves resources at any of the listed locations. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests events across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **lastModified (>=, >, <=, <):** - ?filter=lastModified>2025-01-01: Retrieves resources where lastModified is after 2025-01-01. - ?filter=lastModified<2025-01-01: Retrieves resources where lastModified is before 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves resources where lastModified is on or after 2025-01-01. - ?filter=lastModified<=2025-01-01: Retrieves resources where lastModified is on or before 2025-01-01. - **groupId (==):** - ?filter=groupId==somegroupID: Retrieves resources where groupId equals somegroupID. 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. default value is 1 schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control. default value is 100 schema: type: string example: 100 - name: lastId in: query required: false description: The largest eventId from the 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 schema: type: string 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, title, start, end schema: type: string example: id, title, start, end style: form explode: false - name: filter in: query required: false description: > Specifies the criteria by which to filter the events. Filters are of the form: - filter=filter1==filter1Value, filter2>=filter2Value **Valid operators:** - equals (==) - not equals (!=) - like (~=) - not like (<>=) - greater than (>) - greater than or equal to (>=) - less than (<) - less than or equal to (<=) - in (->) - absent (.absent) - present (.present) **Valid Filter Keys with Operators:** - **id (->):** - ?filter=id->[123, 456]: Retrieves resources where id is either 123 or 456. - **title (==, !=, ~=, <>=):** - ?filter=title==exactTitle: Retrieves resources where title equals exactTitle. - ?filter=title!=exactTitle: Retrieves resources where title is not equals exactTitle. - ?filter=title~=partialTitle: Retrieves resources where title likes partialTitle. - ?filter=title<>=partialTitle: Retrieves resources where title doesn't like partialTitle. - **start (>, <, >=, <=):** - ?filter=start>2025-01-01: Retrieves resources where start is after 2025-01-01. - ?filter=start<2025-01-01: Retrieves resources where start is before 2025-01-01. - ?filter=start>=2025-01-01: Retrieves resources where start is on or after 2025-01-01. - ?filter=start<=2025-01-01: Retrieves resources where start is on or before 2025-01-01. - **operatory.id (==, !=, ->):** - ?filter=operatory.id==123: Retrieves resources where operatory.id equals 123. - ?filter=operatory.id!=123: Retrieves resources where operatory.id does not equal 123. - ?filter=operatory.id->[123, 456]: Retrieves resources where operatory.id is either 123 or 456. - **location.id (==, !=, ->):** - ?filter=location.id==456: Retrieves resources where location.id equals 456. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves resources where location.id equals all locations. - ?filter=location.id!=456: Retrieves resources where location.id does not equal 456. - ?filter=location.id->[123,456]: Retrieves resources at any of the listed locations. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests events across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to all locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **lastModified (>=, >, <=, <):** - ?filter=lastModified>2025-01-01: Retrieves resources where lastModified is after 2025-01-01. - ?filter=lastModified<2025-01-01: Retrieves resources where lastModified is before 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves resources where lastModified is on or after 2025-01-01. - ?filter=lastModified<=2025-01-01: Retrieves resources where lastModified is on or before 2025-01-01. - **groupId (==):** - ?filter=groupId==somegroupID: Retrieves resources where groupId equals somegroupID. When filtering by dates (like lastModified), you should use the lastId parameter to cycle through records as they are sorted by id. For a complete list of available filters, see the regular bulk get endpoint: **/api/v1/events** schema: type: string example: lastModified>=2019-12-18T20:31:38Z,location.id!=90000023 - name: lastId in: query required: false description: The largest eventId from the 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: The ID of the event to retrieve schema: type: integer format: int64 minimum: 1 example: 9000000903375 - 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. 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 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: The ID of the event to update schema: type: integer format: int64 minimum: 1 example: 9000000903375 - name: Organization-ID in: header required: true 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: Event data to update 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: The ID of the event to delete schema: type: integer format: int64 minimum: 1 example: 9000000903375 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Exam (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 - name: filter in: query required: true description: > Specifies the criteria by which to filter the exams. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **patient.id (==):** - ?filter=patient.id==123: Retrieves resources where patient.id equals 123. 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 tags: - Exam (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Exam data 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. tags: - Exam (V1) parameters: - in: path name: examId required: true description: the ID of Exam schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true 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 tags: - Exam (V1) parameters: - name: examId in: path required: true description: ID of the exam for which to delete the exam model. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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. tags: - Exam (V1) parameters: - in: path name: examId required: true description: ID of the exam for which to update the exam model. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID required: true schema: type: string example: 1006 requestBody: description: Exam data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - FeeScheduleAssociations (V1) parameters: - name: Organization-ID in: header required: true 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 tags: - FeeScheduleRanges (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the fee schedules. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **feeSchedule.id (==, !=, ->):** - ?filter=feeSchedule.id==123: Retrieves resources where feeSchedule.id equals 123. - ?filter=feeSchedule.id!=123: Retrieves resources where feeSchedule.id does not equal 123. - ?filter=feeSchedule.id->[123, 456]: Retrieves resources where feeSchedule.id is either 123 or 456. - **startDate (>=, >, <=, <):** - ?filter=startDate>=2022-01-01: Retrieves insuranceClaims with startDate greater than or equal to 2022-01-01. - ?filter=startDate>2022-01-01: Retrieves insuranceClaims with startDate strictly greater than 2022-01-01. - ?filter=startDate<=2022-01-01: Retrieves insuranceClaims with startDate less than or equal to 2022-01-01. - ?filter=startDate<2022-01-01: Retrieves insuranceClaims with startDate strictly less than 2022-01-01. - **endDate (>=, >, <=, <):** - ?filter=endDate>=2022-01-01: Retrieves insuranceClaims with endDate greater than or equal to 2022-01-01. - ?filter=endDate>2022-01-01: Retrieves insuranceClaims with endDate strictly greater than 2022-01-01. - ?filter=endDate<=2022-01-01: Retrieves insuranceClaims with endDate less than or equal to 2022-01-01. - ?filter=endDate<2022-01-01: Retrieves insuranceClaims with endDate strictly less than 2022-01-01. schema: type: string example: /api/v1/feescheduleranges?filter=feeSchedule.id=9000002389 - name: page in: query required: false description: Page number for pagination control. Default value is 1. schema: type: string - name: pageSize in: query required: false description: Page size for pagination control. Default value is 100. schema: type: string - name: lastId in: query required: false description: The biggest feeScheduleRangeId from the 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 tags: - FeeScheduleRanges (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: FeeScheduleRange data 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. tags: - FeeScheduleRanges (V1) parameters: - in: path name: feeScheduleRangeId required: true description: ID for getting the FeeScheduleRange. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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/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 tags: - FeeScheduleRanges (V1) parameters: - name: feeScheduleRangeId in: path required: true description: ID for updating the FeeScheduleRange. schema: type: string example: '1000000000001' - 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: FeeScheduleRange data 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 tags: - FeeScheduleRanges (V1) parameters: - name: feeScheduleRangeId in: path required: true description: ID for deleting the FeeScheduleRange. schema: type: string example: '1000000000001' - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - FeeSchedules (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the fee schedules. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (->):** - ?filter=id->[789, 101]: Retrieves resources where id is either 789 or 101. - **lastModified (>=, >, <=, <):** - ?filter=lastModified>2025-01-01: Retrieves resources where lastModified is after 2025-01-01. - ?filter=lastModified<2025-01-01: Retrieves resources where lastModified is before 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves resources where lastModified is on or after 2025-01-01. - ?filter=lastModified<=2025-01-01: Retrieves resources where lastModified is on or before 2025-01-01. 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. Default value is 1. schema: type: string - name: pageSize in: query required: false description: Page size for pagination control. Default value is 100. schema: type: string - name: lastId in: query required: false description: The biggest feeScheduleId from the 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 tags: - FeeSchedules (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: FeeSchedule data 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. tags: - FeeSchedules (V1) parameters: - in: path name: feeScheduleId required: true description: ID for getting the FeeSchedule. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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/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 tags: - FeeSchedules (V1) parameters: - in: path name: feeScheduleId required: true description: ID for updating the FeeSchedule. 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: FeeSchedule data 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 tags: - FeeSchedules (V1) parameters: - name: feeScheduleId in: path required: true description: ID for deleting the FeeSchedule. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - GlobalInsuranceCarriers (V1) 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. - **BASE_MODEL**: Returns all fields that are part of the base model. schema: type: string style: form explode: false - name: filter in: query required: false description: > Specifies the criteria by which to filter the insurance carriers. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (->):** - ?filter=id->[1000000020702,1000000020703]: Retrieves GlobalInsuranceCarriers where id is either 1000000020702 or 1000000020703. - **name (==, ~=):** - ?filter=name~=health: Retrieves GlobalInsuranceCarriers where name contains "health". - **payorId (==, ~=):** - ?filter=payorId==123: Retrieves GlobalInsuranceCarriers where payorId equals 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 global insurance carrier ID from the 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. tags: - GlobalInsuranceCarriers (V1) parameters: - name: carrierId in: path required: true description: carrierId for which to get the GlobalInsuranceCarrierV1 model. 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. BASE_MODEL - Returns all fields that are part of the base model. 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - GlobalProcedureMappingRules (V1) 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 globalProcedureMappingRuleId from the 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. tags: - GlobalProcedureMappingRules (V1) parameters: - name: globalProcedureMappingRuleId in: path required: true description: globalProcedureMappingRuleId for which to get the GlobalProcedureMappingRule model. 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - GlobalProcedures (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the operatories. Filters are of the form: - ?filter=filter1:filter1Value,filter2:filter2Value These criteria search for any name that starts with the given value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **adaCode (==, ~=):** - ?filter=adaCode~=Del.1.1: Retrieves adaCode that contains the characters "Del.1.1". **Valid Operators:** - **equals (==)**: Exact match. - **like (~=)**: Performs a text search for field values that start with the given 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 globalProcedureId from the 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. tags: - GlobalProcedures (V1) parameters: - name: procedureId in: path required: true description: procedureId for which to get the GlobalProcedure model. 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - InsuranceCarrierWithExcludedProcedure (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the insurance carriers with ExcludedProcedures. Filters are of the form: - ?filter=filter1==filter1Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **insurancecarrier.id (==, ->):** - ?filter=insurancecarrier.id==12: Retrieves InsuranceCarrierWithExcludedProcedure with insurancecarrier id equal to 12. - ?filter=insurancecarrier.id->[12,13]: Retrieves InsuranceCarrierWithExcludedProcedure with insurancecarrier ids containing 12 and 13. 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 tags: - InsuranceCarrierWithExcludedProcedure (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: InsuranceCarrierWithExcludedProcedure data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - InsuranceCarriers (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the insurance carriers. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (->):** - ?filter=id->[1000000020702,1000000020703]: Retrieves InsuranceCarriers with ids 1000000020702 or 1000000020703. - **name (==, ~=):** - ?filter=name~=health: Retrieves InsuranceCarriers that have "health" in their name. - **globalInsuranceCarrier.id (==, ->):** - ?filter=globalInsuranceCarrier.id==12: Retrieves InsuranceCarriers with globalInsuranceCarrier id equal to 12. - ?filter=globalInsuranceCarrier.id->[12,13]: Retrieves InsuranceCarriers with globalInsuranceCarrier ids 12 or 13. - **lastModified (>=, >, <=, <):** - ?filter=lastModified>=2022-01-01: Retrieves InsuranceCarriers where lastModified date is greater than or equal to "2022-01-01". - ?filter=lastModified<2022-01-01: Retrieves InsuranceCarriers where lastModified date is less than "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 insurance carrier ID from the 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 tags: - InsuranceCarriers (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: InsuranceCarrier data 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. tags: - InsuranceCarriers (V1) parameters: - name: carrierId in: path required: true description: carrierId for which to get the InsuranceCarrier model. 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/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. tags: - InsuranceCarriers (V1) parameters: - in: path name: carrierId required: true description: carrierId for which to update the InsuranceCarrier model. 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: InsuranceCarrier data 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 tags: - InsuranceCarriers (V1) parameters: - name: carrierId in: path required: true description: delete the insuranceCarrier model by carrierId. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - InsuranceClaims (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the insurance claims. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (==, ->):** - ?filter=id==12: Retrieves insuranceClaims with ids equal to 12. - ?filter=id->[12,13]: Retrieves insuranceClaims with ids containing 12 and 13. - **location.id (==, ->):** - ?filter=location.id==12: Retrieves insuranceClaims with location ids equal to 12. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves insuranceClaims across all locations. - ?filter=location.id->[12,13]: Retrieves insuranceClaims with location ids containing 12 and 13. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests claims across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **patient.id (==, ->):** - ?filter=patient.id==123: Retrieves insuranceClaims with patient id equal to 123. - ?filter=patient.id->[123,456]: Retrieves insuranceClaims where patient id is either 123 or 456. - **subscriber.id (==, ->):** - ?filter=subscriber.id==123: Retrieves insuranceClaims with subscriber id equal to 123. - ?filter=subscriber.id->[123,456]: Retrieves insuranceClaims where subscriber id is either 123 or 456. - **renderingProvider.id (==, ->):** - ?filter=renderingProvider.id==123: Retrieves insuranceClaims with rendering provider id equal to 123. - ?filter=renderingProvider.id->[123,456]: Retrieves insuranceClaims where rendering provider id is either 123 or 456. - **insuranceCarrier.id (==, ->):** - ?filter=insuranceCarrier.id==123: Retrieves insuranceClaims with insurance carrier id equal to 123. - ?filter=insuranceCarrier.id->[123,456]: Retrieves insuranceClaims where insurance carrier id is either 123 or 456. - **carrierInsurancePlan.id (==, ->):** - ?filter=carrierInsurancePlan.id==123: Retrieves insuranceClaims with carrier insurance plan id equal to 123. - ?filter=carrierInsurancePlan.id->[123,456]: Retrieves insuranceClaims where carrier insurance plan id is either 123 or 456. - **sentDate (>=, >, <=, <):** - ?filter=sentDate>=2022-01-01: Retrieves insuranceClaims with sentDate greater than or equal to 2022-01-01. - ?filter=sentDate>2022-01-01: Retrieves insuranceClaims with sentDate strictly greater than 2022-01-01. - ?filter=sentDate<=2022-01-01: Retrieves insuranceClaims with sentDate less than or equal to 2022-01-01. - ?filter=sentDate<2022-01-01: Retrieves insuranceClaims with sentDate strictly less than 2022-01-01. - **lastModified (>=, >, <=, <):** - ?filter=lastModified>=2022-01-01: Retrieves insuranceClaims with lastModified date greater than or equal to 2022-01-01. - ?filter=lastModified>2022-01-01: Retrieves insuranceClaims with lastModified date strictly greater than 2022-01-01. - ?filter=lastModified<=2022-01-01: Retrieves insuranceClaims with lastModified date less than or equal to 2022-01-01. - ?filter=lastModified<2022-01-01: Retrieves insuranceClaims with lastModified date strictly less than 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 insurance claim ID from the 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. tags: - InsuranceClaims (V1) parameters: - name: claimId in: path required: true description: claimId for which to get the InsuranceClaim model. 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - ClaimAttachments (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the claim attachments. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), and less than equal to (<=). Equals operators check for exact match. Like operators perform text search for field values that start with the given value. Valid filter keys are: - **id (==, ->)**: - ?filter=id==12 (Retrieves claim attachment with id equal to 12) - ?filter=id->[12,13] (Retrieves claim attachments with ids 12 and 13) - **insuranceClaim.id (==, ->)**: - ?filter=insuranceClaim.id==12 (Retrieves resources where insuranceClaim.id equals 12) - ?filter=insuranceClaim.id->[12,13] (Retrieves resources where insuranceClaim.id is in the list [12, 13]) 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 the 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. tags: - ClaimAttachments (V1) parameters: - name: claimAttachmentId in: path required: true description: claimAttachmentId for which to get the ClaimAttachment model. schema: type: integer format: int64 minimum: 1 example: 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - ImageAttachments (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the image attachments. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (== and ->) - Example ?filter=id==12 (Retrieves ImageAttachments with ids equal to 12), ?filter=id->[12,13] (Retrieves ImageAttachments with ids containing 12 and 13) insuranceClaim.id (== and ->) - Example ?filter=insuranceClaim.id==12 (Retrieves ImageAttachments with insuranceClaim ids equal to 12), ?filter=insuranceClaim.id->[12,13] (Retrieves ImageAttachments with insuranceClaim ids containing 12 and 13) 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 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 schema: type: string example: 1006 description: Organization identifier for the request. - 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, name, created, insuranceClaim.id schema: type: string example: id, name, created, insuranceClaim.id style: form explode: false - name: filter in: query required: false description: | Specifies the criteria by which to filter the image attachments. Filters are of the form: - filter=filter1==filter1Value, filter2>=filter2Value **Valid operators:** - equals (==) - not equals (!=) - like (~=) - not like (<>=) - greater than (>) - greater than or equal to (>=) - less than (<) - less than or equal to (<=) - in (->) **Valid filter keys:** - id (==, ->): e.g. filter=id==12 or filter=id->[12, 13] - insuranceClaim.id (==, ->): e.g. filter=insuranceClaim.id==12 or filter=insuranceClaim.id->[12, 13] 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 largest image attachment ID from the previous page (for pagination). 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. tags: - ImageAttachments (V1) parameters: - name: imageAttachmentId in: path required: true description: imageAttachmentId for which to get the ImageAttachment model. 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/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 tags: - ICD10s (V1) parameters: - in: header name: Organization-ID 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: filter in: query required: false description: > Specifies the criteria by which to filter the ICD10. Filters are of the form ?filter=filter1==filter1Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==) and like (~=). Equals operators check for exact match. Valid filter keys are: code (==, ~=) - Example ?filter=code==K05 (Retrieves ICD10 with code of K05) 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 ICD10 ID 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. tags: - ICD10s (V1) parameters: - in: path name: icd10Id required: true description: the ID of ICD10. schema: type: integer format: int32 minimum: 1 - in: header name: Organization-ID 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/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 tags: - LocationClaimDefaults (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the location claim defaults. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **location.id (==, !=):** - ?filter=location.id==12: Retrieves location with id of 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. tags: - LocationClaimDefaults (V1) parameters: - in: path name: locationId required: true description: ID for getting LocationClaimDefault. 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - LocationWithExcludedProcedure (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the location with ExcludedProcedures. Filters are of the form: - ?filter=filter1==filter1Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **location.id (==, ->):** - ?filter=location.id==12: Retrieves locations where location.id equals 12. - ?filter=location.id->[12,13]: Retrieves locations where location.id is either 12 or 13. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves resources across all locations. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests results across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). 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 tags: - LocationWithExcludedProcedure (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: LocationWithExcludedProcedure data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Location hours (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the location schedule. Filters are of the form: - ?filter=filter1==filter1Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **location.id (==, != and ->):** - ?filter=location.id==12: Retrieves location hours with location id of 12. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves results across all locations. - ?filter=location.id->[12,13]: Retrieves location hours where location.id matches one or more IDs in the list. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests results across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **lastModified (>=, >, <=, <):** - ?filter=lastModified>=2022-01-01: Retrieves LocationHours with lastModified date greater than or equal to "2022-01-01". - ?filter=lastModified<2022-01-01: Retrieves LocationHours with lastModified date less than "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 the 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 tags: - Location hours (V1) parameters: - in: header name: Organization-ID required: true schema: type: string example: 1006 requestBody: description: Location Hour data 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. tags: - Location hours (V1) parameters: - in: path name: locationHourId required: true description: ID of the location hour for which to get the location hour model. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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/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). tags: - Location hours (V1) parameters: - in: path name: locationHourId required: true description: ID of the location hour for which to update the location hour model. 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: Location Hour data. 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 tags: - Location hours (V1) parameters: - name: locationHourId in: path required: true description: ID of the location hour for which to delete the location hour model. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - LocationPovertyLevels (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the location poverty levels. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **location.id (==, != and ->):** - ?filter=location.id==12: Retrieves location with id of 12. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves resources across all locations. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests results across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). 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 the 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. tags: - LocationPovertyLevels (V1) parameters: - name: locationPovertyLevelId in: path required: true description: ID of the location poverty level for which to get the location poverty level model. 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/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. tags: - LocationPovertyLevels (V1) parameters: - in: path name: locationPovertyLevelId required: true description: ID of the location poverty level for which to update the location poverty level model. 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: Location Poverty Level data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 schema: type: string example: 1006 - name: responseFields in: query required: false description: |- A URL-encoded comma-delimited list of field names to include in each element of `data`. Supported values: `ALL` (all fields), `date`, `actualAmount`. 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` **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 schema: type: string example: 1006 - name: responseFields in: query required: false description: |- A URL-encoded comma-delimited list of field names to include in each element of `data`. Supported values: `ALL` (all fields), `date`, `scheduledAmount`. 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` **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 schema: type: string example: 1006 - name: responseFields in: query required: false description: > A url encoded comma-delimited list 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 by which to calculate the report. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. These filters are mutually exclusive: provider.id, patient.id, appointment.id. Required filter keys are: fromDate (==) - ?filter=fromDate==2025-01-14 (Retrieves resources where fromDate equals 2025-01-14) Valid filter keys are: location.id (==,->) - ?filter=location.id==123 (Retrieves resources where location.id equals 123) - ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves results across all locations) - ?filter=location.id->[123,124] (Retrieves resources where location.id matches one or more IDs in the list) - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests across all locations) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). provider.id (==,->) - ?filter=provider.id==789 (Retrieves resources where provider.id equals 789) ?filter=provider.id->[789,790] (Retrieves resources where provider.id matches one or more IDs in the list) patient.id (==, ->) - ?filter=patient.id==456 (Retrieves resources where patient.id equals 456) ?filter=patient.id->[456,457] (Retrieves resources where patient.id matches one or more IDs in the list) appointment.id (==,->) - ?filter=appointment.id==345 (Retrieves resources where appointment.id equals 345) ?filter=appointment.id->[345,346] (Retrieves resources where appointment.id matches one or more IDs in the list) range (==) (example: 7) - amount of days (max - 31) - ?filter=range==7 (Retrieves resources within a range of 7 days. The maximum range is 31 days.) timezone (==) - ?filter=timezone==America/New_York (Sets the timezone to Eastern Time. Defaults to the location or organization timezone.) isPrimaryWriteOff (==) - ?filter=isPrimaryWriteOff==true (Retrieves resources where isPrimaryWriteOff is true. This filter is deprecated and should not be used in new implementations.) - Deprecated 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 schema: type: string example: 1006 - name: responseFields in: query required: false description: |- A URL-encoded comma-delimited list of field names to include in each element of `data`. Supported values: `ALL` (all fields), `date`, `actualAmount`, `scheduledAmount`. 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` **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 tags: - Locations (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the insurance claims. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (->):** - ?filter=id->[12,13]: Retrieves location with ids containing 12 and 13. - **lastModified (>=, >, <=, <):** - ?filter=lastModified>=2022-01-01: Retrieves location with lastModified date greater than or equal to 2022-01-01. - ?filter=lastModified>2022-01-01: Retrieves location with lastModified date strictly greater than 2022-01-01. - ?filter=lastModified<=2022-01-01: Retrieves location with lastModified date less than or equal to 2022-01-01. - ?filter=lastModified<2022-01-01: Retrieves location with lastModified date strictly less than 2022-01-01. 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. tags: - Locations (V1) parameters: - in: path name: locationId required: true description: ID for getting LocationV1. 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/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. tags: - Locations (V1) parameters: - in: path name: locationId required: true description: ID of the location for which to update the location model. 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: Location data 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/totalcount: get: summary: Returns the total count of records based on filter criteria tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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) tags: - MedicalAlertCategories (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the insurance claims. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **lastModified (>=, >, <=, <):** - ?filter=lastModified>=2022-01-01: Retrieves medicalAlertCategory with lastModified date greater than or equal to 2022-01-01. - ?filter=lastModified>2022-01-01: Retrieves medicalAlertCategory with lastModified date strictly greater than 2022-01-01. - ?filter=lastModified<=2022-01-01: Retrieves medicalAlertCategory with lastModified date less than or equal to 2022-01-01. - ?filter=lastModified<2022-01-01: Retrieves medicalAlertCategory with lastModified date strictly less than 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. tags: - MedicalAlertCategories (V1) parameters: - in: path name: medicalAlertCategoryId required: true description: ID for getting MedicalAlertCategoryV1. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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) tags: - MedicalAlertReactions (V1) 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 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. tags: - MedicalAlertReactions (V1) parameters: - in: path name: medicalAlertReactionId required: true description: ID for getting MedicalAlertReaction (V1). schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - MedicalAlerts (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the medical alerts. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: lastModified (>=, >, <=, and <) - Examples: ?filter=lastModified>=2022-01-01 (Retrieves MedicalAlerts with lastModified date greater than or equal to "2022-01-01"), ?filter=lastModified<2022-01-01 (Retrieves MedicalAlerts with lastModified date less than "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 ID of MedicalAlertV1 from previous page schema: type: string responses: '200': description: OK 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 tags: - MedicalAlerts (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: MedicalAlertV1 data 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. tags: - MedicalAlerts (V1) parameters: - in: path name: medicalAlertId required: true description: ID for getting MedicalAlertV1. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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/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. tags: - MedicalAlerts (V1) parameters: - in: path name: medicalAlertId required: true description: ID for which to update the MedicalAlertV1. 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: MedicalAlertV1 data 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 tags: - MedicalAlerts (V1) parameters: - name: medicalAlertId in: path required: true description: ID for which to delete the MedicalAlertV1. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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) tags: - MedicalAlertSeverities (V1) 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 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. tags: - MedicalAlertSeverities (V1) parameters: - in: path name: medicalAlertSeverityId required: true description: ID for getting MedicalAlertSeverity (V1). schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Missed Appointments (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the missed appointments. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: location.id (==, != and ->) - Example: ?filter=location.id==12 (Retrieves location with id of 12) - You can also use ?filter=location.id==ALL or ?filter=location.id==\* to retrieve results across all locations. - Or ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] to explicitly request results across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). start (>, <, >=, and <=) - Examples: ?filter=start>=2022-01-01 (Retrieves MissedAppointment with start date greater than or equal to "2022-01-01"), ?filter=start<2022-01-01 (Retrieves MissedAppointment with start date less than "2022-01-01") patient.id (== and !=) - Example: ?filter=patient.id==12 (Retrieves patient with id of 12) operatory.id (==, != and ->) - Example: ?filter=operatory.id->[12,13] (Retrieves operatory with ids containing 12 and 13) appointment.id (==) - Example: ?filter=appointment.id==12 (Retrieves appointment with id of 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. tags: - Missed Appointments (V1) parameters: - in: path name: missedAppointmentId required: true description: ID of the missed appointment for which to get the missed appointment model. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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/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. tags: - Missed Appointments (V1) parameters: - in: path name: missedAppointmentId required: true description: ID of the missed appointment for which to update the missed appointment model. 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: Missed Appointment data. 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 tags: - Missed Appointments (V1) parameters: - name: missedAppointmentId in: path required: true description: ID of the missed appointment for which to delete the missed appointment model. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - OnlineBookingLocations (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the operatories. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), less than equal to (<=) or contains (->). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: location.id (->) - Example: ?filter=location.id->[12,13] (Retrieves OnlineBookingLocation with ids containing 12 and 13) enabled (==) - Example: ?filter=enabled==true (Retrieves OnlineBookingLocation with enabled equals 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 ID of OperatoryV1 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 tags: - OnlineBookingLocations (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: OnlineBookingLocationV1 data 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. tags: - OnlineBookingLocations (V1) parameters: - name: locationId in: path required: true description: ID for getting the OnlineBookingLocationV1. 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/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. tags: - OnlineBookingLocations (V1) parameters: - in: path name: locationId required: true description: ID for which to update the OnlineBookingLocationV1. 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: OnlineBookingLocation data 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 tags: - OnlineBookingLocations (V1) parameters: - name: locationId in: path required: true description: ID for deleting the OnlineBookingLocationV1. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - Operatories (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the operatories. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), less than equal to (<=) or contains (->). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: location.id (==, != and ->) - Example: ?filter=location.id==12 (Retrieves locations with id of 12). You can also use ?filter=location.id==ALL or ?filter=location.id==\* to retrieve results across all locations. You can also use ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] to explicitly request results across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). id (->) - Example: ?filter=id->[12,13] (Retrieves Operatory with ids containing 12 and 13) 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 ID of OperatoryV1 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 tags: - Operatories (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: OperatoryV1 data 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. tags: - Operatories (V1) parameters: - name: operatoryId in: path required: true description: ID for getting the OperatoryV1. 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/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. tags: - Operatories (V1) parameters: - in: path name: operatoryId required: true description: ID for which to update the OperatoryV1. 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: Operatory data 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 tags: - Operatories (V1) parameters: - name: operatoryId in: path required: true description: ID for deleting the OperatoryV1. 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: DeleteOperatoriesByOperatoryIdV1 /v1/operatories/totalcount: get: summary: Returns the total count of records based on filter criteria tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - OrganizationConditions (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the organization conditions. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **condition.id (==, ->):** - ?filter=condition.id->[12,13]: Retrieves conditions with ids containing 12 and 13. - **condition.snomedCode (==, ~=):** - ?filter=condition.snomedCode~=235010005: Retrieves conditions where the snomedCode contains 235010005. - **condition.snodent.code (==):** - ?filter=condition.snodent.code==100242D: Retrieves conditions with snodent code equal to 100242D. - **condition.icd10.code (==):** - ?filter=condition.icd10.code==K05.20: Retrieves conditions with icd10 code equal to K05.20. - **condition.icd10.description (==):** - ?filter=condition.icd10.description==Dental caries: Retrieves conditions with icd10 description equal to "Dental caries". - **description (==, ~=):** - ?filter=description==Dental caries: Retrieves conditions with description equal to "Dental caries". - **lastModified (>, <, >=, <=):** - ?filter=lastModified>2025-01-01: Retrieves resources where lastModified is after 2025-01-01. - ?filter=lastModified<2025-01-01: Retrieves resources where lastModified is before 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves resources where lastModified is on or after 2025-01-01. - ?filter=lastModified<=2025-01-01: Retrieves resources where lastModified is on or before 2025-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 organization condition ID from the 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. tags: - OrganizationConditions (V1) parameters: - in: path name: organizationConditionId required: true description: the ID of organizationCondition. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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/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. tags: - OrganizationConditions (V1) parameters: - in: path name: organizationConditionId required: true description: organizationConditionId for which to update the organizationCondition model. 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: OrganizationCondition data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - OrganizationLedgerRules (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 - name: filter in: query required: false description: > Specifies the criteria by which to filter the visits. Filters are of the form: - ?filter=filter1==filter1Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (==):** - ?filter=id==12: Retrieves organizationLedgerRule with ids equal to 12. schema: type: string - name: responseFields in: query required: false description: | - **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 ID of OrganizationLedgerRule from the 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. tags: - OrganizationLedgerRules (V1) parameters: - in: path name: organizationLedgerRuleId required: true description: ID for which to update the OrganizationLedgerRule. 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: OrganizationLedgerRule data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - OrganizationLedgerTypes (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the organization ledger types. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (==, ->):** - ?filter=id==12: Retrieves organizationLedgerType with ids equal to 12. - ?filter=id->[12,13]: Retrieves organizationLedgerType with ids containing 12 and 13. - **description (==, ~=):** - ?filter=description==Cash Payment: Retrieves organizationLedgerType with descriptions equal to "Cash Payment". - **lastModified (>=, >, <=, <):** - ?filter=lastModified>=2022-01-01: Retrieves organizationLedgerType with lastModified date greater than or equal to "2022-01-01". - ?filter=lastModified<2022-01-01: Retrieves organizationLedgerType with lastModified date less than "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 organization ledger type ID from the 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. tags: - OrganizationLedgerTypes (V1) parameters: - in: path name: organizationLedgerTypeId required: true description: the ID of organizationLedgerType. schema: type: integer format: int64 minimum: 1 - in: header name: Organization-ID 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/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/{organizationId}: get: summary: Returns an organization by organization ID. tags: - Organizations (V1) parameters: - name: organizationId in: path required: true description: ID of the organization for which to get the organization model. 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: OK 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 '401': description: Unauthorized '403': description: Forbidden '404': description: Not found '429': description: Rate limit exceeded '500': description: Unexpected error operationId: GetOrganizationsByOrganizationIdV1 /v1/organizations/totalcount: get: summary: Returns the total count of records based on filter criteria tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PatientConditions (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the patient conditions. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **patient.id (==, ->):** - ?filter=patient.id==111: Retrieves resources where patient.id equals 111. - ?filter=patient.id->[111, 112]: Retrieves resources where patient.id is either 111 or 112. - **serviceDate (>, <, >=, <=):** - ?filter=serviceDate>2025-01-01: Retrieves resources where serviceDate is after 2025-01-01. - ?filter=serviceDate<2025-01-01: Retrieves resources where serviceDate is before 2025-01-01. - ?filter=serviceDate>=2025-01-01: Retrieves resources where serviceDate is on or after 2025-01-01. - ?filter=serviceDate<=2025-01-01: Retrieves resources where serviceDate is on or before 2025-01-01. - **lastModified (>, <, >=, <=):** - ?filter=lastModified>2025-01-01: Retrieves resources where lastModified is after 2025-01-01. - ?filter=lastModified<2025-01-01: Retrieves resources where lastModified is before 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves resources where lastModified is on or after 2025-01-01. - ?filter=lastModified<=2025-01-01: Retrieves resources where lastModified is on or before 2025-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 the 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 tags: - PatientConditions (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: PatientCondition data 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. tags: - PatientConditions (V1) parameters: - in: path name: patientConditionId required: true description: the ID of patientCondition. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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. tags: - PatientConditions (V1) parameters: - in: path name: patientConditionId required: true description: patientConditionId for which to update the patientCondition model. schema: type: integer format: int64 minimum: 1 example: 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: PatientCondition data 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 tags: - PatientConditions (V1) parameters: - name: patientConditionId in: path required: true description: patientConditionId for which to delete the patientCondition model. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PatientInsurancePlans (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the patient insurance plans. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (== and ->) - ?filter=id==1000000020702 (Retrieves resources where id equals 1000000020702) ?filter=id->[1000000020702,1000000020703] (Retrieves resources where id is either 1000000020702 or 1000000020703) patient.id (== and ->) - ?filter=patient.id==123 (Retrieves resources where patient.id equals 123) ?filter=patient.id->[123, 124] (Retrieves resources where patient.id is either 123 or 124) lastModified (>=, >, <=, and <) - ?filter=lastModified>2025-01-01 (Retrieves resources where lastModified is after 2025-01-01) ?filter=lastModified<2025-01-01 (Retrieves resources where lastModified is before 2025-01-01) ?filter=lastModified>=2025-01-01 (Retrieves resources where lastModified is on or after 2025-01-01) ?filter=lastModified<=2025-01-01 (Retrieves resources where lastModified is on or before 2025-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 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. tags: - PatientInsurancePlans (V1) parameters: - in: path name: patientInsurancePlanId required: true description: the ID of Patient Insurance Plan. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PatientMedicalAlerts (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the patient medical alerts. Filters are of the form ?filter=filter1==filter1Value,filter2!=filter2Value,filter3->[filter3Value1,filter3Value2]. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=) and in (->). Equals operators check for exact match. Valid filter keys are: patient.id (==, !=, and ->) - ?filter=patient.id==123 (Retrieves resources where patient.id equals 123) ?filter=patient.id!=123 (Retrieves resources where patient.id does not equal 123) ?filter=patient.id->[123, 124] (Retrieves resources where patient.id is either 123 or 124) medicalAlert.id (==, !=, and ->) - ?filter=medicalAlert.id==456 (Retrieves resources where medicalAlert.id equals 456) ?filter=medicalAlert.id!=456 (Retrieves resources where medicalAlert.id does not equal 456) ?filter=medicalAlert.id->[456, 457] (Retrieves resources where medicalAlert.id is either 456 or 457) lastModified (>, >=, <, <=) - ?filter=lastModified>2025-01-01 (Retrieves resources where lastModified is after 2025-01-01) ?filter=lastModified<2025-01-01 (Retrieves resources where lastModified is before 2025-01-01) ?filter=lastModified>=2025-01-01 (Retrieves resources where lastModified is on or after 2025-01-01) ?filter=lastModified<=2025-01-01 (Retrieves resources where lastModified is on or before 2025-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 ID of PatientMedicalAlertV1 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 tags: - PatientMedicalAlerts (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: PatientMedicalAlertV1 data 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. tags: - PatientMedicalAlerts (V1) parameters: - in: path name: patientMedicalAlertId required: true description: ID for getting the PatientMedicalAlertV1. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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. tags: - PatientMedicalAlerts (V1) parameters: - in: path name: patientMedicalAlertId required: true description: ID for which to update the PatientMedicalAlertV1. schema: type: integer format: int64 minimum: 1 example: 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: PatientMedicalAlertV1 data 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 tags: - PatientMedicalAlerts (V1) parameters: - name: patientMedicalAlertId in: path required: true description: ID for which to delete the PatientMedicalAlertV1. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PatientNotes (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the patient notes. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: patient.id (== and ->) When filtering by noteDate or lastModified, the results will be returned in descending order for greater performance, meaning the newest data will appear first. Previously, results were returned in ascending order, which displayed the oldest entries first. This query is indexed off of descending order. noteDate (==, >, <, >=, and <=) - ?filter=noteDate==2025-01-01 (Retrieves resources where noteDate equals 2025-01-01) ?filter=noteDate>2025-01-01 (Retrieves resources where noteDate is after 2025-01-01) ?filter=noteDate<2025-01-01 (Retrieves resources where noteDate is before 2025-01-01) ?filter=noteDate>=2025-01-01 (Retrieves resources where noteDate is on or after 2025-01-01) ?filter=noteDate<=2025-01-01 (Retrieves resources where noteDate is on or before 2025-01-01) lastModified (>, >=, <, and <=) - ?filter=lastModified>2025-01-01 (Retrieves resources where lastModified is after 2025-01-01) ?filter=lastModified<2025-01-01 (Retrieves resources where lastModified is before 2025-01-01) ?filter=lastModified>=2025-01-01 (Retrieves resources where lastModified is on or after 2025-01-01) ?filter=lastModified<=2025-01-01 (Retrieves resources where lastModified is on or before 2025-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 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 tags: - PatientNotes (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Input patient note data 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. tags: - PatientNotes (V1) parameters: - in: path name: patientNoteId required: true description: the ID of patientNote. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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. tags: - PatientNotes (V1) parameters: - in: path name: patientNoteId required: true description: ID of the patient note model. schema: type: integer format: int64 minimum: 1 example: 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: PatientNote data 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 tags: - PatientNotes (V1) parameters: - name: patientNoteId in: path required: true description: ID of the patient note model. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PatientPaymentPlans (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the payment plans. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (==) - ?filter=id==1000000020702 (Retrieves resources where id equals 1000000020702) patient.id (== and ->) - ?filter=patient.id==123 (Retrieves resources where patient.id equals 123) ?filter=patient.id->[123, 124] (Retrieves resources where patient.id is either 123 or 124) location.id (== and ->) - ?filter=location.id==456 (Retrieves resources where location.id equals 456) ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) ?filter=location.id->[456, 457] (Retrieves resources where location.id is either 456 or 457) ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). provider.id (== and ->) - ?filter=provider.id==789 (Retrieves resources where provider.id equals 789) ?filter=provider.id->[789, 790] (Retrieves resources where provider.id is either 789 or 790) To get calculated fields, currentBalance, lastPayment, lastPaymentDate you need to use location filter and set showCalculated parameter to true. 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. tags: - PatientPaymentPlans (V1) parameters: - in: path name: patientPaymentPlanId required: true description: ID of the payment plan for which to get the payment plan model. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PatientPrescriptions (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the patient prescriptions. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2]. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Examples:** - **patient.id (==, ->):** - ?filter=patient.id==123: Retrieves patient prescriptions where patient.id equals 123. - ?filter=patient.id->[123, 124]: Retrieves patient prescriptions where patient.id is either 123 or 124. - **lastModified (>, >=, <, <=):** - ?filter=lastModified>2025-01-01: Retrieves patient prescriptions where lastModified is after 2025-01-01. - ?filter=lastModified<2025-01-01: Retrieves patient prescriptions where lastModified is before 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves patient prescriptions where lastModified is on or after 2025-01-01. - ?filter=lastModified<=2025-01-01: Retrieves patient prescriptions where lastModified is on or before 2025-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 the 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 tags: - PatientPrescriptions (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: PatientPrescriptionV1 data 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. tags: - PatientPrescriptions (V1) parameters: - in: path name: patientPrescriptionId required: true description: ID of the PatientPrescriptionV1 for which to get the model. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - PatientPrescriptions (V1) parameters: - in: path name: patientPrescriptionId required: true description: ID for which to update the PatientPrescriptionV1. schema: type: integer format: int64 minimum: 1 example: 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: PatientPrescriptionV1 data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PatientProcedures(V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the patient procedures. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional for this endpoint.** If used, ensure they align with the field types and operators specified. - **Default Behavior:** If `lastModified` is not provided, the system automatically applies a `lastModified >= (current date - 1 year)` filter to limit results to procedures modified within the last year. **Allowed Filter Keys and Operators:** - **serviceDate (>, <, >=, <=):** - ?filter=serviceDate>2025-01-25 (Service date after January 25, 2025) - ?filter=serviceDate<=2025-01-25 (Service date on or before January 25, 2025) - **entryDate (>, <, >=, <=):** - ?filter=entryDate>=2025-01-25 (Entry date on or after January 25, 2025) - ?filter=entryDate<2025-01-25 (Entry date before January 25, 2025) - **lastModified (>, <, >=, <=):** - ?filter=lastModified>2025-01-25 (Modified after January 25, 2025) - ?filter=lastModified<=2025-01-25 (Modified on or before January 25, 2025) - **treatmentPlannedProvider.id (==, !=):** - ?filter=treatmentPlannedProvider.id==123 (Provider ID equals 123) - ?filter=treatmentPlannedProvider.id!=456 (Provider ID not equal to 456) - **status (==, !=):** - ?filter=status==COMPLETED (Status is COMPLETED) - ?filter=status==EXISTING (Status is EXISTING) - ?filter=status==TREATMENT_PLAN (Status is TREATMENT_PLAN) - **txCase.id (==, ->):** - ?filter=txCase.id==789 (txCase ID equals 789) - ?filter=txCase.id->[789, 791] (txCase ID equals 789 and 791) - **location.id (==, != and ->):** - ?filter=location.id==789 (Location ID equals 789) - ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - ?filter=location.id!=101 (Location ID not equal to 101) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **patient.id (==, !=):** - ?filter=patient.id==123 (Patient ID equals 123) - ?filter=patient.id!=456 (Patient ID not equal to 456) - **state (==):** - ?filter=state==ACTIVE (Retrieves resources where state is ACTIVE) - ?filter=state==CANCELLED (Retrieves resources where state is not CANCELLED) - ?filter=state==INVALIDATED (Retrieves resources where state is INVALIDATED) - **referredOut (==, !=):** - ?filter=referredOut==TRUE (Retrieves resources where referredOut is TRUE) - ?filter=referredOut==FALSE (Retrieves resources where referredOut is not FALSE) **Examples of Invalid Filters:** - ?filter=ledgerType== (Empty value, will result in 405 error) - ?filter= (Empty filter, key will result in 405 error) - ?filter=page=1 or ?filter=pageSize=100 or both page and pageSize without a valid filter (invalid request, will result in 405 error). 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 tags: - PatientProcedures(V1) parameters: - name: Organization-ID in: header required: true 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: PatientProcedure data 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. tags: - PatientProcedures(V1) parameters: - name: procedureId in: path required: true description: procedureId for which to get the PatientProcedure model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - PatientProcedures(V1) parameters: - in: path name: procedureId required: true description: procedureId for which to update the PatientProcedure model. schema: type: integer format: int64 minimum: 1 example: 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 - 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: PatientProcedure data 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 tags: - PatientProcedures(V1) parameters: - name: procedureId in: path required: true description: delete the patientProcedure model by procedureId. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 schema: type: string example: 1006 - name: filter in: query required: true description: >- Filter string for the calculated-fields endpoint. General grammar: the Public API filter documentation. Only the keys below are accepted (see `PatientProcedureFilterValidation`). **Required** - **patientProcedure.id** (==, ->): one ID or a list of procedure IDs to evaluate. - `?filter=patientProcedure.id==123` - `?filter=patientProcedure.id->[123,456]` **Optional** - **location.id** (==, !=, ->): same semantics as bulk GET (including ALL / `*` where supported). - **isEditable** (==): boolean, match editability for the procedure. - **appointmentToBeDeleted** (==, ->): appointment id(s) for the match logic used with calculated fields. **MCP (first successful call):** `filter=patientProcedure.id==` and `responseFields=isEditable,appointmentToBeDeleted` (both fields required in `responseFields`). schema: type: string - name: responseFields in: query required: true description: |- Required. Must include both fields (comma-separated): `isEditable` and `appointmentToBeDeleted`. Example: `responseFields=isEditable,appointmentToBeDeleted` 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 tags: - PatientProcedures(V1) parameters: - name: Organization-ID in: header required: true 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 schema: type: string example: 1006 - name: procedureId in: path required: true description: Patient procedure ID for which to return linked visits and appointments. 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: procedureId for which to get the PatientProcedure graph model. schema: type: integer format: int64 minimum: 1 example: 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/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: patientId for which to get all of PatientProcedure graph models. schema: type: integer format: int64 minimum: 1 example: 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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. tags: - PatientProcedures (Beta) 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: filter in: query required: false description: > Specifies the criteria by which to filter the patient procedures. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional for this endpoint.** If used, ensure they align with the field types and operators specified. - **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Allowed Filter Keys and Operators:** - **serviceDate (>, <, >=, <=):** - ?filter=serviceDate>2025-01-25 (Service date after January 25, 2025) - ?filter=serviceDate<=2025-01-25 (Service date on or before January 25, 2025) - **entryDate (>, <, >=, <=):** - ?filter=entryDate>=2025-01-25 (Entry date on or after January 25, 2025) - ?filter=entryDate<2025-01-25 (Entry date before January 25, 2025) - **lastModified (>, <, >=, <=):** - ?filter=lastModified>2025-01-25 (Modified after January 25, 2025) - ?filter=lastModified<=2025-01-25 (Modified on or before January 25, 2025) - **treatmentPlannedProvider.id (==, !=):** - ?filter=treatmentPlannedProvider.id==123 (Provider ID equals 123) - ?filter=treatmentPlannedProvider.id!=456 (Provider ID not equal to 456) - **status (==, !=):** - ?filter=status==COMPLETED (Status is COMPLETED) - ?filter=status==EXISTING (Status is EXISTING) - ?filter=status==TREATMENT_PLAN (Status is TREATMENT_PLAN) - **location.id (==, !=):** - ?filter=location.id==789 (Location ID equals 789) - ?filter=location.id!=101 (Location ID not equal to 101) - **patient.id (==, !=):** - ?filter=patient.id==123 (Patient ID equals 123) - ?filter=patient.id!=456 (Patient ID not equal to 456) - **state (==):** - ?filter=state==ACTIVE (Retrieves resources where state is ACTIVE) - ?filter=state==CANCELLED (Retrieves resources where state is not CANCELLED) - ?filter=state==INVALIDATED (Retrieves resources where state is INVALIDATED) - **referredOut (==, !=):** - ?filter=referredOut==TRUE (Retrieves resources where referredOut is TRUE) - ?filter=referredOut==FALSE (Retrieves resources where referredOut is not FALSE) **Examples of Invalid Filters:** - ?filter=ledgerType== (Empty value, will result in 405 error) - ?filter= (Empty filter, key will result in 405 error) - ?filter=page=1 or ?filter=pageSize=100 or both page and pageSize without a valid filter (invalid request, will result in 405 error). 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 tags: - PatientRecares (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the recares. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), IN (->), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: scheduledAppointment.id (== and ->) - ?filter=scheduledAppointment.id==123 (Retrieves resources where scheduledAppointment.id equals 123) ?filter=scheduledAppointment.id->[123, 124] (Retrieves resources where scheduledAppointment.id is in the list [123, 124]) recareTemplate.id (== and ->) - ?filter=recareTemplate.id==456 (Retrieves resources where recareTemplate.id equals 456) ?filter=recareTemplate.id->[456, 457] (Retrieves resources where recareTemplate.id is in the list [456, 457]) patient.id (== and ->) - ?filter=patient.id==789 (Retrieves resources where patient.id equals 789) ?filter=patient.id->[789, 790] (Retrieves resources where patient.id is in the list [789, 790]) lastModified (>=, >, <=, and <) - ?filter=lastModified>=2025-01-01 (Retrieves resources where lastModified is on or after 2025-01-01) ?filter=lastModified>2025-01-01 (Retrieves resources where lastModified is after 2025-01-01) ?filter=lastModified<=2025-01-01 (Retrieves resources where lastModified is on or before 2025-01-01) ?filter=lastModified<2025-01-01 (Retrieves resources where lastModified is before 2025-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 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 tags: - PatientRecares (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: PatientRecareV1 data 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. tags: - PatientRecares (V1) parameters: - name: patientRecareId in: path required: true description: ID for getting PatientRecareV1. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - PatientRecares (V1) parameters: - in: path name: patientRecareId required: true description: ID for which to update the PatientRecareV1. schema: type: integer format: int64 minimum: 1 example: 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: PatientRecareV1 data 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 tags: - PatientRecares (V1) parameters: - name: patientRecareId in: path required: true description: ID for which to delete the PatientRecareV1. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Patients (V1) 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. Supported values: - **ALL**: Returns all field names. - Example: id, firstName, lastName, chartNumber schema: type: string example: id, firstName, lastName, chartNumber style: form explode: false - name: filter in: query required: false description: >- Specifies the criteria by which to filter the patients. Filters are of the form: - filter=filter1==filter1Value, filter2>=filter2Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid operators:** - equals (==) - not equals (!=) - like (~=) - not like (<>=) - greater than (>) - greater than or equal to (>=) - less than (<) - less than or equal to (<=) - in (->) - absent (.absent) - present (.present) **Valid Filter Keys with Operators:** - **firstName (==, !=, ~=, <>=):** - ?filter=firstName==exactFirstName: Retrieves resources where firstName equals exactFirstName. - ?filter=firstName!=exactFirstName: Retrieves resources where firstName is not equals exactFirstName. - ?filter=firstName~=partialFirstName: Retrieves resources where firstName likes partialFirstName. - ?filter=firstName<>=partialFirstName: Retrieves resources where firstName doesn't like partialFirstName. - **lastName (==, !=, ~=, <>=):** - ?filter=lastName==exactLastName: Retrieves resources where lastName equals exactLastName. - ?filter=lastName!=exactLastName: Retrieves resources where lastName is not equals exactLastName. - ?filter=lastName~=partialLastName: Retrieves resources where lastName likes partialLastName. - ?filter=lastName<>=partialLastName: Retrieves resources where lastName doesn't like partialLastName. - **gender (==, !=):** - ?filter=gender==M: Retrieves resources where gender equals M. - ?filter=gender!=F: Retrieves resources where gender does not equal F. - Gender should be in [M, F, O]. - **preferredName (==, !=, ~=, <>=):** - ?filter=preferredName==exactPreferredName: Retrieves resources where preferredName equals exactPreferredName. - ?filter=preferredName!=exactPreferredName: Retrieves resources where preferredName is not equals exactPreferredName. - ?filter=preferredName~=partialPreferredName: Retrieves resources where preferredName likes partialPreferredName. - ?filter=preferredName<>=partialPreferredName: Retrieves resources where preferredName doesn't like partialPreferredName. - **dateOfBirth (==, !=):** - ?filter=dateOfBirth==2025-01-01: Retrieves resources where dateOfBirth equals 2025-01-01. - ?filter=dateOfBirth!=2025-01-01: Retrieves resources where dateOfBirth does not equal 2025-01-01. - **patientStatus (==, !=):** - ?filter=patientStatus==NEW: Retrieves resources where patientStatus equals NEW. - ?filter=patientStatus!=NON-PATIENT: Retrieves resources where patientStatus does not equal NON-PATIENT. - PatientStatus should be in [NEW, ACTIVE, NON-PATIENT, INACTIVE, DUPLICATE]. - **phones.number (==, !=, ->):** - ?filter=phones.number==123: Retrieves resources where phones.number equals 123. - ?filter=phones.number!=123: Retrieves resources where phones.number does not equal 123. - ?filter=phones.number->[123, 456]: Retrieves resources where phones.number is either 123 or 456. - **emailAddress (==):** - ?filter=emailAddress==someEmail: Retrieves resources where emailAddress equals someEmail. - **chartNumber (==, .absent, .present):** - ?filter=chartNumber==123: Retrieves resources where chartNumber equals 123. - ?filter=chartNumber.absent: Retrieves resources where chartNumber is NULL. - ?filter=chartNumber.present: Retrieves resources where chartNumber is not NULL. - **preferredLocation.id (==, != and ->):** - ?filter=preferredLocation.id==789: Retrieves resources where preferredLocation.id equals 789. - ?filter=preferredLocation.id!=789: Retrieves resources where preferredLocation.id does not equal 789. - ?filter=preferredLocation.id==ALL OR ?filter=preferredLocation.id==\*: Retrieves resources across all locations. - ?filter=preferredLocation.id->["ALL"] OR ?filter=preferredLocation.id->["*"]: Explicitly requests results across all locations. - **NOTE:** - For a transitional period, omitting preferredLocation.id will default to ALL locations. - Soon, preferredLocation.id will become a required filter (IDs list or ["ALL"]). - **primaryGuarantor.id (==):** - ?filter=primaryGuarantor.id==456: Retrieves resources where primaryGuarantor.id equals 456. - **duplicateOfPatient.id (==):** - ?filter=duplicateOfPatient.id==456: Retrieves resources where duplicateOfPatient.id equals 456. - **primaryContact.id (==):** - ?filter=primaryContact.id==456: Retrieves resources where primaryContact.id equals 456. - **firstVisitDate (==, >=, >, <=, <):** - ?filter=firstVisitDate==2025-01-01: Retrieves resources where firstVisitDate equals 2025-01-01. - ?filter=firstVisitDate>2025-01-01: Retrieves resources where firstVisitDate is after 2025-01-01. - ?filter=firstVisitDate<2025-01-01: Retrieves resources where firstVisitDate is before 2025-01-01. - ?filter=firstVisitDate>=2025-01-01: Retrieves resources where firstVisitDate is on or after 2025-01-01. - ?filter=firstVisitDate<=2025-01-01: Retrieves resources where firstVisitDate is on or before 2025-01-01. - **lastModified (>=, >, <=, <):** - ?filter=lastModified>2025-01-01: Retrieves resources where lastModified is after 2025-01-01. - ?filter=lastModified<2025-01-01: Retrieves resources where lastModified is before 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves resources where lastModified is on or after 2025-01-01. - ?filter=lastModified<=2025-01-01: Retrieves resources where lastModified is on or before 2025-01-01. - **referredByPatient.id (==, !=, ->):** - ?filter=referredByPatient.id==789: Retrieves resources where referredByPatient.id equals 789. - ?filter=referredByPatient.id!=789: Retrieves resources where referredByPatient.id does not equal 789. - ?filter=referredByPatient.id->[789, 101]: Retrieves resources where referredByPatient.id is either 789 or 101. - **referredByReferral.id (==, !=, ->):** - ?filter=referredByReferral.id==789: Retrieves resources where referredByReferral.id equals 789. - ?filter=referredByReferral.id!=789: Retrieves resources where referredByReferral.id does not equal 789. - ?filter=referredByReferral.id->[789, 101]: Retrieves resources where referredByReferral.id is either 789 or 101. - **id (->):** - ?filter=id->[123, 124]: Retrieves resources where id is in the list [123, 124]. When filtering by dates (like lastModified), you should use the lastId parameter to cycle through records as they are sorted by id. 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. defaut value is 1 schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control. defaut value is 100 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 tags: - Patients (V1) operationId: createPatient parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Patient data to create 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 schema: type: string 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 style: form explode: false - name: filter in: query required: false description: > Specifies the criteria by which to filter the patients. Filters are of the form: - filter=filter1==filter1Value, filter2>=filter2Value **Valid operators:** - equals (==) - not equals (!=) - like (~=) - not like (<>=) - greater than (>) - greater than or equal to (>=) - less than (<) - less than or equal to (<=) - in (->) - absent (.absent) - present (.present) **Valid Filter Keys with Operators:** - **firstName (==, !=, ~=, <>=):** - ?filter=firstName==exactFirstName: Retrieves resources where firstName equals exactFirstName. - ?filter=firstName!=exactFirstName: Retrieves resources where firstName is not equals exactFirstName. - ?filter=firstName~=partialFirstName: Retrieves resources where firstName likes partialFirstName. - ?filter=firstName<>=partialFirstName: Retrieves resources where firstName doesn't like partialFirstName. - **lastName (==, !=, ~=, <>=):** - ?filter=lastName==exactLastName: Retrieves resources where lastName equals exactLastName. - ?filter=lastName!=exactLastName: Retrieves resources where lastName is not equals exactLastName. - ?filter=lastName~=partialLastName: Retrieves resources where lastName likes partialLastName. - ?filter=lastName<>=partialLastName: Retrieves resources where lastName doesn't like partialLastName. - **gender (==, !=):** - ?filter=gender==M: Retrieves resources where gender equals M. - ?filter=gender!=F: Retrieves resources where gender does not equal F. - Gender should be in [M, F, O]. - **preferredName (==, !=, ~=, <>=):** - ?filter=preferredName==exactPreferredName: Retrieves resources where preferredName equals exactPreferredName. - ?filter=preferredName!=exactPreferredName: Retrieves resources where preferredName is not equals exactPreferredName. - ?filter=preferredName~=partialPreferredName: Retrieves resources where preferredName likes partialPreferredName. - ?filter=preferredName<>=partialPreferredName: Retrieves resources where preferredName doesn't like partialPreferredName. - **dateOfBirth (==, !=):** - ?filter=dateOfBirth==2025-01-01: Retrieves resources where dateOfBirth equals 2025-01-01. - ?filter=dateOfBirth!=2025-01-01: Retrieves resources where dateOfBirth does not equal 2025-01-01. - **patientStatus (==, !=):** - ?filter=patientStatus==NEW: Retrieves resources where patientStatus equals NEW. - ?filter=patientStatus!=NON-PATIENT: Retrieves resources where patientStatus does not equal NON-PATIENT. - PatientStatus should be in [NEW, ACTIVE, NON-PATIENT, INACTIVE, DUPLICATE]. - **phones.number (==, !=, ->):** - ?filter=phones.number==123: Retrieves resources where phones.number equals 123. - ?filter=phones.number!=123: Retrieves resources where phones.number does not equal 123. - ?filter=phones.number->[123, 456]: Retrieves resources where phones.number is either 123 or 456. - **emailAddress (==):** - ?filter=emailAddress==someEmail: Retrieves resources where emailAddress equals someEmail. - **chartNumber (==, .absent, .present):** - ?filter=chartNumber==123: Retrieves resources where chartNumber equals 123. - ?filter=chartNumber.absent: Retrieves resources where chartNumber is NULL. - ?filter=chartNumber.present: Retrieves resources where chartNumber is not NULL. - **preferredLocation.id (==, != and ->):** - ?filter=preferredLocation.id==789: Retrieves resources where preferredLocation.id equals 789. - ?filter=preferredLocation.id!=789: Retrieves resources where preferredLocation.id does not equal 789. - ?filter=preferredLocation.id==ALL OR ?filter=preferredLocation.id==\*: Retrieves resources across all locations. - ?filter=preferredLocation.id->["ALL"] OR ?filter=preferredLocation.id->["*"]: Explicitly requests results across all locations. - **NOTE:** - For a transitional period, omitting preferredLocation.id will default to ALL locations. - Soon, preferredLocation.id will become a required filter (IDs list or ["ALL"]). - **primaryGuarantor.id (==):** - ?filter=primaryGuarantor.id==456: Retrieves resources where primaryGuarantor.id equals 456. - **duplicateOfPatient.id (==):** - ?filter=duplicateOfPatient.id==456: Retrieves resources where duplicateOfPatient.id equals 456. - **primaryContact.id (==):** - ?filter=primaryContact.id==456: Retrieves resources where primaryContact.id equals 456. - **firstVisitDate (==, >=, >, <=, <):** - ?filter=firstVisitDate==2025-01-01: Retrieves resources where firstVisitDate equals 2025-01-01. - ?filter=firstVisitDate>2025-01-01: Retrieves resources where firstVisitDate is after 2025-01-01. - ?filter=firstVisitDate<2025-01-01: Retrieves resources where firstVisitDate is before 2025-01-01. - ?filter=firstVisitDate>=2025-01-01: Retrieves resources where firstVisitDate is on or after 2025-01-01. - ?filter=firstVisitDate<=2025-01-01: Retrieves resources where firstVisitDate is on or before 2025-01-01. - **lastModified (>=, >, <=, <):** - ?filter=lastModified>2025-01-01: Retrieves resources where lastModified is after 2025-01-01. - ?filter=lastModified<2025-01-01: Retrieves resources where lastModified is before 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves resources where lastModified is on or after 2025-01-01. - ?filter=lastModified<=2025-01-01: Retrieves resources where lastModified is on or before 2025-01-01. - **referredByPatient.id (==, !=, ->):** - ?filter=referredByPatient.id==789: Retrieves resources where referredByPatient.id equals 789. - ?filter=referredByPatient.id!=789: Retrieves resources where referredByPatient.id does not equal 789. - ?filter=referredByPatient.id->[789, 101]: Retrieves resources where referredByPatient.id is either 789 or 101. - **referredByReferral.id (==, !=, ->):** - ?filter=referredByReferral.id==789: Retrieves resources where referredByReferral.id equals 789. - ?filter=referredByReferral.id!=789: Retrieves resources where referredByReferral.id does not equal 789. - ?filter=referredByReferral.id->[789, 101]: Retrieves resources where referredByReferral.id is either 789 or 101. When filtering by dates (like lastModified), you should use the lastId parameter to cycle through records as they are sorted by id. For a complete list of available filters, see the regular bulk get endpoint: **/api/v1/patients** schema: type: string example: lastModified>=2019-09-25T20:41:38.163Z,firstVisitDate<2019-10-25 - name: lastId in: query required: false description: The largest patientId from the 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 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 schema: type: string 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 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 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 schema: type: string 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: Patient data to update 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/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 schema: type: string example: 1006 - name: filter in: query required: true description: >- Filter patients for calculated fields. Grammar: the Public API filter documentation. **Key** - **patient.id** (`==`, `->`) — e.g. `patient.id==123` or `patient.id->[456,789]` **MCP (first successful call):** `filter` plus `responseFields` with at least one allowed field (e.g. `lastVisitDate`). 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. For calculations, at least 1 response field is required. **Available fields:** - lastVisitDate 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PatientStatements (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the patientStatements. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), less than equal to (<=) or contains (->), absent (.absent), present (.present) . Equals operators check for exact match, like operators perform text search for field values that start with the given value. Absent and present operators check whether the value of this field exists (equals to null) Valid filter keys are: id (->) - ?filter=id->[1000000020702,1000000020703] (Retrieves resources where id is in the list [1000000020702, 1000000020703]) patient.id (== and ->) - ?filter=patient.id==789 (Retrieves resources where patient.id equals 789) ?filter=patient.id->[789, 790] (Retrieves resources where patient.id is in the list [789, 790]) lastModified (>=, >, <=, and <) - ?filter=lastModified>=2025-01-01 (Retrieves resources where lastModified is on or after 2025-01-01) ?filter=lastModified>2025-01-01 (Retrieves resources where lastModified is after 2025-01-01) ?filter=lastModified<=2025-01-01 (Retrieves resources where lastModified is on or before 2025-01-01) ?filter=lastModified<2025-01-01 (Retrieves resources where lastModified is before 2025-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 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. tags: - PatientStatements (V1) parameters: - name: patientstatementId in: path required: true description: ID of the patient statement for which to get the PatientStatement model. schema: type: integer format: int64 minimum: 1 example: 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PatientTeethV1 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. 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: Must be exactly `patient.id=={patientId}` with a valid patient ID. schema: type: integer format: int64 minimum: 1 example: /api/v1/patientteeth?filter=patient.id==64000000000002 - name: Organization-ID in: header required: true schema: type: string example: 1006 - name: responseFields in: query required: false description: >- Comma-separated field names for each PatientToothV1 in `data`, or `ALL` / `MODIFIED` (see standard bulk GET behavior). 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. tags: - PatientTeethV1 parameters: - name: patient.id in: query required: true description: patient.id for which to update the patientTeeth model. schema: type: integer format: int64 minimum: 1 example: 9000023397 - 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: 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 tags: - PerioExams (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the PerioExams. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Examples:** - **id (==, ->):** - ?filter=id==123: Retrieves PerioExams where id equals 123. - ?filter=id->[456,789]: Retrieves PerioExams where id is either 456 or 789. - **createdByUser.id (==):** - ?filter=createdByUser.id==789: Retrieves PerioExams where createdByUser.id equals 789. - **patient.id (==):** - ?filter=patient.id==789: Retrieves PerioExams where patient.id equals 789. - **lastModified (>, >=, <, <=):** - ?filter=lastModified>=2024-01-01: Retrieves PerioExams where lastModified is greater than or equal to 2024-01-01. - ?filter=lastModified>2024-01-01T10:00:00: Retrieves PerioExams where lastModified is greater than 2024-01-01T10:00:00. - ?filter=lastModified<=2024-12-31: Retrieves PerioExams where lastModified is less than or equal to 2024-12-31. - ?filter=lastModified<2024-12-31T23:59:59: Retrieves PerioExams where lastModified is less than 2024-12-31T23:59:59. - **serviceDate (>, >=, <, <=):** - ?filter=serviceDate>=2024-01-01: Retrieves PerioExams where serviceDate is greater than or equal to 2024-01-01. - ?filter=serviceDate>2024-01-01T10:00:00: Retrieves PerioExams where serviceDate is greater than 2024-01-01T10:00:00. - ?filter=serviceDate<=2024-12-31: Retrieves PerioExams where serviceDate is less than or equal to 2024-12-31. - ?filter=serviceDate<2024-12-31T23:59:59: Retrieves PerioExams where serviceDate is less than 2024-12-31T23:59:59. **Combined Filter Examples:** - ?filter=lastModified>=2024-01-01&lastId=12345: Retrieves PerioExams where lastModified is greater than or equal to 2024-01-01, starting after the PerioExam with ID 12345. schema: type: string example: /api/v1/perioexams?filter=patient.id==9002 - name: page in: query required: false description: Page number for pagination control. Default value is 1. schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control. Default value is 100. schema: type: string example: 100 - name: lastId in: query required: false description: The biggest recareId from the 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 tags: - PerioExams (V1) parameters: - name: Organization-ID in: header required: true 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 tags: - PerioExams (V1) parameters: - name: Organization-ID in: header required: true 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: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: The requested resource is either missing or does 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. tags: - PerioExams (V1) parameters: - name: perioExamId in: path required: true description: the perioExamId for getting perioExam model. 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/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. tags: - PerioExams (V1) parameters: - in: path name: perioExamId required: true description: ID of the perioExam for which to update the perioExam model. 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: PerioExam data 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 tags: - PerioExams (V1) parameters: - name: perioExamId in: path required: true description: perioExamId for which to delete the perioExam model. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - PerioProbes (V1) parameters: - name: perioExamId in: path required: true description: perioExamId which is the perioProbe model belongs to. schema: type: string example: 10000440046 - name: Organization-ID in: header required: true 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 tags: - PerioProbes (V1) parameters: - name: perioExamId in: path required: true description: perioExamId, which the PerioProbe model belongs to. schema: type: string example: 10000440046 - 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: filter in: query required: false description: > Specifies the criteria by which to filter the PerioProbes. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Examples:** - **id (==, ->):** - ?filter=id==123: Retrieves PerioProbes where id equals 123. - ?filter=id->[456,789]: Retrieves PerioProbes where id is either 456 or 789. 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 tags: - PerioProbes (V1) parameters: - name: perioExamId in: path required: true description: perioExamId which the PerioProbe model belongs to. schema: type: string example: 10000440046 - name: Organization-ID in: header required: true 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: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: The requested resource is either missing or does 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: perioExamId for which the perioProbe model belongs to. schema: type: string example: 10000440046 - name: perioProbeId in: path required: true description: the perioProbeId for getting perioProbe model. 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/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. tags: - PerioProbes (V1) parameters: - name: perioExamId in: path required: true description: perioExamId for which the perioProbe model belongs to. schema: type: string example: 10000440046 - in: path name: perioProbeId required: true description: ID of the perioProbe for which to update the perioProbe model. 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: PerioProbe data 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 tags: - PerioProbes (V1) parameters: - name: perioExamId in: path required: true description: perioExamId which is the perioProbe model belongs to. schema: type: string example: 10000440046 - name: perioProbeId in: path required: true description: perioProbeId for which to delete the perioProbe model. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PracticeProcedures (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the practice procedures. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Examples:** - **adaCode (==, ~=, ->):** - ?filter=adaCode==D0123: Retrieves resources where adaCode equals D0123. - ?filter=adaCode~=123: Retrieves resources where adaCode contains "123". - ?filter=adaCode->[D0123, E0456]: Retrieves resources where adaCode is either D0123 or E0456. - **aliasCode (==, ~=):** - ?filter=aliasCode==D0123.1: Retrieves resources where aliasCode equals D0123.1. - ?filter=aliasCode~=123: Retrieves resources where aliasCode contains "123". - **recareTemplate.id (==):** - ?filter=recareTemplate.id==789: Retrieves resources where recareTemplate.id equals 789. - **category (==, ->):** - ?filter=category==DIAGNOSTIC: Retrieves resources where category equals DIAGNOSTIC. - ?filter=category->[PERIODONTICS, PREVENTIVE]: Retrieves resources where category is either PERIODONTICS or PREVENTIVE. **Valid categories:** - DIAGNOSTIC, PREVENTIVE, RESTORATIVE, ENDODONTICS, PERIODONTICS, PROSTHREMOV, MAXILLOPROSTH, IMPLANTSERV, PROSTHOFIXED, ORALSURGERY, ORTHODONTICS, ADJUNCTSERV, MULTICODES, PRODUCTS, SLEEPAPNEASERV. - **lastModified (>, >=, <, <=):** - ?filter=lastModified>2025-01-01: Retrieves resources where lastModified is after 2025-01-01. - ?filter=lastModified<2025-01-01: Retrieves resources where lastModified is before 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves resources where lastModified is on or after 2025-01-01. - ?filter=lastModified<=2025-01-01: Retrieves resources where lastModified is on or before 2025-01-01. 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. Default value is 1. schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control. Default value is 100. schema: type: string example: 100 - name: lastId in: query required: false description: The biggest practiceProcedureId from the 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 tags: - PracticeProcedures (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: PracticeProcedure data 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. tags: - PracticeProcedures (V1) parameters: - name: procedureId in: path required: true description: procedureId for which to get the PracticeProcedure model. 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/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. tags: - PracticeProcedures (V1) parameters: - in: path name: procedureId required: true description: procedureId for which to update the PracticeProcedure model. 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: PracticeProcedure data 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 tags: - PracticeProcedures (V1) parameters: - name: procedureId in: path required: true description: delete the PracticeProcedure model by procedureId. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - ProcedureCategories (V1) 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 responses: '200': description: OK 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: Bad request '401': description: Unauthorized '403': description: Forbidden '429': description: Rate limit exceeded '500': description: Unexpected error operationId: GetProcedurecategoriesV1 /v1/prescriptiondrugcategories: get: summary: Returns a list of PrescriptionDrugCategories (V1) based on filter criteria tags: - PrescriptionDrugCategories (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the prescription drug categories. Filters are of the form: - ?filter=filter1==filter1Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. schema: type: string example: /api/v1/prescriptiondrugcategories?filter=id==123 - name: page in: query required: false description: Page number for pagination control. Default value is 1. schema: type: string example: 1 - name: pageSize in: query required: false description: Page size for pagination control. Default value is 100. schema: type: string example: 100 - name: lastId in: query required: false description: The biggest drugCategoryId from the 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 tags: - PrescriptionDrugCategories (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: PrescriptionDrugCategoryV1 data 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. tags: - PrescriptionDrugCategories (V1) parameters: - name: drugCategoryId in: path required: true description: drugCategoryId for which to get the PrescriptionDrugCategoryV1. 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/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 tags: - PrescriptionDrugCategories (V1) parameters: - name: drugCategoryId in: path required: true description: ID for which to update the PrescriptionDrugCategoryV1. 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 requestBody: description: PrescriptionDrugCategoryV1 data 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 tags: - PrescriptionDrugCategories (V1) parameters: - name: drugCategoryId in: path required: true description: ID for which to delete the PrescriptionDrugCategoryV1. schema: type: integer format: int64 minimum: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PrescriptionDrugUnits (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the prescription drug categories. Filters are of the form ?filter=filter1==filter1Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. 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 drugCategoryId from the 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 tags: - PrescriptionDrugUnits (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: DrugUnit data 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. tags: - PrescriptionDrugUnits (V1) parameters: - name: drugUnitId in: path required: true description: drugUnitId for which to get the PrescriptionDrugUnitV1. schema: type: integer format: int64 minimum: 1 example: 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PrescriptionTemplates (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the prescription templates. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value,filter3->[filter3Value1,filter3Value2]. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Operators:** - **Equals (==)** - **IN (->)** - **Greater than (>)** - **Greater than or equal to (>=)** - **Less than (<)** - **Less than or equal to (<=)** **Valid Filter Keys:** - **drugCategory.id (==)**: Example - ?filter=drugCategory.id==123 (Retrieves resources where drugCategory.id equals 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 the 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 tags: - PrescriptionTemplates (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: PrescriptionTemplateV1 data 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. tags: - PrescriptionTemplates (V1) parameters: - in: path name: prescriptionTemplateId required: true description: ID of the PrescriptionTemplateV1 for which to get the model. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - PrescriptionTemplates (V1) parameters: - in: path name: prescriptionTemplateId required: true description: ID for which to update the PrescriptionTemplateV1. schema: type: integer format: int64 minimum: 1 example: 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: PrescriptionTemplateV1 data 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 tags: - PrescriptionTemplates (V1) parameters: - name: prescriptionTemplateId in: path required: true description: ID for which to update the PrescriptionTemplateV1. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - ProviderGroups (V1) parameters: - in: header name: Organization-ID 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: filter in: query required: false description: > Specifies the criteria by which to filter the provider groups. Filters are of the form ?filter=filter1==filter1Value,filter2->[filter2Value]. Valid operators are equals(==) and in(->). Equals operators check for exact match. **Valid filter keys are:** - **id (->)**: - ?filter=id->[789,790] (Retrieves resources where id matches one or more IDs in the list) - **groupName (== and !=)**: - ?filter=groupName==My Group (Retrieves resources where groupName equals 'My Group') - ?filter=groupName!=My Group (Retrieves resources where groupName is NOT equals 'My Group') - **lastModified (>=, >, <=, <):** - ?filter=lastModified>=2022-01-01: Retrieves providerGroup with lastModified date greater than or equal to 2022-01-01. - ?filter=lastModified>2022-01-01: Retrieves providerGroup with lastModified date strictly greater than 2022-01-01. - ?filter=lastModified<=2022-01-01: Retrieves providerGroup with lastModified date less than or equal to 2022-01-01. - ?filter=lastModified<2022-01-01: Retrieves providerGroup with lastModified date strictly less than 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 tags: - ProviderGroups (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - name: OrganizationId in: header required: true schema: type: string example: 1001 requestBody: description: ProviderHour data 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. tags: - ProviderGroups (V1) parameters: - name: providerGroupId in: path required: true description: providerGroupId for which to get the providerGroup model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - ProviderGroups (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - in: path name: providerGroupId required: true description: ProviderGroupId for which to update the ProviderGroup model. 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: ProviderGroup data 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 tags: - ProviderGroups (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - name: providerGroupId in: path required: true description: Delete the ProviderGroup model by ProviderGroupId 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 tags: - ProviderHours (V1) parameters: - in: header name: Organization-ID 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: filter in: query required: false description: > Specifies the criteria by which to filter the provider hours. Filters are of the form ?filter=filter1==filter1Value,filter2->[filter2Value]. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==) and in(->). Equals operators check for exact match. **Valid filter keys are:** - **location.id (== and ->)**: - ?filter=location.id==123 (Retrieves resources where location.id equals 123) - ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) - ?filter=location.id->[123,124] (Retrieves resources where location.id matches one or more IDs in the list) - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **provider.id (== and ->)**: - ?filter=provider.id==789 (Retrieves resources where provider.id equals 789) - ?filter=provider.id->[789,790] (Retrieves resources where provider.id matches one or more IDs in the list) - **endDate (>, <, >=, and <=)**: - ?filter=endDate>2025-01-25 (Retrieves resources where endDate is after 2025-01-25) - ?filter=endDate<2025-01-25 (Retrieves resources where endDate is before 2025-01-25) - ?filter=endDate>=2025-01-25 (Retrieves resources where endDate is on or after 2025-01-25) - ?filter=endDate<=2025-01-25 (Retrieves resources where endDate is on or before 2025-01-25) - **startDate (>, <, >=, and <=)**: - ?filter=startDate>2025-01-25 (Retrieves resources where startDate is after 2025-01-25) - ?filter=startDate<2025-01-25 (Retrieves resources where startDate is before 2025-01-25) - ?filter=startDate>=2025-01-25 (Retrieves resources where startDate is on or after 2025-01-25) - ?filter=startDate<=2025-01-25 (Retrieves resources where startDate is on or before 2025-01-25) - **lastModified (>=, >, <=, <):** - ?filter=lastModified>=2022-01-01: Retrieves medicalAlertCategory with lastModified date greater than or equal to 2022-01-01. - ?filter=lastModified>2022-01-01: Retrieves medicalAlertCategory with lastModified date strictly greater than 2022-01-01. - ?filter=lastModified<=2022-01-01: Retrieves medicalAlertCategory with lastModified date less than or equal to 2022-01-01. - ?filter=lastModified<2022-01-01: Retrieves medicalAlertCategory with lastModified date strictly less than 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 tags: - ProviderHours (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - name: OrganizationId in: header required: true schema: type: string example: 1001 requestBody: description: ProviderHour data 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. tags: - ProviderHours (V1) parameters: - name: providerHourId in: path required: true description: providerHourId for which to get the providerHour model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - ProviderHours (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - in: path name: providerHourId required: true description: ProviderHourId for which to update the ProviderHour model. 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: ProviderHour data 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 tags: - ProviderHours (V1) parameters: - $ref: '#/components/parameters/OrganizationId' - name: providerHourId in: path required: true description: Delete the ProviderHour model by ProviderHourId 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Providers (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the providers. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (->) - ?filter=id->[1000000020702,1000000020703] (Retrieves resources where id matches one or more IDs in the list) location.id (==, ->) - ?filter=location.id==123 (Retrieves resources where location.id equals 123) ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) ?filter=location.id->[123,124] (Retrieves resources where location.id matches one or more IDs in the list) ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). user.id (==, ->) - ?filter=user.id==789 (Retrieves resources where user.id equals 789) ?filter=user.id->[789,790] (Retrieves resources where user.id matches one or more IDs in the list) lastModified (>, >=, <, <=) - ?filter=lastModified>=2025-01-14 (Retrieves resources where lastModified is greater than or equal to 2025-01-14) ?filter=lastModified>2025-01-14 (Retrieves resources where lastModified is strictly greater than 2025-01-14) ?filter=lastModified<=2025-01-14 (Retrieves resources where lastModified is less than or equal to 2025-01-14) ?filter=lastModified<2025-01-14 (Retrieves resources where lastModified is strictly less than 2025-01-14) 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 tags: - Providers (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: ProviderV1 data 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. tags: - Providers (V1) parameters: - name: providerId in: path required: true description: providerId for which to get the providerV1 model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - Providers (V1) parameters: - in: path name: providerId required: true description: providerId for which to update the providerV1 model. schema: type: integer format: int64 minimum: 1 example: 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: ProviderV1 data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - RecareTemplates (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the recareTemplates. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), greater than (>), greater than equal to (>=), less than (<) and less than equal to (<=). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: lastModified (>, >=, <, <=) - ?filter=lastModified>=2025-01-14 (Retrieves resources where lastModified is greater than or equal to 2025-01-14) ?filter=lastModified>2025-01-14 (Retrieves resources where lastModified is strictly greater than 2025-01-14) ?filter=lastModified<=2025-01-14 (Retrieves resources where lastModified is less than or equal to 2025-01-14) ?filter=lastModified<2025-01-14 (Retrieves resources where lastModified is strictly less than 2025-01-14) 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 ID of RecareTemplateV1 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 tags: - RecareTemplates (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: RecareTemplateV1 data 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. tags: - RecareTemplates (V1) parameters: - name: recareTemplateId in: path required: true description: ID for getting the RecareTemplateV1. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - RecareTemplates (V1) parameters: - in: path name: recareTemplateId required: true description: ID for which to update the RecareTemplateV1. schema: type: integer format: int64 minimum: 1 example: 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: RecareTemplateV1 data 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 tags: - RecareTemplates (V1) parameters: - name: recareTemplateId in: path required: true description: ID for which to delete the RecareTemplateV1. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - PatientBookingAvailabilities (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the operatories. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **location.id (==, != and ->):** - ?filter=location.id==456: Retrieves resources where location.id equals 456. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves resources across all locations. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests results across all locations. - ?filter=location.id!=456: Retrieves resources where location.id does not equal 456. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). 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 the 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 tags: - PatientBookingAvailabilities (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Patient Booking Availability data 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. tags: - PatientBookingAvailabilities (V1) parameters: - name: patientBookingAvailabilityId in: path required: true description: ID of the patient booking availability for which to get the patient booking availability model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - PatientBookingAvailabilities (V1) parameters: - in: path name: patientBookingAvailabilityId required: true description: ID of the patient booking vailability for which to update the patient booking availability model. schema: type: integer format: int64 minimum: 1 example: 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: Patient Booking Availability data 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 tags: - PatientBookingAvailabilities (V1) parameters: - name: patientBookingAvailabilityId in: path required: true description: ID of the patient booking availability for which to delete the patient booking availability model. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - ScheduleTemplates (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the schedule templates. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (->):** - ?filter=id->[456,789]: Retrieves resources where id is either 456 or 789. - **operatory.id (==, ->):** - ?filter=operatory.id==123: Retrieves resources where operatory.id equals 123. - ?filter=operatory.id->[456,789]: Retrieves resources where operatory.id is either 456 or 789. - **location.id (==, != and ->):** - ?filter=location.id==123: Retrieves resources where location.id equals 123. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves resources across all locations. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests results across all locations. - ?filter=location.id!=456: Retrieves resources where location.id does not equal 456. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["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 schedule template Id from the 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 tags: - ScheduleTemplates (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Schedule Template (V1) data 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. tags: - ScheduleTemplates (V1) parameters: - name: scheduleTemplateId in: path required: true description: ID of the schedule template (V1) for which to get the schedule template (V1) model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - ScheduleTemplates (V1) parameters: - in: path name: scheduleTemplateId required: true description: ID of the schedule template for which to update the schedule template model. schema: type: integer format: int64 minimum: 1 example: 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: Schedule Template data 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 tags: - ScheduleTemplates (V1) parameters: - name: scheduleTemplateId in: path required: true description: ID of the schedule template (V1) for which to delete the schedule template (V1) model. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - TransferReasons (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the transfer reasons. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), less than equal to (<=) and in (->). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: id (->) - ?filter=id->[1000000020702,1000000020703] (Retrieves resources where id is in the list [1000000020702, 1000000020703]) tagText (==, !=, ~=, and <>=) - ?filter=tagText==urgent (Retrieves resources where tagText exactly matches urgent) ?filter=tagText!=important (Retrieves resources where tagText is not equal to important) ?filter=tagText~=high (Retrieves resources where tagText starts with high) ?filter=tagText<>=critical (Retrieves resources where tagText does not equal critical) 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 tags: - TransferReasons (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: TransferReason data 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. tags: - TransferReasons (V1) parameters: - in: path name: transferReasonId required: true description: ID of the transfer reason for which to get the transfer reason model. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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. tags: - TransferReasons (V1) parameters: - in: path name: transferReasonId required: true description: transferReasonId for which to update the TransferReasonV1 model. schema: type: integer format: int64 minimum: 1 example: 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: TransferReasonV1 data 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 tags: - TransferReasons (V1) parameters: - in: path name: transferReasonId required: true description: delete the TransferReasonV1 model by transferReasonId. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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. tags: - ReferralSources (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the ReferralSources. Filters are of the form: - ?filter=filter1==filter1Value,filter2!=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **firstName (~=):** - ?filter=firstName~=John: Retrieves resources where firstName contains the substring "John" (case insensitive). - **lastName (~=):** - ?filter=lastName~=Doe: Retrieves resources where lastName contains the substring "Doe" (case insensitive). - **referralSourceType (==, !=):** - ?filter=referralSourceType==Online: Retrieves resources where referralSourceType equals "Online". - ?filter=referralSourceType!=Offline: Retrieves resources where referralSourceType does not equal "Offline". - **lastModified (>, >=, <, <=):** - ?filter=lastModified>=2025-01-14: Retrieves resources where lastModified is greater than or equal to 2025-01-14. - ?filter=lastModified>2025-01-14: Retrieves resources where lastModified is strictly greater than 2025-01-14. - ?filter=lastModified<=2025-01-14: Retrieves resources where lastModified is less than or equal to 2025-01-14. - ?filter=lastModified<2025-01-14: Retrieves resources where lastModified is strictly less than 2025-01-14. 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 the 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. tags: - ReferralSources (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: ReferralSource data 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. tags: - ReferralSources (V1) parameters: - name: referralSourceId in: path required: true description: ReferralSourceId for which to get the ReferralSource model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - ReferralSources (V1) parameters: - in: path name: referralSourceId required: true description: ReferralSourceId for which to update the ReferralSource model. schema: type: integer format: int64 minimum: 1 example: 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: ReferralSource data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 schema: type: string example: 1006 - name: responseFields in: query required: false description: |- URL-encoded, comma-delimited field names to include in each item in `data`. Allowed values: `provider`, `operatory`, `day`, `slots`. When omitted, all of these fields are returned. schema: type: string style: form explode: false - name: filter in: query required: true description: >- Filter schedule openings (comma-separated clauses). Operators and list patterns: the Public API filter documentation. **Required (always):** - **location.id** (`==`): Location ID. - **startDate** (`==`): Range start, `YYYY-MM-DD` (interpreted in the location time zone). - **endDate** (`==`): Range end, `YYYY-MM-DD` (inclusive). `endDate` must be on or after `startDate`. The number of days from `startDate` through `endDate` must not exceed **14**. **Optional:** - **operatory.id** (`==` or `->`): One operatory or a list, e.g. `operatory.id->[456,457]`. If omitted, all active operatories at the location are used. - **provider.id** (`==` or `->`): One provider or a list. If omitted, all active non–non-person providers for the organization are used. - **minOpeningLength** (`==`): Minimum slot length in minutes; **5–1440**. Default is **60** if omitted. - **booking.type** (`==` or `->`): One or more of `TREATMENT`, `RECARE`, `NEW_PATIENT`, `EXISTING_PATIENT`. - **reason.id** (`==` or `->`): Schedule template reason ID(s). - **scheduleTemplate.id** (`==` or `->`): One or more schedule template IDs. When present, the request uses the template-specific flow. **Do not** combine with `booking.type` or `reason.id` (the API returns a validation error if you do). **Conflicts:** `booking.type` and `reason.id` cannot be used together with `scheduleTemplate.id`. **MCP (first successful call):** include `location.id`, `startDate`, and `endDate` (`YYYY-MM-DD`), with the span ≤ 14 days, e.g. `?filter=location.id==123,startDate==2026-04-07,endDate==2026-04-08`. 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 tags: - ScheduleTemplateAppointmentReasons (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the schedule template appointment reasons. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **location.id (==, != and ->):** - ?filter=location.id==123;location.id!=456: Retrieves resources where location.id equals 123, but does not equal 456. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves resources across all locations. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests results across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **lastModified (>, >=, <, <=):** - ?filter=lastModified>=2025-01-14: Retrieves resources where lastModified is greater than or equal to 2025-01-14. - ?filter=lastModified>2025-01-14: Retrieves resources where lastModified is strictly greater than 2025-01-14. - ?filter=lastModified<=2025-01-14: Retrieves resources where lastModified is less than or equal to 2025-01-14. - ?filter=lastModified<2025-01-14: Retrieves resources where lastModified is strictly less than 2025-01-14. 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 the 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 tags: - ScheduleTemplateAppointmentReasons (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Schedule Template Appointment Reason data 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. tags: - ScheduleTemplateAppointmentReasons (V1) parameters: - name: scheduleTemplateAppointmentReasonId in: path required: true description: >- ID of the schedule template appointment reason for which to get the schedule template appointment reason model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - ScheduleTemplateAppointmentReasons (V1) parameters: - in: path name: scheduleTemplateAppointmentReasonId required: true description: >- ID of the schedule template appointment reason for which to update the schedule template appointment reason model. schema: type: integer format: int64 minimum: 1 example: 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: Schedule Template Appointment Reason data 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 tags: - ScheduleTemplateAppointmentReasons (V1) parameters: - name: scheduleTemplateAppointmentReasonId in: path required: true description: >- ID of the schedule template appointment reason for which to delete the schedule template appointment reason model. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - ScheduleTemplateReasons (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the schedule template reasons. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **location.id (==, != and ->):** - ?filter=location.id==123;location.id!=456: Retrieves resources where location.id equals 123, but does not equal 456. - ?filter=location.id==ALL or ?filter=location.id==\*: Retrieves resources across all locations. - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"]: Explicitly requests results across all locations. - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). **Valid Operators:** - **equals (==)**: Exact match. - **not equals (!=)**: Exact non-match. - **like (~=)**: Performs text search for field values that start with the given value. - **not like (<>=)**: Performs text search for field values that do not start with the given value. - **greater than (>)**: Values greater than the given value. - **greater than or equal to (>=)**: Values greater than or equal to the given value. - **less than (<)**: Values less than the given value. - **less than or equal to (<=)**: Values less than or equal to the given value. - **contains (->)**: Contains a substring. 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 the 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 tags: - ScheduleTemplateReasons (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Schedule Template Reason (V1) data 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. tags: - ScheduleTemplateReasons (V1) parameters: - name: scheduleTemplateReasonId in: path required: true description: ID of the schedule template reason (V1) for which to get the schedule template reason model. schema: type: integer format: int64 minimum: 1 example: 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/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). tags: - ScheduleTemplateReasons (V1) parameters: - in: path name: scheduleTemplateReasonId required: true description: ID of the schedule template reason for which to update the schedule template reason model (V1). schema: type: integer format: int64 minimum: 1 example: 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: Schedule Template Reason (V1) data 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 tags: - ScheduleTemplateReasons (V1) parameters: - name: scheduleTemplateReasonId in: path required: true description: ID of the schedule template reason (V1) for which to delete the schedule template reason model. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Signatures (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the operatories. Filters are of the form: - ?filter=filter1==filter1Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operator is equals (==). Valid filter keys are: - **id (==, ->)**: - ?filter=id==123 (Retrieves resources where id equals 123) - ?filter=id->[123, 456] (Retrieves resources where id is either 123 or 456) - **user.id (==)**: - ?filter=user.id==789 (Retrieves resources where user.id equals 789) 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 the 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 tags: - Signatures (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: User data 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 tags: - Signatures (V1) parameters: - name: signatureId in: path required: true description: signature ID for which to get the signature model schema: type: string example: 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - SMSNumber (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the SMS numbers. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), less than equal to (<=), or contains (->). Equals operators check for exact match. Like operators perform text search for field values that start with the given value. Valid filter keys are: - **number (==, ->)**: - ?filter=number==123 (Retrieves resources where number equals 123) - ?filter=number->[123, 456] (Retrieves resources where number is either 123 or 456) - **location.id (== and ->)**: - ?filter=location.id==789 (Retrieves resources where location.id equals 789) - ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["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 SmsNumberId from the 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. tags: - SMSNumber (V1) parameters: - name: smsNumberId in: path required: true description: ID for getting the SMSNumber. schema: type: integer format: int64 minimum: 1 example: 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - SubscriberInsurancePlans (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the subscriber insurance plans. Filters are of the form: - ?filter=filter1==filter1Value,filter2->filter2Value,filter3~=filter3Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), like (~=), and in (->). Equals operators check for exact match. Like operators perform text search for field values that start with the given value. Valid filter keys are: - **id (==, ->)**: - ?filter=id==123 (Retrieves resources where id equals 123) - ?filter=id->[123, 456] (Retrieves resources where id is either 123 or 456) - **patient.id (==, ->)**: - ?filter=patient.id==789 (Retrieves resources where patient.id equals 789) - ?filter=patient.id->[789, 790] (Retrieves resources where patient.id is either 789 or 790) - **lastModified (>=, >, <=, <)**: - ?filter=lastModified>=2025-01-01 (Retrieves resources where lastModified is greater than or equal to 2025-01-01) - ?filter=lastModified>2025-01-01 (Retrieves resources where lastModified is after 2025-01-01) - ?filter=lastModified<=2025-01-31 (Retrieves resources where lastModified is on or before 2025-01-31) - ?filter=lastModified<2025-01-15 (Retrieves resources where lastModified is before 2025-01-15) 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 the 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. tags: - SubscriberInsurancePlans (V1) parameters: - in: path name: subscriberInsurancePlanId required: true description: the ID of Subscriber Insurance Plan. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Transactions (V1) 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: filter in: query required: true description: > Specifies the criteria by which to filter the transactions. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Mandatory Filters:** All requests must include a valid filter. If pagination parameters (page, pageSize) are used, a valid filter is also required. Requests without a filter or with pagination but no filter will result in a 405 error. - **Pagination with Date Filters:** When filtering by dates (e.g., lastModified), utilize the lastId parameter to navigate through records, as they are sorted by ID. This method is currently the most efficient for pagination. - **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (->)**: - ?filter=id->[123, 124] (Retrieves resources where id is in the list [123, 124]) - **ledgerType (==, !=)**: - ?filter=ledgerType==credit (Retrieves resources where ledgerType equals credit) - ?filter=ledgerType!=debit (Retrieves resources where ledgerType is not equal to debit) - **patient.id (== and ->)**: - ?filter=patient.id==789 (Retrieves resources where patient.id equals 789) - ?filter=patient.id->[789, 790] (Retrieves resources where patient.id is in the list [789, 790]) - **provider.id (==)**: - ?filter=provider.id==456 (Retrieves resources where provider.id equals 456) - **transactionDate (>, <, >=, and <=)**: - ?filter=transactionDate>2025-01-25 (Retrieves resources where transactionDate is after 2025-01-25) - ?filter=transactionDate<2025-01-25 (Retrieves resources where transactionDate is before 2025-01-25) - ?filter=transactionDate>=2025-01-25 (Retrieves resources where transactionDate is on or after 2025-01-25) - ?filter=transactionDate<=2025-01-25 (Retrieves resources where transactionDate is on or before 2025-01-25) - **location.id (==, != and ->)**: - ?filter=location.id==123 (Retrieves resources where location.id equals 123) - ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - ?filter=location.id!=456 (Retrieves resources where location.id is not equal to 456) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **lastModified (>, <, >=, and <=)**: - ?filter=lastModified>2025-01-25 (Retrieves resources where lastModified is after 2025-01-25) - ?filter=lastModified<2025-01-25 (Retrieves resources where lastModified is before 2025-01-25) - ?filter=lastModified>=2025-01-25 (Retrieves resources where lastModified is on or after 2025-01-25) - ?filter=lastModified<=2025-01-25 (Retrieves resources where lastModified is on or before 2025-01-25) **Examples of Valid Filters:** - ?filter=transactionDate>=2025-01-25 - ?filter=ledgerType==credit **Examples of Invalid Filters:** - ?filter=ledgerType== (Empty value, will result in 405 error) - ?filter= (Empty filter, key will result in 405 error) - ?filter=page=1 or ?filter=pageSize=100 or both page and pageSize without a valid filter (invalid request, will result in 405 error). 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 the 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. tags: - Transactions (V1) parameters: - in: path name: transactionId required: true description: the ID of transaction. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Adjustment Transactions (V1) 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: filter in: query required: true description: > Specifies the criteria by which to filter the transactions. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Mandatory Filters:** All requests must include a valid filter. If pagination parameters (page, pageSize) are used, a valid filter is also required. Requests without a filter or with pagination but no filter will result in a 405 error. - **Pagination with Date Filters:** When filtering by dates (e.g., lastModified), utilize the lastId parameter to navigate through records, as they are sorted by ID. This method is currently the most efficient for pagination. - **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (->)**: - ?filter=id->[123, 124] (Retrieves resources where id is in the list [123, 124]) - **patient.id (== and ->)**: - ?filter=patient.id==789 (Retrieves resources where patient.id equals 789) - ?filter=patient.id->[789, 790] (Retrieves resources where patient.id is in the list [789, 790]) - **provider.id (==)**: - ?filter=provider.id==456 (Retrieves resources where provider.id equals 456) - **ledgerType (==, !=)**: - ?filter=ledgerType==credit (Retrieves resources where ledgerType equals credit) - ?filter=ledgerType!=debit (Retrieves resources where ledgerType is not equal to debit) - **transactionDate (>, <, >=, and <=)**: - ?filter=transactionDate>2025-01-25 (Retrieves resources where transactionDate is after 2025-01-25) - ?filter=transactionDate<2025-01-25 (Retrieves resources where transactionDate is before 2025-01-25) - ?filter=transactionDate>=2025-01-25 (Retrieves resources where transactionDate is on or after 2025-01-25) - ?filter=transactionDate<=2025-01-25 (Retrieves resources where transactionDate is on or before 2025-01-25) - **location.id (==, != and ->)**: - ?filter=location.id==123 (Retrieves resources where location.id equals 123) - ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - ?filter=location.id!=456 (Retrieves resources where location.id is not equal to 456) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **lastModified (>, <, >=, and <=)**: - ?filter=lastModified>2025-01-25 (Retrieves resources where lastModified is after 2025-01-25) - ?filter=lastModified<2025-01-25 (Retrieves resources where lastModified is before 2025-01-25) - ?filter=lastModified>=2025-01-25 (Retrieves resources where lastModified is on or after 2025-01-25) - ?filter=lastModified<=2025-01-25 (Retrieves resources where lastModified is on or before 2025-01-25) **Examples of Valid Filters:** - ?filter=transactionDate>=2025-01-25 - ?filter=ledgerType==credit **Examples of Invalid Filters:** - ?filter=ledgerType== (Empty value, will result in 405 error) - ?filter= (Empty filter, key will result in 405 error) - ?filter=page=1 or ?filter=pageSize=100 or both page and pageSize without a valid filter (invalid request, will result in 405 error). schema: type: string - name: page in: query required: false description: >- Page number for pagination control. **Must be used with a valid filter. If used without a valid filter, this will return a 405 error.** schema: type: string example: 1 - name: pageSize in: query required: false description: >- Page size for pagination control. **Must be used with a valid filter. If used without a valid filter, this will return a 405 error.** schema: type: string example: 100 - name: lastId in: query required: false description: The biggest patient ledger ID from the 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. tags: - Adjustment Transactions (V1) parameters: - in: path name: transactionId required: true description: the ID of transaction. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Insurance Payment Transactions (V1) 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: filter in: query required: true description: > Specifies the criteria by which to filter the transactions. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Mandatory Filters:** All requests must include a valid filter. If pagination parameters (page, pageSize) are used, a valid filter is also required. Requests without a filter or with pagination but no filter will result in a 405 error. - **Pagination with Date Filters:** When filtering by dates (e.g., lastModified), utilize the lastId parameter to navigate through records, as they are sorted by ID. This method is currently the most efficient for pagination. - **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (->)**: - ?filter=id->[123, 124] (Retrieves resources where id is in the list [123, 124]) - **patient.id (== and ->)**: - ?filter=patient.id==789 (Retrieves resources where patient.id equals 789) - ?filter=patient.id->[789, 790] (Retrieves resources where patient.id is in the list [789, 790]) - **transactionDate (>, <, >=, and <=)**: - ?filter=transactionDate>2025-01-25 (Retrieves resources where transactionDate is after 2025-01-25) - ?filter=transactionDate<2025-01-25 (Retrieves resources where transactionDate is before 2025-01-25) - ?filter=transactionDate>=2025-01-25 (Retrieves resources where transactionDate is on or after 2025-01-25) - ?filter=transactionDate<=2025-01-25 (Retrieves resources where transactionDate is on or before 2025-01-25) - **location.id (==, != and ->)**: - ?filter=location.id==123 (Retrieves resources where location.id equals 123) - ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - ?filter=location.id!=456 (Retrieves resources where location.id is not equal to 456) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **provider.id (==)**: - ?filter=provider.id==456 (Retrieves resources where provider.id equals 456) - **lastModified (>, <, >=, and <=)**: - ?filter=lastModified>2025-01-25 (Retrieves resources where lastModified is after 2025-01-25) - ?filter=lastModified<2025-01-25 (Retrieves resources where lastModified is before 2025-01-25) - ?filter=lastModified>=2025-01-25 (Retrieves resources where lastModified is on or after 2025-01-25) - ?filter=lastModified<=2025-01-25 (Retrieves resources where lastModified is on or before 2025-01-25) **Examples of Valid Filters:** - ?filter=transactionDate>=2025-01-25 - ?filter=ledgerType==credit **Examples of Invalid Filters:** - ?filter=ledgerType== (Empty value, will result in a 405 error) - ?filter= (Empty filter, key will result in a 405 error) - ?filter=page=1 or ?filter=pageSize=100 or both page and pageSize without a valid filter (invalid request, will result in 405 error). 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 the 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. tags: - Insurance Payment Transactions (V1) parameters: - in: path name: transactionId required: true description: the ID of transaction. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Patient Payment Transactions (V1) 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: filter in: query required: true description: > Specifies the criteria by which to filter the transactions. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Mandatory Filters:** All requests must include a valid filter. If pagination parameters (page, pageSize) are used, a valid filter is also required. Requests without a filter or with pagination but no filter will result in a 405 error. - **Pagination with Date Filters:** When filtering by dates (e.g., lastModified), utilize the lastId parameter to navigate through records, as they are sorted by ID. This method is currently the most efficient for pagination. - **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (->)**: - ?filter=id->[123, 124] (Retrieves resources where id is in the list [123, 124]) - **patient.id (== and ->)**: - ?filter=patient.id==789 (Retrieves resources where patient.id equals 789) - ?filter=patient.id->[789, 790] (Retrieves resources where patient.id is in the list [789, 790]) - **transactionDate (>, <, >=, and <=)**: - ?filter=transactionDate>2025-01-25 (Retrieves resources where transactionDate is after 2025-01-25) - ?filter=transactionDate<2025-01-25 (Retrieves resources where transactionDate is before 2025-01-25) - ?filter=transactionDate>=2025-01-25 (Retrieves resources where transactionDate is on or after 2025-01-25) - ?filter=transactionDate<=2025-01-25 (Retrieves resources where transactionDate is on or before 2025-01-25) - **location.id (==, != and ->)**: - ?filter=location.id==123 (Retrieves resources where location.id equals 123) - ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - ?filter=location.id!=456 (Retrieves resources where location.id is not equal to 456) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **lastModified (>, <, >=, and <=)**: - ?filter=lastModified>2025-01-25 (Retrieves resources where lastModified is after 2025-01-25) - ?filter=lastModified<2025-01-25 (Retrieves resources where lastModified is before 2025-01-25) - ?filter=lastModified>=2025-01-25 (Retrieves resources where lastModified is on or after 2025-01-25) - ?filter=lastModified<=2025-01-25 (Retrieves resources where lastModified is on or before 2025-01-25) **Examples of Valid Filters:** - ?filter=transactionDate>=2025-01-25 - ?filter=ledgerType==credit **Examples of Invalid Filters:** - ?filter=ledgerType== (Empty value, will result in 405 error) - ?filter= (Empty filter, key will result in 405 error) - ?filter=page=1 or ?filter=pageSize=100 or both page and pageSize without a valid filter (invalid request, will result in 405 error). 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 the 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. tags: - Patient Payment Transactions (V1) parameters: - in: path name: transactionId required: true description: the ID of transaction. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Patient Procedure Transactions (V1) 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: filter in: query required: true description: > Specifies the criteria by which to filter the transactions. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Mandatory Filters:** All requests must include a valid filter. If pagination parameters (page, pageSize) are used, a valid filter is also required. Requests without a filter or with pagination but no filter will result in a 405 error. - **Pagination with Date Filters:** When filtering by dates (e.g., lastModified), utilize the lastId parameter to navigate through records, as they are sorted by ID. This method is currently the most efficient for pagination. - **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Operators:** - **id (->)**: - ?filter=id->[123, 124] (Retrieves resources where id is in the list [123, 124]) - **ledgerType (==, !=)**: - ?filter=ledgerType==credit (Retrieves resources where ledgerType equals credit) - ?filter=ledgerType!=debit (Retrieves resources where ledgerType is not equal to debit) - **patient.id (== and ->)**: - ?filter=patient.id==789 (Retrieves resources where patient.id equals 789) - ?filter=patient.id->[789, 790] (Retrieves resources where patient.id is in the list [789, 790]) - **provider.id (==)**: - ?filter=provider.id==456 (Retrieves resources where provider.id equals 456) - **transactionDate (>, <, >=, and <=)**: - ?filter=transactionDate>2025-01-25 (Retrieves resources where transactionDate is after 2025-01-25) - ?filter=transactionDate<2025-01-25 (Retrieves resources where transactionDate is before 2025-01-25) - ?filter=transactionDate>=2025-01-25 (Retrieves resources where transactionDate is on or after 2025-01-25) - ?filter=transactionDate<=2025-01-25 (Retrieves resources where transactionDate is on or before 2025-01-25) - **location.id (==, != and ->)**: - ?filter=location.id==123 (Retrieves resources where location.id equals 123) - ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - ?filter=location.id!=456 (Retrieves resources where location.id is not equal to 456) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["ALL"]). - **lastModified (>, <, >=, and <=)**: - ?filter=lastModified>2025-01-25 (Retrieves resources where lastModified is after 2025-01-25) - ?filter=lastModified<2025-01-25 (Retrieves resources where lastModified is before 2025-01-25) - ?filter=lastModified>=2025-01-25 (Retrieves resources where lastModified is on or after 2025-01-25) - ?filter=lastModified<=2025-01-25 (Retrieves resources where lastModified is on or before 2025-01-25) **Examples of Valid Filters:** - ?filter=transactionDate>=2025-01-25 - ?filter=ledgerType==credit **Examples of Invalid Filters:** - ?filter=ledgerType== (Empty value, will result in 405 error) - ?filter= (Empty filter, key will result in 405 error) - ?filter=page=1 or ?filter=pageSize=100 or both page and pageSize without a valid filter (invalid request, will result in 405 error). 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 the 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. tags: - Patient Procedure Transactions (V1) parameters: - in: path name: transactionId required: true description: the ID of transaction. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - TransactionTags (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the transaction tags. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals(==), not equals(!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), less than equal to (<=) and in (->). Equals operators check for exact match, like operators perform text search for field values that start with the given value. Valid filter keys are: tagText (==, !=, ~=, and <>=) - ?filter=tagText==exampleText (Retrieves resources where tagText equals exampleText) ?filter=tagText!=exampleText (Retrieves resources where tagText is not equal to exampleText) ?filter=tagText~=sample (Retrieves resources where tagText contains text starting with sample) ?filter=tagText<>=sample (Retrieves resources where tagText contains sample anywhere) tagType (== and !=) - ?filter=tagType==TypeA (Retrieves resources where tagType equals TypeA) ?filter=tagType!=TypeB (Retrieves resources where tagType is not equal to TypeB) id (->) - ?filter=id->[1000000020702,1000000020703] (Retrieves resources where id is in the list [1000000020702, 1000000020703]) 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 tags: - TransactionTags (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: TransactionTag data 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. tags: - TransactionTags (V1) parameters: - in: path name: transactionTagId required: true description: ID of the transaction tag for which to get the transaction tag model. schema: type: integer format: int64 minimum: 1 example: 1 - in: header name: Organization-ID 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/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 tags: - TransactionTags (V1) parameters: - in: path name: transactionTagId required: true description: delete the TransactionTag model by transactionTagId. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - TxCases (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 - name: filter in: query required: false description: > Specifies the criteria by which to filter the TxCases. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Examples:** - **patient.id (==):** - ?filter=patient.id==123: Retrieves TxCases where patient.id equals 123. - **lastModified (>, >=, <, <=):** - ?filter=lastModified>2025-01-01: Retrieves TxCases where lastModified is after 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves TxCases where lastModified is greater than or equal to 2025-01-01. - ?filter=lastModified<2025-01-15: Retrieves TxCases where lastModified is before 2025-01-15. - ?filter=lastModified<=2025-01-31: Retrieves TxCases where lastModified is on or before 2025-01-31. 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 providerId from the 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 tags: - TxCases (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: TxCaseV1 data 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 schema: type: string example: 1006 - name: filter in: query required: true description: |- Select TxCases for calculated fields. Filter grammar: the Public API filter documentation. **Key** - `ids` (`->`) — e.g. `ids->[1001,1002,1003]` **MCP (first successful call):** `filter=ids->[]` with at least one real tx case id, and `responseFields=isCompleted` (required). 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. tags: - TxCases (V1) parameters: - name: txCaseId in: path required: true description: ID for which to get the TxCase. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - TxCases (V1) parameters: - in: path name: txCaseId required: true description: ID for which to update the TxCaseV1. schema: type: integer format: int64 minimum: 1 example: 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: TxCaseV1 data 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 tags: - TxCases (V1) parameters: - name: txCaseId in: path required: true description: ID for which to delete the TxCaseV1. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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: txCaseId for which to get the calculated fields of TxCaseV1. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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. tags: - TxCases (V1) parameters: - name: txCaseId in: path required: true description: txCaseId for which to get the total amount of TxCaseV1. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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 tags: - Users (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 - name: filter in: query required: false description: > Specifies the criteria by which to filter the users. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), less than equal to (<=), or contains (->). Equals operators check for exact match. Like operators perform text search for field values that start with the given value. Valid filter keys are: - **id (->)**: - ?filter=id->[1000001,1000002] (Retrieves resources where id matches one of the values in the list [1000001, 1000002]) - **roles.location.id (== and ->)**: - ?filter=roles.location.id==123 (Retrieves resources where roles.location.id equals 123) - ?filter=roles.location.id==ALL OR ?filter=roles.location.id==\* (Retrieves users across all locations) - ?filter=roles.location.id->[123,124] (Retrieves users with a role at one or more of the listed location IDs) - ?filter=roles.location.id->["ALL"] OR ?filter=roles.location.id->["*"] (Explicitly requests results across all locations) - **NOTE:** - For a transitional period, omitting roles.location.id will default to ALL locations. - Soon, roles.location.id will become a required filter (IDs list or ["ALL"]). - **userName (==, ~=)**: - ?filter=userName==john_doe (Retrieves resources where userName is exactly john_doe) - ?filter=userName~=john (Retrieves resources where userName starts with john) - **email (==, ~=)**: - ?filter=email==example@domain.com (Retrieves resources where email is exactly example@domain.com) - ?filter=email~=domain (Retrieves resources where email contains domain) - **roles.role (==, ->)**: - ?filter=roles.role==123 (Retrieves resources where roles.role equals 123) - ?filter=roles.role->[123,456] (Retrieves resources where roles.role is either 123 or 456) - **enabled (==, !=)**: - ?filter=enabled==true (Retrieves resources where enabled is true) - ?filter=enabled!=false (Retrieves resources where enabled is not false) 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 the 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 tags: - Users (V1) parameters: - name: userId in: path required: true description: ID of the user for which to get the user model schema: type: string - 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/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. tags: - Users (V1) parameters: - in: path name: userId required: true description: ID of the user for which to update schema: type: string example: 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: User data 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 tags: - Visits (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 - name: filter in: query required: false description: > Specifies the criteria by which to filter the visits. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value. **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. **Valid Filter Keys with Examples:** - **txCase.id (==):** - ?filter=txCase.id==123: Retrieves resources where txCase.id equals 123. - **lastModified (>, >=, <, <=):** - ?filter=lastModified>2025-01-01: Retrieves resources where lastModified is after 2025-01-01. - ?filter=lastModified>=2025-01-01: Retrieves resources where lastModified is greater than or equal to 2025-01-01. - ?filter=lastModified<2025-01-15: Retrieves resources where lastModified is before 2025-01-15. - ?filter=lastModified<=2025-01-31: Retrieves resources where lastModified is on or before 2025-01-31. 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 providerId from the 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 tags: - Visits (V1) parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: Visit data 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. tags: - Visits (V1) parameters: - name: visitId in: path required: true description: ID for which to get the VisitV1. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - Visits (V1) parameters: - in: path name: visitId required: true description: ID for which to update the VisitV1. schema: type: integer format: int64 minimum: 1 example: 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: Visit data 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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. tags: - TimeClockV1 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: filter in: query required: false description: > Specifies the criteria by which to filter the day notes. Filters are of the form: - ?filter=filter1==filter1Value,filter2>=filter2Value **Note:** If you do not provide a date-limiting filter (such as lastModified), one will be automatically applied to your query. The specific filter used may vary depending on the endpoint. Valid operators are equals (==), not equals (!=), like (~=), not like (<>=), greater than (>), greater than equal to (>=), less than (<), less than equal to (<=), or contains (->). Equals operators check for exact match. Like operators perform text search for field values that start with the given value. Valid filter keys are: - **punchDateTime (>, <, >=, <=)**: - ?filter=punchDateTime>=2025-01-01T00:00:00 (Retrieves resources where punchDateTime is on or after 2025-01-01) - ?filter=punchDateTime>2025-01-01T00:00:00 (Retrieves resources where punchDateTime is after 2025-01-01) - ?filter=punchDateTime<=2025-01-01T23:59:59 (Retrieves resources where punchDateTime is on or before 2025-01-01) - ?filter=punchDateTime<2025-01-01T00:00:00 (Retrieves resources where punchDateTime is before 2025-01-01) - **id and user.id (->)**: - ?filter=id->[123, 124] (Retrieves resources where id is in the list [123, 124]) - ?filter=user.id->[789, 790] (Retrieves resources where user.id is in the list [789, 790]) - **location.id (== and ->)**: - ?filter=location.id==456 (Retrieves resources where location.id equals 456) - ?filter=location.id==ALL or ?filter=location.id==\* (Retrieves resources across all locations) - ?filter=location.id->["ALL"] OR ?filter=location.id->["\*"] (Explicitly requests results across all locations) - **NOTE:** - For a transitional period, omitting location.id will default to ALL locations. - Soon, location.id will become a required filter (IDs list or ["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: 100 - name: lastId in: query required: false description: The biggest day note Id from the 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 tags: - TimeClockV1 parameters: - name: Organization-ID in: header required: true schema: type: string example: 1006 requestBody: description: TimeClock data 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. tags: - TimeClockV1 parameters: - name: timeClockId in: path required: true description: timeClock ID for getting the timeClock model. schema: type: integer format: int64 minimum: 1 example: 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/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. tags: - TimeClockV1 parameters: - in: path name: timeClockId required: true description: ID of the timeClock for which to update the timeClock model. schema: type: integer format: int64 minimum: 1 example: 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: TimeClock data 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 tags: - TimeClockV1 parameters: - in: path name: timeClockId required: true description: delete timeClock model by ID. schema: type: integer format: int64 minimum: 1 example: 1 - name: Organization-ID in: header required: true 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 tags: - Total Count (V1) 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: filter in: query required: false description: > Specifies the criteria by which to filter the domain. Filters are of the form ?filter=filter1==filter1Value,filter2>=filter2Value. **Important:** - **Filters are optional when using the Total Count endpoint.** - **To determine the available filter types and operators for a specific endpoint, please refer to the bulk GET operation documentation for that endpoint.** The filter capabilities supported by the Total Count endpoint correspond to those available in the corresponding bulk GET endpoint. **Filter Syntax Examples:** The following examples demonstrate the general filter syntax format. Note that the specific filter keys and operators available vary by endpoint: - Equality operators (==, !=): - ?filter=fieldName==value (Retrieves resources where fieldName equals value) - ?filter=fieldName!=value (Retrieves resources where fieldName is not equal to value) - ?filter=fieldName==ALL OR ?filter=fieldName==\* (Retrieves resources across all values for the specified field) - Comparison operators (>, <, >=, <=): - ?filter=fieldName>value (Retrieves resources where fieldName is greater than value) - ?filter=fieldName=value (Retrieves resources where fieldName is greater than or equal to value) - ?filter=fieldName<=value (Retrieves resources where fieldName is less than or equal to value) - IN operator (->): - ?filter=fieldName->[value1,value2] (Retrieves resources where fieldName matches any of the listed values) - ?filter=fieldName->["ALL"] OR ?filter=fieldName->["\*"] (Retrieves resources across all values for the specified field) - Multiple filters can be combined using commas: - ?filter=field1==value1,field2>=value2 **Note:** For endpoint-specific filter keys, operators, and usage requirements, consult the bulk GET operation documentation for the corresponding endpoint. 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 largest id from the previous page (for pagination purposes). 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: >- Important! This endpoint does not provide any statistics if called on the first day of the month. Filter grammar (including quoted date values for this endpoint): the Public API filter documentation. **Valid filter keys (operator `==` unless noted):** - startDate ( == ): - This filter option is not required. If not set, the default value is the first day of the current month. - Value can not be equal to "endDate". - Value can not be earlier than the first day of the current month. - endDate ( == ): - This filter option is not required. If not set, the default value is the current date. - Value can not be equal to "startDate". - Value can not be earlier than "startDate". - Value can not be later than the current date. "startDate" or "endDate" set in "2025-03-01" format is equal to "2025-03-01:00h:00m:00s" which is equal to start of the day of Mar. 1st - endpoint ( == ): - This filter option is not required. If no value is set, the statistics are returned broken down by endpoint. - This value must be a known endpoint name from the API documentation, without any versioning or special characters. Example of the valid filter: ?filter=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: - {} '401': description: Authentication is required and has failed or has not been provided '403': description: The request is understood, but it has been refused or access is not allowed '404': description: The requested resource is either missing or does not exist '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 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 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: {} 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 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) - 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) - 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)