caredb API definition (1.0.0)

caredb API definition

/v1/action-categories

/v1/action-categories/

query Parameters

filter[name]

string <= 60 characters

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"hint": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "action-categories"
}
],
"meta": { }
}

/v1/action-daily-achievements

/v1/action-daily-achievements/

query Parameters

action-id required	string <uuid> Example: action-id=11111111-1111-1111-1111-111111111111
filter[date][gte]	string <date>
filter[date][lt]	string <date>
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"able-to-complete": true,
"achieved": true,
"action": {"type": "able"
},
"action-id": "11111111-1111-1111-1111-111111111111",
"date": "2019-08-24",
"scale-value": "agree",
"value": 0
},
"type": "action-daily-achievements"
}
],
"meta": { }
}

/v1/action-individual-summaries

/v1/action-individual-summaries/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"actions": [{"achieved-count": 0,
"achieved-pct": 0,
"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"scale-most-frequent": "scale-agree",
"type": "able",
"value-avg": 0,
"value-total": 0
}
],
"completed-count": 0,
"extra-count": 0,
"start-date": "2019-08-24",
"total-count": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "action-individual-summaries"
},
"meta": { }
}

/v1/action-reminder-days

/v1/action-reminder-days/

query Parameters

individual-id

required

string <uuid>

Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"buckets": [{"actions": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
}
],
"time": "14:15:22Z",
"type": "afternoon",
"user-muted": true
},
{"actions": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
}
],
"time": "14:15:22Z",
"type": "afternoon",
"user-muted": true
},
{"actions": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
}
],
"time": "14:15:22Z",
"type": "afternoon",
"user-muted": true
},
{"actions": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
}
],
"time": "14:15:22Z",
"type": "afternoon",
"user-muted": true
},
{"actions": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
}
],
"time": "14:15:22Z",
"type": "afternoon",
"user-muted": true
}
],
"day": "friday"
},
"id": "s",
"type": "reminder-days"
}
],
"meta": { }
}

/v1/action-reminder-days/{id}/set-muted/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

bucket-type required	string Enum: "afternoon" "early_morning" "evening" "late_night" "morning"
individual-id required	string <uuid>
user-muted required	boolean

Responses

Request samples

Payload

Content type

application/json

{"bucket-type": "afternoon",
"individual-id": "11111111-1111-1111-1111-111111111111",
"user-muted": true
}

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"buckets": [{"actions": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
}
],
"time": "14:15:22Z",
"type": "afternoon",
"user-muted": true
},
{"actions": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
}
],
"time": "14:15:22Z",
"type": "afternoon",
"user-muted": true
},
{"actions": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
}
],
"time": "14:15:22Z",
"type": "afternoon",
"user-muted": true
},
{"actions": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
}
],
"time": "14:15:22Z",
"type": "afternoon",
"user-muted": true
},
{"actions": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
}
],
"time": "14:15:22Z",
"type": "afternoon",
"user-muted": true
}
],
"day": "friday"
},
"id": "s",
"type": "reminder-days"
}
],
"meta": { }
}

/v1/action-reminder-times

/v1/action-reminder-times/

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"time": "14:15:22Z",
"value": "afternoon"
},
"type": "action-reminder-times"
}
],
"meta": { }
}

/v1/action-trigger-reminders

/v1/action-trigger-reminders/

Request Body schema: application/json

Any of

utc-hour required	integer [ 0 .. 23 ]
individual-ids	Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"individual-ids": ["11111111-1111-1111-1111-111111111111"
],
"utc-datetime": "string"
}

Response samples

Content type

application/vnd.api+json

{"task-id": "string"
}

/v1/actions

/v1/actions/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
filter[care-plan-id]	string <uuid> Example: filter[care-plan-id]=11111111-1111-1111-1111-111111111111
filter[currently-tracking]	boolean Actions that have started and have not yet been stopped/reached their end date
include-all-time-summary	boolean Default: false
include-currently-tracking-summary	boolean Default: false
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
week-of	string <date> defaults to current week

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"all-time-able-no-pct": 100,
"all-time-able-yes-pct": 100,
"all-time-completion": 100,
"all-time-extras": 0,
"all-time-possible-progress": 0,
"all-time-progress": 0,
"all-time-scale-agree-pct": 100,
"all-time-scale-disagree-pct": 100,
"all-time-scale-neutral-pct": 100,
"all-time-scale-strongly-agree-pct": 100,
"all-time-scale-strongly-disagree-pct": 100,
"all-time-scale-unanswered-pct": 100,
"all-time-value-total": 0,
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"categories": [{"display-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"daily-achievements": [{"achievements": [{"able-to-complete": true,
"achieved": true,
"date": "2019-08-24",
"scale-value": "agree",
"value": 0
}
],
"start-of-week": "2019-08-24"
}
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reminder-days": [{"day": "friday",
"value": 1
}
],
"reminder-schedulers": [{"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"follow-tz": true,
"id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"rrule": "string",
"start-at": "string",
"start-tz": "string",
"working-tz": "string"
}
],
"reminder-times": [{"time": "14:15:22Z",
"value": "afternoon"
}
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "actions"
}
],
"meta": {"all-time-completion": 100,
"all-time-extras": 0,
"all-time-possible-progress": 0,
"all-time-progress": 0,
"currently-tracking-completion": 100,
"currently-tracking-extras": 0,
"currently-tracking-possible-progress": 0,
"currently-tracking-progress": 0
}
}

/v1/actions/

Request Body schema: application/json

required

object

type

required

string

Value: "actions"

required

object (JsActionPost)

category-ids

required

Array of strings <uuid> [ items <uuid > ]

description

required

string <= 255 characters

individual-id

required

string <uuid>

metrics

required

Array of strings[ items <= 255 characters ]

num-days-per-week

required

integer [ 1 .. 7 ]

start-date

required

string <date>

care-plan-id

string <uuid>

reminder-days

Array of integers[ items [ 1 .. 7 ] ]

Array of objects

Array

follow-tz required	boolean
start-at required	string <datetime>
byday	Array of strings Items Enum: "FR" "MO" "SA" "SU" "TH" "TU" "WE"

reminder-times

Array of strings

Items Enum: "afternoon" "early_morning" "evening" "late_night" "morning"

stop-date

string <date>

type

string

Default: "achieve"

Enum: "able" "achieve" "scale" "value"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"care-plan-id": "11111111-1111-1111-1111-111111111111",
"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"type": "actions"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"all-time-able-no-pct": 100,
"all-time-able-yes-pct": 100,
"all-time-completion": 100,
"all-time-extras": 0,
"all-time-possible-progress": 0,
"all-time-progress": 0,
"all-time-scale-agree-pct": 100,
"all-time-scale-disagree-pct": 100,
"all-time-scale-neutral-pct": 100,
"all-time-scale-strongly-agree-pct": 100,
"all-time-scale-strongly-disagree-pct": 100,
"all-time-scale-unanswered-pct": 100,
"all-time-value-total": 0,
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"categories": [{"display-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"daily-achievements": [{"achievements": [{"able-to-complete": true,
"achieved": true,
"date": "2019-08-24",
"scale-value": "agree",
"value": 0
}
],
"start-of-week": "2019-08-24"
}
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reminder-days": [{"day": "friday",
"value": 1
}
],
"reminder-schedulers": [{"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"follow-tz": true,
"id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"rrule": "string",
"start-at": "string",
"start-tz": "string",
"working-tz": "string"
}
],
"reminder-times": [{"time": "14:15:22Z",
"value": "afternoon"
}
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "actions"
},
"meta": { }
}

/v1/actions/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/actions/{id}/

path Parameters

required

string

Resource identifier

query Parameters

week-of

string <date>

defaults to current week

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"all-time-able-no-pct": 100,
"all-time-able-yes-pct": 100,
"all-time-completion": 100,
"all-time-extras": 0,
"all-time-possible-progress": 0,
"all-time-progress": 0,
"all-time-scale-agree-pct": 100,
"all-time-scale-disagree-pct": 100,
"all-time-scale-neutral-pct": 100,
"all-time-scale-strongly-agree-pct": 100,
"all-time-scale-strongly-disagree-pct": 100,
"all-time-scale-unanswered-pct": 100,
"all-time-value-total": 0,
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"categories": [{"display-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"daily-achievements": [{"achievements": [{"able-to-complete": true,
"achieved": true,
"date": "2019-08-24",
"scale-value": "agree",
"value": 0
}
],
"start-of-week": "2019-08-24"
}
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reminder-days": [{"day": "friday",
"value": 1
}
],
"reminder-schedulers": [{"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"follow-tz": true,
"id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"rrule": "string",
"start-at": "string",
"start-tz": "string",
"working-tz": "string"
}
],
"reminder-times": [{"time": "14:15:22Z",
"value": "afternoon"
}
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "actions"
},
"meta": { }
}

/v1/actions/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "actions"

required

object

description

string <= 255 characters

Array of objects

Array

follow-tz required	boolean
start-at required	string <datetime>
byday	Array of strings Items Enum: "FR" "MO" "SA" "SU" "TH" "TU" "WE"
id	string <uuid>

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"description": "string",
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"id": "11111111-1111-1111-1111-111111111111",
"start-at": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "actions"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"all-time-able-no-pct": 100,
"all-time-able-yes-pct": 100,
"all-time-completion": 100,
"all-time-extras": 0,
"all-time-possible-progress": 0,
"all-time-progress": 0,
"all-time-scale-agree-pct": 100,
"all-time-scale-disagree-pct": 100,
"all-time-scale-neutral-pct": 100,
"all-time-scale-strongly-agree-pct": 100,
"all-time-scale-strongly-disagree-pct": 100,
"all-time-scale-unanswered-pct": 100,
"all-time-value-total": 0,
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"categories": [{"display-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"daily-achievements": [{"achievements": [{"able-to-complete": true,
"achieved": true,
"date": "2019-08-24",
"scale-value": "agree",
"value": 0
}
],
"start-of-week": "2019-08-24"
}
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reminder-days": [{"day": "friday",
"value": 1
}
],
"reminder-schedulers": [{"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"follow-tz": true,
"id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"rrule": "string",
"start-at": "string",
"start-tz": "string",
"working-tz": "string"
}
],
"reminder-times": [{"time": "14:15:22Z",
"value": "afternoon"
}
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "actions"
},
"meta": { }
}

/v1/actions/{id}/set-daily-achievement/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

achieved required	boolean Default: true
date required	string <date>

Responses

Request samples

Payload

Content type

application/json

{"achieved": true,
"date": "2019-08-24"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"all-time-able-no-pct": 100,
"all-time-able-yes-pct": 100,
"all-time-completion": 100,
"all-time-extras": 0,
"all-time-possible-progress": 0,
"all-time-progress": 0,
"all-time-scale-agree-pct": 100,
"all-time-scale-disagree-pct": 100,
"all-time-scale-neutral-pct": 100,
"all-time-scale-strongly-agree-pct": 100,
"all-time-scale-strongly-disagree-pct": 100,
"all-time-scale-unanswered-pct": 100,
"all-time-value-total": 0,
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"categories": [{"display-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"daily-achievements": [{"achievements": [{"able-to-complete": true,
"achieved": true,
"date": "2019-08-24",
"scale-value": "agree",
"value": 0
}
],
"start-of-week": "2019-08-24"
}
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reminder-days": [{"day": "friday",
"value": 1
}
],
"reminder-schedulers": [{"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"follow-tz": true,
"id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"rrule": "string",
"start-at": "string",
"start-tz": "string",
"working-tz": "string"
}
],
"reminder-times": [{"time": "14:15:22Z",
"value": "afternoon"
}
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "actions"
},
"meta": { }
}

/v1/actions/{id}/snooze-reminder/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

delay-mins

integer

Default: 30

Responses

Request samples

Payload

Content type

application/json

{"delay-mins": 30
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"all-time-able-no-pct": 100,
"all-time-able-yes-pct": 100,
"all-time-completion": 100,
"all-time-extras": 0,
"all-time-possible-progress": 0,
"all-time-progress": 0,
"all-time-scale-agree-pct": 100,
"all-time-scale-disagree-pct": 100,
"all-time-scale-neutral-pct": 100,
"all-time-scale-strongly-agree-pct": 100,
"all-time-scale-strongly-disagree-pct": 100,
"all-time-scale-unanswered-pct": 100,
"all-time-value-total": 0,
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"categories": [{"display-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"daily-achievements": [{"achievements": [{"able-to-complete": true,
"achieved": true,
"date": "2019-08-24",
"scale-value": "agree",
"value": 0
}
],
"start-of-week": "2019-08-24"
}
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reminder-days": [{"day": "friday",
"value": 1
}
],
"reminder-schedulers": [{"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"follow-tz": true,
"id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"rrule": "string",
"start-at": "string",
"start-tz": "string",
"working-tz": "string"
}
],
"reminder-times": [{"time": "14:15:22Z",
"value": "afternoon"
}
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "actions"
},
"meta": { }
}

/v1/actions/{id}/stop-action/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

date	string <date>

Responses

Request samples

Payload

Content type

application/json

{"date": "2019-08-24"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"all-time-able-no-pct": 100,
"all-time-able-yes-pct": 100,
"all-time-completion": 100,
"all-time-extras": 0,
"all-time-possible-progress": 0,
"all-time-progress": 0,
"all-time-scale-agree-pct": 100,
"all-time-scale-disagree-pct": 100,
"all-time-scale-neutral-pct": 100,
"all-time-scale-strongly-agree-pct": 100,
"all-time-scale-strongly-disagree-pct": 100,
"all-time-scale-unanswered-pct": 100,
"all-time-value-total": 0,
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"categories": [{"display-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"daily-achievements": [{"achievements": [{"able-to-complete": true,
"achieved": true,
"date": "2019-08-24",
"scale-value": "agree",
"value": 0
}
],
"start-of-week": "2019-08-24"
}
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reminder-days": [{"day": "friday",
"value": 1
}
],
"reminder-schedulers": [{"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"follow-tz": true,
"id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"rrule": "string",
"start-at": "string",
"start-tz": "string",
"working-tz": "string"
}
],
"reminder-times": [{"time": "14:15:22Z",
"value": "afternoon"
}
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "actions"
},
"meta": { }
}

/v1/actions/{id}/update-reminders/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

reminder-days required	Array of integers[ items [ 1 .. 7 ] ]
reminder-times required	Array of strings Items Enum: "afternoon" "early_morning" "evening" "late_night" "morning"

Responses

Request samples

Payload

Content type

application/json

{"reminder-days": [1
],
"reminder-times": ["afternoon"
]
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"all-time-able-no-pct": 100,
"all-time-able-yes-pct": 100,
"all-time-completion": 100,
"all-time-extras": 0,
"all-time-possible-progress": 0,
"all-time-progress": 0,
"all-time-scale-agree-pct": 100,
"all-time-scale-disagree-pct": 100,
"all-time-scale-neutral-pct": 100,
"all-time-scale-strongly-agree-pct": 100,
"all-time-scale-strongly-disagree-pct": 100,
"all-time-scale-unanswered-pct": 100,
"all-time-value-total": 0,
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"categories": [{"display-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"daily-achievements": [{"achievements": [{"able-to-complete": true,
"achieved": true,
"date": "2019-08-24",
"scale-value": "agree",
"value": 0
}
],
"start-of-week": "2019-08-24"
}
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reminder-days": [{"day": "friday",
"value": 1
}
],
"reminder-schedulers": [{"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"follow-tz": true,
"id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"rrule": "string",
"start-at": "string",
"start-tz": "string",
"working-tz": "string"
}
],
"reminder-times": [{"time": "14:15:22Z",
"value": "afternoon"
}
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "actions"
},
"meta": { }
}

/v1/aggregation-individuals

/v1/aggregation-individuals/

query Parameters

fields	Array of strings Items Enum: "action-completion-pct" "birth-date" "communication-preferences" "created-time" "current-action-completion-pct" "email" "email-verified" "first-name" "last-activity-time" "last-appointment-time" "last-article-read-time" "last-blood-glucose" "last-blood-glucose-context" "last-blood-glucose-state" "last-blood-glucose-time" "last-body-mass" "last-body-mass-time" "last-bp-diastolic" "last-bp-diastolic-state" "last-bp-systolic" "last-bp-systolic-state" "last-bp-time" "last-feeling" "last-feeling-time" "last-heart-rate" "last-heart-rate-time" "last-journal-ack-time" "last-login-time" "last-message-read-time" "last-message-received-time" "last-message-sent-time" "last-name" "last-o2-saturation" "last-o2-saturation-time" "last-survey-assigned-time" "last-survey-completed-time" "last-text-status" "phone-verified" "preferred-name" "registered" "registration-completed-time" "registration-invite" "sms-mode" "state" "unack-journal-count"
filter[account-type]	string Default: "regular" Enum: "provider" "regular"
filter[birth-date]	string <date>
filter[email-verified]	boolean
filter[email]	string <= 255 characters
filter[exclude-self]	boolean Default: false
filter[first-name]	string <= 255 characters
filter[individual-group-id]	string <uuid> Example: filter[individual-group-id]=11111111-1111-1111-1111-111111111111
filter[individual-ids]	Array of strings <uuid> [ items <uuid > ] Example: filter[individual-ids]=11111111-1111-1111-1111-111111111111
filter[last-name]	string <= 255 characters
filter[last-text-status]	string Enum: "created" "failed" "sent"
filter[only-in-groups-with-leader-id]	string <uuid> Example: filter[only-in-groups-with-leader-id]=11111111-1111-1111-1111-111111111111
filter[phone-verified]	boolean
filter[phone]	string <= 255 characters
filter[registered]	boolean
filter[registration-invite]	string Enum: "accepted" "failed" "none" "sent"
filter[sms-mode]	string Enum: "disabled" "enabled" "optout"
filter[state]	string Enum: "archived" "confirmed" "disabled" "force_reset_password" "init" "registered" "registered_disabled"
filter[tag-ids]	Array of strings <uuid> [ items <uuid > ] Example: filter[tag-ids]=11111111-1111-1111-1111-111111111111
filter[workflowtype-name]	Array of strings[ items <= 255 characters ]
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Default: "last-name" Items Enum: "-action-completion-pct" "-birth-date" "-communication-preferences" "-created-time" "-current-action-completion-pct" "-email" "-email-verified" "-first-name" "-last-activity-time" "-last-appointment-time" "-last-article-read-time" "-last-blood-glucose" "-last-blood-glucose-context" "-last-blood-glucose-state" "-last-blood-glucose-time" "-last-body-mass" "-last-body-mass-time" "-last-bp-diastolic" "-last-bp-diastolic-state" "-last-bp-systolic" "-last-bp-systolic-state" "-last-bp-time" "-last-feeling" "-last-feeling-time" "-last-heart-rate" "-last-heart-rate-time" "-last-journal-ack-time" "-last-login-time" "-last-message-read-time" "-last-message-received-time" "-last-message-sent-time" "-last-name" "-last-o2-saturation" "-last-o2-saturation-time" "-last-survey-assigned-time" "-last-survey-completed-time" "-last-text-status" "-phone-verified" "-preferred-name" "-registration-completed-time" "-registration-invite" "-sms-mode" "-state" "-unack-journal-count" "action-completion-pct" "birth-date" "communication-preferences" "created-time" "current-action-completion-pct" "email" "email-verified" "first-name" "last-activity-time" "last-appointment-time" "last-article-read-time" "last-blood-glucose" "last-blood-glucose-context" "last-blood-glucose-state" "last-blood-glucose-time" "last-body-mass" "last-body-mass-time" "last-bp-diastolic" "last-bp-diastolic-state" "last-bp-systolic" "last-bp-systolic-state" "last-bp-time" "last-feeling" "last-feeling-time" "last-heart-rate" "last-heart-rate-time" "last-journal-ack-time" "last-login-time" "last-message-read-time" "last-message-received-time" "last-message-sent-time" "last-name" "last-o2-saturation" "last-o2-saturation-time" "last-survey-assigned-time" "last-survey-completed-time" "last-text-status" "phone-verified" "preferred-name" "registration-completed-time" "registration-invite" "sms-mode" "state" "unack-journal-count"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"action-completion-pct": "string",
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"created-time": "string",
"current-action-completion-pct": "string",
"email": "string",
"email-verified": true,
"first-name": "string",
"last-activity-time": "string",
"last-appointment-time": "string",
"last-article-read-time": "string",
"last-blood-glucose": 0,
"last-blood-glucose-context": "string",
"last-blood-glucose-state": "ALERT_HIGH",
"last-blood-glucose-time": "string",
"last-body-mass": "string",
"last-body-mass-time": "string",
"last-bp-diastolic": 0,
"last-bp-diastolic-state": "BELOW_NORMAL",
"last-bp-systolic": 0,
"last-bp-systolic-state": "BELOW_NORMAL",
"last-bp-time": "string",
"last-feeling": 0,
"last-feeling-time": "string",
"last-heart-rate": 0,
"last-heart-rate-time": "string",
"last-journal-ack-time": "string",
"last-login-time": "string",
"last-message-read-time": "string",
"last-message-received-time": "string",
"last-message-sent-time": "string",
"last-name": "string",
"last-o2-saturation": "string",
"last-o2-saturation-time": "string",
"last-survey-assigned-time": "string",
"last-survey-completed-time": "string",
"last-text-status": "created",
"phone-verified": true,
"preferred-name": "string",
"registered": true,
"registration-completed-time": "string",
"registration-invite": "accepted",
"sms-mode": "disabled",
"state": "archived",
"unack-journal-count": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "aggregation-individuals"
}
],
"meta": { }
}

/v1/aggregation-individuals/{id}/

path Parameters

required

string

Resource identifier

query Parameters

fields

Array of strings

Items Enum: "action-completion-pct" "birth-date" "communication-preferences" "created-time" "current-action-completion-pct" "email" "email-verified" "first-name" "last-activity-time" "last-appointment-time" "last-article-read-time" "last-blood-glucose" "last-blood-glucose-context" "last-blood-glucose-state" "last-blood-glucose-time" "last-body-mass" "last-body-mass-time" "last-bp-diastolic" "last-bp-diastolic-state" "last-bp-systolic" "last-bp-systolic-state" "last-bp-time" "last-feeling" "last-feeling-time" "last-heart-rate" "last-heart-rate-time" "last-journal-ack-time" "last-login-time" "last-message-read-time" "last-message-received-time" "last-message-sent-time" "last-name" "last-o2-saturation" "last-o2-saturation-time" "last-survey-assigned-time" "last-survey-completed-time" "last-text-status" "phone-verified" "preferred-name" "registered" "registration-completed-time" "registration-invite" "sms-mode" "state" "unack-journal-count"

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"action-completion-pct": "string",
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"created-time": "string",
"current-action-completion-pct": "string",
"email": "string",
"email-verified": true,
"first-name": "string",
"last-activity-time": "string",
"last-appointment-time": "string",
"last-article-read-time": "string",
"last-blood-glucose": 0,
"last-blood-glucose-context": "string",
"last-blood-glucose-state": "ALERT_HIGH",
"last-blood-glucose-time": "string",
"last-body-mass": "string",
"last-body-mass-time": "string",
"last-bp-diastolic": 0,
"last-bp-diastolic-state": "BELOW_NORMAL",
"last-bp-systolic": 0,
"last-bp-systolic-state": "BELOW_NORMAL",
"last-bp-time": "string",
"last-feeling": 0,
"last-feeling-time": "string",
"last-heart-rate": 0,
"last-heart-rate-time": "string",
"last-journal-ack-time": "string",
"last-login-time": "string",
"last-message-read-time": "string",
"last-message-received-time": "string",
"last-message-sent-time": "string",
"last-name": "string",
"last-o2-saturation": "string",
"last-o2-saturation-time": "string",
"last-survey-assigned-time": "string",
"last-survey-completed-time": "string",
"last-text-status": "created",
"phone-verified": true,
"preferred-name": "string",
"registered": true,
"registration-completed-time": "string",
"registration-invite": "accepted",
"sms-mode": "disabled",
"state": "archived",
"unack-journal-count": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "aggregation-individuals"
},
"meta": { }
}

/v1/aggregation-individuals/{id}/update/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

columns

Array of strings

Items Enum: "action-completion-pct" "birth-date" "created-time" "current-action-completion-pct" "email" "email-verified" "first-name" "last-activity-time" "last-appointment-time" "last-article-read-time" "last-blood-glucose" "last-blood-glucose-context" "last-blood-pressure" "last-body-mass" "last-feeling" "last-heart-rate" "last-journal-ack-time" "last-login-time" "last-message-read-time" "last-message-received-time" "last-message-sent-time" "last-name" "last-o2-saturation" "last-survey-assigned-time" "last-survey-completed-time" "last-text-status" "phone-verified" "preferred-name" "registration-completed-time" "registration-invite" "sms-mode" "state" "unack-journal-count"

Responses

Request samples

Payload

Content type

application/json

{"columns": ["action-completion-pct"
]
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"action-completion-pct": "string",
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"created-time": "string",
"current-action-completion-pct": "string",
"email": "string",
"email-verified": true,
"first-name": "string",
"last-activity-time": "string",
"last-appointment-time": "string",
"last-article-read-time": "string",
"last-blood-glucose": 0,
"last-blood-glucose-context": "string",
"last-blood-glucose-state": "ALERT_HIGH",
"last-blood-glucose-time": "string",
"last-body-mass": "string",
"last-body-mass-time": "string",
"last-bp-diastolic": 0,
"last-bp-diastolic-state": "BELOW_NORMAL",
"last-bp-systolic": 0,
"last-bp-systolic-state": "BELOW_NORMAL",
"last-bp-time": "string",
"last-feeling": 0,
"last-feeling-time": "string",
"last-heart-rate": 0,
"last-heart-rate-time": "string",
"last-journal-ack-time": "string",
"last-login-time": "string",
"last-message-read-time": "string",
"last-message-received-time": "string",
"last-message-sent-time": "string",
"last-name": "string",
"last-o2-saturation": "string",
"last-o2-saturation-time": "string",
"last-survey-assigned-time": "string",
"last-survey-completed-time": "string",
"last-text-status": "created",
"phone-verified": true,
"preferred-name": "string",
"registered": true,
"registration-completed-time": "string",
"registration-invite": "accepted",
"sms-mode": "disabled",
"state": "archived",
"unack-journal-count": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "aggregation-individuals"
},
"meta": { }
}

/v1/aggregation-requests

/v1/aggregation-requests/

Request Body schema: application/json

required

object

type

required

string

Value: "aggregation-requests"

required

object

required

Array of objects

Array

column required	string <= 64 characters
individual-id required	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"entries": [{"column": "string",
"individual-id": "11111111-1111-1111-1111-111111111111"
}
]
},
"type": "aggregation-requests"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "aggregation-requests"
},
"meta": { }
}

/v1/allergy-intolerances

/v1/allergy-intolerances/

query Parameters

individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0
sort-by	Array of strings Items Enum: "-alphabetical" "-category" "-criticality" "alphabetical" "category" "criticality"
ui-only	boolean Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"_ui": {"category": ["string"
],
"clinical-status": "",
"criticality": "",
"display": "string",
"last-occurrence": "2019-08-24",
"onset-date-time": "string",
"reaction-names": ["string"
],
"type": "",
"verification-status": ""
},
"asserted-date": "2019-08-24",
"asserter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"category": ["string"
],
"clinical-status": "",
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"criticality": "",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-occurrence": "2019-08-24",
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"onset-date-time": "string",
"onset-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"onset-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"onset-string": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"patient": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"reaction": [{"description": "string",
"exposure-route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"manifestation": [{"coding": [{"code": null,
"display": null,
"system": null,
"user-selected": null,
"version": null
}
],
"text": "string"
}
],
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": null,
"period": { },
"system": null,
"type": null,
"use": null,
"value": null
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset": "string",
"severity": "",
"substance": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"recorder": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"type": "",
"verification-status": ""
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "allergy-intolerances"
}
],
"meta": { }
}

/v1/allergy-intolerances/

Request Body schema: application/json

required

object

type

required

string

Value: "allergy-intolerances"

required

object

individual-id

required

string <uuid>

object

category	Array of strings[ items <= 255 characters ]
clinical-status	string Enum: "" "Active" "Inactive" "Resolved"
criticality	string Enum: "" "High" "Low" "Unable-To-Assess"
display	string <= 255 characters
last-occurrence	string <date>
onset-date-time	string <datetime>
reaction-names	Array of strings[ items <= 255 characters ]
type	string Enum: "" "Allergy" "Intolerance"
verification-status	string Enum: "" "Confirmed" "Entered-In-Error" "Refuted" "Unconfirmed"

asserted-date

string <date>

object

display	string <= 255 characters
	object
reference	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"_ui": {"category": ["string"
],
"clinical-status": "",
"criticality": "",
"display": "string",
"last-occurrence": "2019-08-24",
"onset-date-time": "string",
"reaction-names": ["string"
],
"type": "",
"verification-status": ""
},
"asserted-date": "2019-08-24",
"asserter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"category": ["string"
],
"clinical-status": "",
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"criticality": "",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-occurrence": "2019-08-24",
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"onset-date-time": "string",
"onset-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"onset-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"onset-string": "string",
"patient": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"reaction": [{"description": "string",
"exposure-route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"manifestation": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": null,
"start": null
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset": "string",
"severity": "",
"substance": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"recorder": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"type": "",
"verification-status": ""
},
"type": "allergy-intolerances"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"category": ["string"
],
"clinical-status": "",
"criticality": "",
"display": "string",
"last-occurrence": "2019-08-24",
"onset-date-time": "string",
"reaction-names": ["string"
],
"type": "",
"verification-status": ""
},
"asserted-date": "2019-08-24",
"asserter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"category": ["string"
],
"clinical-status": "",
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"criticality": "",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-occurrence": "2019-08-24",
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"onset-date-time": "string",
"onset-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"onset-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"onset-string": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"patient": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"reaction": [{"description": "string",
"exposure-route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"manifestation": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": null,
"start": null
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset": "string",
"severity": "",
"substance": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"recorder": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"type": "",
"verification-status": ""
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "allergy-intolerances"
},
"meta": { }
}

/v1/allergy-intolerances/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/allergy-intolerances/{id}/

path Parameters

required

string

Resource identifier

query Parameters

ui-only

boolean

Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"category": ["string"
],
"clinical-status": "",
"criticality": "",
"display": "string",
"last-occurrence": "2019-08-24",
"onset-date-time": "string",
"reaction-names": ["string"
],
"type": "",
"verification-status": ""
},
"asserted-date": "2019-08-24",
"asserter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"category": ["string"
],
"clinical-status": "",
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"criticality": "",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-occurrence": "2019-08-24",
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"onset-date-time": "string",
"onset-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"onset-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"onset-string": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"patient": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"reaction": [{"description": "string",
"exposure-route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"manifestation": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": null,
"start": null
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset": "string",
"severity": "",
"substance": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"recorder": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"type": "",
"verification-status": ""
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "allergy-intolerances"
},
"meta": { }
}

