The CarePlan resource implements the FHIR R4 CarePlan specification and US Core v3.1.1 CarePlan profile

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*    
subject ResourceReference 0..1    
status string 1..1   draft | active | on-hold | revoked | completed | entered-in-error | unknown - ValueSet
period Period 0..1    
modified dateTime 0..1    
addresses ResourceReference 0..*    
careTeam CarePlan.Participant 0..*    
goal ResourceReference 0..*    
activity CarePlan.Activity 0..*    
notes string 0..1    
category CodeableConcept 1..* * Type of plan - always has at least one coding with system=http://hl7.org/fhir/us/core/CodeSystem/careplan-category, code=assess-plan
encounter ResourceReference 0..1    
intent code 1..1 * proposal | plan | order | option - ValueSet
text Narrative 1..1 *  
text.status code 1..1 * generated | extensions | additional | empty - ValueSet

Interactions

Read

Get a CarePlan entry by id

GET /CarePlan/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/CarePlan/fece8076-bfb7-5ae5-8a2b-5b4bfe8d145c

Response

{
  "resourceType": "CarePlan",
  "subject": {
    "reference": "Patient/bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2"
  },
  "status": "completed",
  "period": {
    "start": "1949-06-17T00:10:44-05:00",
    "end": "1949-12-20T23:56:44-05:00"
  },
  "addresses": [
    {
      "reference": "Condition/6f20a5e3-0f15-a28c-bf72-901f5e2f2bf9"
    }
  ],
  "careTeam": [
    {
      "reference": "CareTeam/38977764-07eb-37c8-4231-91cf77fb95ca"
    }
  ],
  "activity": [
    {
      "detail": {
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "304510005",
              "display": "Recommendation to avoid exercise"
            }
          ],
          "text": "Recommendation to avoid exercise"
        },
        "status": "completed",
        "location": {
          "reference": "Location/80e11f9b-dff5-3ffe-7b86-badb7cb41ad0",
          "display": "BETH ISRAEL DEACONESS HOSPITAL - PLYMOUTH"
        },
        "doNotPerform": false
      }
    },
    {
      "detail": {
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "371605008",
              "display": "Deep breathing and coughing exercises"
            }
          ],
          "text": "Deep breathing and coughing exercises"
        },
        "status": "completed",
        "location": {
          "reference": "Location/80e11f9b-dff5-3ffe-7b86-badb7cb41ad0",
          "display": "BETH ISRAEL DEACONESS HOSPITAL - PLYMOUTH"
        },
        "doNotPerform": false
      }
    }
  ],
  "category": [
    {
      "coding": [
        {
          "code": "assess-plan",
          "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category"
        }
      ]
    },
    {
      "coding": [
        {
          "code": "53950000",
          "system": "http://snomed.info/sct",
          "display": "Respiratory therapy"
        }
      ],
      "text": "Respiratory therapy"
    }
  ],
  "intent": "order",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
  },
  "id": "fece8076-bfb7-5ae5-8a2b-5b4bfe8d145c"
}

Query CarePlan resources

GET /CarePlan?:query_parameters

Parameters

Name Type Description
activity-code token  
activity-date date  
activity-reference reference  
based-on reference  
care-team reference  
category token  
condition reference  
date date  
encounter reference  
goal reference  
identifier token  
intent token  
part-of reference  
patient reference  
performer reference  
replaces reference  
status token  
subject reference  
_revinclude   Provenance:target

Example

Request

https://r4cert.medicasoft.us/api/fhir/CarePlan?category=assess-plan&patient=bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2

Errors

Code Description
400 Invalid parameters
404 Resource not found