Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Params

Param name Description
access_token
required

CarePaths User OAuth Token

Validations:

  • Must be String.

patient
optional

ID of the requested patient

Validations:

  • Must be number.

type
optional

Loinc code i.e. “11506-3” or“loinc.org|11506-3

Validations:

  • Must be string.

category
optional

Document category i.e. “clinical-note”

Validations:

  • Must be string.

date
optional

Date of document with optional prefix in the form of two letters i.e. lt/gt/le/ge

Validations:

  • Must be string.

start_date
optional

Start date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.

end_date
optional

End date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.