/v1/allergy-intolerances/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "allergy-intolerances"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "allergy-intolerances"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"category": ["string"
],
"clinical-status": "",
"criticality": "",
"display": "string",
"last-occurrence": "2019-08-24",
"onset-date-time": "string",
"reaction-names": ["string"
],
"type": "",
"verification-status": ""
},
"asserted-date": "2019-08-24",
"asserter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"category": ["string"
],
"clinical-status": "",
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"criticality": "",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-occurrence": "2019-08-24",
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"onset-date-time": "string",
"onset-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"onset-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"onset-string": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"patient": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"reaction": [{"description": "string",
"exposure-route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"manifestation": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": null,
"start": null
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset": "string",
"severity": "",
"substance": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"recorder": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"type": "",
"verification-status": ""
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "allergy-intolerances"
},
"meta": { }
}

/v1/appointments

/v1/appointments/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
filter[cmp-start-time]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against start-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.
filter[reference-id]	string <= 64 characters
filter[status]	string Enum: "arrived" "booked" "cancelled" "entered-in-error" "fulfilled" "noshow" "pending" "proposed"
page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0
ui-only	boolean Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"_ui": {"comment": "string",
"contact-phone": "string",
"duration": 0,
"location-city": "string",
"location-state": "string",
"location-street": "string",
"location-zipcode": "string",
"patient-instruction": "string",
"practitioner-display": "string",
"practitioner-first-name": "string",
"practitioner-last-name": "string",
"practitioner-prefix": "string",
"practitioner-suffix": "string",
"practitioner-text": "string",
"reference-id": "string",
"start": "string",
"status": "arrived"
},
"comment": "string",
"duration": 0,
"incoming-referral-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"location": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"patient-instruction": "string",
"practitioner-name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"reference-id": "string",
"start": "string",
"status": "arrived",
"telecom": {"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "appointments"
}
],
"meta": { }
}

/v1/appointments/

Request Body schema: application/json

required

object

type

required

string

Value: "appointments"

required

object

individual-id

required

string <uuid>

object

location-city required	string <= 255 characters
location-state required	string <= 255 characters
location-street required	string <= 255 characters
location-zipcode required	string <= 255 characters
start required	string <datetime>
status required	string Enum: "arrived" "booked" "cancelled" "entered-in-error" "fulfilled" "noshow" "pending" "proposed"
comment	string <= 9999 characters
contact-phone	string <= 255 characters
duration	integer
patient-instruction	string <= 9999 characters
practitioner-first-name	string <= 255 characters
practitioner-last-name	string <= 255 characters
practitioner-prefix	string <= 255 characters
practitioner-suffix	string <= 255 characters
practitioner-text	string <= 255 characters
reference-id	string <= 64 characters

comment

string <= 9999 characters

duration

integer

incoming-referral-id

string <uuid>

Deprecated

object

city	string <= 255 characters
country	string <= 64 characters
district	string <= 255 characters
line	Array of strings[ items <= 255 characters ]
	object
postal	string <= 32 characters
state	string <= 255 characters
text	string <= 1024 characters
type	string Enum: "postal" "physical" "both"
use	string Enum: "home" "work" "temp" "old"

object

type required	string Enum: "event" "emr" "unspecified" "user"
event-id	string <uuid> available when type is event
organization-id	string <uuid> available when type is emr
reference-id	string <= 255 characters available when type is emr
server-id	string <= 255 characters available when type is emr
source	string <= 255 characters available when type is event
user-id	string <uuid> available when type is user

patient-instruction

string <= 9999 characters

object

family	string <= 255 characters
given	Array of strings[ items <= 255 characters ]
	object
prefix	Array of strings[ items <= 32 characters ]
suffix	Array of strings[ items <= 32 characters ]
text	string <= 9999 characters
use	string Enum: "usual" "official" "temp" "nickname" "anonymous" "old" "maiden"

reference-id

string <= 64 characters

start

string <datetime>

status

string

Enum: "arrived" "booked" "cancelled" "entered-in-error" "fulfilled" "noshow" "pending" "proposed"

object

	object
gender	any Enum: "female" "male" "other" "unknown"
	object
organization	string <= 255 characters
	object
	object
	Array of objects

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"_ui": {"comment": "string",
"contact-phone": "string",
"duration": 0,
"location-city": "string",
"location-state": "string",
"location-street": "string",
"location-zipcode": "string",
"patient-instruction": "string",
"practitioner-first-name": "string",
"practitioner-last-name": "string",
"practitioner-prefix": "string",
"practitioner-suffix": "string",
"practitioner-text": "string",
"reference-id": "string",
"start": "string",
"status": "arrived"
},
"comment": "string",
"duration": 0,
"incoming-referral-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"location": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"patient-instruction": "string",
"practitioner-name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"reference-id": "string",
"start": "string",
"status": "arrived",
"telecom": {"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
},
"type": "appointments"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"comment": "string",
"contact-phone": "string",
"duration": 0,
"location-city": "string",
"location-state": "string",
"location-street": "string",
"location-zipcode": "string",
"patient-instruction": "string",
"practitioner-display": "string",
"practitioner-first-name": "string",
"practitioner-last-name": "string",
"practitioner-prefix": "string",
"practitioner-suffix": "string",
"practitioner-text": "string",
"reference-id": "string",
"start": "string",
"status": "arrived"
},
"comment": "string",
"duration": 0,
"incoming-referral-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"location": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"patient-instruction": "string",
"practitioner-name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"reference-id": "string",
"start": "string",
"status": "arrived",
"telecom": {"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "appointments"
},
"meta": { }
}

/v1/appointments/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/appointments/{id}/

path Parameters

required

string

Resource identifier

query Parameters

ui-only

boolean

Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"comment": "string",
"contact-phone": "string",
"duration": 0,
"location-city": "string",
"location-state": "string",
"location-street": "string",
"location-zipcode": "string",
"patient-instruction": "string",
"practitioner-display": "string",
"practitioner-first-name": "string",
"practitioner-last-name": "string",
"practitioner-prefix": "string",
"practitioner-suffix": "string",
"practitioner-text": "string",
"reference-id": "string",
"start": "string",
"status": "arrived"
},
"comment": "string",
"duration": 0,
"incoming-referral-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"location": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"patient-instruction": "string",
"practitioner-name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"reference-id": "string",
"start": "string",
"status": "arrived",
"telecom": {"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "appointments"
},
"meta": { }
}

/v1/appointments/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "appointments"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "appointments"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"comment": "string",
"contact-phone": "string",
"duration": 0,
"location-city": "string",
"location-state": "string",
"location-street": "string",
"location-zipcode": "string",
"patient-instruction": "string",
"practitioner-display": "string",
"practitioner-first-name": "string",
"practitioner-last-name": "string",
"practitioner-prefix": "string",
"practitioner-suffix": "string",
"practitioner-text": "string",
"reference-id": "string",
"start": "string",
"status": "arrived"
},
"comment": "string",
"duration": 0,
"incoming-referral-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"location": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"patient-instruction": "string",
"practitioner-name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"reference-id": "string",
"start": "string",
"status": "arrived",
"telecom": {"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "appointments"
},
"meta": { }
}

/v1/article-activities

/v1/article-activities/

query Parameters

article-id	string <uuid> Example: article-id=11111111-1111-1111-1111-111111111111
individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
version-id	string <uuid> Example: version-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"article": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"individual": {"email": "user@example.com",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"user-id": "11111111-1111-1111-1111-111111111111"
},
"read-at": "string",
"version": {"id": "11111111-1111-1111-1111-111111111111",
"version": 0
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "article-activities"
}
],
"meta": { }
}

/v1/article-activities/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"article": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"individual": {"email": "user@example.com",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"user-id": "11111111-1111-1111-1111-111111111111"
},
"read-at": "string",
"version": {"id": "11111111-1111-1111-1111-111111111111",
"version": 0
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "article-activities"
},
"meta": { }
}

/v1/article-contents

/v1/article-contents/{id}/get-assignments/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"individual-groups": [{"follow-group": true,
"id": "11111111-1111-1111-1111-111111111111"
}
],
"individuals": [{"auto-add": true,
"id": "11111111-1111-1111-1111-111111111111"
}
]
}

/v1/article-tags

/v1/article-tags/

query Parameters

organization-id

required

string <uuid>

Example: organization-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "string",
"type": "article-tags"
}
],
"meta": { }
}

/v1/article-tags/

Request Body schema: application/json

required

object

type

required

string

Value: "article-tags"

required

object (JsArticleTag)

name required	string <= 127 characters
organization-id required	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "article-tags"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "string",
"type": "article-tags"
},
"meta": { }
}

/v1/article-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/article-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "string",
"type": "article-tags"
},
"meta": { }
}

/v1/articles

returns article summary based on article-version i

returns article summary based on article-version ids OR individual-id

query Parameters

article-content-ids	Array of strings <uuid> [ items <uuid > ] Example: article-content-ids=11111111-1111-1111-1111-111111111111 article-content ids
filter[article-name]	string <= 255 characters
filter[organization-id]	string <uuid> Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
include-assigned-count	boolean Deprecated Default: false
include-view-stats	boolean Default: false
individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
query	string <= 255 characters search term for searching tags, title and description
sort	Array of strings Items Enum: "-assigned-date" "-published-date" "-tags" "-views" "assigned-date" "published-date" "tags" "views"
sort-by	Array of strings Deprecated Items Enum: "-published-date" "-tags" "-views" "published-date" "tags" "views" deprecated, use 'sort' option

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"article-name": "string",
"assigned-count": 0,
"content-direct-url": "string",
"content-filename": "string",
"content-id": "11111111-1111-1111-1111-111111111111",
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string",
"version-id": "11111111-1111-1111-1111-111111111111"
},
"content-url": "string",
"created-at": "string",
"description": "string",
"individual-assigned-at": "string",
"individual-last-viewed-at": "string",
"individual-views": 0,
"locale": "en_US",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-id": "11111111-1111-1111-1111-111111111111",
"photo": "string",
"photo-filename": "string",
"photo-type": "string",
"photo-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"selected-version": { },
"tags": ["string"
],
"title": "string",
"versions": ["11111111-1111-1111-1111-111111111111"
],
"views": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
}
],
"meta": { }
}

/v1/articles/

Request Body schema:
application/json

Any of

article-name required	string <= 255 characters
content-type required	string
organization-id required	string <uuid>
photo-type required	string Enum: "image/avif" "image/bmp" "image/gif" "image/heic" "image/jpeg" "image/png" "image/tiff" "image/webp"
title required	string <= 255 characters
assigned-count	integer
content-filename	string
content-id	string <uuid> Deprecated
description	string <= 255 characters
locale	string Default: "en_US" Enum: "en_US" "es_US"
parent-id	string <uuid>
photo-filename	string
tags	string Comma separated list of tags

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"article-name": "string",
"assigned-count": 0,
"content-id": "11111111-1111-1111-1111-111111111111",
"description": "string",
"locale": "en_US",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-id": "11111111-1111-1111-1111-111111111111",
"tags": "string",
"title": "string"
},
"type": "articles"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"article-name": "string",
"assigned-count": 0,
"content-direct-url": "string",
"content-filename": "string",
"content-id": "11111111-1111-1111-1111-111111111111",
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string",
"version-id": "11111111-1111-1111-1111-111111111111"
},
"content-url": "string",
"created-at": "string",
"description": "string",
"individual-assigned-at": "string",
"individual-last-viewed-at": "string",
"individual-views": 0,
"locale": "en_US",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-id": "11111111-1111-1111-1111-111111111111",
"photo": "string",
"photo-filename": "string",
"photo-type": "string",
"photo-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"selected-version": { },
"tags": ["string"
],
"title": "string",
"versions": ["11111111-1111-1111-1111-111111111111"
],
"views": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

/v1/articles/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/articles/{id}/

path Parameters

required

string

Resource identifier

query Parameters

include-view-stats	boolean Default: false
individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"article-name": "string",
"assigned-count": 0,
"content-direct-url": "string",
"content-filename": "string",
"content-id": "11111111-1111-1111-1111-111111111111",
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string",
"version-id": "11111111-1111-1111-1111-111111111111"
},
"content-url": "string",
"created-at": "string",
"description": "string",
"individual-assigned-at": "string",
"individual-last-viewed-at": "string",
"individual-views": 0,
"locale": "en_US",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-id": "11111111-1111-1111-1111-111111111111",
"photo": "string",
"photo-filename": "string",
"photo-type": "string",
"photo-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"selected-version": { },
"tags": ["string"
],
"title": "string",
"versions": ["11111111-1111-1111-1111-111111111111"
],
"views": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

/v1/articles/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "articles"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com. Supported (op, path)s are: ('replace', '/description'), ('replace', '/locale'), ('replace', '/parent-id'), ('replace', '/selected-version'), ('replace', '/tags'), ('replace', '/title').

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value required	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"article-name": "string",
"assigned-count": 0,
"content-direct-url": "string",
"content-filename": "string",
"content-id": "11111111-1111-1111-1111-111111111111",
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string",
"version-id": "11111111-1111-1111-1111-111111111111"
},
"content-url": "string",
"created-at": "string",
"description": "string",
"individual-assigned-at": "string",
"individual-last-viewed-at": "string",
"individual-views": 0,
"locale": "en_US",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-id": "11111111-1111-1111-1111-111111111111",
"photo": "string",
"photo-filename": "string",
"photo-type": "string",
"photo-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"selected-version": { },
"tags": ["string"
],
"title": "string",
"versions": ["11111111-1111-1111-1111-111111111111"
],
"views": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

/v1/articles/{id}/add-photo/

path Parameters

required

string

Resource identifier

Request Body schema: multipart/form-data

photo required	string <binary>
photo-type required	string <= 127 characters
photo-filename	string <= 255 characters

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"article-name": "string",
"assigned-count": 0,
"content-direct-url": "string",
"content-filename": "string",
"content-id": "11111111-1111-1111-1111-111111111111",
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string",
"version-id": "11111111-1111-1111-1111-111111111111"
},
"content-url": "string",
"created-at": "string",
"description": "string",
"individual-assigned-at": "string",
"individual-last-viewed-at": "string",
"individual-views": 0,
"locale": "en_US",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-id": "11111111-1111-1111-1111-111111111111",
"photo": "string",
"photo-filename": "string",
"photo-type": "string",
"photo-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"selected-version": { },
"tags": ["string"
],
"title": "string",
"versions": ["11111111-1111-1111-1111-111111111111"
],
"views": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

/v1/articles/{id}/add-tags/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

tag-ids

Array of strings[ items <= 32 characters ]

Responses

Request samples

Payload

Content type

application/json

{"tag-ids": ["string"
]
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"article-name": "string",
"assigned-count": 0,
"content-direct-url": "string",
"content-filename": "string",
"content-id": "11111111-1111-1111-1111-111111111111",
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string",
"version-id": "11111111-1111-1111-1111-111111111111"
},
"content-url": "string",
"created-at": "string",
"description": "string",
"individual-assigned-at": "string",
"individual-last-viewed-at": "string",
"individual-views": 0,
"locale": "en_US",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-id": "11111111-1111-1111-1111-111111111111",
"photo": "string",
"photo-filename": "string",
"photo-type": "string",
"photo-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"selected-version": { },
"tags": ["string"
],
"title": "string",
"versions": ["11111111-1111-1111-1111-111111111111"
],
"views": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

/v1/articles/{id}/add-version/

path Parameters

required

string

Resource identifier

Request Body schema:
application/json

url required	string
update-assignment	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"update-assignment": false,
"url": "string"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-filename": "string",
"content-size": 0,
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"url": "string",
"version": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

/v1/articles/{id}/assign-content/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

Any of

all-participants required	any Value: true
follow-group	boolean Default: true
reassign	boolean Default: false
send_notification	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"follow-group": true,
"individual-group-ids": ["11111111-1111-1111-1111-111111111111"
],
"individual-ids": ["11111111-1111-1111-1111-111111111111"
],
"reassign": false,
"send_notification": true
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-filename": "string",
"content-size": 0,
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"url": "string",
"version": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

/v1/articles/{id}/delete-version/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/articles/{id}/get-assignments/ Deprecated

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"individual-groups": [{"follow-group": true,
"id": "11111111-1111-1111-1111-111111111111"
}
],
"individuals": [{"auto-add": true,
"id": "11111111-1111-1111-1111-111111111111"
}
]
}

returns article content metadata

path Parameters

required

string

Resource identifier

query Parameters

version-id

required

string <uuid>

Example: version-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-filename": "string",
"content-size": 0,
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"url": "string",
"version": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

returns article content

path Parameters

required

string

Resource identifier

query Parameters

individual-id

required

string <uuid>

Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"errors": [{"code": "string",
"detail": "string",
"meta": { },
"source": {"parameter": "string",
"pointer": "string"
},
"status": 400
}
]
}

use get-content-metadata Deprecated

use get-content-metadata

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-filename": "string",
"content-size": 0,
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"url": "string",
"version": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

/v1/articles/{id}/process-upload/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

version-id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"version-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type

application/vnd.api+json

{ }

/v1/articles/{id}/remove-tags/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

tag-ids

Array of strings[ items <= 32 characters ]

Responses

Request samples

Payload

Content type

application/json

{"tag-ids": ["string"
]
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"article-name": "string",
"assigned-count": 0,
"content-direct-url": "string",
"content-filename": "string",
"content-id": "11111111-1111-1111-1111-111111111111",
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string",
"version-id": "11111111-1111-1111-1111-111111111111"
},
"content-url": "string",
"created-at": "string",
"description": "string",
"individual-assigned-at": "string",
"individual-last-viewed-at": "string",
"individual-views": 0,
"locale": "en_US",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-id": "11111111-1111-1111-1111-111111111111",
"photo": "string",
"photo-filename": "string",
"photo-type": "string",
"photo-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"selected-version": { },
"tags": ["string"
],
"title": "string",
"versions": ["11111111-1111-1111-1111-111111111111"
],
"views": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

/v1/articles/{id}/unassign-content/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

Any of

individual-id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"individual-group-ids": ["11111111-1111-1111-1111-111111111111"
],
"individual-ids": ["11111111-1111-1111-1111-111111111111"
]
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-filename": "string",
"content-size": 0,
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"url": "string",
"version": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

/v1/articles/{id}/update/

path Parameters

required

string

Resource identifier

Request Body schema:
application/json

Any of

description	string <= 255 characters
tags	string Comma separated list of tags
title	string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"tags": "string",
"title": "string",
"url": "string"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"article-name": "string",
"assigned-count": 0,
"content-direct-url": "string",
"content-filename": "string",
"content-id": "11111111-1111-1111-1111-111111111111",
"content-type": "string",
"content-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string",
"version-id": "11111111-1111-1111-1111-111111111111"
},
"content-url": "string",
"created-at": "string",
"description": "string",
"individual-assigned-at": "string",
"individual-last-viewed-at": "string",
"individual-views": 0,
"locale": "en_US",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-id": "11111111-1111-1111-1111-111111111111",
"photo": "string",
"photo-filename": "string",
"photo-type": "string",
"photo-upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
},
"selected-version": { },
"tags": ["string"
],
"title": "string",
"versions": ["11111111-1111-1111-1111-111111111111"
],
"views": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "articles"
},
"meta": { }
}

/v1/bulk-actions

/v1/bulk-actions/

Request Body schema: application/json

required

object

required

Array of objects

Array

type required	string Value: "actions"
required	object (JsActionPost)

type

required

string

Value: "bulk-actions"

Responses

Request samples

Payload

Content type

application/json

{"data": {"objects": [{"attributes": {"care-plan-id": "11111111-1111-1111-1111-111111111111",
"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"type": "actions"
}
],
"type": "bulk-actions"
}
}

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"all-time-able-no-pct": 100,
"all-time-able-yes-pct": 100,
"all-time-completion": 100,
"all-time-extras": 0,
"all-time-possible-progress": 0,
"all-time-progress": 0,
"all-time-scale-agree-pct": 100,
"all-time-scale-disagree-pct": 100,
"all-time-scale-neutral-pct": 100,
"all-time-scale-strongly-agree-pct": 100,
"all-time-scale-strongly-disagree-pct": 100,
"all-time-scale-unanswered-pct": 100,
"all-time-value-total": 0,
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"categories": [{"display-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"daily-achievements": [{"achievements": [{"able-to-complete": true,
"achieved": true,
"date": "2019-08-24",
"scale-value": "agree",
"value": 0
}
],
"start-of-week": "2019-08-24"
}
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reminder-days": [{"day": "friday",
"value": 1
}
],
"reminder-schedulers": [{"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"follow-tz": true,
"id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"rrule": "string",
"start-at": "string",
"start-tz": "string",
"working-tz": "string"
}
],
"reminder-times": [{"time": "14:15:22Z",
"value": "afternoon"
}
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "actions"
}
],
"meta": { }
}

/v1/calendly-accounts

/v1/calendly-accounts/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]	string <= 255 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"last-modified-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-accounts"
}
],
"meta": { }
}

/v1/calendly-accounts/

Request Body schema: application/json

required

object

type

required

string

Value: "calendly-accounts"

required

object

name required	string <= 255 characters
organization-id required	string <uuid>
token required	string <= 9999 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"token": "string"
},
"type": "calendly-accounts"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"last-modified-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-accounts"
},
"meta": { }
}

/v1/calendly-accounts/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"last-modified-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-accounts"
},
"meta": { }
}

/v1/calendly-accounts/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "calendly-accounts"

required

object

name	string <= 255 characters
token	string <= 9999 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"token": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-accounts"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"last-modified-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-accounts"
},
"meta": { }
}

/v1/calendly-accounts/{id}/subscribe/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"task-id": "string"
}

/v1/calendly-accounts/{id}/sync-users/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

user-emails

Array of strings <email> non-empty [ items <email > ]

Responses

Request samples

Payload

Content type

application/json

{"user-emails": ["user@example.com"
]
}

Response samples

Content type

application/vnd.api+json

{"task-id": "string"
}

/v1/calendly-accounts/{id}/unsubscribe/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"task-id": "string"
}

/v1/calendly-scheduled-events

/v1/calendly-scheduled-events/

query Parameters

account-id	string <uuid> Example: account-id=11111111-1111-1111-1111-111111111111
appointment-id	string <uuid> Example: appointment-id=11111111-1111-1111-1111-111111111111
filter[end-time][lt]	string <datetime>
filter[end-time][lte]	string <datetime>
filter[start-time][gt]	string <datetime>
filter[start-time][gte]	string <datetime>
filter[status]	string Enum: "active" "canceled"
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"account": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"appointment-id": "11111111-1111-1111-1111-111111111111",
"cancel-url": "string",
"created-at": "string",
"end-time": "string",
"last-modified-at": "string",
"name": "string",
"reschedule-url": "string",
"resource-id": "string",
"start-time": "string",
"status": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-scheduled-events"
}
],
"meta": { }
}

/v1/calendly-scheduled-events/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"appointment-id": "11111111-1111-1111-1111-111111111111",
"cancel-url": "string",
"created-at": "string",
"end-time": "string",
"last-modified-at": "string",
"name": "string",
"reschedule-url": "string",
"resource-id": "string",
"start-time": "string",
"status": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-scheduled-events"
},
"meta": { }
}

/v1/calendly-users

/v1/calendly-users/

query Parameters

account-id	string <uuid> Example: account-id=11111111-1111-1111-1111-111111111111
filter[email]	string <email> <= 255 characters
filter[practitioner-id]	string <uuid> Example: filter[practitioner-id]=11111111-1111-1111-1111-111111111111
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"account": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"add-video-channel": true,
"created-at": "string",
"default-appointment-status-id": "11111111-1111-1111-1111-111111111111",
"default-appointment-type-id": "11111111-1111-1111-1111-111111111111",
"email": "string",
"last-modified-at": "string",
"name": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"resource-id": "string",
"scheduling-url": "string",
"slug": "string",
"subscription": {"count-event-cancel": 0,
"count-event-create": 0,
"id": "11111111-1111-1111-1111-111111111111"
},
"timezone": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-users"
}
],
"meta": { }
}

/v1/calendly-users/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"add-video-channel": true,
"created-at": "string",
"default-appointment-status-id": "11111111-1111-1111-1111-111111111111",
"default-appointment-type-id": "11111111-1111-1111-1111-111111111111",
"email": "string",
"last-modified-at": "string",
"name": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"resource-id": "string",
"scheduling-url": "string",
"slug": "string",
"subscription": {"count-event-cancel": 0,
"count-event-create": 0,
"id": "11111111-1111-1111-1111-111111111111"
},
"timezone": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-users"
},
"meta": { }
}

/v1/calendly-users/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "calendly-users"

required

object

add-video-channel	boolean
default-appointment-status-id	string <uuid>
default-appointment-type-id	string <uuid>
practitioner-id	string <uuid>

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"add-video-channel": true,
"default-appointment-status-id": "11111111-1111-1111-1111-111111111111",
"default-appointment-type-id": "11111111-1111-1111-1111-111111111111",
"practitioner-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-users"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"add-video-channel": true,
"created-at": "string",
"default-appointment-status-id": "11111111-1111-1111-1111-111111111111",
"default-appointment-type-id": "11111111-1111-1111-1111-111111111111",
"email": "string",
"last-modified-at": "string",
"name": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"resource-id": "string",
"scheduling-url": "string",
"slug": "string",
"subscription": {"count-event-cancel": 0,
"count-event-create": 0,
"id": "11111111-1111-1111-1111-111111111111"
},
"timezone": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-users"
},
"meta": { }
}

/v1/calendly-users/{id}/subscribe/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"add-video-channel": true,
"created-at": "string",
"default-appointment-status-id": "11111111-1111-1111-1111-111111111111",
"default-appointment-type-id": "11111111-1111-1111-1111-111111111111",
"email": "string",
"last-modified-at": "string",
"name": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"resource-id": "string",
"scheduling-url": "string",
"slug": "string",
"subscription": {"count-event-cancel": 0,
"count-event-create": 0,
"id": "11111111-1111-1111-1111-111111111111"
},
"timezone": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-users"
},
"meta": { }
}

/v1/calendly-users/{id}/unsubscribe/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"add-video-channel": true,
"created-at": "string",
"default-appointment-status-id": "11111111-1111-1111-1111-111111111111",
"default-appointment-type-id": "11111111-1111-1111-1111-111111111111",
"email": "string",
"last-modified-at": "string",
"name": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"resource-id": "string",
"scheduling-url": "string",
"slug": "string",
"subscription": {"count-event-cancel": 0,
"count-event-create": 0,
"id": "11111111-1111-1111-1111-111111111111"
},
"timezone": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "calendly-users"
},
"meta": { }
}

/v1/calendly-webhooks

/v1/calendly-webhooks/

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{ }

/v1/challenge-bulk-points

/v1/challenge-bulk-points/

Request Body schema: application/json

required

object

type

required

string

Value: "challenge-bulk-points"

required

object

required

Array of objects non-empty

Array (non-empty)

challenge-id required	string <uuid>
individual-id required	string <uuid>
value required	integer
update-total	boolean Default: false

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"entries": [{"challenge-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"update-total": false,
"value": 0
}
]
},
"type": "challenge-bulk-points"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"entries": [{"challenge-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"update-total": true,
"value": 0
}
],
"last-modified-at": "string",
"state": "completed"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenge-bulk-points"
},
"meta": { }
}

/v1/challenge-bulk-points/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"entries": [{"challenge-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"update-total": true,
"value": 0
}
],
"last-modified-at": "string",
"state": "completed"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenge-bulk-points"
},
"meta": { }
}

/v1/challenge-points

/v1/challenge-points/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
challenge-id	string <uuid> Example: challenge-id=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against last-modified-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.
filter[format]	string Default: "none" Enum: "dataengine" "none"
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"challenge-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"value": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenge-points"
}
],
"meta": { }
}

/v1/challenge-points/

Request Body schema: application/json

required

object

type

required

string

Value: "challenge-points"

required

object

challenge-id required	string <uuid>
individual-id required	string <uuid>
value required	integer
update-total	boolean Default: false

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"challenge-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"update-total": false,
"value": 0
},
"type": "challenge-points"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"challenge-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"value": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenge-points"
},
"meta": { }
}

/v1/challenge-points/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/challenge-points/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"challenge-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"value": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenge-points"
},
"meta": { }
}

/v1/challenges

/v1/challenges/

query Parameters

filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against last-modified-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.
filter[name]	string <= 255 characters
filter[private]	boolean
filter[workflow-name]	string <= 255 characters
include-participation-rate	boolean
individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"auto-group-sync": true,
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"end-time": "string",
"group-members-count": 0,
"groups-count": 0,
"individual-points": 0,
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"participants-count": 0,
"participation-rate": 100,
"private": true,
"start-time": "string",
"status": "active",
"workflow-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenges"
}
],
"meta": { }
}

/v1/challenges/

Request Body schema: application/json

required

object

type

required

string

Value: "challenges"

required

object

name required	string <= 255 characters
organization-id required	string <uuid>
workflow-name required	string <= 255 characters
auto-group-sync	boolean Default: false
description	string <= 9999 characters Default: ""
individual-group-ids	Array of strings <uuid> [ items <uuid > ]
private	boolean Default: true

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"auto-group-sync": false,
"description": "",
"individual-group-ids": ["11111111-1111-1111-1111-111111111111"
],
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"private": true,
"workflow-name": "string"
},
"type": "challenges"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"auto-group-sync": true,
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"end-time": "string",
"group-members-count": 0,
"groups-count": 0,
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"participants-count": 0,
"private": true,
"start-time": "string",
"status": "active",
"workflow-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenges"
},
"meta": { }
}

/v1/challenges/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/challenges/{id}/

path Parameters

required

string

Resource identifier

query Parameters

individual-id

string <uuid>

Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"auto-group-sync": true,
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"end-time": "string",
"group-members-count": 0,
"groups-count": 0,
"individual-groups": [{"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
],
"individual-points": 0,
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"participants-count": 0,
"private": true,
"rank": 0,
"start-time": "string",
"status": "active",
"workflow-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenges"
},
"meta": { }
}

/v1/challenges/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "challenges"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com. Supported (op, path)s are: ('replace', '/auto-group-sync'), ('replace', '/description'), ('replace', '/name'), ('replace', '/private').

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value required	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenges"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"auto-group-sync": true,
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"end-time": "string",
"group-members-count": 0,
"groups-count": 0,
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"participants-count": 0,
"private": true,
"start-time": "string",
"status": "active",
"workflow-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenges"
},
"meta": { }
}

/v1/challenges/{id}/add-participant/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

individual-group-id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"individual-group-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"auto-group-sync": true,
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"end-time": "string",
"group-members-count": 0,
"groups-count": 0,
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"participants-count": 0,
"private": true,
"start-time": "string",
"status": "active",
"workflow-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenges"
},
"meta": { }
}

/v1/challenges/{id}/get-participant-stats/

path Parameters

required

string

Resource identifier

query Parameters

individual-id

required

string <uuid>

Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"rank": 0
}
}

/v1/challenges/{id}/get-participants/

path Parameters

required

string

Resource identifier

query Parameters

individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"individual-first-name": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"individual-last-name": "string",
"is-active": true,
"points": 0
}
],
"meta": { }
}

/v1/challenges/{id}/remove-participant/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

