Goals

To define

Supported Formats

json
>>>

GET /Goals
Goals

Supported Formats

json

Errors

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

Examples

GET /Goal?patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "f3c5d9ebbfb43daa94618c47cb20b652",
  "type": "search set",
  "entry": [
    {
      "full_url": "https://camp.carepaths.dev:9215/Goal/1001",
      "resource": {
        "resourceType": "Goal",
        "id": "1001",
        "lifecycleStatus": "proposed",
        "description": {
          "text": "Test Narrative"
        },
        "subject": {
          "reference": "Patient/1",
          "display": "Newman, Alice, Jones, Alicia, "
        },
        "target": [
          {
            "dueDate": "2022-11-09"
          }
        ]
      }
    }
  ],
  "total": 1
}

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.
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.
>>>

GET /Goals/:id
Goals by id

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.
>>>

GET /Goals/_search
Goals search

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.
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.