CarePlan

Overview

The DSTU2 CarePlan resource can be used to represent both care plans and care teams.

Care Plans

The CarePlan resource describes the intentions of how one or more practitioners plan to deliver care to a specific patient. Care plans are used in a variety of areas and scopes ranging from encounter or visit specific to cross-visits. Care plans are used to group activities, goals and/or practitioners to create context. Care plans are intended to be specific to the patient. It is possible for a planned activity to stand alone without a care plan such as a scheduled appointment.

The following fields are returned if valued:

Care Teams

The CareTeam resource will be available in the STU3 version to represent care team members. Meanwhile, the CarePlan resource will be used to identify the care team members in DSTU2. Care team members or participants include practitioners (physicians, nurses, technicians, etc.), family members, friends, guardians, and the patient. The care team can be specific to an encounter or the patient across all encounters (longitudinal).

The following fields are returned if valued:

Terminology Bindings

CarePlan.category
  • Description
    • Identifies what kind of plan this is. This is also used to return a CareTeam (CarePlan with participants). "assess-plan" and "careteam" both belong to the Argonaut extension codes. "longitudinal" and "encounter" are CareTeam specific values from the CareTeam category codes. Currently these are the only category bindings which are supported.
  • Details: Argonaut Extension Codes
    System: http://argonaut.hl7.org

  • Details: CareTeam Category Codes
    System: http://hl7.org/fhir/care-team-category

Search for CarePlans that meet supplied query parameters:

GET /CarePlan?:parameters

Implementation Notes

Authorization Types

Parameters

Name Required? Type Description
_id This, or one of patient or subject token The logical resource id associated with the resource.
date N date Time period plan covers. Example: date=ge2016-08 or date=le2017-01-24T12:00:00.000Z
patient This, or one of _id or subject reference Who care plan is for. Example: patient=1316024
subject This, or one of _id or patient reference Who care plan is for. Must represent a Patient resource. May use the :Patient modifier. Example: subject=Patient/1316024 or subject:Patient=1316024
_count N number Number of results per page.
category N token The scope of care plan being searched for. Examples: category=assess-plan, category=http://argonaut.hl7.org|careteam, category=http://hl7.org/fhir/care-team-category|longitudinal, or category=careteam
context N reference The encounter id of the care plan. Example: context=1138

