CarePlan - FHIR Resource (dstu2)
This CarePlan Resource uses the FHIR API standard for access and structure.
Validate an CarePlan FHIR Resource (dstu2)
CarePlan Attributes
AttributeField is listTypeDescription
Description: proposed | draft | active | completed | cancelled
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (CarePlan) status FHIR attribute
Description: Type of plan
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": Learn more about the (CarePlan) category FHIR attribute
Description: Who's involved in plan?
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"participant": Learn more about the (CarePlan) participant FHIR attribute
Description: Desired outcome of plan
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"goal": Learn more about the (CarePlan) goal FHIR attribute
Description: Who is responsible for contents of the plan
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"author": Learn more about the (CarePlan) author FHIR attribute
Description: Summary of nature of plan
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (CarePlan) description FHIR attribute
Description: Plans related to this one
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relatedPlan": Learn more about the (CarePlan) relatedPlan FHIR attribute
Description: Who care plan is for
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": Learn more about the (CarePlan) subject FHIR attribute
Description: Time period plan covers
FHIR Version: dstu2
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": Learn more about the (CarePlan) period FHIR attribute
Description: When last updated
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"modified": Learn more about the (CarePlan) modified FHIR attribute
Description: Comments about the plan
FHIR Version: dstu2
Attribute Type : Annotation
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (CarePlan) note FHIR attribute
Description: Created in context of
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"context": Learn more about the (CarePlan) context FHIR attribute
Description: Action to occur as part of plan
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"activity": Learn more about the (CarePlan) activity FHIR attribute
Description: External Ids for this plan
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (CarePlan) identifier FHIR attribute
Description: Information considered as part of plan
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"support": Learn more about the (CarePlan) support FHIR attribute
Description: Health issues this plan addresses
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"addresses": Learn more about the (CarePlan) addresses FHIR attribute
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 them like so:
https://api.1up.health/fhir/dstu2/CarePlan?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
activitycode | text | activity.detail.code |
activitydate | date | activity.detail.scheduled[x] |
activityreference | reference | activity.reference |
condition | reference | addresses |
date | date | period |
goal | reference | goal |
participant | reference | participant.member |
patient | reference | subject |
performer | reference | activity.detail.performer |
related | composite | |
relatedcode | text | relatedPlan.code |
relatedplan | reference | relatedPlan.plan |
subject | reference | subject |