individual-group-id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"individual-group-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"auto-group-sync": true,
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"end-time": "string",
"group-members-count": 0,
"groups-count": 0,
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"participants-count": 0,
"private": true,
"start-time": "string",
"status": "active",
"workflow-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenges"
},
"meta": { }
}

/v1/challenges/{id}/start/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"auto-group-sync": true,
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"end-time": "string",
"group-members-count": 0,
"groups-count": 0,
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"participants-count": 0,
"private": true,
"start-time": "string",
"status": "active",
"workflow-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenges"
},
"meta": { }
}

/v1/challenges/{id}/stop/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"auto-group-sync": true,
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"end-time": "string",
"group-members-count": 0,
"groups-count": 0,
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"participants-count": 0,
"private": true,
"start-time": "string",
"status": "active",
"workflow-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "challenges"
},
"meta": { }
}

/v1/conditions

/v1/conditions/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0
ui-only	boolean Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"_ui": {"abatement-date-time": "string",
"asserted-date": "string",
"category": "string",
"clinical-status": "",
"display": "string",
"onset-date-time": "string",
"practitioner": "string",
"verification-status": ""
},
"abatement-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"abatement-boolean": { },
"abatement-date-time": "string",
"abatement-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"abatement-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"abatement-string": "string",
"asserted-date": "string",
"asserter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"body-site": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"category": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"clinical-status": "",
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"context": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"evidence": [{"code": [{"coding": [{"code": null,
"display": null,
"system": null,
"user-selected": null,
"version": null
}
],
"text": "string"
}
],
"detail": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": null,
"start": null
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
]
}
],
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"onset-date-time": "string",
"onset-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"onset-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"onset-string": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"severity": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"stage": {"assessment": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"summary": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
},
"verification-status": ""
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "conditions"
}
],
"meta": { }
}

/v1/conditions/

Request Body schema: application/json

required

object

type

required

string

Value: "conditions"

required

object

individual-id

required

string <uuid>

object

code	string <= 255 characters
comparator	string Enum: "<" "<=" ">=" ">"
system	string <= 255 characters
unit	string <= 255 characters
value	number

null or boolean

Any of

null

abatement-date-time

string <datetime>

object

end	string <datetime> Default: "1975-11-25 00:00:00"
start	string <datetime> Default: "1975-11-25 00:00:00"

object

	object
	object

abatement-string

string <= 255 characters

asserted-date

string <datetime>

object

display	string <= 255 characters
	object
reference	string <= 255 characters

Array of objects

Array

	Array of objects
text	string <= 255 characters

Array of objects

Array

	Array of objects
text	string <= 255 characters

clinical-status

string

Enum: "" "active" "inactive" "recurrence" "remission" "resolved"

object

	Array of objects
text	string <= 255 characters

object

display	string <= 255 characters
	object
reference	string <= 255 characters

Array of objects

Array

	Array of objects
	Array of objects

Array of objects

Array

assigner	string <= 255 characters
	object
system	string <= 255 characters
type	string Enum: "DL" "PPN" "BRN" "MR" "MCN" "EN" "TAX" "NIIP" "PRN" "MD" "DR"
use	string Enum: "usual" "official" "temp" "secondary"
value	string <= 255 characters

Array of objects

Array

	object
author-string	string <= 255 characters
text	string <= 255 characters
time	string <= 255 characters

object

code	string <= 255 characters
comparator	string Enum: "<" "<=" ">=" ">"
system	string <= 255 characters
unit	string <= 255 characters
value	number

onset-date-time

string <datetime>

object

end	string <datetime> Default: "1975-11-25 00:00:00"
start	string <datetime> Default: "1975-11-25 00:00:00"

object

	object
	object

onset-string

string <= 255 characters

object

	Array of objects
text	string <= 255 characters

object

	Array of objects
	object

verification-status

string

Enum: "" "confirmed" "differential" "entered-in-error" "provisional" "refuted" "unknown"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"abatement-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"abatement-boolean": { },
"abatement-date-time": "string",
"abatement-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"abatement-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"abatement-string": "string",
"asserted-date": "string",
"asserter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"body-site": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"category": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"clinical-status": "",
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"context": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"evidence": [{"code": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"detail": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
]
}
],
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"onset-date-time": "string",
"onset-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"onset-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"onset-string": "string",
"severity": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"stage": {"assessment": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"summary": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
},
"verification-status": ""
},
"type": "conditions"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"abatement-date-time": "string",
"asserted-date": "string",
"category": "string",
"clinical-status": "",
"display": "string",
"onset-date-time": "string",
"practitioner": "string",
"verification-status": ""
},
"abatement-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"abatement-boolean": { },
"abatement-date-time": "string",
"abatement-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"abatement-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"abatement-string": "string",
"asserted-date": "string",
"asserter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"body-site": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"category": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"clinical-status": "",
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"context": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"evidence": [{"code": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"detail": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
]
}
],
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"onset-date-time": "string",
"onset-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"onset-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"onset-string": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"severity": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"stage": {"assessment": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"summary": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
},
"verification-status": ""
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "conditions"
},
"meta": { }
}

/v1/conditions/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/conditions/{id}/

path Parameters

required

string

Resource identifier

query Parameters

ui-only

boolean

Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"abatement-date-time": "string",
"asserted-date": "string",
"category": "string",
"clinical-status": "",
"display": "string",
"onset-date-time": "string",
"practitioner": "string",
"verification-status": ""
},
"abatement-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"abatement-boolean": { },
"abatement-date-time": "string",
"abatement-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"abatement-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"abatement-string": "string",
"asserted-date": "string",
"asserter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"body-site": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"category": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"clinical-status": "",
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"context": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"evidence": [{"code": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"detail": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
]
}
],
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"onset-age": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"onset-date-time": "string",
"onset-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"onset-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"onset-string": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"severity": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"stage": {"assessment": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"summary": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
},
"verification-status": ""
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "conditions"
},
"meta": { }
}

/v1/customext-entries

/v1/customext-entries/

query Parameters

fields	Array of strings[ items <= 255 characters ]
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
parent-id	string <uuid> Example: parent-id=11111111-1111-1111-1111-111111111111
sort	Array of strings Default: "-effective-time" Items Enum: "-created-at" "-effective-time" "created-at" "effective-time"
table-id	string <uuid> Example: table-id=11111111-1111-1111-1111-111111111111
table-name	string <= 255 characters

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"content": { },
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"effective-time": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"parent-id": "string",
"table-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-entries"
}
],
"meta": { }
}

/v1/customext-entries/

Request Body schema: application/json

required

object

type

required

string

Value: "customext-entries"

required

object

entries required	object
parent-id required	string <uuid>
effective-time	string <datetime>
organization-id	string <uuid>
table-id	string <uuid>
table-name	string <= 255 characters
upsert-filters	object

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"effective-time": "string",
"entries": { },
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-id": "11111111-1111-1111-1111-111111111111",
"table-id": "11111111-1111-1111-1111-111111111111",
"table-name": "string",
"upsert-filters": { }
},
"type": "customext-entries"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content": { },
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"effective-time": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"parent-id": "string",
"table-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-entries"
},
"meta": { }
}

/v1/customext-entries/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/customext-entries/{id}/

path Parameters

required

string

Resource identifier

query Parameters

fields

Array of strings[ items <= 255 characters ]

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content": { },
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"effective-time": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"parent-id": "string",
"table-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-entries"
},
"meta": { }
}

/v1/customext-entries/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "customext-entries"

required

object

effective-time	string <datetime>
entries	object
override	boolean Default: false

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"effective-time": "string",
"entries": { },
"override": false
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-entries"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content": { },
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"effective-time": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"parent-id": "string",
"table-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-entries"
},
"meta": { }
}

/v1/customext-entries/{id}/get-download-url/

path Parameters

required

string

Resource identifier

query Parameters

field

required

string <= 255 characters

Responses

Response samples

Content type

application/vnd.api+json

{"expiration-time": 0,
"url": "string"
}

/v1/customext-entries/{id}/get-upload-url/

path Parameters

required

string

Resource identifier

query Parameters

field

required

string <= 255 characters

Responses

Response samples

Content type

application/vnd.api+json

{"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
}

/v1/customext-entries/{id}/process-upload/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

field

required

string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"field": "string"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content": { },
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"effective-time": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"parent-id": "string",
"table-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-entries"
},
"meta": { }
}

/v1/customext-fields

/v1/customext-fields/

query Parameters

filter[name]	string <= 255 characters
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
table-id	string <uuid> Example: table-id=11111111-1111-1111-1111-111111111111
table-name	string <= 255 characters

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"default": "string",
"display-name": "string",
"indexed": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"options": { },
"required": true,
"table-id": "11111111-1111-1111-1111-111111111111",
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-fields"
}
],
"meta": { }
}

/v1/customext-fields/

Request Body schema: application/json

required

object

type

required

string

Value: "customext-fields"

required

object

name required	string <= 255 characters
table-id required	string <uuid>
type required	string Enum: "boolean" "date" "datetime" "enum" "file" "float" "integer" "string"
default	string <= 255 characters
display-name	string <= 255 characters
indexed	boolean Default: false
options	object
required	boolean Default: true

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"default": "string",
"display-name": "string",
"indexed": false,
"name": "string",
"options": { },
"required": true,
"table-id": "11111111-1111-1111-1111-111111111111",
"type": "boolean"
},
"type": "customext-fields"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"default": "string",
"display-name": "string",
"indexed": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"options": { },
"required": true,
"table-id": "11111111-1111-1111-1111-111111111111",
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-fields"
},
"meta": { }
}

/v1/customext-fields/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/customext-fields/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"default": "string",
"display-name": "string",
"indexed": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"options": { },
"required": true,
"table-id": "11111111-1111-1111-1111-111111111111",
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-fields"
},
"meta": { }
}

/v1/customext-fields/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "customext-fields"

required

object

default	string <= 255 characters
display-name	string <= 255 characters
options	object
required	boolean

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"default": "string",
"display-name": "string",
"options": { },
"required": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-fields"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"default": "string",
"display-name": "string",
"indexed": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"options": { },
"required": true,
"table-id": "11111111-1111-1111-1111-111111111111",
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-fields"
},
"meta": { }
}

/v1/customext-tables

/v1/customext-tables/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]	string <= 255 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Items Enum: "-created-at" "-display-name" "-name" "created-at" "display-name" "name"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-model": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-tables"
}
],
"meta": { }
}

/v1/customext-tables/

Request Body schema: application/json

required

object

type

required

string

Value: "customext-tables"

required

object

name required	string <= 255 characters
organization-id required	string <uuid>
parent-model required	string <= 255 characters
display-name	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"display-name": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-model": "string"
},
"type": "customext-tables"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-model": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-tables"
},
"meta": { }
}

/v1/customext-tables/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/customext-tables/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-model": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-tables"
},
"meta": { }
}

/v1/customext-tables/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "customext-tables"

required

object

display-name

string <= 255 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"display-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-tables"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-model": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "customext-tables"
},
"meta": { }
}

/v1/diagnostic-reports

/v1/diagnostic-reports/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0
ui-only	boolean Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"_ui": { },
"based-on": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"category": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"coded-diagnosis": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"conclusion": "string",
"context": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"effective-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"image": [{"comment": "string",
"link": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
}
],
"imaging-study": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"issued": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"performer": [{"actor": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"role": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"presented-form": [{"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
}
],
"result": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"specimen": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"status": ""
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "diagnostic-reports"
}
],
"meta": { }
}

/v1/diagnostic-reports/

Request Body schema: application/json

required

object

type

required

string

Value: "diagnostic-reports"

required

object

individual-id

required

string <uuid>

Array of objects

Array

display	string <= 255 characters
	object
reference	string <= 255 characters

object

	Array of objects
text	string <= 255 characters

object

	Array of objects
text	string <= 255 characters

Array of objects

Array

	Array of objects
text	string <= 255 characters

conclusion

string <= 255 characters

object

display	string <= 255 characters
	object
reference	string <= 255 characters

object

end	string <datetime> Default: "1975-11-25 00:00:00"
start	string <datetime> Default: "1975-11-25 00:00:00"

Array of objects

Array

assigner	string <= 255 characters
	object
system	string <= 255 characters
type	string Enum: "DL" "PPN" "BRN" "MR" "MCN" "EN" "TAX" "NIIP" "PRN" "MD" "DR"
use	string Enum: "usual" "official" "temp" "secondary"
value	string <= 255 characters

Array of objects

Array

comment	string <= 255 characters
	object

Array of objects

Array

display	string <= 255 characters
	object
reference	string <= 255 characters

issued

string <datetime>

Array of objects

Array

	object
	object

Array of objects

Array

content-type	string <= 255 characters
creation	string <= 255 characters
data	string <= 255 characters
hash	string <= 255 characters
language	string <= 255 characters
size	number
title	string <= 255 characters
url	string <= 255 characters

Array of objects

Array

display	string <= 255 characters
	object
reference	string <= 255 characters

Array of objects

Array

display	string <= 255 characters
	object
reference	string <= 255 characters

status

string

Enum: "" "amended" "appended" "cancelled" "corrected" "entered-in-error" "final" "partial" "preliminary" "registered" "unknown"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"based-on": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"category": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"coded-diagnosis": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"conclusion": "string",
"context": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"effective-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"image": [{"comment": "string",
"link": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
}
],
"imaging-study": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"issued": "string",
"performer": [{"actor": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"role": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"presented-form": [{"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
}
],
"result": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"specimen": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"status": ""
},
"type": "diagnostic-reports"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": { },
"based-on": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"category": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"coded-diagnosis": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"conclusion": "string",
"context": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"effective-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"image": [{"comment": "string",
"link": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
}
],
"imaging-study": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"issued": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"performer": [{"actor": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"role": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"presented-form": [{"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
}
],
"result": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"specimen": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"status": ""
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "diagnostic-reports"
},
"meta": { }
}

/v1/diagnostic-reports/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/diagnostic-reports/{id}/

path Parameters

required

string

Resource identifier

query Parameters

ui-only

boolean

Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": { },
"based-on": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"category": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"coded-diagnosis": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"conclusion": "string",
"context": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"effective-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"image": [{"comment": "string",
"link": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
}
],
"imaging-study": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"issued": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"performer": [{"actor": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"role": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"presented-form": [{"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
}
],
"result": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"specimen": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"status": ""
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "diagnostic-reports"
},
"meta": { }
}

/v1/goals

/v1/goals/ Deprecated

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0
status	string <= 255 characters
ui-only	boolean Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "goals"
}
],
"meta": { }
}

/v1/goals/ Deprecated

Request Body schema: application/json

required

object

type required	string Value: "goals"
attributes required	object

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": { },
"type": "goals"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "goals"
},
"meta": { }
}

/v1/goals/{id}/ Deprecated

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/goals/{id}/ Deprecated

path Parameters

required

string

Resource identifier

query Parameters

ui-only

boolean

Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "goals"
},
"meta": { }
}

/v1/goals/{id}/ Deprecated

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "goals"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "goals"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "goals"
},
"meta": { }
}

/v1/icd-objects

/v1/icd-objects/

query Parameters

filter[id]	string <= 12 characters
filter[name]	string <= 255 characters
filter[text]	string <= 255 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"description": "string",
"type": "string"
},
"id": "string",
"type": "icd-objects"
}
],
"meta": { }
}

/v1/icd-objects/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"description": "string",
"type": "string"
},
"id": "string",
"type": "icd-objects"
},
"meta": { }
}

/v1/immunizations

/v1/immunizations/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0
ui-only	boolean Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"_ui": {"date": "string",
"display": "string",
"not-given": true,
"status": "string"
},
"date": "string",
"dose-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"encounter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"expiration-date": "2019-08-24",
"explanation": {"reason": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"reason-not-given": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"location": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"lot-number": "string",
"manufacturer": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"not-given": true,
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"practitioner": [{"actor": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"role": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"primary-source": true,
"reaction": [{"date": "string",
"detail": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"reported": true
}
],
"report-origin": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"status": "string",
"vaccination-protocol": [{"authority": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"description": "string",
"dose-sequence": 0,
"dose-status": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"dose-status-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"series": "string",
"series-doses": 0,
"target-disease": [{"coding": [{"code": null,
"display": null,
"system": null,
"user-selected": null,
"version": null
}
],
"text": "string"
}
]
}
],
"vaccine-code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "immunizations"
}
],
"meta": { }
}

/v1/immunizations/

Request Body schema: application/json

required

object

type

required

string

Value: "immunizations"

required

object

individual-id

required

string <uuid>

date

string <datetime>

object

code	string <= 255 characters
comparator	string Enum: "<" "<=" ">=" ">"
system	string <= 255 characters
unit	string <= 255 characters
	null or number

object

display	string <= 255 characters
	object
reference	string <= 255 characters

expiration-date

string <date>

object

	Array of objects
	Array of objects

Array of objects

Array

assigner	string <= 255 characters
	object
system	string <= 255 characters
type	string Enum: "DL" "PPN" "BRN" "MR" "MCN" "EN" "TAX" "NIIP" "PRN" "MD" "DR"
use	string Enum: "usual" "official" "temp" "secondary"
value	string <= 255 characters

object

display	string <= 255 characters
	object
reference	string <= 255 characters

lot-number

string <= 255 characters

object

display	string <= 255 characters
	object
reference	string <= 255 characters

not-given

boolean

Array of objects

Array

	object
author-string	string <= 255 characters
text	string <= 255 characters
time	string <= 255 characters

Array of objects

Array

	object
	object

primary-source

boolean

Array of objects

Array

date	string <datetime>
	object
reported	boolean

object

	Array of objects
text	string <= 255 characters

object

	Array of objects
text	string <= 255 characters

object

	Array of objects
text	string <= 255 characters

status

string <= 255 characters

Array of objects

Array

	object
description	string <= 255 characters
dose-sequence	number
	object
	object
series	string <= 255 characters
series-doses	number
	Array of objects

object

	Array of objects
text	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"date": "string",
"dose-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"encounter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"expiration-date": "2019-08-24",
"explanation": {"reason": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"reason-not-given": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"location": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"lot-number": "string",
"manufacturer": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"not-given": true,
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"practitioner": [{"actor": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"role": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"primary-source": true,
"reaction": [{"date": "string",
"detail": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"reported": true
}
],
"report-origin": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"status": "string",
"vaccination-protocol": [{"authority": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"description": "string",
"dose-sequence": 0,
"dose-status": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"dose-status-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"series": "string",
"series-doses": 0,
"target-disease": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
}
],
"vaccine-code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
},
"type": "immunizations"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"date": "string",
"display": "string",
"not-given": true,
"status": "string"
},
"date": "string",
"dose-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"encounter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"expiration-date": "2019-08-24",
"explanation": {"reason": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"reason-not-given": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"location": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"lot-number": "string",
"manufacturer": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"not-given": true,
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"practitioner": [{"actor": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"role": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"primary-source": true,
"reaction": [{"date": "string",
"detail": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"reported": true
}
],
"report-origin": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"status": "string",
"vaccination-protocol": [{"authority": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"description": "string",
"dose-sequence": 0,
"dose-status": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"dose-status-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"series": "string",
"series-doses": 0,
"target-disease": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
}
],
"vaccine-code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "immunizations"
},
"meta": { }
}

/v1/immunizations/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/immunizations/{id}/

path Parameters

required

string

Resource identifier

query Parameters

ui-only

boolean

Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"date": "string",
"display": "string",
"not-given": true,
"status": "string"
},
"date": "string",
"dose-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"encounter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"expiration-date": "2019-08-24",
"explanation": {"reason": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"reason-not-given": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"location": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"lot-number": "string",
"manufacturer": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"not-given": true,
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"practitioner": [{"actor": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"role": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"primary-source": true,
"reaction": [{"date": "string",
"detail": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"reported": true
}
],
"report-origin": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"status": "string",
"vaccination-protocol": [{"authority": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"description": "string",
"dose-sequence": 0,
"dose-status": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"dose-status-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"series": "string",
"series-doses": 0,
"target-disease": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
}
],
"vaccine-code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "immunizations"
},
"meta": { }
}

/v1/immunizations/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "immunizations"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "immunizations"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"date": "string",
"display": "string",
"not-given": true,
"status": "string"
},
"date": "string",
"dose-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"encounter": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"expiration-date": "2019-08-24",
"explanation": {"reason": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"reason-not-given": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"location": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"lot-number": "string",
"manufacturer": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"not-given": true,
"note": [{"author-reference": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"author-string": "string",
"text": "string",
"time": "string"
}
],
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"practitioner": [{"actor": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"role": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"primary-source": true,
"reaction": [{"date": "string",
"detail": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"reported": true
}
],
"report-origin": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"status": "string",
"vaccination-protocol": [{"authority": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"description": "string",
"dose-sequence": 0,
"dose-status": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"dose-status-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"series": "string",
"series-doses": 0,
"target-disease": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
}
],
"vaccine-code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "immunizations"
},
"meta": { }
}

/v1/individual-contacts

/v1/individual-contacts/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"individual-id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"phone-work": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individual-contacts"
}
],
"meta": { }
}

/v1/individual-groups

/v1/individual-groups/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"individuals": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"last-sync-time": "string",
"leaders": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"parent-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individual-groups"
},
"meta": { }
}

/v1/individual-search

/v1/individual-search/

Request Body schema: application/json

organization-id required	string <uuid>
filter[birth-date]	string <date>
filter[email-verified]	boolean
filter[email]	string <email>
filter[name]	Array of strings [ 1 .. 8 ] items [ items <= 255 characters ] Each name is treated as a prefix search
filter[phone-verified]	boolean
filter[phone]	string <phonenumberE164>
filter[registered]	boolean

Responses

Request samples

Payload

Content type

application/json

{"filter[birth-date]": "2019-08-24",
"filter[email-verified]": true,
"filter[email]": "user@example.com",
"filter[name]": ["string"
],
"filter[phone-verified]": true,
"filter[phone]": "string",
"filter[registered]": true,
"organization-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"account-type": "provider",
"active": true,
"address-city": "string",
"address-state": "string",
"address-street": ["string"
],
"address-zipcode": "string",
"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "string",
"created-at": "string",
"email": "string",
"email-verified": true,
"first-name": "string",
"gender": "string",
"last-modified-at": "string",
"last-name": "string",
"marital-status": "string",
"owner-id": "11111111-1111-1111-1111-111111111111",
"phone": "string",
"phone-mobile": "string",
"phone-verified": true,
"preferred-name": "string",
"registered": true,
"registration-invite": "accepted",
"thumbnail": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individual-search"
}
],
"meta": { }
}

/v1/individual-tags

/v1/individual-tags/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[individual-id]	string <uuid> Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-tag-id]	string <uuid> Example: filter[organization-tag-id]=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"organization-tag-id": "11111111-1111-1111-1111-111111111111",
"organization-tag-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individual-tags"
}
],
"meta": { }
}

/v1/individual-tags/

Request Body schema: application/json

required

object

type

required

string

Value: "individual-tags"

required

object

individual-id required	string <uuid>
organization-tag-id required	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"individual-id": "11111111-1111-1111-1111-111111111111",
"organization-tag-id": "11111111-1111-1111-1111-111111111111"
},
"type": "individual-tags"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"organization-tag-id": "11111111-1111-1111-1111-111111111111",
"organization-tag-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individual-tags"
},
"meta": { }
}

/v1/individual-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/individual-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"organization-tag-id": "11111111-1111-1111-1111-111111111111",
"organization-tag-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individual-tags"
},
"meta": { }
}

/v1/individuals

/v1/individuals/

query Parameters

birth-date	string <date> Deprecated
filter[account-type]	string Default: "regular" Enum: "All" "provider" "regular"
filter[active-referral]	boolean Deprecated
filter[birth-date]	string <date>
filter[cmp-last-modified-time]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against last-modified-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.
filter[cmp-workflow-last-modified-time]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against workflow last-modified-time. Specify [comparator][datetime]. Comparators supported <, >. Use multiple to build a bounded time frame.
filter[email-verified]	boolean
filter[exclude-self]	boolean exclude logged in user owned individuals
filter[first-name]	string <= 255 characters
filter[individual-group-id]	string <uuid> Example: filter[individual-group-id]=11111111-1111-1111-1111-111111111111
filter[last-name]	string <= 255 characters
filter[name]	string <= 255 characters
filter[only-in-groups-with-leader-id]	string <uuid> Example: filter[only-in-groups-with-leader-id]=11111111-1111-1111-1111-111111111111
filter[phone]	string <= 255 characters
filter[registered]	boolean
filter[workflowtype-name-state]	Array of strings[^[0-9a-zA-Z_]+::[0-9a-zA-Z_]+$] ::
filter[workflowtype-name]	Array of strings[ items <= 255 characters ]
first-name	string <= 255 characters Deprecated
id-only	boolean Default: false
include-active-referral-count	boolean Deprecated Default: true
include-photo	boolean Default: false
include-workflows	boolean Default: true
individual-id	Array of strings <uuid> [ items <uuid > ] Example: individual-id=11111111-1111-1111-1111-111111111111
last-name	string <= 255 characters Deprecated
name	string <= 255 characters Deprecated
order-by	string Default: "name" Enum: "created-time" "name"
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0
phone	string <= 255 characters Deprecated

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "individuals"
}
],
"meta": { }
}

/v1/individuals/

Request Body schema: application/json

required

object

type

required

string

Value: "individuals"

required

object

account-type

string

Enum: "provider" "regular"

active

boolean

Array of objects

Array

city	string <= 255 characters
country	string <= 64 characters
district	string <= 255 characters
line	Array of strings[ items <= 255 characters ]
	object
postal	string <= 32 characters
state	string <= 255 characters
text	string <= 1024 characters
type	string Enum: "postal" "physical" "both"
use	string Enum: "home" "work" "temp" "old"

birth-date

string <date>

Array of objects

Array

language	string <= 255 characters
preferred	boolean

Array of objects

Array

	object
gender	any Enum: "female" "male" "other" "unknown"
	object
organization	string <= 255 characters
	object
	object
	Array of objects

email-verified

boolean

extension

string <= 2048 characters

gender

string

Enum: "female" "male" "other" "pnta" "unknown"

Array of objects

Array

assigner	string <= 255 characters
	object
system	string <= 255 characters
type	string Enum: "DL" "PPN" "BRN" "MR" "MCN" "EN" "TAX" "NIIP" "PRN" "MD" "DR"
use	string Enum: "usual" "official" "temp" "secondary"
value	string <= 255 characters

marital-status

string <= 1 characters

Array of objects

Array

family	string <= 255 characters
given	Array of strings[ items <= 255 characters ]
	object
prefix	Array of strings[ items <= 32 characters ]
suffix	Array of strings[ items <= 32 characters ]
text	string <= 9999 characters
use	string Enum: "usual" "official" "temp" "nickname" "anonymous" "old" "maiden"

owner-id

string <= 255 characters

User ID of owner (restricted)

preferred-name

string <= 255 characters

Array of objects

Array

	object
rank	number Default: 1
system	string Enum: "phone" "fax" "email" "pager" "url" "sms" "other"
use	string Enum: "home" "work" "temp" "old" "mobile"
value	string <= 255 characters

telecom-preference

string

