Goals

To define

Supported Formats

json
>>>

GET /api/Goal
Goals

Supported Formats

json

Errors

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

Examples

GET /Goal?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
403

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.
patient
optional

Patient ID

Validations:

  • Must be number.
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

Goal

Validations:

  • Must be String.
lifecycle_status
required

Validations:

  • Must be String.
description
required

Validations:

  • Must be Hash.
subject
required

Validations:

  • Must be Hash.
target
required

Validations:

  • Must be Array.
>>>

POST /api/Goal/_search
Goals by POST

GET /api/Goal/:id
Goals

Supported Formats

json

Errors

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

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Goal

Validations:

  • Must be String.
lifecycle_status
required

Validations:

  • Must be String.
description
required

Validations:

  • Must be Hash.
subject
required

Validations:

  • Must be Hash.
target
required

Validations:

  • Must be Array.