CarePlan - FHIR Resource (stu3)


This CarePlan Resource uses the FHIR API standard for access and structure.

Validate an CarePlan FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
activitytrueData Type# Action to occur as part of plan
addressestrueReference# Health issues this plan addresses
authortrueReference# "author" : [{ Reference(Patient|Practitioner|RelatedPerson|Organization|
basedOntrueReference# Fulfills care plan
careTeamtrueReference# Who's involved in plan?
categorytrueCodeableConcept# Type of plan
contextfalseReference# Created in context of
definitiontrueReference# Protocol or definition
descriptionfalsestring# Summary of nature of plan
goaltrueReference# Desired outcome of plan
identifiertrueIdentifier# External Ids for this plan
intentfalsecode# proposal | plan | order | option
notetrueAnnotation# Comments about the plan
partOftrueReference# Part of referenced CarePlan
periodfalsePeriod# Time period plan covers
replacestrueReference# CarePlan replaced by this CarePlan
statusfalsecode# draft | active | suspended | completed | entered-in-error | cancelled | unknown
subjectfalseReference# Who care plan is for
supportingInfotrueReference# Information considered as part of plan
titlefalsestring# Human-friendly name for the CarePlan

CarePlan Example

{
  "status": "active",
  "definition": [
    {
      "display": "A PlanDefinition protocol for obesity"
    }
  ],
  "replaces": [
    {
      "display": "Plan from urgent care clinic"
    }
  ],
  "addresses": [
    {
      "display": "obesity",
      "reference": "#p1"
    }
  ],
  "description": "Manage obesity and weight loss",
  "category": [
    {
      "text": "Weight management plan"
    }
  ],
  "author": [
    {
      "display": "Dr Adam Careful",
      "reference": "Practitioner/example"
    }
  ],
  "resourceType": "CarePlan",
  "text": {
    "status": "additional",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p> A simple care plan to indicate a patient taking their weight once a day because of obesity.</p>\n    </div>"
  },
  "goal": [
    {
      "reference": "Goal/example"
    }
  ],
  "basedOn": [
    {
      "display": "Management of Type 2 Diabetes"
    }
  ],
  "period": {
    "end": "2017-06-01"
  },
  "contained": [
    {
      "code": {
        "text": "Obesity"
      },
      "resourceType": "Condition",
      "id": "p1",
      "clinicalStatus": "active",
      "verificationStatus": "confirmed",
      "subject": {
        "display": "Peter James Chalmers",
        "reference": "Patient/example"
      }
    }
  ],
  "intent": "plan",
  "context": {
    "reference": "Encounter/home"
  },
  "activity": [
    {
      "outcomeCodeableConcept": [
        {
          "coding": [
            {
              "code": "161832001",
              "system": "http://snomed.info/sct",
              "display": "Progressive weight loss"
            }
          ]
        }
      ],
      "outcomeReference": [
        {
          "display": "Weight Measured",
          "reference": "Observation/example"
        }
      ],
      "detail": {
        "category": {
          "coding": [
            {
              "code": "observation",
              "system": "http://hl7.org/fhir/care-plan-activity-category"
            }
          ]
        },
        "status": "completed",
        "code": {
          "coding": [
            {
              "code": "3141-9",
              "system": "http://loinc.org",
              "display": "Weight Measured"
            },
            {
              "code": "27113001",
              "system": "http://snomed.info/sct",
              "display": "Body weight"
            }
          ]
        },
        "statusReason": "Achieved weight loss to mitigate diabetes risk.",
        "performer": [
          {
            "display": "Peter James Chalmers",
            "reference": "Patient/example"
          }
        ],
        "prohibited": false,
        "location": {
          "display": "Patient's home"
        },
        "scheduledTiming": {
          "repeat": {
            "frequency": 1,
            "periodUnit": "d",
            "period": 1
          }
        }
      }
    }
  ],
  "careTeam": [
    {
      "reference": "CareTeam/example"
    }
  ],
  "identifier": [
    {
      "value": "12345"
    }
  ],
  "id": "example",
  "partOf": [
    {
      "display": "Overall wellness plan"
    }
  ],
  "subject": {
    "display": "Peter James Chalmers",
    "reference": "Patient/example"
  }
}