Enum: "" "email" "phone" "sms"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"account-type": "provider",
"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"birth-date": "2019-08-24",
"communication": [{"language": "string",
"preferred": true
}
],
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"email-verified": true,
"extension": "string",
"gender": "female",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"marital-status": "s",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"owner-id": "string",
"preferred-name": "string",
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"telecom-preference": ""
},
"type": "individuals"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account-type": "provider",
"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"address-city": "string",
"address-state": "string",
"address-street": ["string"
],
"address-zipcode": "string",
"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication": [{"language": "string",
"preferred": true
}
],
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"contact-email": "string",
"contact-phone-home": "string",
"contact-phone-mobile": "string",
"contact-phone-mobile-verified": true,
"created-time": "string",
"email-verified": true,
"extension": "string",
"first-name": "string",
"gender": "female",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"last-modified-time": "string",
"last-name": "string",
"last-signup-email-sent-time": "string",
"marital-status": "s",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"owner-id": "11111111-1111-1111-1111-111111111111",
"phone-verified": true,
"photo": "string",
"photo-link": "string",
"preferred-name": "string",
"registered": true,
"registration-completed-time": "string",
"registration-invite": "accepted",
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"telecom-preference": "",
"workflows": [{"created-at": "string",
"current-state": "string",
"state-data": { },
"workflow-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
],
"workflows-pending": [{"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individuals"
},
"meta": { }
}

/v1/individuals/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/individuals/{id}/

path Parameters

required

string

Resource identifier

query Parameters

include-photo	boolean Default: false
include-photo-link	boolean Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account-type": "provider",
"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"address-city": "string",
"address-state": "string",
"address-street": ["string"
],
"address-zipcode": "string",
"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication": [{"language": "string",
"preferred": true
}
],
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"contact-email": "string",
"contact-phone-home": "string",
"contact-phone-mobile": "string",
"contact-phone-mobile-verified": true,
"created-time": "string",
"email-verified": true,
"extension": "string",
"first-name": "string",
"gender": "female",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"last-modified-time": "string",
"last-name": "string",
"last-signup-email-sent-time": "string",
"marital-status": "s",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"owner-id": "11111111-1111-1111-1111-111111111111",
"phone-verified": true,
"photo": "string",
"photo-link": "string",
"preferred-name": "string",
"registered": true,
"registration-completed-time": "string",
"registration-invite": "accepted",
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"telecom-preference": "",
"workflows": [{"created-at": "string",
"current-state": "string",
"state-data": { },
"workflow-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
],
"workflows-pending": [{"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individuals"
},
"meta": { }
}

/v1/individuals/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "individuals"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "individuals"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account-type": "provider",
"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"address-city": "string",
"address-state": "string",
"address-street": ["string"
],
"address-zipcode": "string",
"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication": [{"language": "string",
"preferred": true
}
],
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"contact-email": "string",
"contact-phone-home": "string",
"contact-phone-mobile": "string",
"contact-phone-mobile-verified": true,
"created-time": "string",
"email-verified": true,
"extension": "string",
"first-name": "string",
"gender": "female",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"last-modified-time": "string",
"last-name": "string",
"last-signup-email-sent-time": "string",
"marital-status": "s",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"owner-id": "11111111-1111-1111-1111-111111111111",
"phone-verified": true,
"photo": "string",
"photo-link": "string",
"preferred-name": "string",
"registered": true,
"registration-completed-time": "string",
"registration-invite": "accepted",
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"telecom-preference": "",
"workflows": [{"created-at": "string",
"current-state": "string",
"state-data": { },
"workflow-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
],
"workflows-pending": [{"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individuals"
},
"meta": { }
}

Cancel a workflow currently associated with an ind

Cancel a workflow currently associated with an individual

path Parameters

required

string

Resource identifier

Request Body schema: application/json

workflowtype-id	string <uuid>
workflowtype-name	string <= 255 characters Deprecated

Responses

Request samples

Payload

Content type

application/json

{"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account-type": "provider",
"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"address-city": "string",
"address-state": "string",
"address-street": ["string"
],
"address-zipcode": "string",
"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication": [{"language": "string",
"preferred": true
}
],
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"contact-email": "string",
"contact-phone-home": "string",
"contact-phone-mobile": "string",
"contact-phone-mobile-verified": true,
"created-time": "string",
"email-verified": true,
"extension": "string",
"first-name": "string",
"gender": "female",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"last-modified-time": "string",
"last-name": "string",
"last-signup-email-sent-time": "string",
"marital-status": "s",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"owner-id": "11111111-1111-1111-1111-111111111111",
"phone-verified": true,
"photo": "string",
"photo-link": "string",
"preferred-name": "string",
"registered": true,
"registration-completed-time": "string",
"registration-invite": "accepted",
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"telecom-preference": "",
"workflows": [{"created-at": "string",
"current-state": "string",
"state-data": { },
"workflow-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
],
"workflows-pending": [{"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individuals"
},
"meta": { }
}

Change the owner of an individual (restricted)

path Parameters

required

string

Resource identifier

Request Body schema: application/json

owner-id required	string <uuid> User ID of the new owner of the individual
account-type	string Enum: "provider" "regular"
email-verified	boolean
phone-verified	boolean

Responses

Request samples

Payload

Content type

application/json

{"account-type": "provider",
"email-verified": true,
"owner-id": "11111111-1111-1111-1111-111111111111",
"phone-verified": true
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account-type": "provider",
"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"address-city": "string",
"address-state": "string",
"address-street": ["string"
],
"address-zipcode": "string",
"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication": [{"language": "string",
"preferred": true
}
],
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"contact-email": "string",
"contact-phone-home": "string",
"contact-phone-mobile": "string",
"contact-phone-mobile-verified": true,
"created-time": "string",
"email-verified": true,
"extension": "string",
"first-name": "string",
"gender": "female",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"last-modified-time": "string",
"last-name": "string",
"last-signup-email-sent-time": "string",
"marital-status": "s",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"owner-id": "11111111-1111-1111-1111-111111111111",
"phone-verified": true,
"photo": "string",
"photo-link": "string",
"preferred-name": "string",
"registered": true,
"registration-completed-time": "string",
"registration-invite": "accepted",
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"telecom-preference": "",
"workflows": [{"created-at": "string",
"current-state": "string",
"state-data": { },
"workflow-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
],
"workflows-pending": [{"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individuals"
},
"meta": { }
}

/v1/individuals/{id}/deidentify/ Deprecated

path Parameters

required

string

Resource identifier

Request Body schema: application/json

email required	string <email>
first-name required	string <= 255 characters
last-name required	string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"first-name": "string",
"last-name": "string"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account-type": "provider",
"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"address-city": "string",
"address-state": "string",
"address-street": ["string"
],
"address-zipcode": "string",
"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication": [{"language": "string",
"preferred": true
}
],
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"contact-email": "string",
"contact-phone-home": "string",
"contact-phone-mobile": "string",
"contact-phone-mobile-verified": true,
"created-time": "string",
"email-verified": true,
"extension": "string",
"first-name": "string",
"gender": "female",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"last-modified-time": "string",
"last-name": "string",
"last-signup-email-sent-time": "string",
"marital-status": "s",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"owner-id": "11111111-1111-1111-1111-111111111111",
"phone-verified": true,
"photo": "string",
"photo-link": "string",
"preferred-name": "string",
"registered": true,
"registration-completed-time": "string",
"registration-invite": "accepted",
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"telecom-preference": "",
"workflows": [{"created-at": "string",
"current-state": "string",
"state-data": { },
"workflow-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
],
"workflows-pending": [{"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individuals"
},
"meta": { }
}

Reset individual data, use with caution Deprecated

Reset individual data, use with caution

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

null

signal that individual has been shared with an org

signal that individual has been shared with an organization

path Parameters

required

string

Resource identifier

Request Body schema: application/json

organization-id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"organization-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type

application/vnd.api+json

null

Associate a workflow with the individual and start

Associate a workflow with the individual and start that workflow. enrollment-data should be built based on the enrollment-schema provided in the workflowtype definition.

path Parameters

required

string

Resource identifier

Request Body schema: application/json

enrollment-data	object
workflowtype-id	string <uuid>
workflowtype-name	string <= 255 characters Deprecated

Responses

Request samples

Payload

Content type

application/json

{"enrollment-data": { },
"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"account-type": "provider",
"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"address-city": "string",
"address-state": "string",
"address-street": ["string"
],
"address-zipcode": "string",
"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication": [{"language": "string",
"preferred": true
}
],
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"gender": "female",
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"organization": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"relationship": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"contact-email": "string",
"contact-phone-home": "string",
"contact-phone-mobile": "string",
"contact-phone-mobile-verified": true,
"created-time": "string",
"email-verified": true,
"extension": "string",
"first-name": "string",
"gender": "female",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"last-modified-time": "string",
"last-name": "string",
"last-signup-email-sent-time": "string",
"marital-status": "s",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"owner-id": "11111111-1111-1111-1111-111111111111",
"phone-verified": true,
"photo": "string",
"photo-link": "string",
"preferred-name": "string",
"registered": true,
"registration-completed-time": "string",
"registration-invite": "accepted",
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"telecom-preference": "",
"workflows": [{"created-at": "string",
"current-state": "string",
"state-data": { },
"workflow-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
],
"workflows-pending": [{"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string",
"workflowtype-type": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individuals"
},
"meta": { }
}

/v1/journal-acks

/v1/journal-acks/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
provider-id required	string <uuid> Example: provider-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"entry-count": 0,
"last-entry": {"created-at": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"provider-id": "11111111-1111-1111-1111-111111111111"
}
}
]
}

/v1/journal-attachments

/v1/journal-attachments/

query Parameters

entry-id

required

string <uuid>

Example: entry-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"content-size": 0,
"content-type": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"entry-id": "11111111-1111-1111-1111-111111111111",
"processing-started-at": "string",
"ready-to-use": true,
"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "journal-attachments"
}
],
"meta": { }
}

/v1/journal-attachments/

Request Body schema: multipart/form-data

content-type required	string Enum: "application/pdf" "image/avif" "image/bmp" "image/gif" "image/heic" "image/jpeg" "image/png" "image/tiff" "image/webp"
entry-id required	string <uuid>
content	string <binary>

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-size": 0,
"content-type": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"entry-id": "11111111-1111-1111-1111-111111111111",
"processing-started-at": "string",
"ready-to-use": true,
"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "journal-attachments"
},
"meta": { }
}

/v1/journal-attachments/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/journal-attachments/{id}/

path Parameters

required

string

Resource identifier

query Parameters

direct

boolean

Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"errors": [{"code": "string",
"detail": "string",
"meta": { },
"source": {"parameter": "string",
"pointer": "string"
},
"status": 400
}
]
}

/v1/journal-attachments/{id}/get-metadata/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-size": 0,
"content-type": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"entry-id": "11111111-1111-1111-1111-111111111111",
"processing-started-at": "string",
"ready-to-use": true,
"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "journal-attachments"
},
"meta": { }
}

/v1/journal-attachments/{id}/process-upload/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-size": 0,
"content-type": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"entry-id": "11111111-1111-1111-1111-111111111111",
"processing-started-at": "string",
"ready-to-use": true,
"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "journal-attachments"
},
"meta": { }
}

/v1/journal-entries

/v1/journal-entries/

query Parameters

end-time	string <datetime>
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ] compare timestamp against last-modified-at time.specify [comparitor][datetime]. comparators supported >, <, <=, >=use multiple to build a bounded time frame.
filter[include-inactive]	boolean Default: false
group-id	string <= 32 characters
group-name	string <= 255 characters
individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
start-time	string <datetime>
thumbnail	boolean Default: false
thumbnail-link	boolean Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"attachments": [{"content-type": "string",
"id": "11111111-1111-1111-1111-111111111111",
"thumbnail": "string",
"thumbnail-link": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"group-id": "string",
"group-name": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"text": "string",
"time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "journal-entries"
}
],
"meta": { }
}

/v1/journal-entries/

Request Body schema: application/json

required

object

type

required

string

Value: "journal-entries"

required

object

individual-id required	string <uuid>
text required	string <= 99999 characters
group-id	string <= 32 characters
group-name	string <= 255 characters
time	string <datetime>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"group-id": "string",
"group-name": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"text": "string",
"time": "string"
},
"type": "journal-entries"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"attachments": [{"content-type": "string",
"id": "11111111-1111-1111-1111-111111111111",
"thumbnail": "string",
"thumbnail-link": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"group-id": "string",
"group-name": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"text": "string",
"time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "journal-entries"
},
"meta": { }
}

/v1/journal-entries/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/journal-entries/{id}/

path Parameters

required

string

Resource identifier

query Parameters

thumbnail

boolean

Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"attachments": [{"content-type": "string",
"id": "11111111-1111-1111-1111-111111111111",
"thumbnail": "string",
"thumbnail-link": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"group-id": "string",
"group-name": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"text": "string",
"time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "journal-entries"
},
"meta": { }
}

/v1/journal-entries/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "journal-entries"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com. Supported (op, path)s are: ('replace', '/group-id'), ('replace', '/text'), ('replace', '/time').

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value required	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "journal-entries"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"attachments": [{"content-type": "string",
"id": "11111111-1111-1111-1111-111111111111",
"thumbnail": "string",
"thumbnail-link": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"group-id": "string",
"group-name": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"text": "string",
"time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "journal-entries"
},
"meta": { }
}

/v1/journal-entries/{id}/ack/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

provider-id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"provider-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"attachments": [{"content-type": "string",
"id": "11111111-1111-1111-1111-111111111111",
"thumbnail": "string",
"thumbnail-link": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"group-id": "string",
"group-name": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"text": "string",
"time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "journal-entries"
},
"meta": { }
}

/v1/journal-groups

/v1/journal-groups/

query Parameters

filter[exclude-level]	Array of strings Items Enum: "individual" "private" "provider" "public"
filter[include-level]	Array of strings Items Enum: "individual" "private" "provider" "public"
filter[include-provider]	boolean Default: false
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"name": "string",
"share-level": "individual"
},
"id": "string",
"type": "journal-groups"
}
],
"meta": { }
}

/v1/journal-groups/

Request Body schema: application/json

required

object

type

required

string

Value: "journal-groups"

required

object

name required	string <= 255 characters
sharing-level	string Default: "private" Enum: "individual" "private" "provider" "public"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"sharing-level": "individual"
},
"type": "journal-groups"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"share-level": "individual"
},
"id": "string",
"type": "journal-groups"
},
"meta": { }
}

/v1/journal-groups/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/journal-groups/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"share-level": "individual"
},
"id": "string",
"type": "journal-groups"
},
"meta": { }
}

/v1/journal-groups/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "journal-groups"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com. Supported (op, path)s are: ('replace', '/name'), ('replace', '/sharing-level').

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value required	any

required

string <= 32 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "string",
"type": "journal-groups"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"share-level": "individual"
},
"id": "string",
"type": "journal-groups"
},
"meta": { }
}

/v1/lcr-contacts

/v1/lcr-contacts/

query Parameters

resource-id required	string <uuid> Example: resource-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Items Enum: "-created-at" "created-at"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"email": "string",
"first-name": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"resource-id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-contacts"
}
],
"meta": { }
}

/v1/lcr-contacts/

Request Body schema: application/json

required

object

type

required

string

Value: "lcr-contacts"

required

object

resource-id required	string <uuid>
email	string <email>
first-name	string <= 255 characters
last-name	string <= 255 characters
phone	string <phonenumberE164>
title	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"email": "user@example.com",
"first-name": "string",
"last-name": "string",
"phone": "string",
"resource-id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"type": "lcr-contacts"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"email": "string",
"first-name": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"resource-id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-contacts"
},
"meta": { }
}

/v1/lcr-contacts/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/lcr-contacts/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"email": "string",
"first-name": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"resource-id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-contacts"
},
"meta": { }
}

/v1/lcr-contacts/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "lcr-contacts"

required

object

email	string <email>
first-name	string <= 255 characters
last-name	string <= 255 characters
phone	string <phonenumberE164>
title	string <= 255 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"email": "user@example.com",
"first-name": "string",
"last-name": "string",
"phone": "string",
"title": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-contacts"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"email": "string",
"first-name": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"resource-id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-contacts"
},
"meta": { }
}

/v1/lcr-program-individual-associations

/v1/lcr-program-individual-associations/

query Parameters

filter[individual-id]	string <uuid> Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]	string <uuid> Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[program-id]	string <uuid> Example: filter[program-id]=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Items Enum: "-created-at" "created-at"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"program": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-program-individual-associations"
}
],
"meta": { }
}

/v1/lcr-program-individual-associations/

Request Body schema: application/json

required

object

type

required

string

Value: "lcr-program-individual-associations"

required

object

individual-id required	string <uuid>
program-id required	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"individual-id": "11111111-1111-1111-1111-111111111111",
"program-id": "11111111-1111-1111-1111-111111111111"
},
"type": "lcr-program-individual-associations"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"program": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-program-individual-associations"
},
"meta": { }
}

/v1/lcr-program-individual-associations/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/lcr-program-individual-associations/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"program": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-program-individual-associations"
},
"meta": { }
}

/v1/lcr-programs

/v1/lcr-programs/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Items Enum: "-created-at" "created-at"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-programs"
}
],
"meta": { }
}

/v1/lcr-programs/

Request Body schema: application/json

required

object

type

required

string

Value: "lcr-programs"

required

object

name required	string <= 255 characters
organization-id required	string <uuid>
description	string <= 1000 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"description": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "lcr-programs"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-programs"
},
"meta": { }
}

/v1/lcr-programs/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/lcr-programs/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-programs"
},
"meta": { }
}

/v1/lcr-programs/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "lcr-programs"

required

object

description	string <= 1000 characters
name	string <= 255 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"description": "string",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-programs"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-programs"
},
"meta": { }
}

/v1/lcr-reachable-resources

/v1/lcr-reachable-resources/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[distance]	number >= 0 Default: 25
filter[latitude]	number [ -90 .. 90 ]
filter[longitude]	number [ -180 .. 180 ]
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"address": "string",
"allow-location-independent": true,
"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"distance": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"max-result": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"program-ids": ["11111111-1111-1111-1111-111111111111"
],
"result": {"count": 0,
"error": "string",
"resources": [{"attributes": { },
"distance": 0,
"id": "11111111-1111-1111-1111-111111111111"
}
]
},
"status": "completed"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-reachable-resources"
}
],
"meta": { }
}

/v1/lcr-reachable-resources/

Request Body schema: application/json

required

object

type

required

string

Value: "lcr-reachable-resources"

required

object

organization-id required	string <uuid>
address	string <= 255 characters
allow-location-independent	boolean Default: true
distance	number >= 0.1 Default: 25 in miles
individual-id	string <uuid>
max-result	integer >= 1 Default: 25
program-ids	Array of strings <uuid> [ items <uuid > ]

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"address": "string",
"allow-location-independent": true,
"distance": 25,
"individual-id": "11111111-1111-1111-1111-111111111111",
"max-result": 25,
"organization-id": "11111111-1111-1111-1111-111111111111",
"program-ids": ["11111111-1111-1111-1111-111111111111"
]
},
"type": "lcr-reachable-resources"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"address": "string",
"allow-location-independent": true,
"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"distance": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"max-result": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"program-ids": ["11111111-1111-1111-1111-111111111111"
],
"result": {"count": 0,
"error": "string",
"resources": [{"attributes": { },
"distance": 0,
"id": "11111111-1111-1111-1111-111111111111"
}
]
},
"status": "completed"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-reachable-resources"
},
"meta": { }
}

/v1/lcr-reachable-resources/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/lcr-reachable-resources/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"address": "string",
"allow-location-independent": true,
"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"distance": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"max-result": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"program-ids": ["11111111-1111-1111-1111-111111111111"
],
"result": {"count": 0,
"error": "string",
"resources": [{"attributes": { },
"distance": 0,
"id": "11111111-1111-1111-1111-111111111111"
}
]
},
"status": "completed"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-reachable-resources"
},
"meta": { }
}

/v1/lcr-resource-individual-associations

/v1/lcr-resource-individual-associations/

query Parameters

filter[individual-id]	string <uuid> Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]	string <uuid> Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[resource-id]	string <uuid> Example: filter[resource-id]=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Items Enum: "-created-at" "created-at"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"distance": 0,
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"resource": {"attributes": {"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"contacts": [{"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"title": "string"
}
],
"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"custom-data": { },
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"latitude": 0,
"location-independent": true,
"longitude": 0,
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"phone": "string",
"program": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"state": "string",
"url": "string",
"zipcode": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-resource-individual-associations"
}
],
"meta": { }
}

/v1/lcr-resource-individual-associations/

Request Body schema: application/json

required

object

type

required

string

Value: "lcr-resource-individual-associations"

required

object

individual-id required	string <uuid>
resource-id required	string <uuid>
distance	number Default: 0

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"distance": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"resource-id": "11111111-1111-1111-1111-111111111111"
},
"type": "lcr-resource-individual-associations"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"distance": 0,
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"resource": {"attributes": {"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"contacts": [{"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"title": "string"
}
],
"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"custom-data": { },
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"latitude": 0,
"location-independent": true,
"longitude": 0,
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"phone": "string",
"program": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"state": "string",
"url": "string",
"zipcode": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-resource-individual-associations"
},
"meta": { }
}

/v1/lcr-resource-individual-associations/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/lcr-resource-individual-associations/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"distance": 0,
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"resource": {"attributes": {"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"contacts": [{"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"title": "string"
}
],
"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"custom-data": { },
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"latitude": 0,
"location-independent": true,
"longitude": 0,
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"phone": "string",
"program": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"state": "string",
"url": "string",
"zipcode": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-resource-individual-associations"
},
"meta": { }
}

/v1/lcr-resource-individual-associations/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "lcr-resource-individual-associations"

required

object

distance

number

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"distance": 0
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-resource-individual-associations"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"distance": 0,
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"resource": {"attributes": {"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"contacts": [{"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"title": "string"
}
],
"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"custom-data": { },
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"latitude": 0,
"location-independent": true,
"longitude": 0,
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"phone": "string",
"program": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"state": "string",
"url": "string",
"zipcode": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-resource-individual-associations"
},
"meta": { }
}

/v1/lcr-resources

/v1/lcr-resources/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[program-ids]	Array of strings <uuid> non-empty [ items <uuid > ] Example: filter[program-ids]=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"contacts": [{"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"title": "string"
}
],
"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"custom-data": { },
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"latitude": 0,
"location-independent": true,
"longitude": 0,
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"phone": "string",
"program": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"state": "string",
"url": "string",
"zipcode": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-resources"
}
],
"meta": { }
}

/v1/lcr-resources/

Request Body schema: application/json

required

object

type

required

string

Value: "lcr-resources"

required

object

name required	string <= 255 characters
organization-id required	string <uuid>
program-id required	string <uuid>
address1	string <= 255 characters
address2	string <= 255 characters
address3	string <= 255 characters
city	string <= 255 characters
custom-data	object
description	string <= 1000 characters
location-independent	boolean Default: false
phone	string <phonenumberE164>
state	string <short_state_us>
url	string <url>
zipcode	string <zipcode_us>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"custom-data": { },
"description": "string",
"location-independent": false,
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"phone": "string",
"program-id": "11111111-1111-1111-1111-111111111111",
"state": "string",
"url": "string",
"zipcode": "string"
},
"type": "lcr-resources"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"contacts": [{"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"title": "string"
}
],
"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"custom-data": { },
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"latitude": 0,
"location-independent": true,
"longitude": 0,
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"phone": "string",
"program": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"state": "string",
"url": "string",
"zipcode": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-resources"
},
"meta": { }
}

/v1/lcr-resources/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/lcr-resources/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"contacts": [{"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"title": "string"
}
],
"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"custom-data": { },
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"latitude": 0,
"location-independent": true,
"longitude": 0,
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"phone": "string",
"program": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"state": "string",
"url": "string",
"zipcode": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-resources"
},
"meta": { }
}

/v1/lcr-resources/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "lcr-resources"

required

object

address1	string <= 255 characters
address2	string <= 255 characters
address3	string <= 255 characters
city	string <= 255 characters
custom-data	object
description	string <= 1000 characters
location-independent	boolean
name	string <= 255 characters
phone	string <phonenumberE164>
program-id	string <uuid>
state	string <short_state_us>
url	string <url>
zipcode	string <zipcode_us>

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"custom-data": { },
"description": "string",
"location-independent": true,
"name": "string",
"phone": "string",
"program-id": "11111111-1111-1111-1111-111111111111",
"state": "string",
"url": "string",
"zipcode": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-resources"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"contacts": [{"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"title": "string"
}
],
"created-at": "string",
"created-by-id": "11111111-1111-1111-1111-111111111111",
"custom-data": { },
"description": "string",
"last-modified-at": "string",
"last-modified-by-id": "11111111-1111-1111-1111-111111111111",
"latitude": 0,
"location-independent": true,
"longitude": 0,
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"phone": "string",
"program": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"state": "string",
"url": "string",
"zipcode": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "lcr-resources"
},
"meta": { }
}

/v1/medication-due-medications

/v1/medication-due-medications/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
filter[cmp-due-at]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against due-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"due-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-scheduler-id": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"medication-taken-medication-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-due-medications"
}
],
"meta": { }
}

/v1/medication-due-medications/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/medication-due-medications/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"due-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-scheduler-id": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"medication-taken-medication-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-due-medications"
},
"meta": { }
}

/v1/medication-due-medications/{id}/taken/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

taken-at required	string <datetime>
taken-at-tz required	string <timezone>

Responses

Request samples

Payload

Content type

application/json

{"taken-at": "string",
"taken-at-tz": "string"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-due-medication-id": "11111111-1111-1111-1111-111111111111",
"medication-scheduler-id": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-taken-medications"
},
"meta": { }
}

/v1/medication-reminders

/v1/medication-reminders/ Deprecated

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"scheduler-id": "11111111-1111-1111-1111-111111111111",
"scheduler-rrule": "string",
"scheduler-start": "string",
"scheduler-tz-aware": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-reminders"
}
],
"meta": { }
}

/v1/medication-reminders/ Deprecated

Request Body schema: application/json

required

object

type

required

string

Value: "medication-reminders"

required

object

individual-id

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"individual-id": "11111111-1111-1111-1111-111111111111"
},
"type": "medication-reminders"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"scheduler-id": "11111111-1111-1111-1111-111111111111",
"scheduler-rrule": "string",
"scheduler-start": "string",
"scheduler-tz-aware": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-reminders"
},
"meta": { }
}

/v1/medication-reminders/{id}/ Deprecated

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/medication-reminders/{id}/ Deprecated

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"scheduler-id": "11111111-1111-1111-1111-111111111111",
"scheduler-rrule": "string",
"scheduler-start": "string",
"scheduler-tz-aware": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-reminders"
},
"meta": { }
}

/v1/medication-reminders/{id}/answer/ Deprecated

path Parameters

required

string

Resource identifier

Request Body schema: application/json

value required	string <= 255 characters
individual-id	string <uuid>
interview-id	string <uuid>
question-id	string <uuid>
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"individual-id": "11111111-1111-1111-1111-111111111111",
"interview-id": "11111111-1111-1111-1111-111111111111",
"question-id": "11111111-1111-1111-1111-111111111111",
"value": "string"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"scheduler-id": "11111111-1111-1111-1111-111111111111",
"scheduler-rrule": "string",
"scheduler-start": "string",
"scheduler-tz-aware": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-reminders"
},
"meta": { }
}

/v1/medication-reminders/{id}/timer/ Deprecated

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"scheduler-id": "11111111-1111-1111-1111-111111111111",
"scheduler-rrule": "string",
"scheduler-start": "string",
"scheduler-tz-aware": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-reminders"
},
"meta": { }
}

/v1/medication-reminders-migrate

/v1/medication-reminders-migrate/

Request Body schema: application/json

individual-id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type

application/vnd.api+json

null

/v1/medication-schedulers

/v1/medication-schedulers/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
include[details-for-date]	string <date> result includes recurrence and takens
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"enabled": true,
"follow-tz": true,
"frequency": "DAILY",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statement": {"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"next-due-at": "string",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"recurrence": "string",
"rrule": "string",
"send-reminder": true,
"start-at": "string",
"start-tz": "string",
"takens": [{"id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}
],
"working-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-schedulers"
}
],
"meta": { }
}

/v1/medication-schedulers/

Request Body schema: application/json

required

object

type

required

string

Value: "medication-schedulers"

required

object

follow-tz required	boolean
frequency required	string Enum: "DAILY" "HOURLY"
individual-id required	string <uuid>
medication-statement-id required	string <uuid>
send-reminder required	boolean
start-at required	string <datetime>
byday	Array of strings Items Enum: "FR" "MO" "SA" "SU" "TH" "TU" "WE"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"byday": ["FR"
],
"follow-tz": true,
"frequency": "DAILY",
"individual-id": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"send-reminder": true,
"start-at": "string"
},
"type": "medication-schedulers"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"enabled": true,
"follow-tz": true,
"frequency": "DAILY",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statement": {"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"next-due-at": "string",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"recurrence": "string",
"rrule": "string",
"send-reminder": true,
"start-at": "string",
"start-tz": "string",
"takens": [{"id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}
],
"working-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-schedulers"
},
"meta": { }
}

/v1/medication-schedulers/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/medication-schedulers/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"enabled": true,
"follow-tz": true,
"frequency": "DAILY",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statement": {"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"next-due-at": "string",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"recurrence": "string",
"rrule": "string",
"send-reminder": true,
"start-at": "string",
"start-tz": "string",
"takens": [{"id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}
],
"working-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-schedulers"
},
"meta": { }
}

/v1/medication-schedulers/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "medication-schedulers"

required

object

byday	Array of strings Items Enum: "FR" "MO" "SA" "SU" "TH" "TU" "WE"
follow-tz	boolean
frequency	string Enum: "DAILY" "HOURLY"
send-reminder	boolean
start-at	string <datetime>

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"byday": ["FR"
],
"follow-tz": true,
"frequency": "DAILY",
"send-reminder": true,
"start-at": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-schedulers"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"enabled": true,
"follow-tz": true,
"frequency": "DAILY",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statement": {"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"next-due-at": "string",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"recurrence": "string",
"rrule": "string",
"send-reminder": true,
"start-at": "string",
"start-tz": "string",
"takens": [{"id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}
],
"working-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-schedulers"
},
"meta": { }
}

/v1/medication-schedulers/{id}/snooze-reminder/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

delay-mins

integer

Default: 30

Responses

Request samples

Payload

Content type

application/json

{"delay-mins": 30
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"enabled": true,
"follow-tz": true,
"frequency": "DAILY",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statement": {"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"next-due-at": "string",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"recurrence": "string",
"rrule": "string",
"send-reminder": true,
"start-at": "string",
"start-tz": "string",
"takens": [{"id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}
],
"working-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-schedulers"
},
"meta": { }
}

/v1/medication-schedulers/{id}/taken/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

status required	string Enum: "SKIPPED" "TAKEN"
taken-at required	string <datetime>
taken-at-tz	string <timezone>

Responses

Request samples

Payload

Content type

application/json

{"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-due-medication-id": "11111111-1111-1111-1111-111111111111",
"medication-scheduler-id": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-taken-medications"
},
"meta": { }
}

/v1/medication-statement-attachments

/v1/medication-statement-attachments/

query Parameters

medication-statement-id required	string <uuid> Example: medication-statement-id=11111111-1111-1111-1111-111111111111
filter[include-pending]	boolean Default: false
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"content-size": 0,
"content-type": "string",
"created-at": "string",
"filename": "string",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"ready-to-use": true,
"thumbnail": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-statement-attachments"
}
],
"meta": { }
}

/v1/medication-statement-attachments/

Request Body schema: application/json

required

object

type

required

string

Value: "medication-statement-attachments"

required

object

content-type required	string <= 64 characters
medication-statement-id required	string <uuid>
filename	string <= 255 characters Default: ""

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"content-type": "string",
"filename": "",
"medication-statement-id": "11111111-1111-1111-1111-111111111111"
},
"type": "medication-statement-attachments"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"expiration-time": 0,
"id": "11111111-1111-1111-1111-111111111111",
"upload-data": { },
"upload-url": "string"
}
}

Deletes a message attachment

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/medication-statement-attachments/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-size": 0,
"content-type": "string",
"created-at": "string",
"filename": "string",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"ready-to-use": true,
"thumbnail": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-statement-attachments"
},
"meta": { }
}

/v1/medication-statement-attachments/{id}/get-download-url/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"url": "string"
}

/v1/medication-statement-attachments/{id}/process-upload/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-size": 0,
"content-type": "string",
"created-at": "string",
"filename": "string",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"ready-to-use": true,
"thumbnail": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-statement-attachments"
},
"meta": { }
}

/v1/medication-statements

/v1/medication-statements/

query Parameters

exclude[care-plan-id]	string <uuid> Example: exclude[care-plan-id]=11111111-1111-1111-1111-111111111111
filter[active-care-plan-id]	string <uuid> Example: filter[active-care-plan-id]=11111111-1111-1111-1111-111111111111
filter[care-plan-id]	string <uuid> Deprecated Example: filter[care-plan-id]=11111111-1111-1111-1111-111111111111 prefer filter[active-care-plan-id]
filter[external-id]	string <= 255 characters
filter[status]	string Enum: "active" "completed" "entered-in-error" "intended" "on-hold" "stopped"
filter[visible]	boolean
include[scheduler-details-for-date]	string <date> scheduler result includes recurrence and takens
individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0
subject	string <= 255 characters
thumbnail	boolean Default: false
ui-only	boolean Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"_ui": {"active-care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"attachments": [{"content-size": 0,
"content-type": "string",
"filename": "string",
"id": "11111111-1111-1111-1111-111111111111",
"thumbnail": "string"
}
],
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"care-plans": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
}
],
"created-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"display-description": "string",
"display-name": "string",
"display-url": "string",
"dose-unit": "string",
"dose-value": 0,
"end": "string",
"last-taken-at": "string",
"medication-code": "string",
"medication-system": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"enabled": true,
"follow-tz": true,
"frequency": "DAILY",
"id": "11111111-1111-1111-1111-111111111111",
"next-due-at": "string",
"recurrence": "string",
"rrule": "string",
"send-reminder": true,
"start-at": "string",
"start-tz": "string",
"takens": [{"id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}
],
"working-tz": "string"
}
],
"start": "string",
"status": "active"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"dosage": [{"additional-instruction": [{"coding": [{"code": null,
"display": null,
"system": null,
"user-selected": null,
"version": null
}
],
"text": "string"
}
],
"dose-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"dose-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"max-dose-per-administration": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"max-dose-per-lifetime": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"max-dose-per-period": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"method": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"patient-instruction": "string",
"rate": ["string"
],
"rate-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"rate-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"rate-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"text": "string",
"timing": {"code": {"coding": [{"code": null,
"display": null,
"system": null,
"user-selected": null,
"version": null
}
],
"text": "string"
},
"event": ["string"
],
"repeat": {"bounds-duration": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"bounds-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"bounds-range": {"high": {"code": null,
"comparator": null,
"system": null,
"unit": null,
"value": null
},
"low": {"code": null,
"comparator": null,
"system": null,
"unit": null,
"value": null
}
},
"count": 0,
"count-max": 0,
"day-of-week": ["string"
],
"duration": 0,
"duration-max": 0,
"duration-unit": "s",
"frequency": 0,
"frequency-max": 0,
"offset": 0,
"period": 0,
"period-max": 0,
"period-unit": "s",
"time-of-day": ["string"
],
"when": ["MORN"
]
}
}
}
],
"effective": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"external-id": "string",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"information-source": "string",
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"medication-ref": "string",
"merged-from-ids": ["string"
],
"merged-to-id": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"reason-for-use": "string",
"status": "active",
"subject": "string",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-statements"
}
],
"meta": {"page[limit]": 100,
"page[offset]": 0,
"page[total]": 0,
"users": [{"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
}
]
}
}

