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.

code
optional

LOINC code of requested observation i.e. 72166-2 or loinc.org|72166-2

Validations:

  • Must be string.

category
optional

Specifies the type of observation i.e. vital-signs or terminology.hl7.org/CodeSystem/observation-category|vital-signs

Validations:

  • Must be string.

date
optional

Date of Observation 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.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Bundle

Validations:

  • Must be String.

type
required

Validations:

  • Must be String.