Supported Formats

json

Errors

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

Examples

GET /Goal/1001?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Goal",
  "id": "1001",
  "lifecycleStatus": "proposed",
  "description": {
    "text": "Test Narrative"
  },
  "subject": {
    "reference": "Patient/1",
    "display": "Newman, Alice, Jones, Alicia, "
  },
  "target": [
    {
      "dueDate": "2022-11-09"
    }
  ]
}

Params

Param name Description
access_token
required

CarePaths User OAuth Token

Validations:

  • Must be String.

id
optional

ID of requested goal

Validations:

  • Must be number.

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.