/v1/medication-statements/

Request Body schema: application/json

required

object

type

required

string

Value: "medication-statements"

required

object

display-name	string <= 255 characters
dose-unit	string <= 255 characters
dose-value	number [ 0 .. 100000 ]
end	string <datetime>
organization-id	string <uuid>
reason-for-use	string <= 255 characters
	Array of objects
start	string <datetime>
status	string Enum: "active" "completed" "entered-in-error" "intended" "on-hold" "stopped"

care-plan-id

string <uuid>

Array of objects

Array

	Array of objects
	object
	object
	object
	object
	object
	object
patient-instruction	string <= 255 characters
rate	Array of strings[ items <= 255 characters ]
	object
	object
	object
	object
	object
text	string <= 255 characters
	object

object

end	string <datetime> Default: "1975-11-25 00:00:00"
start	string <datetime> Default: "1975-11-25 00:00:00"

external-id

string <= 255 characters

Array of objects

Array

assigner	string <= 255 characters
	object
system	string <= 255 characters
type	string Enum: "DL" "PPN" "BRN" "MR" "MCN" "EN" "TAX" "NIIP" "PRN" "MD" "DR"
use	string Enum: "usual" "official" "temp" "secondary"
value	string <= 255 characters

individual-id

string <uuid>

information-source

string <= 255 characters

object

	Array of objects
text	string <= 255 characters

medication-ref

string <= 255 characters

merged-from-ids

Array of strings[ items <= 255 characters ]

organization-id

string <uuid>

reason-for-use

string <= 255 characters

status

string

Enum: "active" "completed" "entered-in-error" "intended" "on-hold" "stopped"

subject

string <= 255 characters

visible

boolean

Default: true

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"_ui": {"display-name": "string",
"dose-unit": "string",
"dose-value": 100000,
"end": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"frequency": "DAILY",
"send-reminder": true,
"start-at": "string"
}
],
"start": "string",
"status": "active"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"dosage": [{"additional-instruction": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"dose-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"dose-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"max-dose-per-administration": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"max-dose-per-lifetime": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"max-dose-per-period": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"method": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"patient-instruction": "string",
"rate": ["string"
],
"rate-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"rate-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"rate-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"text": "string",
"timing": {"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"event": ["string"
],
"repeat": {"bounds-duration": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"bounds-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"bounds-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"count": 0,
"count-max": 0,
"day-of-week": ["string"
],
"duration": 0,
"duration-max": 0,
"duration-unit": "s",
"frequency": 0,
"frequency-max": 0,
"offset": 0,
"period": 0,
"period-max": 0,
"period-unit": "s",
"time-of-day": ["string"
],
"when": ["MORN"
]
}
}
}
],
"effective": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"external-id": "string",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"information-source": "string",
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"medication-ref": "string",
"merged-from-ids": ["string"
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"reason-for-use": "string",
"status": "active",
"subject": "string",
"visible": true
},
"type": "medication-statements"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"active-care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"attachments": [{"content-size": 0,
"content-type": "string",
"filename": "string",
"id": "11111111-1111-1111-1111-111111111111",
"thumbnail": "string"
}
],
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"care-plans": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
}
],
"created-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"display-description": "string",
"display-name": "string",
"display-url": "string",
"dose-unit": "string",
"dose-value": 0,
"end": "string",
"last-taken-at": "string",
"medication-code": "string",
"medication-system": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"enabled": true,
"follow-tz": true,
"frequency": "DAILY",
"id": "11111111-1111-1111-1111-111111111111",
"next-due-at": "string",
"recurrence": "string",
"rrule": "string",
"send-reminder": true,
"start-at": "string",
"start-tz": "string",
"takens": [{"id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}
],
"working-tz": "string"
}
],
"start": "string",
"status": "active"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"dosage": [{"additional-instruction": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"dose-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"dose-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"max-dose-per-administration": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"max-dose-per-lifetime": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"max-dose-per-period": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"method": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"patient-instruction": "string",
"rate": ["string"
],
"rate-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"rate-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"rate-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"text": "string",
"timing": {"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"event": ["string"
],
"repeat": {"bounds-duration": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"bounds-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"bounds-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"count": 0,
"count-max": 0,
"day-of-week": ["string"
],
"duration": 0,
"duration-max": 0,
"duration-unit": "s",
"frequency": 0,
"frequency-max": 0,
"offset": 0,
"period": 0,
"period-max": 0,
"period-unit": "s",
"time-of-day": ["string"
],
"when": ["MORN"
]
}
}
}
],
"effective": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"external-id": "string",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"information-source": "string",
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"medication-ref": "string",
"merged-from-ids": ["string"
],
"merged-to-id": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"reason-for-use": "string",
"status": "active",
"subject": "string",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-statements"
},
"meta": {"users": [{"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
}
]
}
}

/v1/medication-statements/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/medication-statements/{id}/

path Parameters

required

string

Resource identifier

query Parameters

include[scheduler-details-for-date]	string <date> scheduler result includes recurrence and takens
thumbnail	boolean Default: false
ui-only	boolean Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"active-care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"attachments": [{"content-size": 0,
"content-type": "string",
"filename": "string",
"id": "11111111-1111-1111-1111-111111111111",
"thumbnail": "string"
}
],
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"care-plans": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
}
],
"created-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"display-description": "string",
"display-name": "string",
"display-url": "string",
"dose-unit": "string",
"dose-value": 0,
"end": "string",
"last-taken-at": "string",
"medication-code": "string",
"medication-system": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"enabled": true,
"follow-tz": true,
"frequency": "DAILY",
"id": "11111111-1111-1111-1111-111111111111",
"next-due-at": "string",
"recurrence": "string",
"rrule": "string",
"send-reminder": true,
"start-at": "string",
"start-tz": "string",
"takens": [{"id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}
],
"working-tz": "string"
}
],
"start": "string",
"status": "active"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"dosage": [{"additional-instruction": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"dose-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"dose-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"max-dose-per-administration": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"max-dose-per-lifetime": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"max-dose-per-period": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"method": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"patient-instruction": "string",
"rate": ["string"
],
"rate-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"rate-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"rate-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"text": "string",
"timing": {"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"event": ["string"
],
"repeat": {"bounds-duration": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"bounds-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"bounds-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"count": 0,
"count-max": 0,
"day-of-week": ["string"
],
"duration": 0,
"duration-max": 0,
"duration-unit": "s",
"frequency": 0,
"frequency-max": 0,
"offset": 0,
"period": 0,
"period-max": 0,
"period-unit": "s",
"time-of-day": ["string"
],
"when": ["MORN"
]
}
}
}
],
"effective": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"external-id": "string",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"information-source": "string",
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"medication-ref": "string",
"merged-from-ids": ["string"
],
"merged-to-id": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"reason-for-use": "string",
"status": "active",
"subject": "string",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-statements"
},
"meta": {"users": [{"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
}
]
}
}

/v1/medication-statements/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "medication-statements"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-statements"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"active-care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"attachments": [{"content-size": 0,
"content-type": "string",
"filename": "string",
"id": "11111111-1111-1111-1111-111111111111",
"thumbnail": "string"
}
],
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"care-plans": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
}
],
"created-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"display-description": "string",
"display-name": "string",
"display-url": "string",
"dose-unit": "string",
"dose-value": 0,
"end": "string",
"last-taken-at": "string",
"medication-code": "string",
"medication-system": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"enabled": true,
"follow-tz": true,
"frequency": "DAILY",
"id": "11111111-1111-1111-1111-111111111111",
"next-due-at": "string",
"recurrence": "string",
"rrule": "string",
"send-reminder": true,
"start-at": "string",
"start-tz": "string",
"takens": [{"id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}
],
"working-tz": "string"
}
],
"start": "string",
"status": "active"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"dosage": [{"additional-instruction": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"dose-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"dose-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"max-dose-per-administration": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"max-dose-per-lifetime": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"max-dose-per-period": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"method": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"patient-instruction": "string",
"rate": ["string"
],
"rate-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"rate-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"rate-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"route": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"text": "string",
"timing": {"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"event": ["string"
],
"repeat": {"bounds-duration": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": 0
},
"bounds-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"bounds-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"count": 0,
"count-max": 0,
"day-of-week": ["string"
],
"duration": 0,
"duration-max": 0,
"duration-unit": "s",
"frequency": 0,
"frequency-max": 0,
"offset": 0,
"period": 0,
"period-max": 0,
"period-unit": "s",
"time-of-day": ["string"
],
"when": ["MORN"
]
}
}
}
],
"effective": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"external-id": "string",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"information-source": "string",
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"medication-ref": "string",
"merged-from-ids": ["string"
],
"merged-to-id": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"reason-for-use": "string",
"status": "active",
"subject": "string",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-statements"
},
"meta": {"users": [{"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
}
]
}
}

/v1/medication-statements/{id}/taken/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

status required	string Enum: "SKIPPED" "TAKEN"
taken-at required	string <datetime>
taken-at-tz	string <timezone>

Responses

Request samples

Payload

Content type

application/json

{"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-due-medication-id": "11111111-1111-1111-1111-111111111111",
"medication-scheduler-id": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-taken-medications"
},
"meta": { }
}

/v1/medication-statements/{id}/weekly-summary/

path Parameters

required

string

Resource identifier

query Parameters

week-of

required

string <date>

Responses

Response samples

Content type

application/vnd.api+json

{"end-of-week": "2019-08-24",
"missed-count": 0,
"scheduled-doses-count": 0,
"skipped-count": 0,
"start-of-week": "2019-08-24",
"taken-count": 0
}

/v1/medication-taken-medications

/v1/medication-taken-medications/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
filter[cmp-taken-at]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against taken-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.
filter[medication-statement-id]	string <uuid> Example: filter[medication-statement-id]=11111111-1111-1111-1111-111111111111
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-due-medication-id": "11111111-1111-1111-1111-111111111111",
"medication-scheduler-id": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-taken-medications"
}
],
"meta": { }
}

/v1/medication-taken-medications/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/medication-taken-medications/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-due-medication-id": "11111111-1111-1111-1111-111111111111",
"medication-scheduler-id": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-taken-medications"
},
"meta": { }
}

/v1/medication-taken-medications/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "medication-taken-medications"

required

object

status	string Enum: "SKIPPED" "TAKEN"
taken-at	string <datetime>
taken-at-tz	string <timezone>

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-taken-medications"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"dose-unit": "string",
"dose-value": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-due-medication-id": "11111111-1111-1111-1111-111111111111",
"medication-scheduler-id": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-taken-medications"
},
"meta": { }
}

/v1/medications-taken

/v1/medications-taken/ Deprecated

Request Body schema: application/json

individual-id required	string <uuid>
time required	string <datetime>
tz required	string <timezone>

Responses

Request samples

Payload

Content type

application/json

{"individual-id": "11111111-1111-1111-1111-111111111111",
"time": "string",
"tz": "string"
}

Response samples

Content type

application/vnd.api+json

{"data": [{"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"time": "string",
"tz-offset-mins": 0,
"unit": "string",
"value": 0
}
]
}

/v1/observations

/v1/observations/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"based-on": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"body-site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"category": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"comment": "string",
"component": [{"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"data-absent-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"interpretation": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reference-range": [{"age": {"high": {"code": null,
"comparator": null,
"system": null,
"unit": null,
"value": null
},
"low": {"code": null,
"comparator": null,
"system": null,
"unit": null,
"value": null
}
},
"applies-to": [{"coding": [ ],
"text": null
}
],
"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"text": "string",
"type": {"coding": [{ }
],
"text": "string"
}
}
],
"value-attachment": {"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
},
"value-codeable-concept": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"value-date-time": "string",
"value-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"value-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"value-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-sampled-data": {"data": "string",
"dimensions": 0,
"factor": 0,
"lower-limit": 0,
"origin": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"period": 0,
"upper-limit": 0
},
"value-string": "string",
"value-time": "string"
}
],
"context": "string",
"data-absent-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"device": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"effective-date-time": "string",
"effective-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"interpretation": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"issued": "string",
"method": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"performer": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"reference-range": [{"age": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"applies-to": [{"coding": [{"code": null,
"display": null,
"system": null,
"user-selected": null,
"version": null
}
],
"text": "string"
}
],
"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"text": "string",
"type": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"related": [{"target": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"type": "has-member"
}
],
"specimen": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"status": "amended",
"value-attachment": {"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
},
"value-boolean": { },
"value-codeable-concept": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"value-date-time": "string",
"value-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"value-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"value-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-sampled-data": {"data": "string",
"dimensions": 0,
"factor": 0,
"lower-limit": 0,
"origin": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"period": 0,
"upper-limit": 0
},
"value-string": "string",
"value-time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "observations"
}
],
"meta": { }
}

/v1/observations/

Request Body schema: application/json

required

object

type

required

string

Value: "observations"

required

object

individual-id

required

string <uuid>

Array of objects

Array

display	string <= 255 characters
	object
reference	string <= 255 characters

object

	Array of objects
text	string <= 255 characters

Array of objects

Array

	Array of objects
text	string <= 255 characters

object

	Array of objects
text	string <= 255 characters

comment

string <= 255 characters

Array of objects

Array

	object
	object
	object
	Array of objects
	object
	object
value-date-time	string <datetime>
	object
	object
	object
	object
	object
value-string	string <= 255 characters
value-time	string <= 255 characters

context

string <= 255 characters

object

	Array of objects
text	string <= 255 characters

object

display	string <= 255 characters
	object
reference	string <= 255 characters

effective-date-time

string <datetime>

object

end	string <datetime> Default: "1975-11-25 00:00:00"
start	string <datetime> Default: "1975-11-25 00:00:00"

Array of objects

Array

assigner	string <= 255 characters
	object
system	string <= 255 characters
type	string Enum: "DL" "PPN" "BRN" "MR" "MCN" "EN" "TAX" "NIIP" "PRN" "MD" "DR"
use	string Enum: "usual" "official" "temp" "secondary"
value	string <= 255 characters

object

	Array of objects
text	string <= 255 characters

issued

string <datetime>

object

	Array of objects
text	string <= 255 characters

Array of objects

Array

display	string <= 255 characters
	object
reference	string <= 255 characters

Array of objects

Array

	object
	Array of objects
	object
	object
text	string <= 255 characters
	object

Array of objects

Array

	object
type	string Enum: "has-member" "derived-from" "sequel-to" "replaces" "qualified-by" "interfered-by"

object

display	string <= 255 characters
	object
reference	string <= 255 characters

status

string

Enum: "amended" "cancelled" "corrected" "entered-in-error" "final" "preliminary" "registered" "unknown"

object

content-type	string <= 255 characters
creation	string <= 255 characters
data	string <= 255 characters
hash	string <= 255 characters
language	string <= 255 characters
size	number
title	string <= 255 characters
url	string <= 255 characters

null or boolean

Any of

null

object

	Array of objects
text	string <= 255 characters

value-date-time

string <datetime>

object

end	string <datetime> Default: "1975-11-25 00:00:00"
start	string <datetime> Default: "1975-11-25 00:00:00"

object

code	string <= 255 characters
comparator	string Enum: "<" "<=" ">=" ">"
system	string <= 255 characters
unit	string <= 255 characters
	null or number

object

	object
	object

object

	object
	object

object

data	string <= 255 characters
dimensions	number
factor	number
lower-limit	number
	object
period	number
upper-limit	number

value-string

string <= 255 characters

value-time

string <datetime>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"based-on": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"body-site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"category": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"comment": "string",
"component": [{"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"data-absent-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"interpretation": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reference-range": [{"age": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"applies-to": [{"coding": [{ }
],
"text": "string"
}
],
"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"text": "string",
"type": {"coding": [{"code": null,
"display": null,
"system": null,
"user-selected": null,
"version": null
}
],
"text": "string"
}
}
],
"value-attachment": {"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
},
"value-codeable-concept": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"value-date-time": "string",
"value-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"value-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"value-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-sampled-data": {"data": "string",
"dimensions": 0,
"factor": 0,
"lower-limit": 0,
"origin": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"period": 0,
"upper-limit": 0
},
"value-string": "string",
"value-time": "string"
}
],
"context": "string",
"data-absent-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"device": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"effective-date-time": "string",
"effective-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"interpretation": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"issued": "string",
"method": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"performer": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"reference-range": [{"age": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"applies-to": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"text": "string",
"type": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"related": [{"target": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"type": "has-member"
}
],
"specimen": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"status": "amended",
"value-attachment": {"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
},
"value-boolean": { },
"value-codeable-concept": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"value-date-time": "string",
"value-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"value-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"value-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-sampled-data": {"data": "string",
"dimensions": 0,
"factor": 0,
"lower-limit": 0,
"origin": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"period": 0,
"upper-limit": 0
},
"value-string": "string",
"value-time": "string"
},
"type": "observations"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"based-on": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"body-site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"category": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"comment": "string",
"component": [{"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"data-absent-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"interpretation": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reference-range": [{"age": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"applies-to": [{"coding": [{ }
],
"text": "string"
}
],
"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"text": "string",
"type": {"coding": [{"code": null,
"display": null,
"system": null,
"user-selected": null,
"version": null
}
],
"text": "string"
}
}
],
"value-attachment": {"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
},
"value-codeable-concept": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"value-date-time": "string",
"value-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"value-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"value-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-sampled-data": {"data": "string",
"dimensions": 0,
"factor": 0,
"lower-limit": 0,
"origin": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"period": 0,
"upper-limit": 0
},
"value-string": "string",
"value-time": "string"
}
],
"context": "string",
"data-absent-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"device": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"effective-date-time": "string",
"effective-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"interpretation": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"issued": "string",
"method": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"performer": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"reference-range": [{"age": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"applies-to": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"text": "string",
"type": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"related": [{"target": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"type": "has-member"
}
],
"specimen": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"status": "amended",
"value-attachment": {"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
},
"value-boolean": { },
"value-codeable-concept": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"value-date-time": "string",
"value-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"value-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"value-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-sampled-data": {"data": "string",
"dimensions": 0,
"factor": 0,
"lower-limit": 0,
"origin": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"period": 0,
"upper-limit": 0
},
"value-string": "string",
"value-time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "observations"
},
"meta": { }
}

/v1/observations/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/observations/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"based-on": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"body-site": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"category": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"comment": "string",
"component": [{"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"data-absent-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"interpretation": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reference-range": [{"age": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"applies-to": [{"coding": [{ }
],
"text": "string"
}
],
"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"text": "string",
"type": {"coding": [{"code": null,
"display": null,
"system": null,
"user-selected": null,
"version": null
}
],
"text": "string"
}
}
],
"value-attachment": {"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
},
"value-codeable-concept": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"value-date-time": "string",
"value-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"value-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"value-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-sampled-data": {"data": "string",
"dimensions": 0,
"factor": 0,
"lower-limit": 0,
"origin": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"period": 0,
"upper-limit": 0
},
"value-string": "string",
"value-time": "string"
}
],
"context": "string",
"data-absent-reason": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"device": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"effective-date-time": "string",
"effective-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"interpretation": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"issued": "string",
"method": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"performer": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"reference-range": [{"age": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"applies-to": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"text": "string",
"type": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
}
],
"related": [{"target": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"type": "has-member"
}
],
"specimen": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"status": "amended",
"value-attachment": {"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
},
"value-boolean": { },
"value-codeable-concept": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"value-date-time": "string",
"value-period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"value-quantity": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"value-range": {"high": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"low": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-ratio": {"denominator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"numerator": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
}
},
"value-sampled-data": {"data": "string",
"dimensions": 0,
"factor": 0,
"lower-limit": 0,
"origin": {"code": "string",
"comparator": "<",
"system": "string",
"unit": "string",
"value": { }
},
"period": 0,
"upper-limit": 0
},
"value-string": "string",
"value-time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "observations"
},
"meta": { }
}

/v1/org-appointment-statuses

/v1/org-appointment-statuses/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[display]	string <= 255 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"is-default": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"voids-appointment": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointment-statuses"
}
],
"meta": { }
}

/v1/org-appointment-statuses/

Request Body schema: application/json

required

object

type

required

string

Value: "org-appointment-statuses"

required

object

display required	string <= 255 characters
organization-id required	string <uuid>
definition	string <= 255 characters
is-default	boolean Default: false
voids-appointment	boolean Default: false

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"definition": "string",
"display": "string",
"is-default": false,
"organization-id": "11111111-1111-1111-1111-111111111111",
"voids-appointment": false
},
"type": "org-appointment-statuses"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"is-default": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"voids-appointment": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointment-statuses"
},
"meta": { }
}

/v1/org-appointment-statuses/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-appointment-statuses/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"is-default": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"voids-appointment": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointment-statuses"
},
"meta": { }
}

/v1/org-appointment-statuses/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-appointment-statuses"

required

object

definition	string <= 255 characters
display	string <= 255 characters
is-default	boolean
voids-appointment	boolean

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"definition": "string",
"display": "string",
"is-default": true,
"voids-appointment": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointment-statuses"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"is-default": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"voids-appointment": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointment-statuses"
},
"meta": { }
}

/v1/org-appointment-types

/v1/org-appointment-types/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[display]	string <= 255 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointment-types"
}
],
"meta": { }
}

/v1/org-appointment-types/

Request Body schema: application/json

required

object

type

required

string

Value: "org-appointment-types"

required

object

display required	string <= 255 characters
organization-id required	string <uuid>
definition	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"definition": "string",
"display": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-appointment-types"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointment-types"
},
"meta": { }
}

/v1/org-appointment-types/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-appointment-types/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointment-types"
},
"meta": { }
}

/v1/org-appointment-types/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-appointment-types"

required

object

definition	string <= 255 characters
display	string <= 255 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"definition": "string",
"display": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointment-types"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointment-types"
},
"meta": { }
}

/v1/org-appointments

/v1/org-appointments/

query Parameters

filter[accessible]	boolean Default: false
filter[cmp-end-time]	Array of strings <= 2 items [ items <= 40 characters ]
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ]
filter[cmp-start-time]	Array of strings <= 2 items [ items <= 40 characters ]
filter[external-id]	string <= 255 characters
filter[individual-id]	string <uuid> Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[practitioner-id]	string <uuid> Example: filter[practitioner-id]=11111111-1111-1111-1111-111111111111
filter[status-id]	string <uuid> Example: filter[status-id]=11111111-1111-1111-1111-111111111111
filter[type-id]	string <uuid> Example: filter[type-id]=11111111-1111-1111-1111-111111111111
filter[visible]	boolean
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Default: "start" Items Enum: "-start" "start"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"appless": true,
"comment": "string",
"completed-scheduler-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"end-time": "string",
"external-id": "string",
"guest-url": "string",
"host-url": "string",
"individual": {"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted"
},
"individuals": [{"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"participant-type": "participant",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted"
}
],
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"location": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"patient-instruction": "string",
"practitioner": {"display-name": "string",
"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"practitioners": [{"display-name": "string",
"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"reminder-scheduler-id": "11111111-1111-1111-1111-111111111111",
"start-time": "string",
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111",
"voids-appointment": true
},
"type": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"video-channel-id": "11111111-1111-1111-1111-111111111111",
"video-channel-join-start": "string",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointments"
}
],
"meta": { }
}

/v1/org-appointments/

Request Body schema: application/json

required

object

type

required

string

Value: "org-appointments"

required

object or object

Any of

end-time required	string <datetime>
individual-id required	string <uuid>
organization-id required	string <uuid>
practitioner-id required	string <uuid>
start-time required	string <datetime>
type-id required	string <uuid>
add-video-channel	boolean Default: false
appless	boolean Default: false
comment	string <= 99999 characters
description	string <= 99999 characters
external-id	string <= 255 characters
guest-url	string <= 255 characters
host-url	string <= 255 characters
location	string <= 99999 characters
patient-instruction	string <= 99999 characters
status-id	string <uuid>
visible	boolean Default: true

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"add-video-channel": false,
"appless": false,
"comment": "string",
"description": "string",
"end-time": "string",
"external-id": "string",
"guest-url": "string",
"host-url": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"location": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"patient-instruction": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"start-time": "string",
"status-id": "11111111-1111-1111-1111-111111111111",
"type-id": "11111111-1111-1111-1111-111111111111",
"visible": true
},
"type": "org-appointments"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"appless": true,
"comment": "string",
"completed-scheduler-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"end-time": "string",
"external-id": "string",
"guest-url": "string",
"host-url": "string",
"individual": {"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted"
},
"individuals": [{"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"participant-type": "participant",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted"
}
],
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"location": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"patient-instruction": "string",
"practitioner": {"display-name": "string",
"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"practitioners": [{"display-name": "string",
"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"reminder-scheduler-id": "11111111-1111-1111-1111-111111111111",
"start-time": "string",
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111",
"voids-appointment": true
},
"type": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"video-channel-id": "11111111-1111-1111-1111-111111111111",
"video-channel-join-start": "string",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointments"
},
"meta": { }
}

/v1/org-appointments/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-appointments/{id}/

path Parameters

required

string

Resource identifier

query Parameters

individual-id

string <uuid>

Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"appless": true,
"comment": "string",
"completed-scheduler-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"end-time": "string",
"external-id": "string",
"guest-url": "string",
"host-url": "string",
"individual": {"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted"
},
"individuals": [{"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"participant-type": "participant",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted"
}
],
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"location": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"patient-instruction": "string",
"practitioner": {"display-name": "string",
"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"practitioners": [{"display-name": "string",
"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"reminder-scheduler-id": "11111111-1111-1111-1111-111111111111",
"start-time": "string",
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111",
"voids-appointment": true
},
"type": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"video-channel-id": "11111111-1111-1111-1111-111111111111",
"video-channel-join-start": "string",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointments"
},
"meta": { }
}

/v1/org-appointments/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-appointments"

required

object

comment

string <= 99999 characters

description

string <= 99999 characters

end-time

string <datetime>

external-id

string <= 255 characters

guest-url

string <= 255 characters

host-url

string <= 255 characters

Array of objects non-empty

Array (non-empty)

id required	string <uuid>
participant-type required	string Enum: "participant" "subject"

location

string <= 99999 characters

patient-instruction

string <= 99999 characters

practitioner-id

string <uuid>

Array of objects non-empty

Array (non-empty)

required

string <uuid>

start-time

string <datetime>

status-id

string <uuid>

type-id

string <uuid>

video-channel

boolean

Whether or not appointment should have an associated video call

visible

boolean

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"comment": "string",
"description": "string",
"end-time": "string",
"external-id": "string",
"guest-url": "string",
"host-url": "string",
"individuals": [{"id": "11111111-1111-1111-1111-111111111111",
"participant-type": "participant"
}
],
"location": "string",
"patient-instruction": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"practitioners": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"start-time": "string",
"status-id": "11111111-1111-1111-1111-111111111111",
"type-id": "11111111-1111-1111-1111-111111111111",
"video-channel": true,
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointments"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"appless": true,
"comment": "string",
"completed-scheduler-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"end-time": "string",
"external-id": "string",
"guest-url": "string",
"host-url": "string",
"individual": {"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted"
},
"individuals": [{"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"participant-type": "participant",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted"
}
],
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"location": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"patient-instruction": "string",
"practitioner": {"display-name": "string",
"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"practitioners": [{"display-name": "string",
"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"reminder-scheduler-id": "11111111-1111-1111-1111-111111111111",
"start-time": "string",
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111",
"voids-appointment": true
},
"type": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"video-channel-id": "11111111-1111-1111-1111-111111111111",
"video-channel-join-start": "string",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointments"
},
"meta": { }
}

/v1/org-appointments/{id}/add-video-channel/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"appless": true,
"comment": "string",
"completed-scheduler-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"end-time": "string",
"external-id": "string",
"guest-url": "string",
"host-url": "string",
"individual": {"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted"
},
"individuals": [{"auto-confirm": true,
"auto-sign-up": true,
"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"participant-type": "participant",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted"
}
],
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"location": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"patient-instruction": "string",
"practitioner": {"display-name": "string",
"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"practitioners": [{"display-name": "string",
"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"reminder-scheduler-id": "11111111-1111-1111-1111-111111111111",
"start-time": "string",
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111",
"voids-appointment": true
},
"type": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"video-channel-id": "11111111-1111-1111-1111-111111111111",
"video-channel-join-start": "string",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-appointments"
},
"meta": { }
}

/v1/org-appointments/{id}/completed-timer/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{ }

/v1/org-appointments/{id}/timer-event/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{ }

/v1/org-care-plan-tags

/v1/org-care-plan-tags/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plan-tags"
}
],
"meta": { }
}

/v1/org-care-plan-tags/

Request Body schema: application/json

required

object

type

required

string

Value: "org-care-plan-tags"

required

object

name required	string <= 127 characters
organization-id required	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-care-plan-tags"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plan-tags"
},
"meta": { }
}

/v1/org-care-plan-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-care-plan-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plan-tags"
},
"meta": { }
}

/v1/org-care-plan-templates

/v1/org-care-plan-templates/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]	string <= 255 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"actions-plan": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"type": "able"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"description": "string",
"goals-plan": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"medication-statements-plan": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string"
}
],
"name": "string",
"plan-description": "string",
"plan-notes": "string",
"plan-observation": {"note": "string",
"note-category": "consultation",
"tags": ["string"
],
"title": "string"
},
"plan-title": "string",
"todo-entries-plan": [{"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plan-templates"
}
],
"meta": { }
}

/v1/org-care-plan-templates/

Request Body schema: application/json

required

object

type

required

string

Value: "org-care-plan-templates"

required

object

name

required

string <= 255 characters

organization-id

required

string <uuid>

Array of objects (JsActionPlanTemplate)

Array

category-ids required	Array of strings <uuid> [ items <uuid > ]
description required	string <= 255 characters
metrics required	Array of strings[ items <= 255 characters ]
num-days-per-week required	integer [ 1 .. 7 ]
reminder-days	Array of integers[ items [ 1 .. 7 ] ]
	Array of objects
reminder-times	Array of strings Items Enum: "afternoon" "early_morning" "evening" "late_night" "morning"
type	string Enum: "able" "achieve" "scale" "value"

description

string <= 255 characters

Array of objects (JsGoalPlan)

Array

description required	string <= 9999 characters
end-date	string <date>
start-date	string <date>

