CarePlan - FHIR Resource (dstu2)


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

Validate an CarePlan FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
activitytrueData Type# Action to occur as part of plan
addressestrueReference# Health issues this plan addresses
authortrueReference# Who is responsible for contents of the plan
categorytrueCodeableConcept# Type of plan
contextfalseReference# Created in context of
descriptionfalsestring# Summary of nature of plan
goaltrueReference# Desired outcome of plan
identifiertrueIdentifier# External Ids for this plan
modifiedfalsedateTime# When last updated
notefalseAnnotation# Comments about the plan
participanttrueData Type# Who's involved in plan?
periodfalsePeriod# Time period plan covers
relatedPlantrueData Type# Plans related to this one
statusfalsecode# proposed | draft | active | completed | cancelled
subjectfalseReference# Who care plan is for
supporttrueReference# Information considered as part of plan

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
  "subject" : { Reference(Patient|Group) }, // Who care plan is for
  "status" : "<code>", // R!  proposed | draft | active | completed | cancelled
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Created in context of
  "period" : { Period }, // Time period plan covers
  "author" : [{ Reference(Patient|Practitioner|RelatedPerson|Organization) }], // Who is responsible for contents of the plan
  "modified" : "<dateTime>", // When last updated
  "category" : [{ CodeableConcept }], // Type of plan
  "description" : "<string>", // Summary of nature of plan
  "addresses" : [{ Reference(Condition) }], // Health issues this plan addresses
  "support" : [{ Reference(Any) }], // Information considered as part of plan
  "relatedPlan" : [{ // Plans related to this one
    "code" : "<code>", // includes | replaces | fulfills
    "plan" : { Reference(CarePlan) } // R!  Plan relationship exists with
  }],
  "participant" : [{ // Who's involved in plan?
    "role" : { CodeableConcept }, // Type of involvement
    "member" : { Reference(Practitioner|RelatedPerson|Patient|Organization) } // Who is involved
  }],
  "goal" : [{ Reference(Goal) }], // Desired outcome of plan
  "activity" : [{ // Action to occur as part of plan
    "actionResulting" : [{ Reference(Any) }], // Appointments, orders, etc.
    "progress" : [{ Annotation }], // Comments about the activity status/progress
    "reference" : { Reference(Appointment|CommunicationRequest|
    DeviceUseRequest|DiagnosticOrder|MedicationOrder|NutritionOrder|Order|
    ProcedureRequest|ProcessRequest|ReferralRequest|SupplyRequest|
    VisionPrescription) }, // C? Activity details defined in specific resource
    "detail" : { // C? In-line definition of activity
      "category" : { CodeableConcept }, // diet | drug | encounter | observation | procedure | supply | other
      "code" : { CodeableConcept }, // Detail type of activity
      "reasonCode" : [{ CodeableConcept }], // Why activity should be done
      "reasonReference" : [{ Reference(Condition) }], // Condition triggering need for activity
      "goal" : [{ Reference(Goal) }], // Goals this activity relates to
      "status" : "<code>", // not-started | scheduled | in-progress | on-hold | completed | cancelled
      "statusReason" : { CodeableConcept }, // Reason for current status
      "prohibited" : <boolean>, // R!  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) }], // 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/dstu2/CarePlan?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
activitycodetextactivity.detail.code
activitydatedateactivity.detail.scheduled[x]
activityreferencereferenceactivity.reference
conditionreferenceaddresses
datedateperiod
goalreferencegoal
participantreferenceparticipant.member
patientreferencesubject
performerreferenceactivity.detail.performer
relatedcomposite
relatedcodetextrelatedPlan.code
relatedplanreferencerelatedPlan.plan
subjectreferencesubject