Care plan

Supported Formats

json

Errors

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

Examples

GET /CarePlan?patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "e41ca4d9ad345c1e2f0096ada003be24",
  "type": "search set",
  "entry": [
    {
      "full_url": "/CarePlan/2",
      "resource": {
        "resourceType": "CarePlan",
        "id": "2",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Test Instrux</div>"
        },
        "status": "unknown",
        "intent": "proposal",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                "code": "assess-plan"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/1",
          "display": " "
        }
      }
    }
  ],
  "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.
category optional	Category of plan i.e. “assess-plan” or “hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan” 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	CarePlan Validations: Must be String.
text required	Validations: Must be Hash.
status required	Validations: Must be String.
intent required	Validations: Must be String.
category required	Validations: Must be Array.
subject required	Validations: Must be Hash.

Supported Formats

json

Errors

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

Examples

GET /CarePlan/2?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "CarePlan",
  "id": "2",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Test Instrux</div>"
  },
  "status": "unknown",
  "intent": "proposal",
  "category": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
          "code": "assess-plan"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/1",
    "display": " "
  }
}

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
id optional	ID of requested Allergy Validations: Must be number.

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	CarePlan Validations: Must be String.
text required	Validations: Must be Hash.
status required	Validations: Must be String.
intent required	Validations: Must be String.
category required	Validations: Must be Array.
subject required	Validations: Must be Hash.

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.
category optional	Category of plan i.e. “assess-plan” or “hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan” 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.