Array of objects (JsMedicationStatementPlanTemplate)

Array

required	object
dose-unit	string <= 255 characters
dose-value	number >= 0 Default: 100000
reason-for-use	string <= 255 characters

plan-description

string <= 9999 characters

plan-notes

string <= 99999 characters

object or object or object

Any of

object

plan-title

string <= 255 characters

Array of objects (JsTodoEntryPlanTemplate)

Array

notes	string <= 9999 characters
provider-notes	string <= 9999 characters
text	string <= 9999 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"actions-plan": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"type": "able"
}
],
"description": "string",
"goals-plan": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"medication-statements-plan": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string"
}
],
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"plan-description": "string",
"plan-notes": "string",
"plan-observation": { },
"plan-title": "string",
"todo-entries-plan": [{"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"type": "org-care-plan-templates"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"actions-plan": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"type": "able"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"description": "string",
"goals-plan": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"medication-statements-plan": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string"
}
],
"name": "string",
"plan-description": "string",
"plan-notes": "string",
"plan-observation": {"note": "string",
"note-category": "consultation",
"tags": ["string"
],
"title": "string"
},
"plan-title": "string",
"todo-entries-plan": [{"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plan-templates"
},
"meta": { }
}

/v1/org-care-plan-templates/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-care-plan-templates/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"actions-plan": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"type": "able"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"description": "string",
"goals-plan": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"medication-statements-plan": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string"
}
],
"name": "string",
"plan-description": "string",
"plan-notes": "string",
"plan-observation": {"note": "string",
"note-category": "consultation",
"tags": ["string"
],
"title": "string"
},
"plan-title": "string",
"todo-entries-plan": [{"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plan-templates"
},
"meta": { }
}

/v1/org-care-plan-templates/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-care-plan-templates"

required

object

Array of objects (JsActionPlanTemplate)

Array

category-ids required	Array of strings <uuid> [ items <uuid > ]
description required	string <= 255 characters
metrics required	Array of strings[ items <= 255 characters ]
num-days-per-week required	integer [ 1 .. 7 ]
reminder-days	Array of integers[ items [ 1 .. 7 ] ]
	Array of objects
reminder-times	Array of strings Items Enum: "afternoon" "early_morning" "evening" "late_night" "morning"
type	string Enum: "able" "achieve" "scale" "value"

description

string <= 255 characters

Array of objects (JsGoalPlan)

Array

description required	string <= 9999 characters
end-date	string <date>
start-date	string <date>

Array of objects (JsMedicationStatementPlanTemplate)

Array

required	object
dose-unit	string <= 255 characters
dose-value	number >= 0 Default: 100000
reason-for-use	string <= 255 characters

name

string <= 255 characters

plan-description

string <= 9999 characters

plan-notes

string <= 99999 characters

object or object or object

Any of

object

plan-title

string <= 255 characters

Array of objects (JsTodoEntryPlanTemplate)

Array

notes	string <= 9999 characters
provider-notes	string <= 9999 characters
text	string <= 9999 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"actions-plan": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"type": "able"
}
],
"description": "string",
"goals-plan": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"medication-statements-plan": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string"
}
],
"name": "string",
"plan-description": "string",
"plan-notes": "string",
"plan-observation": { },
"plan-title": "string",
"todo-entries-plan": [{"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plan-templates"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"actions-plan": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"type": "able"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"description": "string",
"goals-plan": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"medication-statements-plan": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string"
}
],
"name": "string",
"plan-description": "string",
"plan-notes": "string",
"plan-observation": {"note": "string",
"note-category": "consultation",
"tags": ["string"
],
"title": "string"
},
"plan-title": "string",
"todo-entries-plan": [{"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plan-templates"
},
"meta": { }
}

/v1/org-care-plans

/v1/org-care-plans/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
filter[created-by-id]	string <uuid> Example: filter[created-by-id]=11111111-1111-1111-1111-111111111111
filter[status]	string Enum: "active" "completed" "draft" "entered-in-error" "on-hold" "revoked" "unknown"
filter[tags]	Array of strings[ items <= 127 characters ]
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"actions": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"actions-draft": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"goals": [{"description": "string",
"end-date": "2019-08-24",
"id": "11111111-1111-1111-1111-111111111111",
"lifecycle-status": "accepted",
"start-date": "2019-08-24"
}
],
"goals-draft": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statements": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"medication-statements-draft": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"frequency": "DAILY",
"send-reminder": true,
"start-at": "string"
}
]
}
],
"notes": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"status": "active",
"tags": ["string"
],
"title": "string",
"todo-entries": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"todo-entries-draft": [{"due-time": "string",
"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plans"
}
],
"meta": { }
}

/v1/org-care-plans/

Request Body schema: application/json

required

object

type

required

string

Value: "org-care-plans"

required

object

individual-id

required

string <uuid>

organization-id

required

string <uuid>

Array of objects (JsActionPlan)

Array

category-ids required	Array of strings <uuid> [ items <uuid > ]
description required	string <= 255 characters
metrics required	Array of strings[ items <= 255 characters ]
num-days-per-week required	integer [ 1 .. 7 ]
start-date required	string <date>
reminder-days	Array of integers[ items [ 1 .. 7 ] ]
	Array of objects
reminder-times	Array of strings Items Enum: "afternoon" "early_morning" "evening" "late_night" "morning"
stop-date	string <date>
type	string Enum: "able" "achieve" "scale" "value"

auto-activate

boolean

Default: false

description

string <= 9999 characters

Array of objects (JsGoalPlan)

Array

description required	string <= 9999 characters
end-date	string <date>
start-date	string <date>

medication-statement-ids

Array of strings <uuid> [ items <uuid > ]

Array of objects (JsMedicationStatementPlan)

Array

required	object
dose-unit	string <= 255 characters
dose-value	number >= 0 Default: 100000
reason-for-use	string <= 255 characters
	Array of objects

notes

string <= 99999 characters

object

note required	string <= 99999 characters
title required	string <= 255 characters
note-category	string Default: "general" Enum: "consultation" "discharge" "general" "history_and_physical" "imaging" "laboratory" "pathology" "procedures" "progress"
tags	Array of strings[ items <= 127 characters ]

tags

Array of strings[ items <= 127 characters ]

title

string <= 255 characters

Array of objects (JsTodoEntryPlan)

Array

due-time	string <datetime>
notes	string <= 9999 characters
provider-notes	string <= 9999 characters
text	string <= 9999 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"actions-draft": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
}
],
"auto-activate": false,
"description": "string",
"goals-draft": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"medication-statement-ids": ["11111111-1111-1111-1111-111111111111"
],
"medication-statements-draft": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"frequency": "DAILY",
"send-reminder": true,
"start-at": "string"
}
]
}
],
"notes": "string",
"observation": {"note": "string",
"note-category": "consultation",
"tags": ["string"
],
"title": "string"
},
"organization-id": "11111111-1111-1111-1111-111111111111",
"tags": ["string"
],
"title": "string",
"todo-entries-draft": [{"due-time": "string",
"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"type": "org-care-plans"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"actions": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"actions-draft": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"goals": [{"description": "string",
"end-date": "2019-08-24",
"id": "11111111-1111-1111-1111-111111111111",
"lifecycle-status": "accepted",
"start-date": "2019-08-24"
}
],
"goals-draft": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statements": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"medication-statements-draft": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"frequency": "DAILY",
"send-reminder": true,
"start-at": "string"
}
]
}
],
"notes": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"status": "active",
"tags": ["string"
],
"title": "string",
"todo-entries": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"todo-entries-draft": [{"due-time": "string",
"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plans"
},
"meta": { }
}

/v1/org-care-plans/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-care-plans/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"actions": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"actions-draft": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"goals": [{"description": "string",
"end-date": "2019-08-24",
"id": "11111111-1111-1111-1111-111111111111",
"lifecycle-status": "accepted",
"start-date": "2019-08-24"
}
],
"goals-draft": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statements": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"medication-statements-draft": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"frequency": "DAILY",
"send-reminder": true,
"start-at": "string"
}
]
}
],
"notes": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"status": "active",
"tags": ["string"
],
"title": "string",
"todo-entries": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"todo-entries-draft": [{"due-time": "string",
"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plans"
},
"meta": { }
}

/v1/org-care-plans/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-care-plans"

required

object

Array of objects (JsActionPlan)

Array

category-ids required	Array of strings <uuid> [ items <uuid > ]
description required	string <= 255 characters
metrics required	Array of strings[ items <= 255 characters ]
num-days-per-week required	integer [ 1 .. 7 ]
start-date required	string <date>
reminder-days	Array of integers[ items [ 1 .. 7 ] ]
	Array of objects
reminder-times	Array of strings Items Enum: "afternoon" "early_morning" "evening" "late_night" "morning"
stop-date	string <date>
type	string Enum: "able" "achieve" "scale" "value"

description

string <= 9999 characters

Array of objects (JsGoalPlan)

Array

description required	string <= 9999 characters
end-date	string <date>
start-date	string <date>

medication-statement-ids

Array of strings <uuid> [ items <uuid > ]

Array of objects (JsMedicationStatementPlan)

Array

required	object
dose-unit	string <= 255 characters
dose-value	number >= 0 Default: 100000
reason-for-use	string <= 255 characters
	Array of objects

notes

string <= 99999 characters

status

string

Enum: "active" "completed" "entered-in-error" "on-hold" "revoked" "unknown"

tags

Array of strings[ items <= 127 characters ]

title

string <= 255 characters

Array of objects (JsTodoEntryPlan)

Array

due-time	string <datetime>
notes	string <= 9999 characters
provider-notes	string <= 9999 characters
text	string <= 9999 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"actions-draft": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
}
],
"description": "string",
"goals-draft": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"medication-statement-ids": ["11111111-1111-1111-1111-111111111111"
],
"medication-statements-draft": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"frequency": "DAILY",
"send-reminder": true,
"start-at": "string"
}
]
}
],
"notes": "string",
"status": "active",
"tags": ["string"
],
"title": "string",
"todo-entries-draft": [{"due-time": "string",
"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plans"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"actions": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"actions-draft": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"goals": [{"description": "string",
"end-date": "2019-08-24",
"id": "11111111-1111-1111-1111-111111111111",
"lifecycle-status": "accepted",
"start-date": "2019-08-24"
}
],
"goals-draft": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statements": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"medication-statements-draft": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"frequency": "DAILY",
"send-reminder": true,
"start-at": "string"
}
]
}
],
"notes": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"status": "active",
"tags": ["string"
],
"title": "string",
"todo-entries": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"todo-entries-draft": [{"due-time": "string",
"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plans"
},
"meta": { }
}

/v1/org-care-plans/{id}/activate/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"actions": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"actions-draft": [{"category-ids": ["11111111-1111-1111-1111-111111111111"
],
"description": "string",
"metrics": ["string"
],
"num-days-per-week": 1,
"reminder-days": [1
],
"reminder-schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"start-at": "string"
}
],
"reminder-times": ["afternoon"
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"goals": [{"description": "string",
"end-date": "2019-08-24",
"id": "11111111-1111-1111-1111-111111111111",
"lifecycle-status": "accepted",
"start-date": "2019-08-24"
}
],
"goals-draft": [{"description": "string",
"end-date": "2019-08-24",
"start-date": "2019-08-24"
}
],
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statements": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"medication-statements-draft": [{"dose-unit": "string",
"dose-value": 100000,
"medication": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"frequency": "DAILY",
"send-reminder": true,
"start-at": "string"
}
]
}
],
"notes": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"status": "active",
"tags": ["string"
],
"title": "string",
"todo-entries": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"todo-entries-draft": [{"due-time": "string",
"notes": "string",
"provider-notes": "string",
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-plans"
},
"meta": { }
}

/v1/org-care-teams

/v1/org-care-teams/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ]
filter[individual-id]	string <uuid> Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"group-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-teams"
}
],
"meta": { }
}

/v1/org-care-teams/

Request Body schema: application/json

required

object

type

required

string

Value: "org-care-teams"

required

object

group-id required	string <uuid>
name required	string <= 255 characters
organization-id required	string <uuid>
external-id	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"external-id": "string",
"group-id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-care-teams"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"group-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-teams"
},
"meta": { }
}

/v1/org-care-teams/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-care-teams/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"group-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-teams"
},
"meta": { }
}

/v1/org-care-teams/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-care-teams"

required

object

external-id	string <= 255 characters
name	string <= 255 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"external-id": "string",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-teams"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"group-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-teams"
},
"meta": { }
}

/v1/org-care-teams/{id}/assign-individual/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

individual-id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"group-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-teams"
},
"meta": { }
}

/v1/org-care-teams/{id}/unassign-individual/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

individual-id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"group-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-care-teams"
},
"meta": { }
}

/v1/org-charge-items

/v1/org-charge-items/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[cmp-end-time]	Array of strings <= 2 items [ items <= 40 characters ]
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ]
filter[created-by-id]	string <uuid> Example: filter[created-by-id]=11111111-1111-1111-1111-111111111111
filter[external-id]	string <= 255 characters
filter[individual-id]	string <uuid> Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[status]	string Enum: "aborted" "billable" "billed" "entered-in-error" "not-billable" "planned" "unknown"
include-total-duration	boolean Default: false
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Default: "created-at" Items Enum: "-created-at" "-end-time" "-start-time" "created-at" "end-time" "start-time"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"end-time": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"note": "string",
"practitioner": {"display-name": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"quantity": 0,
"reason": "string",
"start-time": "string",
"status": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-charge-items"
}
],
"meta": {"total-duration": 0
}
}

/v1/org-charge-items/

Request Body schema: application/json

required

object

type

required

string

Value: "org-charge-items"

required

object

end-time

required

string <datetime>

individual-id

required

string <uuid>

status

required

string

Enum: "aborted" "billable" "billed" "entered-in-error" "not-billable" "planned" "unknown"

code

string <= 20 characters

external-id

string <= 255 characters

note

string <= 99999 characters

organization-id

string <uuid>

practitioner-id

string <uuid>

quantity

integer >= 1

Default: 1

reason

string <= 20 characters

Array of objects non-empty

Array (non-empty)

class required	string <= 128 characters
id required	string <= 64 characters

start-time

string <datetime>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"code": "string",
"end-time": "string",
"external-id": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"note": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"quantity": 1,
"reason": "string",
"references": [{"class": "string",
"id": "string"
}
],
"start-time": "string",
"status": "aborted"
},
"type": "org-charge-items"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"end-time": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"note": "string",
"practitioner": {"display-name": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"quantity": 0,
"reason": "string",
"start-time": "string",
"status": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-charge-items"
},
"meta": { }
}

/v1/org-charge-items/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-charge-items/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"end-time": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"note": "string",
"practitioner": {"display-name": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"quantity": 0,
"reason": "string",
"start-time": "string",
"status": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-charge-items"
},
"meta": { }
}

/v1/org-charge-items/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-charge-items"

required

object

code	string <= 20 characters
end-time	string <datetime>
external-id	string <= 255 characters
note	string <= 99999 characters
practitioner-id	string <uuid>
quantity	integer >= 1
reason	string <= 20 characters
start-time	string <datetime>
status	string Enum: "aborted" "billable" "billed" "entered-in-error" "not-billable" "planned" "unknown"

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"code": "string",
"end-time": "string",
"external-id": "string",
"note": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"quantity": 1,
"reason": "string",
"start-time": "string",
"status": "aborted"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-charge-items"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"end-time": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"note": "string",
"practitioner": {"display-name": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"quantity": 0,
"reason": "string",
"start-time": "string",
"status": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-charge-items"
},
"meta": { }
}

/v1/org-conditions

/v1/org-conditions/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ]
filter[cmp-recorded-time]	Array of strings <= 2 items [ items <= 40 characters ]
filter[external-id]	string <= 255 characters
filter[individual-id]	string <uuid> Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[practitioner-id]	string <uuid> Example: filter[practitioner-id]=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"abatement-time": "string",
"clinical-status": "string",
"code-codings": [{"code": "string",
"display": "string",
"system": "string"
}
],
"code-text": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"note": "string",
"onset-time": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"recorded-time": "string",
"severity": "string",
"verification-status": "confirmed"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-conditions"
}
],
"meta": { }
}

/v1/org-conditions/

Request Body schema: application/json

required

object

type

required

string

Value: "org-conditions"

required

object

individual-id

required

string <uuid>

organization-id

required

string <uuid>

recorded-time

required

string <datetime>

abatement-time

string <datetime>

clinical-status

string

Default: "active"

Enum: "active" "inactive" "recurrence" "relapse" "remission" "resolved"

Array of objects non-empty

Array (non-empty)

code required	string <= 32 characters
display required	string <= 255 characters
system required	string <= 255 characters

code-text

string <= 255 characters

encounter-id

string <uuid>

external-id

string <= 255 characters

name

string <= 255 characters

note

string <= 99999 characters

onset-time

string <datetime>

practitioner-id

string <uuid>

severity

string

Default: "moderate"

Enum: "mild" "moderate" "severe"

verification-status

string

Default: "confirmed"

Enum: "confirmed" "differential" "entered-error" "provisional" "refuted" "unconfirmed"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"abatement-time": "string",
"clinical-status": "active",
"code-codings": [{"code": "string",
"display": "string",
"system": "string"
}
],
"code-text": "string",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"note": "string",
"onset-time": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"recorded-time": "string",
"severity": "mild",
"verification-status": "confirmed"
},
"type": "org-conditions"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"abatement-time": "string",
"clinical-status": "string",
"code-codings": [{"code": "string",
"display": "string",
"system": "string"
}
],
"code-text": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"note": "string",
"onset-time": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"recorded-time": "string",
"severity": "string",
"verification-status": "confirmed"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-conditions"
},
"meta": { }
}

/v1/org-conditions/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-conditions/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"abatement-time": "string",
"clinical-status": "string",
"code-codings": [{"code": "string",
"display": "string",
"system": "string"
}
],
"code-text": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"note": "string",
"onset-time": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"recorded-time": "string",
"severity": "string",
"verification-status": "confirmed"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-conditions"
},
"meta": { }
}

/v1/org-conditions/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-conditions"

required

object

abatement-time

string <datetime>

clinical-status

string

Default: "active"

Enum: "active" "inactive" "recurrence" "relapse" "remission" "resolved"

Array of objects non-empty

Array (non-empty)

code required	string <= 32 characters
display required	string <= 255 characters
system required	string <= 255 characters

code-text

string <= 255 characters

encounter-id

string <uuid>

external-id

string <= 255 characters

name

string <= 255 characters

note

string <= 99999 characters

onset-time

string <datetime>

practitioner-id

string <uuid>

recorded-time

string <datetime>

severity

string

Enum: "mild" "moderate" "severe"

verification-status

string

Default: "confirmed"

Enum: "confirmed" "differential" "entered-error" "provisional" "refuted" "unconfirmed"

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"abatement-time": "string",
"clinical-status": "active",
"code-codings": [{"code": "string",
"display": "string",
"system": "string"
}
],
"code-text": "string",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"name": "string",
"note": "string",
"onset-time": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"recorded-time": "string",
"severity": "mild",
"verification-status": "confirmed"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-conditions"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"abatement-time": "string",
"clinical-status": "string",
"code-codings": [{"code": "string",
"display": "string",
"system": "string"
}
],
"code-text": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"note": "string",
"onset-time": "string",
"practitioner-id": "11111111-1111-1111-1111-111111111111",
"recorded-time": "string",
"severity": "string",
"verification-status": "confirmed"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-conditions"
},
"meta": { }
}

/v1/org-contacts

/v1/org-contacts/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ]
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"phone-work": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-contacts"
}
],
"meta": { }
}

/v1/org-contacts/

Request Body schema: application/json

required

object

type

required

string

Value: "org-contacts"

required

object

name required	string <= 255 characters
organization-id required	string <uuid>
phone-work required	string <= 16 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"phone-work": "string"
},
"type": "org-contacts"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"phone-work": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-contacts"
},
"meta": { }
}

/v1/org-contacts/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-contacts/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"phone-work": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-contacts"
},
"meta": { }
}

/v1/org-contacts/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-contacts"

required

object

name	string <= 255 characters
phone-work	string <= 16 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"phone-work": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-contacts"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"phone-work": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-contacts"
},
"meta": { }
}

/v1/org-diagnostic-reports

/v1/org-diagnostic-reports/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against last-modified-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.
filter[external-id]	string <= 255 characters
filter[patient-id]	string <uuid> Example: filter[patient-id]=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"code": "string",
"conclusion": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"external-id": "string",
"issued-time": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111",
"status": "amended"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-diagnostic-reports"
}
],
"meta": { }
}

/v1/org-diagnostic-reports/

Request Body schema: application/json

required

object

type

required

string

Value: "org-diagnostic-reports"

required

object

organization-id required	string <uuid>
patient-id required	string <uuid>
code	string <= 32 characters
conclusion	string <= 255 characters
description	string <= 255 characters
external-id	string <= 255 characters
issued-time	string <datetime>
status	string Default: "unknown" Enum: "amended" "cancelled" "entered-in-error" "final" "partial" "registered" "unknown"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"code": "string",
"conclusion": "string",
"description": "string",
"external-id": "string",
"issued-time": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111",
"status": "amended"
},
"type": "org-diagnostic-reports"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"code": "string",
"conclusion": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"external-id": "string",
"issued-time": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111",
"status": "amended"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-diagnostic-reports"
},
"meta": { }
}

/v1/org-diagnostic-reports/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-diagnostic-reports/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"code": "string",
"conclusion": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"external-id": "string",
"issued-time": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111",
"status": "amended"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-diagnostic-reports"
},
"meta": { }
}

/v1/org-diagnostic-reports/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-diagnostic-reports"

required

object

code	string <= 32 characters
conclusion	string <= 255 characters
description	string <= 255 characters
external-id	string <= 255 characters
issued-time	string <datetime>
status	string Enum: "amended" "cancelled" "entered-in-error" "final" "partial" "registered" "unknown"

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"code": "string",
"conclusion": "string",
"description": "string",
"external-id": "string",
"issued-time": "string",
"status": "amended"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-diagnostic-reports"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"code": "string",
"conclusion": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"external-id": "string",
"issued-time": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111",
"status": "amended"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-diagnostic-reports"
},
"meta": { }
}

/v1/org-document-classes

/v1/org-document-classes/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-classes"
}
],
"meta": { }
}

/v1/org-document-classes/

Request Body schema: application/json

required

object

type

required

string

Value: "org-document-classes"

required

object

code required	string <= 32 characters
description required	string <= 255 characters
organization-id	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"code": "string",
"description": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-document-classes"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-classes"
},
"meta": { }
}

/v1/org-document-classes/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-document-classes/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-classes"
},
"meta": { }
}

/v1/org-document-classes/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-document-classes"

required

object

code	string <= 32 characters
description	string <= 255 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"code": "string",
"description": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-classes"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-classes"
},
"meta": { }
}

/v1/org-document-references

/v1/org-document-references/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[class-id]	string <uuid> Example: filter[class-id]=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ]
filter[created-by-id]	string <uuid> Example: filter[created-by-id]=11111111-1111-1111-1111-111111111111
filter[external-id]	string <= 255 characters
filter[individual-id]	string <uuid> Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[name]	string <= 255 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Default: "created-at" Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"attachment-content-type": "string",
"attachment-filename": "string",
"attachment-ready-to-use": true,
"class": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-references"
}
],
"meta": { }
}

/v1/org-document-references/

Request Body schema: application/json

required

object

type

required

string

Value: "org-document-references"

required

object

attachment-content-type required	string <= 255 characters
attachment-filename required	string <= 255 characters
class-id required	string <uuid>
individual-id required	string <uuid>
organization-id required	string <uuid>
description	string <= 9999 characters
external-id	string <= 255 characters
name	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"attachment-content-type": "string",
"attachment-filename": "string",
"class-id": "11111111-1111-1111-1111-111111111111",
"description": "string",
"external-id": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-document-references"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"attachment-content-type": "string",
"attachment-filename": "string",
"attachment-ready-to-use": true,
"class": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-references"
},
"meta": { }
}

/v1/org-document-references/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-document-references/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"attachment-content-type": "string",
"attachment-filename": "string",
"attachment-ready-to-use": true,
"class": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-references"
},
"meta": { }
}

/v1/org-document-references/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-document-references"

required

object

class-id	string <uuid>
description	string <= 9999 characters
external-id	string <= 255 characters
name	string <= 255 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"class-id": "11111111-1111-1111-1111-111111111111",
"description": "string",
"external-id": "string",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-references"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"attachment-content-type": "string",
"attachment-filename": "string",
"attachment-ready-to-use": true,
"class": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-references"
},
"meta": { }
}

/v1/org-document-references/{id}/get-download-info/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"url": "string"
}

/v1/org-document-references/{id}/get-upload-info/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"attachment-content-type": "string",
"attachment-filename": "string",
"attachment-ready-to-use": true,
"class": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-references"
},
"meta": { }
}

/v1/org-document-references/{id}/process-upload/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"attachment-content-type": "string",
"attachment-filename": "string",
"attachment-ready-to-use": true,
"class": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-document-references"
},
"meta": { }
}

/v1/org-encounter-reasons

/v1/org-encounter-reasons/

query Parameters

filter[encounter-id]	string <uuid> Example: filter[encounter-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]	string <uuid> Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"type": "coding",
"value": {"text": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounter-reasons"
}
],
"meta": { }
}

/v1/org-encounter-reasons/

Request Body schema: application/json

required

object

type

required

string

Value: "org-encounter-reasons"

required

object

encounter-id

required

string <uuid>

type

required

string

Enum: "coding" "text" "value"

required

object or object or object

Any of

text

required

string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"encounter-id": "11111111-1111-1111-1111-111111111111",
"type": "coding",
"value": {"text": "string"
}
},
"type": "org-encounter-reasons"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"type": "coding",
"value": {"text": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounter-reasons"
},
"meta": { }
}

/v1/org-encounter-reasons/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-encounter-reasons/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"type": "coding",
"value": {"text": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounter-reasons"
},
"meta": { }
}

/v1/org-encounter-types

/v1/org-encounter-types/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounter-types"
}
],
"meta": { }
}

/v1/org-encounter-types/

Request Body schema: application/json

required

object

type

required

string

Value: "org-encounter-types"

required

object

display required	string <= 255 characters
definition	string <= 255 characters
organization-id	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"definition": "string",
"display": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-encounter-types"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounter-types"
},
"meta": { }
}

/v1/org-encounter-types/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-encounter-types/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounter-types"
},
"meta": { }
}

/v1/org-encounter-types/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-encounter-types"

required

object

definition	string <= 255 characters
display	string <= 255 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"definition": "string",
"display": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounter-types"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounter-types"
},
"meta": { }
}

/v1/org-encounters

/v1/org-encounters/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ]
filter[cmp-start-time]	Array of strings <= 2 items [ items <= 40 characters ]
filter[created-by-id]	string <uuid> Example: filter[created-by-id]=11111111-1111-1111-1111-111111111111
filter[external-id]	string <= 255 characters
filter[individual-id]	string <uuid> Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[status]	string Enum: "arrived" "cancelled" "entered-in-error" "finished" "in-progress" "onleave" "planned" "triaged" "unknown"
include-individual-info	boolean Default: false
include-total-duration	boolean Default: false
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Default: "created-at" Items Enum: "-created-at" "-end-time" "-start-time" "created-at" "end-time" "start-time"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"duration": 0,
"end-time": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"notes": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reasons": [{"type": "coding",
"value": {"text": "string"
}
}
],
"service-type": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"start-time": "string",
"status": "arrived",
"video-channel-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounters"
}
],
"meta": {"total-duration": 0
}
}

/v1/org-encounters/

Request Body schema: application/json

required

object

type

required

string

Value: "org-encounters"

required

object

individual-id

required

string <uuid>

start-time

required

string <datetime>

status

required

string

Default: "finished"

Enum: "arrived" "cancelled" "entered-in-error" "finished" "in-progress" "onleave" "planned" "triaged" "unknown"

end-time

string <datetime>

external-id

string <= 255 characters

notes

string <= 99999 characters

organization-id

string <uuid>

Array of objects non-empty

Array (non-empty)

type	string Enum: "coding" "text" "value"
	object or object or object

service-type-id

string <uuid>

video-channel-id

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"end-time": "string",
"external-id": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"notes": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"reasons": [{"type": "coding",
"value": {"text": "string"
}
}
],
"service-type-id": "11111111-1111-1111-1111-111111111111",
"start-time": "string",
"status": "arrived",
"video-channel-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-encounters"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"duration": 0,
"end-time": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"notes": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reasons": [{"type": "coding",
"value": {"text": "string"
}
}
],
"service-type": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"start-time": "string",
"status": "arrived",
"video-channel-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounters"
},
"meta": { }
}

/v1/org-encounters/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-encounters/{id}/

path Parameters

required

string

Resource identifier

query Parameters

include-individual-info

boolean

Default: false

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"duration": 0,
"end-time": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"notes": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reasons": [{"type": "coding",
"value": {"text": "string"
}
}
],
"service-type": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"start-time": "string",
"status": "arrived",
"video-channel-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounters"
},
"meta": { }
}

/v1/org-encounters/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-encounters"

required

object

end-time	string <datetime>
external-id	string <= 255 characters
notes	string <= 99999 characters
service-type-id	string <uuid>
start-time	string <datetime>
status	string Default: "finished" Enum: "arrived" "cancelled" "entered-in-error" "finished" "in-progress" "onleave" "planned" "triaged" "unknown"

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"end-time": "string",
"external-id": "string",
"notes": "string",
"service-type-id": "11111111-1111-1111-1111-111111111111",
"start-time": "string",
"status": "arrived"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounters"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"duration": 0,
"end-time": "string",
"external-id": "string",
"individual": {"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"notes": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reasons": [{"type": "coding",
"value": {"text": "string"
}
}
],
"service-type": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"start-time": "string",
"status": "arrived",
"video-channel-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-encounters"
},
"meta": { }
}

/v1/org-histories

/v1/org-histories/

query Parameters

object-class required	string Enum: "Appointment" "AppointmentPatient" "AppointmentPractitioner" "AppointmentStatus" "AppointmentType" "CalendlyAccount" "CalendlyEvent" "CalendlyScheduledEvent" "CalendlySubscription" "CalendlyUser" "CarePlan" "CarePlanMedicationStatement" "CarePlanTag" "CarePlanTags" "CarePlanTemplate" "CareTeam" "CareTeamSubject" "ChargeItem" "Condition" "ConditionCodeCoding" "ContactDetail" "DiagnosticReport" "DocumentClass" "DocumentReference" "Encounter" "EncounterReason" "EncounterServiceType" "Goal" "History" "Identifier" "MetricObservation" "Observation" "ObservationTag" "ObservationTags" "ObservationTemplate" "ObservationTemplateTags" "Patient" "Practitioner" "PractitionerSubject" "ResourceReference"
object-id required	string <uuid> Example: object-id=11111111-1111-1111-1111-111111111111
filter[cmp-created-at]	Array of strings <= 2 items [ items <= 40 characters ]
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"changes": [{"field": "string",
"new": "string",
"old": "string"
}
],
"child-history": {"changes": [{"field": "string",
"new": "string",
"old": "string"
}
],
"id": "11111111-1111-1111-1111-111111111111",
"object-class": "string",
"object-id": "11111111-1111-1111-1111-111111111111",
"operation": "create"
},
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"creator": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"object-class": "string",
"object-id": "11111111-1111-1111-1111-111111111111",
"operation": "create"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-histories"
}
],
"meta": { }
}

