Create a custom schema

Beta

POST

/api/custom-schemas/v1

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.

Request

This endpoint expects an object.

namestringRequired

fieldslist of objectsRequired

descriptionstringOptional

Response

This endpoint returns an object.

idUUID

namestring

fieldslist of objects

descriptionstringOptional

Errors

POST

1 curl -X POST https://api.joincandidhealth.com/api/custom-schemas/v1 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "General Medicine",
6   "fields": [
7     {
8       "key": "provider_category",
9       "type": "STRING"
10     },
11     {
12       "key": "is_urgent_care",
13       "type": "BOOLEAN"
14     },
15     {
16       "key": "bmi",
17       "type": "DOUBLE"
18     },
19     {
20       "key": "age",
21       "type": "INTEGER"
22     }
23   ],
24   "description": "Values associated with a generic visit"
25 }'

200Successful

1 {
2   "id": "ec096b13-f80a-471d-aaeb-54b021c9d582",
3   "name": "General Medicine",
4   "fields": [
5     {
6       "key": "provider_category",
7       "type": "STRING"
8     },
9     {
10       "key": "is_urgent_care",
11       "type": "BOOLEAN"
12     },
13     {
14       "key": "bmi",
15       "type": "DOUBLE"
16     },
17     {
18       "key": "age",
19       "type": "INTEGER"
20     }
21   ],
22   "description": "Values associated with a generic visit"
23 }

Built with

1	curl -X POST https://api.joincandidhealth.com/api/custom-schemas/v1 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "General Medicine",
6	"fields": [
7	{
8	"key": "provider_category",
9	"type": "STRING"
10	},
11	{
12	"key": "is_urgent_care",
13	"type": "BOOLEAN"
14	},
15	{
16	"key": "bmi",
17	"type": "DOUBLE"
18	},
19	{
20	"key": "age",
21	"type": "INTEGER"
22	}
23	],
24	"description": "Values associated with a generic visit"
25	}'

1	{
2	"id": "ec096b13-f80a-471d-aaeb-54b021c9d582",
3	"name": "General Medicine",
4	"fields": [
5	{
6	"key": "provider_category",
7	"type": "STRING"
8	},
9	{
10	"key": "is_urgent_care",
11	"type": "BOOLEAN"
12	},
13	{
14	"key": "bmi",
15	"type": "DOUBLE"
16	},
17	{
18	"key": "age",
19	"type": "INTEGER"
20	}
21	],
22	"description": "Values associated with a generic visit"
23	}