--- swagger: "2.0" info: version: 1.0.0 title: Configurations x-ibm-name: configurations description: "" basePath: /v1 paths: /configurations: get: summary: Retrieve configurations by type, sub-type, and payer. May return abbreviated versions if multiple are found. operationId: findConfigurations produces: - application/json - application/xml parameters: - name: type type: string in: query description: The type of configuration. required: true - name: subtypeId type: string in: query description: The subtype of the configuration. - name: payerId type: string in: query description: The Availity payer id of the configuration. responses: 200: description: 200 OK schema: $ref: '#/definitions/ResultSet' 400: description: Bad Request schema: $ref: '#/definitions/ErrorResponse' 401: description: Not Authorized schema: $ref: '#/definitions/ErrorResponse' 403: description: Forbidden schema: $ref: '#/definitions/ErrorResponse' 500: description: Internal Server Error schema: $ref: '#/definitions/ErrorResponse' securityDefinitions: oauth2: type: oauth2 description: "" flow: application scopes: hipaa: Realtime - Live HIPAA API tokenUrl: https://api.availity.com/v1/token security: - oauth2: - hipaa x-ibm-configuration: enforced: true testable: true phase: realized schemes: - https definitions: ResultSet: type: object properties: totalCount: type: integer description: Total number of assets. count: type: integer description: Number of assets in the result set. offset: type: integer description: Paging offset. limit: type: integer description: Paging limit. links: type: object description: Links. additionalProperties: $ref: '#/definitions/Link' configurations: type: array description: list of configurations. items: $ref: '#/definitions/Configuration' Link: type: object properties: href: type: string description: The URL. Configuration: type: object description: A payer specific input form display and validation configuration. properties: type: type: string description: The configuration type. categoryId: type: string description: The configuration category id. categoryValue: type: string description: The configuration category value. subtypeId: type: string description: The configuration subtype id. subtypeValue: type: string description: The configuration subtype value. payerId: type: string description: The configuration payer id. payerName: type: string description: The configuration payer name. version: type: string description: The configuration version. sourceId: type: string description: The configuration source id. elements: type: object description: The elements that make up the form. additionalProperties: $ref: '#/definitions/Element' requiredFieldCombinations: type: object description: Each entry in the required field combinations defines a rule where all fields in at least one of the lists of fields must be provided. additionalProperties: type: array items: type: array items: type: string settings: type: object description: Key-value settings. additionalProperties: type: string Element: type: object description: A form element. properties: type: type: string description: The type of element. Generally maps to type of UI element. Unsupported is not show. Boolean is a checkmark. Collection is a searchable REST backed drop down. Date is a date picker. Enumeration is a searchable inline drop down. Information is just text. Section is a grouper or container with text. Text is a standard text box. Number is generally a text box, but serialized as a numeric. Object is grouping like section but with additional metadata. ObjectArray is a repeating grouping with additional metadata. enum: - Unsupported - Boolean - Collection - Date - Enumeration - Information - Section - Text - Number - Object - ObjectArray label: type: string description: A human friendly label. order: type: integer description: The order within the elements. helpTopicId: type: string description: Help topic id. elements: type: object description: Child elements additionalProperties: $ref: '#/definitions/Element' errorMessage: type: string description: An error message. maxRepeats: type: integer description: Number of times an item can repeat. allowed: type: boolean description: Allowed indicator. required: type: boolean description: Required indicator. information: type: array description: A list of information. items: type: string groups: type: array description: A list of groups. items: type: string repeats: type: boolean description: Item repeats indicator. hidden: type: boolean description: Hidden indicator. minRepeats: type: integer description: Minimum number of repetitions. defaultValue: description: A default value. values: description: A list of values. valuesWhen: type: object description: Conditional values. additionalProperties: type: array items: type: object min: type: string format: date-time description: Minimum date. max: type: string format: date-time description: Maximum date. pattern: type: string description: Regular expression. maxLength: type: integer description: The max length. minLength: type: integer description: The minimum length. maxLengthWhen: type: object description: Conditional max lengths. additionalProperties: type: array items: $ref: '#/definitions/FieldCondition' patternWhen: type: object description: Conditional patterns. additionalProperties: type: array items: $ref: '#/definitions/FieldCondition' mode: type: string description: The mode. enum: - DropDown - RadioGroup allowedWhen: type: object description: Field is allowed when one condition is true. additionalProperties: $ref: '#/definitions/FieldCondition' notAllowedWhen: type: object description: Field is not allowed when one condition is true. additionalProperties: $ref: '#/definitions/FieldCondition' requiredWhen: type: object description: Field is required when one condition is true. additionalProperties: $ref: '#/definitions/FieldCondition' notRequiredWhen: type: object description: Field is not required when one condition is true. additionalProperties: $ref: '#/definitions/FieldCondition' objectTypes: type: object description: Object array item type prototype definitions. additionalProperties: $ref: '#/definitions/ObjectType' FieldCondition: type: object properties: equalTo: type: string description: Applies when the field value is equal to this value. containedIn: type: array description: Applies when the field value is in the list. items: type: string greaterThan: type: string description: Applies when the field value is greater than this value. lessThan: type: string description: Applies when the field value is less than this value. greaterEqual: type: string description: Applies when the field value is greater than or equal to this value. lessEqual: type: string description: Applies when the field value is less than or equal to this value. maxLength: type: integer description: Max length. pattern: type: integer description: Regular expression. values: description: Possible values or link to possible values. ObjectType: type: object properties: label: type: string description: A label for this object type. minInstances: type: integer description: Minimum number of instance of this type of object. maxInstances: type: integer description: Maximum number of instance of this type of object. required: type: boolean description: Required indicator. allowedWhen: type: object description: Object type is allowed when one condition is true. additionalProperties: $ref: '#/definitions/FieldCondition' notAllowedWhen: type: object description: Object type is not allowed when one condition is true. additionalProperties: $ref: '#/definitions/FieldCondition' requiredWhen: type: object description: Object type is required when one condition is true. additionalProperties: $ref: '#/definitions/FieldCondition' notRequiredWhen: type: object description: Object type is not required when one condition is true. additionalProperties: $ref: '#/definitions/FieldCondition' fieldValues: type: object description: Object type discriminators. additionalProperties: $ref: '#/definitions/FieldCondition' ErrorResponse: type: object properties: userMessage: type: string description: A high level error message. developerMessage: type: string description: A more technical error message. reasonCode: type: integer description: A reason code. statusCode: type: integer description: The status code. errors: type: array description: A list of detailed user friendly messages. items: $ref: '#/definitions/FieldError' FieldError: type: object properties: field: type: string description: The field or parameter associated with this error. code: type: string description: A code for the error. errorMessage: type: string description: The message associated with this error. index: type: integer description: The array index of the item associated with this error. x-ibm-endpoints: - endpointUrl: https://api.availity.com/availity description: Custom API Endpoint type: - production ...