/v1/org-identifiers

/v1/org-identifiers/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[created-by-id]	string <uuid> Example: filter[created-by-id]=11111111-1111-1111-1111-111111111111
filter[owner-id]	string <uuid> Example: filter[owner-id]=11111111-1111-1111-1111-111111111111
filter[owner-type]	string Value: "patient"
filter[system]	string <= 255 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"external-url": "string",
"last-modified-at": "string",
"last-modified-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"organization-id": "11111111-1111-1111-1111-111111111111",
"owner-id": "11111111-1111-1111-1111-111111111111",
"owner-type": "patient",
"system": "string",
"system-name": "string",
"value": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-identifiers"
}
],
"meta": { }
}

/v1/org-identifiers/

Request Body schema: application/json

required

object

type

required

string

Value: "org-identifiers"

required

object

organization-id required	string <uuid>
owner-id required	string <uuid>
owner-type required	string Value: "patient"
system required	string <= 255 characters
value required	string <= 255 characters
external-url	string <= 255 characters
system-name	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"external-url": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"owner-id": "11111111-1111-1111-1111-111111111111",
"owner-type": "patient",
"system": "string",
"system-name": "string",
"value": "string"
},
"type": "org-identifiers"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"external-url": "string",
"last-modified-at": "string",
"last-modified-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"organization-id": "11111111-1111-1111-1111-111111111111",
"owner-id": "11111111-1111-1111-1111-111111111111",
"owner-type": "patient",
"system": "string",
"system-name": "string",
"value": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-identifiers"
},
"meta": { }
}

/v1/org-identifiers/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-identifiers/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"external-url": "string",
"last-modified-at": "string",
"last-modified-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"organization-id": "11111111-1111-1111-1111-111111111111",
"owner-id": "11111111-1111-1111-1111-111111111111",
"owner-type": "patient",
"system": "string",
"system-name": "string",
"value": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-identifiers"
},
"meta": { }
}

/v1/org-identifiers/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-identifiers"

required

object

external-url	string <= 255 characters
value	string <= 255 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"external-url": "string",
"value": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-identifiers"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"external-url": "string",
"last-modified-at": "string",
"last-modified-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"organization-id": "11111111-1111-1111-1111-111111111111",
"owner-id": "11111111-1111-1111-1111-111111111111",
"owner-type": "patient",
"system": "string",
"system-name": "string",
"value": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-identifiers"
},
"meta": { }
}

/v1/org-metric-observation-counts

/v1/org-metric-observation-counts/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
patient-id required	string <uuid> Example: patient-id=11111111-1111-1111-1111-111111111111
filter[metric][cmp-begin-time]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against begin-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.
filter[metric][cmp-time]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.
filter[metric][series-type]	string <= 255 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"metric": {"organization-id": "11111111-1111-1111-1111-111111111111",
"series-type": "string",
"source": "string",
"time": "string"
},
"observation-count": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-metric-observation-counts"
}
],
"meta": { }
}

/v1/org-observation-tags

/v1/org-observation-tags/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observation-tags"
}
],
"meta": { }
}

/v1/org-observation-tags/

Request Body schema: application/json

required

object

type

required

string

Value: "org-observation-tags"

required

object

name required	string <= 127 characters
organization-id required	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-observation-tags"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observation-tags"
},
"meta": { }
}

/v1/org-observation-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-observation-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observation-tags"
},
"meta": { }
}

/v1/org-observation-templates

/v1/org-observation-templates/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]	string <= 255 characters
filter[observation-tags]	Array of strings[ items <= 127 characters ]
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"name": "string",
"observation-note": "string",
"observation-note-category": "consultation",
"observation-tags": ["string"
],
"observation-title": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observation-templates"
}
],
"meta": { }
}

/v1/org-observation-templates/

Request Body schema: application/json

required

object

type

required

string

Value: "org-observation-templates"

required

object

name required	string <= 255 characters
organization-id required	string <uuid>
observation-note	string <= 99999 characters
observation-note-category	string Default: "general" Enum: "consultation" "discharge" "general" "history_and_physical" "imaging" "laboratory" "pathology" "procedures" "progress"
observation-tags	Array of strings[ items <= 127 characters ]
observation-title	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"observation-note": "string",
"observation-note-category": "consultation",
"observation-tags": ["string"
],
"observation-title": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-observation-templates"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"name": "string",
"observation-note": "string",
"observation-note-category": "consultation",
"observation-tags": ["string"
],
"observation-title": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observation-templates"
},
"meta": { }
}

/v1/org-observation-templates/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-observation-templates/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"name": "string",
"observation-note": "string",
"observation-note-category": "consultation",
"observation-tags": ["string"
],
"observation-title": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observation-templates"
},
"meta": { }
}

/v1/org-observation-templates/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-observation-templates"

required

object

name	string <= 255 characters
observation-note	string <= 99999 characters
observation-note-category	string Enum: "consultation" "discharge" "general" "history_and_physical" "imaging" "laboratory" "pathology" "procedures" "progress"
observation-tags	Array of strings[ items <= 127 characters ]
observation-title	string <= 255 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"observation-note": "string",
"observation-note-category": "consultation",
"observation-tags": ["string"
],
"observation-title": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observation-templates"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-user": {"email": "string",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"name": "string",
"observation-note": "string",
"observation-note-category": "consultation",
"observation-tags": ["string"
],
"observation-title": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observation-templates"
},
"meta": { }
}

/v1/org-observations

/v1/org-observations/

query Parameters

filter[action-id]	string <uuid> Example: filter[action-id]=11111111-1111-1111-1111-111111111111
filter[appointment-id]	string <uuid> Example: filter[appointment-id]=11111111-1111-1111-1111-111111111111
filter[care-plan-id]	string <uuid> Example: filter[care-plan-id]=11111111-1111-1111-1111-111111111111
filter[cmp-created-at]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against created-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ] Compare timestamp against last-modified-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.
filter[external-id]	string <= 255 characters
filter[is-diagnostic-result]	boolean Default: false
filter[medication-statement-id]	string <uuid> Example: filter[medication-statement-id]=11111111-1111-1111-1111-111111111111
filter[messaging-channel-id]	string <uuid> Example: filter[messaging-channel-id]=11111111-1111-1111-1111-111111111111
filter[metric][begin-time]	string <datetime>
filter[metric][organization-id]	string <uuid> Example: filter[metric][organization-id]=11111111-1111-1111-1111-111111111111
filter[metric][series-type]	string <= 255 characters
filter[metric][source]	string <= 255 characters
filter[metric][time]	string <datetime>
filter[note-category]	string Enum: "consultation" "discharge" "general" "history_and_physical" "imaging" "laboratory" "pathology" "procedures" "progress"
filter[note]	string <= 9999 characters
filter[patient-id]	string <uuid> Example: filter[patient-id]=11111111-1111-1111-1111-111111111111
filter[tags]	Array of strings[ items <= 127 characters ]
filter[todo-entry-id]	string <uuid> Example: filter[todo-entry-id]=11111111-1111-1111-1111-111111111111
filter[video-channel-id]	string <uuid> Example: filter[video-channel-id]=11111111-1111-1111-1111-111111111111
filter[visible]	boolean
filter[with-linked]	Array of strings Items Enum: "action" "appointment" "care-plan" "medication-statement" "messaging-channel" "metric" "todo-entry" "video-channel"
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"action-id": "11111111-1111-1111-1111-111111111111",
"appointment-id": "11111111-1111-1111-1111-111111111111",
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"care-plan-title": "string",
"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"effective-time": "string",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"interpretation": "a",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"messaging-channel-id": "11111111-1111-1111-1111-111111111111",
"metric": {"organization-id": "11111111-1111-1111-1111-111111111111",
"series-type": "string",
"source": "string",
"time": "string"
},
"note": "string",
"note-category": "consultation",
"organization-id": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111",
"record-type": "clinical_note",
"reference-range": {"high": "string",
"low": "string"
},
"status": "amended",
"tags": ["string"
],
"title": "string",
"todo-entry-id": "11111111-1111-1111-1111-111111111111",
"value": {"unit": "string",
"value": "string"
},
"video-channel-id": "11111111-1111-1111-1111-111111111111",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observations"
}
],
"meta": { }
}

/v1/org-observations/

Request Body schema: application/json

required

object

type

required

string

Value: "org-observations"

required

object

organization-id

required

string <uuid>

patient-id

required

string <uuid>

action-id

string <uuid>

appointment-id

string <uuid>

care-plan-id

string <uuid>

code

string <= 32 characters

description

string <= 255 characters

diagnostic-report-id

string <uuid>

effective-time

string <datetime>

encounter-id

string <uuid>

external-id

string <= 255 characters

individual-group-id

string <uuid>

interpretation

string

Default: "n"

Enum: "a" "exp" "h" "ind" "l" "n" "neg" "pos" "s" "une"

medication-statement-id

string <uuid>

messaging-channel-id

string <uuid>

object or object

One of

series-type required	string <= 255 characters
time required	string <datetime>
organization-id	string <uuid>
source	string <= 255 characters

note

string <= 99999 characters

note-category

string

Default: "general"

Enum: "consultation" "discharge" "general" "history_and_physical" "imaging" "laboratory" "pathology" "procedures" "progress"

record-type

string

Default: "observation"

Enum: "clinical_note" "observation"

object

high	string <= 255 characters
low	string <= 255 characters

status

string

Default: "unknown"

Enum: "amended" "cancelled" "entered-in-error" "final" "preliminary" "registered" "unknown"

tags

Array of strings[ items <= 127 characters ]

title

string <= 255 characters

todo-entry-id

string <uuid>

object

unit	string <= 255 characters
value	string <= 255 characters

video-channel-id

string <uuid>

visible

boolean

Default: true

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"action-id": "11111111-1111-1111-1111-111111111111",
"appointment-id": "11111111-1111-1111-1111-111111111111",
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"code": "string",
"description": "string",
"diagnostic-report-id": "11111111-1111-1111-1111-111111111111",
"effective-time": "string",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"interpretation": "a",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"messaging-channel-id": "11111111-1111-1111-1111-111111111111",
"metric": {"organization-id": "11111111-1111-1111-1111-111111111111",
"series-type": "string",
"source": "string",
"time": "string"
},
"note": "string",
"note-category": "consultation",
"organization-id": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111",
"record-type": "clinical_note",
"reference-range": {"high": "string",
"low": "string"
},
"status": "amended",
"tags": ["string"
],
"title": "string",
"todo-entry-id": "11111111-1111-1111-1111-111111111111",
"value": {"unit": "string",
"value": "string"
},
"video-channel-id": "11111111-1111-1111-1111-111111111111",
"visible": true
},
"type": "org-observations"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"action-id": "11111111-1111-1111-1111-111111111111",
"appointment-id": "11111111-1111-1111-1111-111111111111",
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"care-plan-title": "string",
"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"effective-time": "string",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"interpretation": "a",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"messaging-channel-id": "11111111-1111-1111-1111-111111111111",
"metric": {"organization-id": "11111111-1111-1111-1111-111111111111",
"series-type": "string",
"source": "string",
"time": "string"
},
"note": "string",
"note-category": "consultation",
"organization-id": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111",
"record-type": "clinical_note",
"reference-range": {"high": "string",
"low": "string"
},
"status": "amended",
"tags": ["string"
],
"title": "string",
"todo-entry-id": "11111111-1111-1111-1111-111111111111",
"value": {"unit": "string",
"value": "string"
},
"video-channel-id": "11111111-1111-1111-1111-111111111111",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observations"
},
"meta": { }
}

/v1/org-observations/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-observations/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"action-id": "11111111-1111-1111-1111-111111111111",
"appointment-id": "11111111-1111-1111-1111-111111111111",
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"care-plan-title": "string",
"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"effective-time": "string",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"interpretation": "a",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"messaging-channel-id": "11111111-1111-1111-1111-111111111111",
"metric": {"organization-id": "11111111-1111-1111-1111-111111111111",
"series-type": "string",
"source": "string",
"time": "string"
},
"note": "string",
"note-category": "consultation",
"organization-id": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111",
"record-type": "clinical_note",
"reference-range": {"high": "string",
"low": "string"
},
"status": "amended",
"tags": ["string"
],
"title": "string",
"todo-entry-id": "11111111-1111-1111-1111-111111111111",
"value": {"unit": "string",
"value": "string"
},
"video-channel-id": "11111111-1111-1111-1111-111111111111",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observations"
},
"meta": { }
}

/v1/org-observations/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-observations"

required

object

code

string <= 32 characters

description

string <= 255 characters

effective-time

string <datetime>

null or string

Any of

null

external-id

string <= 255 characters

interpretation

string

Enum: "a" "exp" "h" "ind" "l" "n" "neg" "pos" "s" "une"

note

string <= 99999 characters

note-category

string

Enum: "consultation" "discharge" "general" "history_and_physical" "imaging" "laboratory" "pathology" "procedures" "progress"

record-type

string

Enum: "clinical_note" "observation"

object

high	string <= 255 characters
low	string <= 255 characters

status

string

Default: "unknown"

Enum: "amended" "cancelled" "entered-in-error" "final" "preliminary" "registered" "unknown"

tags

Array of strings[ items <= 127 characters ]

title

string <= 255 characters

object

unit	string <= 255 characters
value	string <= 255 characters

visible

boolean

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"code": "string",
"description": "string",
"effective-time": "string",
"encounter-id": { },
"external-id": "string",
"interpretation": "a",
"note": "string",
"note-category": "consultation",
"record-type": "clinical_note",
"reference-range": {"high": "string",
"low": "string"
},
"status": "amended",
"tags": ["string"
],
"title": "string",
"value": {"unit": "string",
"value": "string"
},
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observations"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"action-id": "11111111-1111-1111-1111-111111111111",
"appointment-id": "11111111-1111-1111-1111-111111111111",
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"care-plan-title": "string",
"code": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"description": "string",
"effective-time": "string",
"encounter-id": "11111111-1111-1111-1111-111111111111",
"external-id": "string",
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"interpretation": "a",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medication-statement-id": "11111111-1111-1111-1111-111111111111",
"messaging-channel-id": "11111111-1111-1111-1111-111111111111",
"metric": {"organization-id": "11111111-1111-1111-1111-111111111111",
"series-type": "string",
"source": "string",
"time": "string"
},
"note": "string",
"note-category": "consultation",
"organization-id": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111",
"record-type": "clinical_note",
"reference-range": {"high": "string",
"low": "string"
},
"status": "amended",
"tags": ["string"
],
"title": "string",
"todo-entry-id": "11111111-1111-1111-1111-111111111111",
"value": {"unit": "string",
"value": "string"
},
"video-channel-id": "11111111-1111-1111-1111-111111111111",
"visible": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-observations"
},
"meta": { }
}

/v1/org-patients

/v1/org-patients/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ]
filter[external-id]	string <= 255 characters
filter[medical-record-number]	string <= 255 characters
filter[patient-id]	string <uuid> Example: filter[patient-id]=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"external-data": { },
"external-id": "string",
"external-source": "string",
"external-url": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medical-record-number": "string",
"note": "string",
"patient-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-patients"
}
],
"meta": { }
}

/v1/org-patients/

Request Body schema: application/json

required

object

type

required

string

Value: "org-patients"

required

object

organization-id required	string <uuid>
patient-id required	string <uuid>
external-data	object
external-id	string <= 255 characters
external-source	string <= 255 characters
external-url	string <= 255 characters
medical-record-number	string <= 255 characters
note	string <= 99999 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"external-data": { },
"external-id": "string",
"external-source": "string",
"external-url": "string",
"medical-record-number": "string",
"note": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"patient-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-patients"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"external-data": { },
"external-id": "string",
"external-source": "string",
"external-url": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medical-record-number": "string",
"note": "string",
"patient-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-patients"
},
"meta": { }
}

/v1/org-patients/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-patients/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"external-data": { },
"external-id": "string",
"external-source": "string",
"external-url": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medical-record-number": "string",
"note": "string",
"patient-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-patients"
},
"meta": { }
}

/v1/org-patients/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-patients"

required

object

external-data	object
external-id	string <= 255 characters
external-source	string <= 255 characters
external-url	string <= 255 characters
medical-record-number	string <= 255 characters
note	string <= 99999 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"external-data": { },
"external-id": "string",
"external-source": "string",
"external-url": "string",
"medical-record-number": "string",
"note": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-patients"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"external-data": { },
"external-id": "string",
"external-source": "string",
"external-url": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"medical-record-number": "string",
"note": "string",
"patient-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-patients"
},
"meta": { }
}

/v1/org-practitioners

/v1/org-practitioners/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ]
filter[enabled]	boolean
filter[external-id]	string <= 255 characters
filter[first-name]	string <= 255 characters
filter[last-name]	string <= 255 characters
filter[name]	string <= 255 characters
filter[user-ids]	Array of strings <uuid> [ items <uuid > ] Example: filter[user-ids]=11111111-1111-1111-1111-111111111111
filter[write-access-to-individual-id]	Array of strings <uuid> [ 1 .. 50 ] items [ items <uuid > ] Example: filter[write-access-to-individual-id]=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"appointment-guest-url": "string",
"appointment-host-url": "string",
"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"enabled": true,
"external-id": "string",
"first-name": "string",
"gender": "female",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"qualification-code": "string",
"user": {"email": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-practitioners"
}
],
"meta": { }
}

/v1/org-practitioners/

Request Body schema: application/json

required

object

type

required

string

Value: "org-practitioners"

required

object

first-name required	string <= 255 characters
last-name required	string <= 255 characters
organization-id required	string <uuid>
appointment-guest-url	string <= 255 characters
appointment-host-url	string <= 255 characters
display-name	string <= 255 characters
external-id	string <= 255 characters
gender	string Default: "unknown" Enum: "female" "male" "other" "pnta" "unknown"
qualification-code	string <= 16 characters
user-id	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"appointment-guest-url": "string",
"appointment-host-url": "string",
"display-name": "string",
"external-id": "string",
"first-name": "string",
"gender": "female",
"last-name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"qualification-code": "string",
"user-id": "11111111-1111-1111-1111-111111111111"
},
"type": "org-practitioners"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"appointment-guest-url": "string",
"appointment-host-url": "string",
"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"enabled": true,
"external-id": "string",
"first-name": "string",
"gender": "female",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"qualification-code": "string",
"user": {"email": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-practitioners"
},
"meta": { }
}

/v1/org-practitioners/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-practitioners/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"appointment-guest-url": "string",
"appointment-host-url": "string",
"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"enabled": true,
"external-id": "string",
"first-name": "string",
"gender": "female",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"qualification-code": "string",
"user": {"email": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-practitioners"
},
"meta": { }
}

/v1/org-practitioners/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "org-practitioners"

required

object

appointment-guest-url	string <= 255 characters
appointment-host-url	string <= 255 characters
display-name	string <= 255 characters
external-id	string <= 255 characters
first-name	string <= 255 characters
gender	string Default: "pnta" Enum: "female" "male" "other" "pnta" "unknown"
last-name	string <= 255 characters
qualification-code	string <= 16 characters
user-id	string <uuid>

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"appointment-guest-url": "string",
"appointment-host-url": "string",
"display-name": "string",
"external-id": "string",
"first-name": "string",
"gender": "female",
"last-name": "string",
"qualification-code": "string",
"user-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-practitioners"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"appointment-guest-url": "string",
"appointment-host-url": "string",
"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"enabled": true,
"external-id": "string",
"first-name": "string",
"gender": "female",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"qualification-code": "string",
"user": {"email": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-practitioners"
},
"meta": { }
}

/v1/org-practitioners/{id}/assign-individual/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

individual-id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"appointment-guest-url": "string",
"appointment-host-url": "string",
"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"enabled": true,
"external-id": "string",
"first-name": "string",
"gender": "female",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"qualification-code": "string",
"user": {"email": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-practitioners"
},
"meta": { }
}

/v1/org-practitioners/{id}/unassign-individual/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

individual-id

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"appointment-guest-url": "string",
"appointment-host-url": "string",
"assigned-individuals": [{"birth-date": "2019-08-24",
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"enabled": true,
"external-id": "string",
"first-name": "string",
"gender": "female",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"qualification-code": "string",
"user": {"email": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-practitioners"
},
"meta": { }
}

/v1/org-resource-references

/v1/org-resource-references/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]	string <= 255 characters
filter[source-class]	string <= 128 characters
filter[source-id]	string <= 64 characters
filter[target-class]	string <= 128 characters
filter[target-id]	string <= 64 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Default: "created-at" Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"source-class": "string",
"source-id": "string",
"target-class": "string",
"target-id": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-resource-references"
}
],
"meta": { }
}

/v1/org-resource-references/

Request Body schema: application/json

required

object

type

required

string

Value: "org-resource-references"

required

object

organization-id required	string <uuid>
source-class required	string <= 128 characters
source-id required	string <= 64 characters
target-class required	string <= 128 characters
target-id required	string <= 64 characters
display	string <= 255 characters
name	string <= 255 characters Default: "related"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"display": "string",
"name": "related",
"organization-id": "11111111-1111-1111-1111-111111111111",
"source-class": "string",
"source-id": "string",
"target-class": "string",
"target-id": "string"
},
"type": "org-resource-references"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"source-class": "string",
"source-id": "string",
"target-class": "string",
"target-id": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-resource-references"
},
"meta": { }
}

/v1/org-resource-references/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/org-resource-references/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"display": "string",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"source-class": "string",
"source-id": "string",
"target-class": "string",
"target-id": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-resource-references"
},
"meta": { }
}

/v1/org-todo-entries-search

/v1/org-todo-entries-search/

Request Body schema: application/json

organization-id required	string <uuid>
filter[assigned-individual-id]	string <uuid>
filter[es-match-text]	string <= 255 characters
filter[es-query-string]	string <= 255 characters
filter[individual-group-id]	string <uuid>
filter[reference-in-individual-group-id]	string <uuid>
filter[reference-individual-id]	string <uuid>
include[done]	boolean Default: false
individual-id	string <uuid> individual directly assigned or in assigned group
page[limit]	integer [ 1 .. 100 ] Default: 50
sort	Array of strings Items Enum: "-assigned-at" "-completed-at" "-created-at" "-due-time" "assigned-at" "completed-at" "created-at" "due-time"

Responses

Request samples

Payload

Content type

application/json

{"filter[assigned-individual-id]": "11111111-1111-1111-1111-111111111111",
"filter[es-match-text]": "string",
"filter[es-query-string]": "string",
"filter[individual-group-id]": "11111111-1111-1111-1111-111111111111",
"filter[reference-in-individual-group-id]": "11111111-1111-1111-1111-111111111111",
"filter[reference-individual-id]": "11111111-1111-1111-1111-111111111111",
"include[done]": false,
"individual-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"page[limit]": 50,
"sort": ["-assigned-at"
]
}

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"assigned-at": "string",
"completed-at": "string",
"completed-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"context-url": "string",
"created-at": "string",
"created-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"done": true,
"due-time": "string",
"external-id": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-group": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"last-modified-at": "string",
"last-modified-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"notes": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"provider-notes": "string",
"references": [{"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"data": { },
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted",
"type": "individual"
}
],
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"tags": ["string"
],
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "org-todo-entries-search"
}
],
"meta": { }
}

/v1/organization-data

/v1/organization-data/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
type required	string Value: "user"
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"data-attributes": { },
"last-updated-at": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-data-user"
}
],
"meta": { }
}

/v1/organization-data/

Request Body schema: application/json

data required	Array of objects
organization-id required	string <uuid>
type required	string Value: "user"

Responses

Request samples

Payload

Content type

application/json

{"data": [{ }
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"type": "user"
}

Response samples

Content type

application/vnd.api+json

null

/v1/organization-data/{id}/

path Parameters

required

string

Resource identifier

query Parameters

type

required

string

Value: "user"

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"data-attributes": { },
"last-updated-at": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-data-user"
},
"meta": { }
}

/v1/organization-preferences

/v1/organization-preferences/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]	string <= 64 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"last-modified-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"value": { }
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-preferences"
}
],
"meta": { }
}

/v1/organization-preferences/

Request Body schema: application/json

required

object

type

required

string

Value: "organization-preferences"

required

object

name required	string <= 64 characters
organization-id required	string <uuid>
value required	object

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"value": { }
},
"type": "organization-preferences"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"last-modified-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"value": { }
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-preferences"
},
"meta": { }
}

/v1/organization-preferences/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/organization-preferences/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"last-modified-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"value": { }
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-preferences"
},
"meta": { }
}

/v1/organization-preferences/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "organization-preferences"

required

object

value

object

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"value": { }
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-preferences"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"last-modified-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"value": { }
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-preferences"
},
"meta": { }
}

/v1/organization-tags

/v1/organization-tags/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]	string <= 64 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"description": "string",
"last-modified-at": "string",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-tags"
}
],
"meta": { }
}

/v1/organization-tags/

Request Body schema: application/json

required

object

type

required

string

Value: "organization-tags"

required

object

name required	string <= 64 characters
organization-id required	string <uuid>
description	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"description": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "organization-tags"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"description": "string",
"last-modified-at": "string",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-tags"
},
"meta": { }
}

/v1/organization-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/organization-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"description": "string",
"last-modified-at": "string",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-tags"
},
"meta": { }
}

/v1/organization-tags/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "organization-tags"

required

object

description	string <= 255 characters
name	string <= 64 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"description": "string",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-tags"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"description": "string",
"last-modified-at": "string",
"name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organization-tags"
},
"meta": { }
}

/v1/organizations

/v1/organizations/

query Parameters

page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"alias": ["string"
],
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"purpose": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"endpoint": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"name": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"part-of": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"type": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organizations"
}
],
"meta": { }
}

/v1/organizations/

Request Body schema: application/json

required

object

type

required

string

Value: "organizations"

required

object

organization-id

required

string <uuid>

active

boolean

Array of objects

Array

city	string <= 255 characters
country	string <= 64 characters
district	string <= 255 characters
line	Array of strings[ items <= 255 characters ]
	object
postal	string <= 32 characters
state	string <= 255 characters
text	string <= 1024 characters
type	string Enum: "postal" "physical" "both"
use	string Enum: "home" "work" "temp" "old"

alias

Array of strings[ items <= 255 characters ]

Array of objects

Array

	object
	object
	object
	Array of objects

Array of objects

Array

display	string <= 255 characters
	object
reference	string <= 255 characters

Array of objects

Array

assigner	string <= 255 characters
	object
system	string <= 255 characters
type	string Enum: "DL" "PPN" "BRN" "MR" "MCN" "EN" "TAX" "NIIP" "PRN" "MD" "DR"
use	string Enum: "usual" "official" "temp" "secondary"
value	string <= 255 characters

name

string <= 255 characters

object

display	string <= 255 characters
	object
reference	string <= 255 characters

Array of objects

Array

	object
rank	number Default: 1
system	string Enum: "phone" "fax" "email" "pager" "url" "sms" "other"
use	string Enum: "home" "work" "temp" "old" "mobile"
value	string <= 255 characters

Array of objects

Array

	Array of objects
text	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"alias": ["string"
],
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"purpose": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"endpoint": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"part-of": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"type": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
},
"type": "organizations"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"alias": ["string"
],
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"purpose": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"endpoint": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"name": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"part-of": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"type": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organizations"
},
"meta": { }
}

/v1/organizations/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"alias": ["string"
],
"contact": [{"address": {"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
},
"name": {"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
},
"purpose": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
}
],
"endpoint": [{"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
}
],
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"name": "string",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"part-of": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
],
"type": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "organizations"
},
"meta": { }
}

/v1/practitioner-role-specialties

/v1/practitioner-role-specialties/

query Parameters

filter[organization-id]

string <uuid>

Example: filter[organization-id]=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

["string"
]

/v1/practitioner-roles

/v1/practitioner-roles/

query Parameters

filter[name]	string <= 255 characters
filter[organization-id]	string <uuid> Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[specialty]	string <= 255 characters
page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"_ui": {"address-city": "string",
"address-state": "string",
"address-street": "string",
"address-zipcode": "string",
"contact-phone": "string",
"first-name": "string",
"last-name": "string",
"referrals-count": 0,
"specialty": "string",
"suffix": "string"
},
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"specialty": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "practitioner-roles"
}
],
"meta": { }
}

/v1/practitioner-roles/

Request Body schema: application/json

required

object

type

required

string

Value: "practitioner-roles"

required

object

organization-id

required

string <uuid>

Array of objects

Array

city	string <= 255 characters
country	string <= 64 characters
district	string <= 255 characters
line	Array of strings[ items <= 255 characters ]
	object
postal	string <= 32 characters
state	string <= 255 characters
text	string <= 1024 characters
type	string Enum: "postal" "physical" "both"
use	string Enum: "home" "work" "temp" "old"

Array of objects

Array

family	string <= 255 characters
given	Array of strings[ items <= 255 characters ]
	object
prefix	Array of strings[ items <= 32 characters ]
suffix	Array of strings[ items <= 32 characters ]
text	string <= 9999 characters
use	string Enum: "usual" "official" "temp" "nickname" "anonymous" "old" "maiden"

Array of objects

Array

	Array of objects
text	string <= 255 characters

Array of objects

Array

	object
rank	number Default: 1
system	string Enum: "phone" "fax" "email" "pager" "url" "sms" "other"
use	string Enum: "home" "work" "temp" "old" "mobile"
value	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"specialty": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
},
"type": "practitioner-roles"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"address-city": "string",
"address-state": "string",
"address-street": "string",
"address-zipcode": "string",
"contact-phone": "string",
"first-name": "string",
"last-name": "string",
"referrals-count": 0,
"specialty": "string",
"suffix": "string"
},
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"specialty": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "practitioner-roles"
},
"meta": { }
}

/v1/practitioner-roles/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/practitioner-roles/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"_ui": {"address-city": "string",
"address-state": "string",
"address-street": "string",
"address-zipcode": "string",
"contact-phone": "string",
"first-name": "string",
"last-name": "string",
"referrals-count": 0,
"specialty": "string",
"suffix": "string"
},
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"specialty": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "practitioner-roles"
},
"meta": { }
}

/v1/practitioners

/v1/practitioners/

query Parameters

page[limit]	integer [ 0 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"birth-date": "2019-08-24",
"communication": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"gender": "",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"photo": [{"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
}
],
"qualification": [{"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"issuer": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
}
}
],
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "practitioners"
}
],
"meta": { }
}

/v1/practitioners/

Request Body schema: application/json

required

object

type

required

string

Value: "practitioners"

required

object

individual-id

required

string <uuid>

active

boolean

Array of objects

Array

city	string <= 255 characters
country	string <= 64 characters
district	string <= 255 characters
line	Array of strings[ items <= 255 characters ]
	object
