CarePlan - FHIR Resource (r4)


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

Validate an CarePlan FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
activitytrueData Type# Action to occur as part of plan
addressestrueReference# Health issues this plan addresses
authorfalseReference# "author" : { Reference(Patient|Practitioner|PractitionerRole|Device|
basedOntrueReference# Fulfills CarePlan
careTeamtrueReference# Who's involved in plan?
categorytrueCodeableConcept# Type of plan
contributortrueReference# "contributor" : [{ Reference(Patient|Practitioner|PractitionerRole|Device|
createdfalsedateTime# Date record was first recorded
descriptionfalsestring# Summary of nature of plan
encounterfalseReference# Encounter created as part of
goaltrueReference# Desired outcome of plan
identifiertrueIdentifier# External Ids for this plan
instantiatesCanonicaltruecanonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)# "instantiatesCanonical" : [{ canonical(PlanDefinition|Questionnaire|Measure|
instantiatesUritrueuri# Instantiates external protocol or definition
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 | on-hold | revoked | completed | entered-in-error | unknown
subjectfalseReference# Who the care plan is for
supportingInfotrueReference# Information considered as part of plan
titlefalsestring# Human-friendly name for the care plan

CarePlan Example

{
  "resourceType": "CarePlan",
  "id": "example",
  "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>"
  },
  "contained": [
    {
      "resourceType": "Condition",
      "id": "p1",
      "clinicalStatus": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
            "code": "active"
          }
        ]
      },
      "verificationStatus": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
            "code": "confirmed"
          }
        ]
      },
      "code": {
        "text": "Obesity"
      },
      "subject": {
        "reference": "Patient/example",
        "display": "Peter James Chalmers"
      }
    }
  ],
  "identifier": [
    {
      "value": "12345"
    }
  ],
  "instantiatesUri": [
    "http://example.org/protocol-for-obesity"
  ],
  "basedOn": [
    {
      "display": "Management of Type 2 Diabetes"
    }
  ],
  "replaces": [
    {
      "display": "Plan from urgent care clinic"
    }
  ],
  "partOf": [
    {
      "display": "Overall wellness plan"
    }
  ],
  "status": "active",
  "intent": "plan",
  "category": [
    {
      "text": "Weight management plan"
    }
  ],
  "description": "Manage obesity and weight loss",
  "subject": {
    "reference": "Patient/example",
    "display": "Peter James Chalmers"
  },
  "encounter": {
    "reference": "Encounter/home"
  },
  "period": {
    "end": "2017-06-01"
  },
  "created": "2016-01-01",
  "author": {
    "reference": "Practitioner/example",
    "display": "Dr Adam Careful"
  },
  "careTeam": [
    {
      "reference": "CareTeam/example"
    }
  ],
  "addresses": [
    {
      "reference": "#p1",
      "display": "obesity"
    }
  ],
  "goal": [
    {
      "reference": "Goal/example"
    }
  ],
  "activity": [
    {
      "outcomeCodeableConcept": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "161832001",
              "display": "Progressive weight loss"
            }
          ]
        }
      ],
      "outcomeReference": [
        {
          "reference": "Observation/example",
          "display": "Weight Measured"
        }
      ],
      "detail": {
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "3141-9",
              "display": "Weight Measured"
            },
            {
              "system": "http://snomed.info/sct",
              "code": "27113001",
              "display": "Body weight"
            }
          ]
        },
        "status": "completed",
        "statusReason": {
          "text": "Achieved weight loss to mitigate diabetes risk."
        },
        "doNotPerform": false,
        "scheduledTiming": {
          "repeat": {
            "frequency": 1,
            "period": 1,
            "periodUnit": "d"
          }
        },
        "location": {
          "display": "Patient's home"
        },
        "performer": [
          {
            "reference": "Patient/example",
            "display": "Peter James Chalmers"
          }
        ]
      }
    }
  ]
}

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
  "instantiatesCanonical" : [{ canonical(PlanDefinition|Questionnaire|Measure|
   ActivityDefinition|OperationDefinition) }], // Instantiates FHIR protocol or definition
  "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
  "basedOn" : [{ Reference(CarePlan) }], // Fulfills CarePlan
  "replaces" : [{ Reference(CarePlan) }], // CarePlan replaced by this CarePlan
  "partOf" : [{ Reference(CarePlan) }], // Part of referenced CarePlan
  "status" : "<code>", // R!  draft | active | on-hold | revoked | completed | entered-in-error | unknown
  "intent" : "<code>", // R!  proposal | plan | order | option
  "category" : [{ CodeableConcept }], // Type of plan
  "title" : "<string>", // Human-friendly name for the care plan
  "description" : "<string>", // Summary of nature of plan
  "subject" : { Reference(Patient|Group) }, // R!  Who the care plan is for
  "encounter" : { Reference(Encounter) }, // Encounter created as part of
  "period" : { Period }, // Time period plan covers
  "created" : "<dateTime>", // Date record was first recorded
  "author" : { Reference(Patient|Practitioner|PractitionerRole|Device|
   RelatedPerson|Organization|CareTeam) }, // Who is the designated responsible party
  "contributor" : [{ Reference(Patient|Practitioner|PractitionerRole|Device|
   RelatedPerson|Organization|CareTeam) }], // Who provided the content of the care 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|ServiceRequest|VisionPrescription|
    RequestGroup) }, // C? Activity details defined in specific resource
    "detail" : { // C? In-line definition of activity
      "kind" : "<code>", // Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
      "instantiatesCanonical" : [{ canonical(PlanDefinition|ActivityDefinition|
     Questionnaire|Measure|OperationDefinition) }], // Instantiates FHIR protocol or definition
      "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
      "code" : { CodeableConcept }, // Detail type of activity
      "reasonCode" : [{ CodeableConcept }], // Why activity should be done or why activity was prohibited
      "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
     DocumentReference) }], // Why activity is needed
      "goal" : [{ Reference(Goal) }], // Goals this activity relates to
      "status" : "<code>", // R!  not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
      "statusReason" : { CodeableConcept }, // Reason for current status
      "doNotPerform" : <boolean>, // If true, activity is prohibiting action
      // 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|PractitionerRole|Organization|
     RelatedPerson|Patient|CareTeam|HealthcareService|Device) }], // 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 them like so:

https://api.1up.health/fhir/r4/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
datedateperiod
encounterreferenceencounter
goalreferencegoal
identifiertextidentifier
instantiates-canonicalreferenceinstantiatesCanonical
instantiates-uriuriinstantiatesUri
intenttextintent
part-ofreferencepartOf
patientreferencesubject.where
performerreferenceactivity.detail.performer
replacesreferencereplaces
statustextstatus
subjectreferencesubject