CarePlan Structure


  
{
  "resourceType" : "CarePlan",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this plan
  "definition" : [{ Reference(PlanDefinition|Questionnaire) }], // Protocol or definition
  "basedOn" : [{ Reference(CarePlan) }], // Fulfills care plan
  "replaces" : [{ Reference(CarePlan) }], // CarePlan replaced by this CarePlan
  "partOf" : [{ Reference(CarePlan) }], // Part of referenced CarePlan
  "status" : "<code>", // R!  draft | active | suspended | completed | entered-in-error | cancelled | unknown
  "intent" : "<code>", // R!  proposal | plan | order | option
  "category" : [{ CodeableConcept }], // Type of plan
  "title" : "<string>", // Human-friendly name for the CarePlan
  "description" : "<string>", // Summary of nature of plan
  "subject" : { Reference(Patient|Group) }, // R!  Who care plan is for
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Created in context of
  "period" : { Period }, // Time period plan covers
  "author" : [{ Reference(Patient|Practitioner|RelatedPerson|Organization|
   CareTeam) }], // Who is responsible for contents of the plan
  "careTeam" : [{ Reference(CareTeam) }], // Who's involved in plan?
  "addresses" : [{ Reference(Condition) }], // Health issues this plan addresses
  "supportingInfo" : [{ Reference(Any) }], // Information considered as part of plan
  "goal" : [{ Reference(Goal) }], // Desired outcome of plan
  "activity" : [{ // Action to occur as part of plan
    "outcomeCodeableConcept" : [{ CodeableConcept }], // Results of the activity
    "outcomeReference" : [{ Reference(Any) }], // Appointment, Encounter, Procedure, etc.
    "progress" : [{ Annotation }], // Comments about the activity status/progress
    "reference" : { Reference(Appointment|CommunicationRequest|DeviceRequest|
    MedicationRequest|NutritionOrder|Task|ProcedureRequest|ReferralRequest|
    VisionPrescription|RequestGroup) }, // C? Activity details defined in specific resource
    "detail" : { // C? In-line definition of activity
      "category" : { CodeableConcept }, // diet | drug | encounter | observation | procedure | supply | other
      "definition" : { Reference(PlanDefinition|ActivityDefinition|
     Questionnaire) }, // Protocol or definition
      "code" : { CodeableConcept }, // Detail type of activity
      "reasonCode" : [{ CodeableConcept }], // Why activity should be done or why activity was prohibited
      "reasonReference" : [{ Reference(Condition) }], // Condition triggering need for activity
      "goal" : [{ Reference(Goal) }], // Goals this activity relates to
      "status" : "<code>", // R!  not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown
      "statusReason" : "<string>", // Reason for current status
      "prohibited" : <boolean>, // Do NOT do
      // scheduled[x]: When activity is to occur. One of these 3:
      "scheduledTiming" : { Timing },
      "scheduledPeriod" : { Period },
      "scheduledString" : "<string>",
      "location" : { Reference(Location) }, // Where it should happen
      "performer" : [{ Reference(Practitioner|Organization|RelatedPerson|Patient|
     CareTeam) }], // Who will be responsible?
      // product[x]: What is to be administered/supplied. One of these 2:
      "productCodeableConcept" : { CodeableConcept },
      "productReference" : { Reference(Medication|Substance) },
      "dailyAmount" : { Quantity(SimpleQuantity) }, // How to consume/day?
      "quantity" : { Quantity(SimpleQuantity) }, // How much to administer/supply/consume
      "description" : "<string>" // Extra info describing activity to perform
    }
  }],
  "note" : [{ Annotation }] // Comments about the plan
}


 

CarePlan Search Parameters

The following search parameters can be used to query CarePlan resources. Just submit the like so:

https://api.1up.health/fhir/stu3/CarePlan?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
activity-codetextactivity.detail.code
activity-datedateactivity.detail.scheduled
activity-referencereferenceactivity.reference
based-onreferencebasedOn
care-teamreferencecareTeam
categorytextcategory
conditionreferenceaddresses
contextreferencecontext
datedateperiod
definitionreferencedefinition
encounterreferencecontext
goalreferencegoal
identifiertextidentifier
intenttextintent
part-ofreferencepartOf
patientreferencesubject
performerreferenceactivity.detail.performer
replacesreferencereplaces
statustextstatus
subjectreferencesubject