JOjoincandidhealth
v1

Create a custom schema

Changed on

Create custom schema with a set of typed keys. Schema keys can be referenced as inputs in user-configurable rules in the Rules Engine, and key-value pairs can be attached to claims via the Encounters API.

post/api/custom-schemas/v1

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/custom-schemas/v1
  • Auth
    HTTP bearer

Request body

namestring required
descriptionstring

Response

Response with status 200

idstring uuid required
namestring required
descriptionstring

Changes

  • d8b0a61873e2Revision changes
    • warning

      added the new DATE enum value to the //// response property for the response status

    • warning

      added the new DATE enum value to the // response property for the response status

    • info

      added the new DATE enum value to the request property //

  • 24b2d80d577aRevision changes
    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • breaking

      the / request property type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the optional property to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status