postal	string <= 32 characters
state	string <= 255 characters
text	string <= 1024 characters
type	string Enum: "postal" "physical" "both"
use	string Enum: "home" "work" "temp" "old"

birth-date

string <date>

Array of objects

Array

	Array of objects
text	string <= 255 characters

gender

string

Default: "unknown"

Enum: "" "female" "male" "other" "unknown"

Array of objects

Array

assigner	string <= 255 characters
	object
system	string <= 255 characters
type	string Enum: "DL" "PPN" "BRN" "MR" "MCN" "EN" "TAX" "NIIP" "PRN" "MD" "DR"
use	string Enum: "usual" "official" "temp" "secondary"
value	string <= 255 characters

Array of objects

Array

family	string <= 255 characters
given	Array of strings[ items <= 255 characters ]
	object
prefix	Array of strings[ items <= 32 characters ]
suffix	Array of strings[ items <= 32 characters ]
text	string <= 9999 characters
use	string Enum: "usual" "official" "temp" "nickname" "anonymous" "old" "maiden"

object

type required	string Enum: "event" "emr" "unspecified" "user"
event-id	string <uuid> available when type is event
organization-id	string <uuid> available when type is emr
reference-id	string <= 255 characters available when type is emr
server-id	string <= 255 characters available when type is emr
source	string <= 255 characters available when type is event
user-id	string <uuid> available when type is user

Array of objects

Array

content-type	string <= 255 characters
creation	string <= 255 characters
data	string <= 255 characters
hash	string <= 255 characters
language	string <= 255 characters
size	number
title	string <= 255 characters
url	string <= 255 characters

Array of objects

Array

	object
	Array of objects
	object
	object

Array of objects

Array

	object
rank	number Default: 1
system	string Enum: "phone" "fax" "email" "pager" "url" "sms" "other"
use	string Enum: "home" "work" "temp" "old" "mobile"
value	string <= 255 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"birth-date": "2019-08-24",
"communication": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"gender": "",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"photo": [{"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
}
],
"qualification": [{"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"issuer": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
}
}
],
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
},
"type": "practitioners"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"birth-date": "2019-08-24",
"communication": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"gender": "",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"photo": [{"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
}
],
"qualification": [{"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"issuer": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
}
}
],
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "practitioners"
},
"meta": { }
}

/v1/practitioners/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"active": true,
"address": [{"city": "string",
"country": "string",
"district": "string",
"line": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"postal": "string",
"state": "string",
"text": "string",
"type": "postal",
"use": "home"
}
],
"birth-date": "2019-08-24",
"communication": [{"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
}
],
"gender": "",
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"name": [{"family": "string",
"given": ["string"
],
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"prefix": ["string"
],
"suffix": ["string"
],
"text": "string",
"use": "usual"
}
],
"origin": {"event-id": "bf2f60f0-ff35-4f24-864f-05afabf1d43c",
"organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
"reference-id": "string",
"server-id": "string",
"source": "string",
"type": "event",
"user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
},
"photo": [{"content-type": "string",
"creation": "string",
"data": "string",
"hash": "string",
"language": "string",
"size": 0,
"title": "string",
"url": "string"
}
],
"qualification": [{"code": {"coding": [{"code": "string",
"display": "string",
"system": "string",
"user-selected": true,
"version": "string"
}
],
"text": "string"
},
"identifier": [{"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
}
],
"issuer": {"display": "string",
"identifier": {"assigner": "string",
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"system": "string",
"type": "DL",
"use": "usual",
"value": "string"
},
"reference": "string"
},
"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
}
}
],
"telecom": [{"period": {"end": "1975-11-25 00:00:00",
"start": "1975-11-25 00:00:00"
},
"rank": 1,
"system": "phone",
"use": "home",
"value": "string"
}
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "practitioners"
},
"meta": { }
}

/v1/profiles

/v1/profiles/

query Parameters

individual-ids

required

Array of strings <uuid> <= 50 items [ items <uuid > ]

Example: individual-ids=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"photo": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individual-profiles"
}
],
"meta": { }
}

/v1/profiles/{id}/

path Parameters

required

string

Resource identifier

query Parameters

thumbnail

boolean

Default: true

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"photo": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individual-profiles"
},
"meta": { }
}

/v1/profiles/{id}/get-upload-url/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"upload-info": {"expiration-time": 0,
"upload-data": { },
"upload-url": "string"
}
}

/v1/profiles/{id}/process-upload/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"photo": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "individual-profiles"
},
"meta": { }
}

/v1/profiles/{id}/remove-photo/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

null

/v1/profiles/{id}/upload-photo/

path Parameters

required

string

Resource identifier

Request Body schema: multipart/form-data

photo

required

string <binary>

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/purge-data

/v1/purge-data/

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/purge-data/

Request Body schema: application/json

required

object

type

required

string

Value: "system-purges"

required

object

entity-id required	string <= 255 characters
entity-type required	string Enum: "individual" "organization" "user"
reference-id required	string <= 255 characters
request-id required	string <= 255 characters
archive	boolean Default: false
property name* additional property	any

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"archive": false,
"entity-id": "string",
"entity-type": "individual",
"reference-id": "string",
"request-id": "string"
},
"type": "system-purges"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

null

/v1/replicators

/v1/replicators/

query Parameters

filter[classpath]

string <= 255 characters

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"classpath": "string",
"created-time": "string",
"last-poll-time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "replicators"
}
],
"meta": { }
}

/v1/replicators/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"classpath": "string",
"created-time": "string",
"last-poll-time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "replicators"
},
"meta": { }
}

/v1/rxnorms

/v1/rxnorms/

query Parameters

filter[source-abbreviation]	string <= 255 characters
filter[term-type]	string <= 255 characters
page[limit]	integer [ 1 .. 1000 ] Default: 20
page[offset]	integer (PageOffset) >= 0 Default: 0
text	string <= 255 characters

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"atom-id": "string",
"concept-id": "string",
"description": "string",
"source-abbreviation": "string",
"term-type": "string"
},
"id": 0,
"type": "rxnorms"
}
],
"meta": { }
}

/v1/rxnorms/{id}/

path Parameters

required

integer

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"atom-id": "string",
"concept-id": "string",
"description": "string",
"source-abbreviation": "string",
"term-type": "string"
},
"id": 0,
"type": "rxnorms"
},
"meta": { }
}

/v1/sniffers

/v1/sniffers/

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-time": "string",
"user-id": "11111111-1111-1111-1111-111111111111",
"valid-until": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "sniffers"
}
],
"meta": { }
}

/v1/sniffers/

Request Body schema: application/json

required

object

type

required

string

Value: "sniffers"

required

object

user-id required	string <uuid>
valid-until required	string <datetime>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"user-id": "11111111-1111-1111-1111-111111111111",
"valid-until": "string"
},
"type": "sniffers"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-time": "string",
"user-id": "11111111-1111-1111-1111-111111111111",
"valid-until": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "sniffers"
},
"meta": { }
}

/v1/sniffers/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/sniffers/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-time": "string",
"user-id": "11111111-1111-1111-1111-111111111111",
"valid-until": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "sniffers"
},
"meta": { }
}

/v1/sniffers/{id}/get-logs/

path Parameters

required

string

Resource identifier

query Parameters

page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"body": "string",
"content_type": "string",
"created-time": "string",
"message": "string",
"method": "string",
"path": "string",
"query-string": "string",
"request-id": "string",
"response": "string",
"status-code": 0,
"trace-id": "string",
"user-agent": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "sniffer-logs"
}
],
"meta": { }
}

/v1/tasks

/v1/tasks/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-time": "string",
"last-modified-time": "string",
"result": null,
"status": "string"
},
"id": "string",
"type": "tasks"
},
"meta": { }
}

/v1/todo-entries

/v1/todo-entries/

query Parameters

filter[assigned-individual-id]	string <uuid> Example: filter[assigned-individual-id]=11111111-1111-1111-1111-111111111111
filter[care-plan-id]	string <uuid> Example: filter[care-plan-id]=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ] compare timestamp against last-modified-at time.specify [comparitor][datetime]. comparators supported >, <, <=, >=use multiple to build a bounded time frame.
filter[due-end-time]	string <datetime>
filter[due-start-time]	string <datetime>
filter[es-match-phrase-prefix]	Array of strings non-empty [ items <= 255 characters ]
filter[es-match-text]	string <= 255 characters
filter[es-query-string]	string <= 255 characters
filter[include-done]	boolean Default: false
filter[include-inactive]	boolean Deprecated Default: false
filter[individual-group-id]	string <uuid> Example: filter[individual-group-id]=11111111-1111-1111-1111-111111111111
filter[provider-only]	boolean Default: false
filter[reference-in-individual-group-id]	string <uuid> Example: filter[reference-in-individual-group-id]=11111111-1111-1111-1111-111111111111
filter[reference-individual-id]	string <uuid> Example: filter[reference-individual-id]=11111111-1111-1111-1111-111111111111
filter[tags]	Array of strings[ items <= 127 characters ]
individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Items Enum: "-assigned-at" "-completed-at" "-created-at" "-due-time" "-last-modified-at" "assigned-at" "completed-at" "created-at" "due-time" "last-modified-at"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"assigned-at": "string",
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"completed-at": "string",
"completed-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"context-url": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"done": true,
"due-time": "string",
"external-id": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-group": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"notes": "string",
"order": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"provider-notes": "string",
"publish-update": true,
"references": [{"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"data": { },
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted",
"type": "individual"
}
],
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"tags": ["string"
],
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries"
}
],
"meta": { }
}

/v1/todo-entries/

Request Body schema: application/json

required

object

type

required

string

Value: "todo-entries"

required

object

text

required

string <= 9999 characters

care-plan-id

string <uuid>

context-url

string <= 2048 characters

due-time

string <datetime>

external-id

string <= 255 characters

individual-group-id

string <uuid>

individual-id

string <uuid>

notes

string <= 9999 characters

organization-id

string <uuid>

provider-notes

string <= 9999 characters

publish-update

boolean

Default: false

Array of objects

Array

id required	string <uuid>
type required	string Enum: "individual" "pathway"
data	object

status-id

string <uuid>

tags

Array of strings[ items <= 127 characters ]

with-notification

boolean

Default: true

Used when individual-id is specified and calling user is an org member or an organization-id is specified

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"care-plan-id": "11111111-1111-1111-1111-111111111111",
"context-url": "string",
"due-time": "string",
"external-id": "string",
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"notes": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"provider-notes": "string",
"publish-update": false,
"references": [{"data": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "individual"
}
],
"status-id": "11111111-1111-1111-1111-111111111111",
"tags": ["string"
],
"text": "string",
"with-notification": true
},
"type": "todo-entries"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"assigned-at": "string",
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"completed-at": "string",
"completed-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"context-url": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"done": true,
"due-time": "string",
"external-id": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-group": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"notes": "string",
"order": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"provider-notes": "string",
"publish-update": true,
"references": [{"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"data": { },
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted",
"type": "individual"
}
],
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"tags": ["string"
],
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries"
},
"meta": { }
}

/v1/todo-entries/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/todo-entries/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"assigned-at": "string",
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"completed-at": "string",
"completed-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"context-url": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"done": true,
"due-time": "string",
"external-id": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-group": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"notes": "string",
"order": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"provider-notes": "string",
"publish-update": true,
"references": [{"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"data": { },
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted",
"type": "individual"
}
],
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"tags": ["string"
],
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries"
},
"meta": { }
}

/v1/todo-entries/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "todo-entries"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com. Supported (op, path)s are: ('remove', '/individual-group-id'), ('remove', '/individual-id'), ('replace', '/context-url'), ('replace', '/done'), ('replace', '/due-time'), ('replace', '/individual-group-id'), ('replace', '/individual-id'), ('replace', '/notes'), ('replace', '/provider-notes'), ('replace', '/references'), ('replace', '/status-id'), ('replace', '/tags'), ('replace', '/text').

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"assigned-at": "string",
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"completed-at": "string",
"completed-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"context-url": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"done": true,
"due-time": "string",
"external-id": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-group": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"notes": "string",
"order": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"provider-notes": "string",
"publish-update": true,
"references": [{"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"data": { },
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted",
"type": "individual"
}
],
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"tags": ["string"
],
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries"
},
"meta": { }
}

/v1/todo-entries-comments

/v1/todo-entries-comments/

query Parameters

entry-id required	string <uuid> Example: entry-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings non-empty Default: "-created-at" Items Enum: "-created-at" "created-at"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"entry-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-comments"
}
],
"meta": { }
}

/v1/todo-entries-comments/

Request Body schema: application/json

required

object

type

required

string

Value: "todo-entries-comments"

required

object

entry-id required	string <uuid>
text required	string <= 9999 characters

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"entry-id": "11111111-1111-1111-1111-111111111111",
"text": "string"
},
"type": "todo-entries-comments"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"entry-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-comments"
},
"meta": { }
}

/v1/todo-entries-comments/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/todo-entries-comments/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"entry-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-comments"
},
"meta": { }
}

/v1/todo-entries-comments/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "todo-entries-comments"

required

object

text	string <= 9999 characters

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-comments"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"entry-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-comments"
},
"meta": { }
}

/v1/todo-entries-logs

/v1/todo-entries-logs/

query Parameters

entry-id required	string <uuid> Example: entry-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"action": "delete",
"created-at": "string",
"data": { },
"entry-id": "11111111-1111-1111-1111-111111111111",
"message": "string",
"user": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-logs"
}
],
"meta": { }
}

/v1/todo-entries-logs/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"action": "delete",
"created-at": "string",
"data": { },
"entry-id": "11111111-1111-1111-1111-111111111111",
"message": "string",
"user": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
}
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-logs"
},
"meta": { }
}

/v1/todo-entries-statuses

/v1/todo-entries-statuses/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
filter[display]	string <= 255 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"is-default": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-statuses"
}
],
"meta": { }
}

/v1/todo-entries-statuses/

Request Body schema: application/json

required

object

type

required

string

Value: "todo-entries-statuses"

required

object

display required	string <= 255 characters
organization-id required	string <uuid>
definition	string <= 255 characters
is-default	boolean Default: false

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"definition": "string",
"display": "string",
"is-default": false,
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "todo-entries-statuses"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"is-default": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-statuses"
},
"meta": { }
}

/v1/todo-entries-statuses/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/todo-entries-statuses/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"is-default": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-statuses"
},
"meta": { }
}

/v1/todo-entries-statuses/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "todo-entries-statuses"

required

object

definition	string <= 255 characters
display	string <= 255 characters
is-default	boolean

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"definition": "string",
"display": "string",
"is-default": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-statuses"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"definition": "string",
"display": "string",
"is-default": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-statuses"
},
"meta": { }
}

/v1/todo-entries-tags

/v1/todo-entries-tags/

query Parameters

organization-id required	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-tags"
}
],
"meta": { }
}

/v1/todo-entries-tags/

Request Body schema: application/json

required

object

type

required

string

Value: "todo-entries-tags"

required

object

name required	string <= 127 characters
organization-id required	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"type": "todo-entries-tags"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-tags"
},
"meta": { }
}

/v1/todo-entries-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/todo-entries-tags/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries-tags"
},
"meta": { }
}

/v1/users

/v1/users/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"communication-preferences": { },
"email": "string",
"email-verified": true,
"enabled": true,
"first-name": "string",
"last-name": "string",
"last-sync-time": "string",
"locale": "string",
"locale-explicit": true,
"organization-id": "11111111-1111-1111-1111-111111111111",
"organization-ids": ["11111111-1111-1111-1111-111111111111"
],
"phone": "string",
"phone-verified": true,
"primary-individual-id": "11111111-1111-1111-1111-111111111111",
"tz": "string",
"tz-explicit": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "users"
},
"meta": { }
}

/v1/webhooks

/v1/webhooks/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
filter[event]	string Enum: "delete" "get" "patch" "post"
filter[source]	string Enum: "article" "challenge" "challenge-points" "journal" "todo"
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"content-type": "string",
"counters": { },
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"data": { },
"enabled": true,
"event": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-response": "string",
"last-status-code": 0,
"source": "string",
"url": "string",
"with-metadata": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "webhooks"
}
],
"meta": { }
}

/v1/webhooks/

Request Body schema: application/json

required

object

type

required

string

Value: "webhooks"

required

object

event required	string Enum: "delete" "get" "patch" "post"
individual-id required	string <uuid>
source required	string Enum: "article" "challenge" "challenge-points" "journal" "todo"
url required	string <url>
content-type	string Default: "json" Enum: "form" "json"
data	object
with-metadata	boolean Default: true

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"content-type": "form",
"data": { },
"event": "delete",
"individual-id": "11111111-1111-1111-1111-111111111111",
"source": "article",
"url": "string",
"with-metadata": true
},
"type": "webhooks"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-type": "string",
"counters": { },
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"data": { },
"enabled": true,
"event": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-response": "string",
"last-status-code": 0,
"source": "string",
"url": "string",
"with-metadata": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "webhooks"
},
"meta": { }
}

/v1/webhooks/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v1/webhooks/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"content-type": "string",
"counters": { },
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"data": { },
"enabled": true,
"event": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-response": "string",
"last-status-code": 0,
"source": "string",
"url": "string",
"with-metadata": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "webhooks"
},
"meta": { }
}

/v1/webhooks/{id}/disable/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

null

/v1/webhooks/{id}/enable/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/vnd.api+json

null

/v1/workflows

/v1/workflows/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"current-state": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"state-data": { },
"user-metadata": { },
"valid-events": [{"display": "string",
"event": "string"
}
],
"workflow-version": "string",
"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "workflows"
}
],
"meta": { }
}

/v1/workflows/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"current-state": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"state-data": { },
"user-metadata": { },
"valid-events": [{"display": "string",
"event": "string"
}
],
"workflow-version": "string",
"workflowtype-id": "11111111-1111-1111-1111-111111111111",
"workflowtype-name": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "workflows"
},
"meta": { }
}

/v1/workflowtypes

/v1/workflowtypes/

query Parameters

page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"category": "string",
"default": true,
"latest-version": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"selected-version": "string",
"supports-unverified-users": true,
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "workflowtypes"
}
],
"meta": { }
}

/v1/workflowtypes/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"category": "string",
"default": true,
"latest-version": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"selected-version": "string",
"supports-unverified-users": true,
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "workflowtypes"
},
"meta": { }
}

/v1/workflowtypes/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "workflowtypes"

required

Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com. Supported (op, path)s are: ('replace', '/default').

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value required	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "workflowtypes"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"category": "string",
"default": true,
"latest-version": "string",
"name": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"selected-version": "string",
"supports-unverified-users": true,
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "workflowtypes"
},
"meta": { }
}

/v2/actions

/v2/actions/{id}/set-daily-achievement/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

date required	string <date>
able-to-complete	boolean
achieved	boolean
scale-value	string Enum: "agree" "disagree" "neutral" "strongly-agree" "strongly-disagree"
value	number <= 99999.99

Responses

Request samples

Payload

Content type

application/json

{"able-to-complete": true,
"achieved": true,
"date": "2019-08-24",
"scale-value": "agree",
"value": 99999.99
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"all-time-able-no-pct": 100,
"all-time-able-yes-pct": 100,
"all-time-completion": 100,
"all-time-extras": 0,
"all-time-possible-progress": 0,
"all-time-progress": 0,
"all-time-scale-agree-pct": 100,
"all-time-scale-disagree-pct": 100,
"all-time-scale-neutral-pct": 100,
"all-time-scale-strongly-agree-pct": 100,
"all-time-scale-strongly-disagree-pct": 100,
"all-time-scale-unanswered-pct": 100,
"all-time-value-total": 0,
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"categories": [{"display-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
}
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"daily-achievements": [{"achievements": [{"able-to-complete": true,
"achieved": true,
"date": "2019-08-24",
"scale-value": "agree",
"value": 0
}
],
"start-of-week": "2019-08-24"
}
],
"description": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"metrics": ["string"
],
"num-days-per-week": 1,
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"reminder-days": [{"day": "friday",
"value": 1
}
],
"reminder-schedulers": [{"byday": ["FR"
],
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"follow-tz": true,
"id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"next-reminder-at": "string",
"previous-reminder-at": "string",
"rrule": "string",
"start-at": "string",
"start-tz": "string",
"working-tz": "string"
}
],
"reminder-times": [{"time": "14:15:22Z",
"value": "afternoon"
}
],
"start-date": "2019-08-24",
"stop-date": "2019-08-24",
"type": "able"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "actions"
},
"meta": { }
}

/v2/goals

/v2/goals/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
filter[care-plan-id]	string <uuid> Example: filter[care-plan-id]=11111111-1111-1111-1111-111111111111
filter[ui-category]	string Default: "wellness-vision" Enum: "all" "general" "long-term" "wellness-vision"
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"care-plan-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"end-date": "2019-08-24",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"lifecycle-status": "accepted",
"organization-id": "11111111-1111-1111-1111-111111111111",
"start-date": "2019-08-24",
"ui-category": "general",
"wellness-vision": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "goals"
}
],
"meta": { }
}

/v2/goals/

Request Body schema: application/json

required

object

type

required

string

Value: "goals"

required

object

description required	string <= 9999 characters
individual-id required	string <uuid>
care-plan-id	string <uuid>
end-date	string <date>
organization-id	string <uuid>
start-date	string <date>
ui-category	string Default: "wellness-vision" Enum: "general" "long-term" "wellness-vision"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"care-plan-id": "11111111-1111-1111-1111-111111111111",
"description": "string",
"end-date": "2019-08-24",
"individual-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"start-date": "2019-08-24",
"ui-category": "general"
},
"type": "goals"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"care-plan-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"end-date": "2019-08-24",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"lifecycle-status": "accepted",
"organization-id": "11111111-1111-1111-1111-111111111111",
"start-date": "2019-08-24",
"ui-category": "general",
"wellness-vision": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "goals"
},
"meta": { }
}

/v2/goals/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v2/goals/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"care-plan-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"end-date": "2019-08-24",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"lifecycle-status": "accepted",
"organization-id": "11111111-1111-1111-1111-111111111111",
"start-date": "2019-08-24",
"ui-category": "general",
"wellness-vision": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "goals"
},
"meta": { }
}

/v2/goals/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "goals"

required

object

description	string <= 9999 characters
end-date	string <date>
lifecycle-status	string Enum: "accepted" "active" "cancelled" "completed" "entered-in-error" "on-hold" "planned" "proposed" "rejected"
start-date	string <date>

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"description": "string",
"end-date": "2019-08-24",
"lifecycle-status": "accepted",
"start-date": "2019-08-24"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "goals"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"care-plan-id": "11111111-1111-1111-1111-111111111111",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"description": "string",
"end-date": "2019-08-24",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"lifecycle-status": "accepted",
"organization-id": "11111111-1111-1111-1111-111111111111",
"start-date": "2019-08-24",
"ui-category": "general",
"wellness-vision": true
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "goals"
},
"meta": { }
}

/v2/medication-statements

/v2/medication-statements/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "medication-statements"

required

object

string or null

One of

string <uuid>

display-name

string <= 255 characters

dose-unit

string <= 255 characters

dose-value

number [ 0 .. 100000 ]

end

string <datetime>

medication-code

string <= 255 characters

reason-for-use

string <= 255 characters

Array of objects

Array

byday required	Array of strings Items Enum: "FR" "MO" "SA" "SU" "TH" "TU" "WE"
follow-tz required	boolean
frequency required	string Enum: "DAILY" "HOURLY"
send-reminder required	boolean
start-at required	string <datetime>
id	string <uuid>

start

string <datetime>

status

string

Enum: "active" "completed" "entered-in-error" "intended" "on-hold" "stopped"

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"care-plan-id": "11111111-1111-1111-1111-111111111111",
"display-name": "string",
"dose-unit": "string",
"dose-value": 100000,
"end": "string",
"medication-code": "string",
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"follow-tz": true,
"frequency": "DAILY",
"id": "11111111-1111-1111-1111-111111111111",
"send-reminder": true,
"start-at": "string"
}
],
"start": "string",
"status": "active"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-statements"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"active-care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"attachments": [{"content-size": 0,
"content-type": "string",
"filename": "string",
"id": "11111111-1111-1111-1111-111111111111",
"thumbnail": "string"
}
],
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"care-plans": [{"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
}
],
"created-by": {"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"email": "string",
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone": "string",
"phone-verified": true,
"registered": true
},
"display-description": "string",
"display-name": "string",
"display-url": "string",
"dose-unit": "string",
"dose-value": 0,
"end": "string",
"last-taken-at": "string",
"medication-code": "string",
"medication-system": "string",
"observations": [{"id": "11111111-1111-1111-1111-111111111111"
}
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"reason-for-use": "string",
"schedulers": [{"byday": ["FR"
],
"enabled": true,
"follow-tz": true,
"frequency": "DAILY",
"id": "11111111-1111-1111-1111-111111111111",
"next-due-at": "string",
"recurrence": "string",
"rrule": "string",
"send-reminder": true,
"start-at": "string",
"start-tz": "string",
"takens": [{"id": "11111111-1111-1111-1111-111111111111",
"status": "SKIPPED",
"taken-at": "string",
"taken-at-tz": "string"
}
],
"working-tz": "string"
}
],
"start": "string",
"status": "active"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "medication-statements"
},
"meta": { }
}

/v2/todo-entries

/v2/todo-entries/

query Parameters

filter[assigned-individual-id]	string <uuid> Example: filter[assigned-individual-id]=11111111-1111-1111-1111-111111111111
filter[care-plan-id]	string <uuid> Example: filter[care-plan-id]=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]	Array of strings <= 2 items [ items <= 40 characters ] compare timestamp against last-modified-at time.specify [comparitor][datetime]. comparators supported >, <, <=, >=use multiple to build a bounded time frame.
filter[due-end-time]	string <datetime>
filter[due-start-time]	string <datetime>
filter[es-match-phrase-prefix]	Array of strings non-empty [ items <= 255 characters ]
filter[es-match-text]	string <= 255 characters
filter[es-query-string]	string <= 255 characters
filter[include-done]	boolean Default: false
filter[include-inactive]	boolean Deprecated Default: false
filter[individual-group-id]	string <uuid> Example: filter[individual-group-id]=11111111-1111-1111-1111-111111111111
filter[provider-only]	boolean Default: false
filter[reference-in-individual-group-id]	string <uuid> Example: filter[reference-in-individual-group-id]=11111111-1111-1111-1111-111111111111
filter[reference-individual-id]	string <uuid> Example: filter[reference-individual-id]=11111111-1111-1111-1111-111111111111
filter[tags]	Array of strings[ items <= 127 characters ]
individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0
sort	Array of strings Items Enum: "-assigned-at" "-completed-at" "-created-at" "-due-time" "-last-modified-at" "assigned-at" "completed-at" "created-at" "due-time" "last-modified-at"

Responses

Response samples

Content type

application/vnd.api+json

{"data": [{"attributes": {"assigned-at": "string",
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"completed-at": "string",
"completed-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"context-url": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"done": true,
"due-time": "string",
"external-id": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-group": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"notes": "string",
"order": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"provider-notes": "string",
"publish-update": true,
"references": [{"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"data": { },
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted",
"type": "individual"
}
],
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"tags": ["string"
],
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries"
}
],
"meta": { }
}

/v2/todo-entries/

Request Body schema: application/json

required

object

type

required

string

Value: "todo-entries"

required

object

text

required

string <= 9999 characters

care-plan-id

string <uuid>

context-url

string <= 2048 characters

due-time

string <datetime>

external-id

string <= 255 characters

individual-group-id

string <uuid>

individual-id

string <uuid>

notes

string <= 9999 characters

organization-id

string <uuid>

provider-notes

string <= 9999 characters

publish-update

boolean

Default: false

Array of objects

Array

id required	string <uuid>
type required	string Enum: "individual" "pathway"
data	object

status-id

string <uuid>

tags

Array of strings[ items <= 127 characters ]

with-notification

boolean

Default: true

Used when individual-id is specified and calling user is an org member or an organization-id is specified

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"care-plan-id": "11111111-1111-1111-1111-111111111111",
"context-url": "string",
"due-time": "string",
"external-id": "string",
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"notes": "string",
"organization-id": "11111111-1111-1111-1111-111111111111",
"provider-notes": "string",
"publish-update": false,
"references": [{"data": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "individual"
}
],
"status-id": "11111111-1111-1111-1111-111111111111",
"tags": ["string"
],
"text": "string",
"with-notification": true
},
"type": "todo-entries"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"assigned-at": "string",
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"completed-at": "string",
"completed-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"context-url": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"done": true,
"due-time": "string",
"external-id": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-group": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"notes": "string",
"order": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"provider-notes": "string",
"publish-update": true,
"references": [{"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"data": { },
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted",
"type": "individual"
}
],
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"tags": ["string"
],
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries"
},
"meta": { }
}

/v2/todo-entries/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

null

/v2/todo-entries/{id}/

path Parameters

required

string

Resource identifier

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"assigned-at": "string",
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"completed-at": "string",
"completed-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"context-url": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"done": true,
"due-time": "string",
"external-id": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-group": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"notes": "string",
"order": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"provider-notes": "string",
"publish-update": true,
"references": [{"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"data": { },
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted",
"type": "individual"
}
],
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"tags": ["string"
],
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries"
},
"meta": { }
}

/v2/todo-entries/{id}/

path Parameters

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "todo-entries"

required

Array of objects

Array

op required	string Enum: "add" "remove" "replace"
path required	string <= 255 characters Path in document to operate on. Starts with "/" which represents the root document
value	any

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": [{"op": "add",
"path": "string",
"value": null
}
],
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries"
},
"meta": { }
}

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"assigned-at": "string",
"care-plan": {"description": "string",
"id": "11111111-1111-1111-1111-111111111111",
"title": "string"
},
"care-plan-id": "11111111-1111-1111-1111-111111111111",
"completed-at": "string",
"completed-by": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"context-url": "string",
"created-at": "string",
"created-by": "11111111-1111-1111-1111-111111111111",
"created-by-first-name": "string",
"created-by-last-name": "string",
"done": true,
"due-time": "string",
"external-id": "string",
"individual": {"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string"
},
"individual-group": {"id": "11111111-1111-1111-1111-111111111111",
"name": "string"
},
"individual-group-id": "11111111-1111-1111-1111-111111111111",
"individual-id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"last-modified-at": "string",
"last-modified-by": "11111111-1111-1111-1111-111111111111",
"last-modified-by-first-name": "string",
"last-modified-by-last-name": "string",
"notes": "string",
"order": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"provider-notes": "string",
"publish-update": true,
"references": [{"birth-date": "2019-08-24",
"communication-preferences": {"email": { },
"mobile": { },
"sms": { },
"voice": { },
"web": { }
},
"data": { },
"email-verified": true,
"first-name": "string",
"id": "11111111-1111-1111-1111-111111111111",
"last-name": "string",
"phone-verified": true,
"registered": true,
"registration-invite": "accepted",
"type": "individual"
}
],
"status": {"display": "string",
"id": "11111111-1111-1111-1111-111111111111"
},
"tags": ["string"
],
"text": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "todo-entries"
},
"meta": { }
}