Notes:

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example retrieve care plan

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/CarePlan?patient=1316020&category=assess-plan

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "c4dac70c-1961-46e8-8662-f4e82b8475c6",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/CarePlan?patient=1316020&category=assess-plan&_count=10"
    },
    {
      "relation": "next",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/CarePlan?patient=1316020&-pageContext=eNqVUmtr2zAU_Ssr2UdH6GXHERTqOCoYujrYStj2xQhFyQS2FBSnrKM_fnKbkXWBeQPB1dU9R_d1lOuA0t5qD7rjkwKqNdYo2eonbXsgO_nDWXCQe2P3IHv1VnKvc2d7_b2f3N2ov_K3Tp264aK86bU3ElS69yYEF898QNS6z8-hm7vJyVv29hnrzJZp34GD9kdn2e6b8YdWPjNEUAIxDGA0n8EpROEICNnrARDCryGEIZpNIZ7iVKAZQwmDBKRpMoQQvM6jnNfAu1YfvNuZVl-yiduHqFjeosCxp7YNZpHVRd5kQlTFYi14HZ74_T3PRbHhzTITPDzsZHvU_2Hz88w-LM_jOg6_flqJL81DUYv3BSu3Dbu4lBh8zXAcjULmoxCCxiHjiQgdhwxLyMLMysdmVZWbYsmrP1t-5_T-NAzq3_V2Fu612sogKNkbZz--qfkaMej7kvKRfxZNvq7qcqgwRgTTGYpikhBC4whRSiidJxQF5UXwt52uKr4pynV94eIUwximURLEGUQcuHGKY0go-cUN7b1MXuBPQFQtOQ%3D%3D&-pageDirection=NEXT"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/CarePlan/6017316",
      "resource": {
        "resourceType": "CarePlan",
        "id": "6017316",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2016-03-17T16:32:29-05:00"
        },
        "text": {
          "status": "additional",
          "div": "<div><p><b>Care Plan</b></p><p><b>Patient</b>: Houde, Test 1</p><p><b>Description</b>:</p><pre>Assessment/Plan&#10;Community acquired pneumonia&#10;Diabetes mellitus&#10;Fracture of arm&#10;Rheumatoid Arthritis&#10;Subjective&#10;Review of Systems&#10;Objective&#10;Vitals & Measurements&#10;Physical Exam&#10;Lab Results&#10;Diagnostic Results</pre><p><b>Author</b>: Who, Doctor</p><p><b>Effective Date/Time</b>: 2016-03-17T16:32:23-05:00</p></div>"
        },
        "subject": {
          "reference": "Patient/1316020",
          "display": "Houde, Test 1"
        },
        "status": "completed",
        "context": {
          "reference": "Encounter/3261906"
        },
        "period": {
          "end": "2016-03-17T16:32:23-05:00"
        },
        "author": [
          {
            "reference": "Practitioner/2048007",
            "display": "Who, Doctor"
          }
        ],
        "modified": "2016-03-17T16:32:29-05:00",
        "category": [
          {
            "coding": [
              {
                "system": "http://argonaut.hl7.org",
                "code": "assess-plan"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/CarePlan/6015260",
      "resource": {
        "resourceType": "CarePlan",
        "id": "6015260",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2016-03-17T13:20:05-05:00"
        },
        "text": {
          "status": "additional",
          "div": "<div><p><b>Care Plan</b></p><p><b>Patient</b>: Houde, Test 1</p><p><b>Description</b>:</p><pre>    &#10;---------------------&#10;From: Who, Doctor&#10;To: Who, Doctor&#10;Sent: March 17, 2016  1:19 PM Show up: March 17, 2016  1:19 PM&#10;Subject: Reminder - Call attending w/results&#10;Actions: Reminder - Call attending w/results&#10;   &#10;Reminder Comments:&#10;Lab Results:Date&#10;Result Name&#10;Ind&#10;Value&#10;Ref Range&#10;3/17/16, 1:13 PM&#10;Lipase Lvl&#10;NORMAL&#10;55&#10;(&lt;=200)</pre><p><b>Author</b>: Who, Doctor</p><p><b>Effective Date/Time</b>: 2016-03-17T13:19:56-05:00</p></div>"
        },
        "subject": {
          "reference": "Patient/1316020",
          "display": "Houde, Test 1"
        },
        "status": "completed",
        "context": {
          "reference": "Encounter/3261906"
        },
        "period": {
          "end": "2016-03-17T13:19:56-05:00"
        },
        "author": [
          {
            "reference": "Practitioner/2048007",
            "display": "Who, Doctor"
          }
        ],
        "modified": "2016-03-17T13:20:05-05:00",
        "category": [
          {
            "coding": [
              {
                "system": "http://argonaut.hl7.org",
                "code": "assess-plan"
              }
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/CarePlan/5673293",
      "resource": {
        "resourceType": "CarePlan",
        "id": "5673293",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2015-12-04T15:11:52-06:00"
        },
        "text": {
          "status": "additional",
          "div": "<div><p><b>Care Plan</b></p><p><b>Patient</b>: Houde, Test 1</p><p><b>Description</b>:</p><pre>Chief Complaint&#10;History of Present Illness&#10;Hpi&#10;Review of Systems&#10;Problem List/Past Medical History&#10;Ongoing&#10;ACAD&#10;Diabetes&#10;Diabetes mellitus&#10;Diabetes resolved&#10;Fish sting&#10;Kidney abscess&#10;Migraine&#10;Pneumonia&#10;Pregnant&#10;Pyogenic Arthritis Involving Multiple Sites&#10;Rheumatoid Arthritis&#10;Resolved&#10;Dukes stage finding&#10;Kinetic tremor&#10;Minimal shared activities&#10;Side lying&#10;Procedure/Surgical History&#10;Influenza (split virion) vaccine injection suspension 0.5mL prefilled syringe (2015),&#10;Influenza (split virion) vaccine injection suspension 0.5mL prefilled syringe (09/16/2014),&#10;Influenza A (H1N1) virus (2007),&#10;Knee abrasion.&#10;Medications&#10;amoxicillin 125 mg oral tablet, chewable, 12.5 mg/kg, Ear-Left, TID, PRN&#10;aspirin 325 mg oral tablet, 1 tabs, Oral, Daily, PRN&#10;Claritin 10 mg oral tablet, 1 tabs, Oral, Daily, PRN&#10;Claritin 10 mg oral tablet, 1 tabs, Oral, Daily, PRN&#10;Claritin 10 mg oral tablet, 1 tabs, Oral, Daily, 10 refills&#10;Ibu 800 mg oral tablet, 1 tabs, Oral, TID, PRN&#10;Lipitor 10 mg oral tablet, 1 tabs, Oral, Daily, PRN&#10;Lipitor 10 mg oral tablet, 1 tabs, Oral, Daily, PRN&#10;Lipitor 10 mg oral tablet, 1 tabs, Oral, Daily, PRN&#10;Nyquil Liquicap oral capsule, 1 tabs, Oral, 1-2x/Day, 11 refills&#10;Allergies&#10;Neupogen (Papular rash)&#10;anti-inhibitor coagulant complex (Anaphylaxis, Apnea, Cardiac arrest)&#10;Grass (Barsony-Teschendorf syndrome)&#10;Peanuts&#10;Hilar lymph node (High)&#10;penicillins&#10;temazepam&#10;Social History&#10;Alcohol - Low Risk&#10;Current, Liquor, Several times per day, Alcohol use interferes with work or home: No. Drinks more than intended: Yes.&#10;Employment/School - Low Risk&#10;Exercise - Regular exercise&#10;Exercise frequency: 3-4 times/week. Self assessment: Good condition. Exercise type: Running, Swimming, Yoga.&#10;Home/Environment - Low Risk&#10;Nutrition/Health - Low Risk&#10;Other - No Risk&#10;Sexual - Low Risk&#10;Substance Abuse - Low Risk&#10;Current, Cocaine, Methamphetamines, 1-2 times per year, Previous treatment: None. Started age 18 Years. IV drug use: No. Drug use interferes with work/home: No. Ready to change: Yes. Household substance abuse concerns: No.&#10;Tobacco - Low Risk&#10;Current every day smoker, Cigarettes, Cigars, Oral, Started age 18 Years. Previous treatment: Counseling, Hypnosis. Household tobacco concerns: Yes. Packs a Year 7.&#10;Family History&#10;Daughter &#10;     Tib-fib&#10;Sister &#10;     Drug addiction&#10;Father  ( Zinedine Zidane )&#10;     Alcoholism&#10;     Depression&#10;     Drug addiction&#10;Mother  ( CombineTo Houde )&#10;     Depression&#10;Brother &#10;     Depression&#10;Patient was Adopted&#10;Immunizations&#10;Physical Exam&#10;Vitals &amp; Measurements&#10;Lab Results&#10;Diagnostic Results&#10;Assessment/Plan&#10;Community acquired pneumonia&#10;Diabetes mellitus&#10;Fracture of arm&#10;Rheumatoid Arthritis</pre><p><b>Author</b>: Song, River</p><p><b>Effective Date/Time</b>: 2015-12-04T15:11:30-06:00</p></div>"
        },
        "subject": {
          "reference": "Patient/1316020",
          "display": "Houde, Test 1"
        },
        "status": "completed",
        "context": {
          "reference": "Encounter/3261906"
        },
        "period": {
          "end": "2015-12-04T15:11:30-06:00"
        },
        "author": [
          {
            "reference": "Practitioner/1628008",
            "display": "Song, River"
          }
        ],
        "modified": "2015-12-04T15:11:52-06:00",
        "category": [
          {
            "coding": [
              {
                "system": "http://argonaut.hl7.org",
                "code": "assess-plan"
              }
            ]
          }
        ]
      }
    }
  ]
}

Example retrieve care teams

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/CarePlan?patient=4734007&category=careteam

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "4b27e0a6-6e5a-4785-9cc7-d4749388a518",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/CarePlan?patient=4734007&category=careteam"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/CarePlan/L4734007",
      "resource": {
        "resourceType": "CarePlan",
        "id": "L4734007",
        "meta": {
          "versionId": "4734007",
          "lastUpdated": "2017-10-21T00:29:49Z"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Care Team</b></p><p><b>Patient</b>: Smart, Matt</p><p><b>Status</b>: active</p><p></p><p><b>Name</b>: Who, Doctor</p><p><b>Role</b>: PCTAUT PRIV LIFETIME PPR</p><p></p><p><b>Name</b>: UTD, PW</p><p><b>Role</b>: PCTAUT PRIV LIFETIME PPR</p><p></p><p><b>Name</b>: Smart, Martha</p><p><b>Role</b>: Spouse</p><p><b>Category</b>: careteam</p></div>"
        },
        "contained": [
          {
            "resourceType": "RelatedPerson",
            "id": "#2",
            "patient": {
              "reference": "Patient/4734007",
              "display": "Smart, Matt"
            },
            "name": {
              "use": "usual",
              "text": "Smart, Martha"
            },
            "telecom": [
              {
                "system": "phone",
                "value": "8162345678",
                "use": "home"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/4734007",
          "display": "Smart, Matt"
        },
        "status": "active",
        "modified": "2017-10-21T00:29:49Z",
        "category": [
          {
            "coding": [
              {
                "system": "http://argonaut.hl7.org",
                "code": "careteam"
              }
            ]
          }
        ],
        "participant": [
          {
            "member": {
              "reference": "Practitioner/4474007",
              "display": "Who, Doctor"
            },
            "role": {
              "text": "PCTAUT PRIV LIFETIME PPR"
            }
          },
          {
            "member": {
              "reference": "Practitioner/4496007",
              "display": "UTD, PW"
            },
            "role": {
              "text": "PCTAUT PRIV LIFETIME PPR"
            }
          },
          {
            "member": {
              "reference": "#2",
              "display": "Smart, Martha"
            },
            "role": {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "127848009",
                  "display": "Spouse (person)",
                  "userSelected": true
                }
              ],
              "text": "Spouse"
            }
          }
        ]
      }
    }
  ]
}

Errors

The common errors may be returned.

Retrieve by id

List an individual CarePlan by its id:

GET /CarePlan/:id

Authorization Types

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/CarePlan/6017316

Response

Status: 200 OK
{
  "resourceType": "CarePlan",
  "id": "6017316",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2016-03-17T16:32:29-05:00"
  },
  "text": {
    "status": "additional",
    "div": "<div><p><b>Care Plan</b></p><p><b>Patient</b>: Houde, Test 1</p><p><b>Description</b>:</p><pre>Assessment/Plan&#10;Community acquired pneumonia&#10;Diabetes mellitus&#10;Fracture of arm&#10;Rheumatoid Arthritis&#10;Subjective&#10;Review of Systems&#10;Objective&#10;Vitals & Measurements&#10;Physical Exam&#10;Lab Results&#10;Diagnostic Results</pre><p><b>Author</b>: Who, Doctor</p><p><b>Effective Date/Time</b>: 2016-03-17T16:32:23-05:00</p></div>"
  },
  "subject": {
    "reference": "Patient/1316020",
    "display": "Houde, Test 1"
  },
  "status": "completed",
  "context": {
    "reference": "Encounter/3261906"
  },
  "period": {
    "end": "2016-03-17T16:32:23-05:00"
  },
  "author": [
    {
      "reference": "Practitioner/2048007",
      "display": "Who, Doctor"
    }
  ],
  "modified": "2016-03-17T16:32:29-05:00",
  "category": [
    {
      "coding": [
        {
          "system": "http://argonaut.hl7.org",
          "code": "assess-plan"
        }
      ]
    }
  ]
}

Errors

The common errors may be returned.