CarePlan - FHIR Resource (r4)
This CarePlan Resource uses the FHIR API standard for access and structure.
Validate an CarePlan FHIR Resource (r4)
CarePlan Attributes
AttributeField is listTypeDescription
Description: External Ids for this plan
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"value": "12345"
}
]Learn more about the (CarePlan) identifier FHIR attribute
Description: "instantiatesCanonical" : [{ canonical(PlanDefinition|Questionnaire|Measure|
FHIR Version: r4
Attribute Type : canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesCanonical": Learn more about the (CarePlan) instantiatesCanonical FHIR attribute
Description: Instantiates external protocol or definition
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesUri": [
"http://example.org/protocol-for-obesity"
]Learn more about the (CarePlan) instantiatesUri FHIR attribute
Description: Fulfills CarePlan
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"basedOn": [
{
"display": "Management of Type 2 Diabetes"
}
]Learn more about the (CarePlan) basedOn FHIR attribute
Description: CarePlan replaced by this CarePlan
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"replaces": [
{
"display": "Plan from urgent care clinic"
}
]Learn more about the (CarePlan) replaces FHIR attribute
Description: Part of referenced CarePlan
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partOf": [
{
"display": "Overall wellness plan"
}
]Learn more about the (CarePlan) partOf FHIR attribute
Description: draft | active | on-hold | revoked | completed | entered-in-error | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (CarePlan) status FHIR attribute
Description: proposal | plan | order | option
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"intent": "plan"Learn more about the (CarePlan) intent FHIR attribute
Description: Type of plan
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": [
{
"text": "Weight management plan"
}
]Learn more about the (CarePlan) category FHIR attribute
Description: Human-friendly name for the care plan
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": Learn more about the (CarePlan) title FHIR attribute
Description: Summary of nature of plan
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "Manage obesity and weight loss"Learn more about the (CarePlan) description FHIR attribute
Description: Who the care plan is for
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example",
"display": "Peter James Chalmers"
}Learn more about the (CarePlan) subject FHIR attribute
Description: Encounter created as part of
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": {
"reference": "Encounter/home"
}Learn more about the (CarePlan) encounter FHIR attribute
Description: Time period plan covers
FHIR Version: r4
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": {
"end": "2017-06-01"
}Learn more about the (CarePlan) period FHIR attribute
Description: Date record was first recorded
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"created": "2016-01-01"Learn more about the (CarePlan) created FHIR attribute
Description: "author" : { Reference(Patient|Practitioner|PractitionerRole|Device|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"author": {
"reference": "Practitioner/example",
"display": "Dr Adam Careful"
}Learn more about the (CarePlan) author FHIR attribute
Description: "contributor" : [{ Reference(Patient|Practitioner|PractitionerRole|Device|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contributor": Learn more about the (CarePlan) contributor FHIR attribute
Description: Who's involved in plan?
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"careTeam": [
{
"reference": "CareTeam/example"
}
]Learn more about the (CarePlan) careTeam FHIR attribute
Description: Health issues this plan addresses
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"addresses": [
{
"reference": "#p1",
"display": "obesity"
}
]Learn more about the (CarePlan) addresses FHIR attribute
Description: Information considered as part of plan
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supportingInfo": Learn more about the (CarePlan) supportingInfo FHIR attribute
Description: Desired outcome of plan
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"goal": [
{
"reference": "Goal/example"
}
]Learn more about the (CarePlan) goal FHIR attribute
Description: Action to occur as part of plan
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
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"
}
]
}
}
]Learn more about the (CarePlan) activity FHIR attribute
Description: Comments about the plan
FHIR Version: r4
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (CarePlan) note FHIR attribute
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 Parameter | Field Type | Resource Fields Searched |
|---|---|---|
activity-code | text | activity.detail.code |
activity-date | date | activity.detail.scheduled |
activity-reference | reference | activity.reference |
based-on | reference | basedOn |
care-team | reference | careTeam |
category | text | category |
condition | reference | addresses |
date | date | period |
encounter | reference | encounter |
goal | reference | goal |
identifier | text | identifier |
instantiates-canonical | reference | instantiatesCanonical |
instantiates-uri | uri | instantiatesUri |
intent | text | intent |
part-of | reference | partOf |
patient | reference | subject.where |
performer | reference | activity.detail.performer |
replaces | reference | replaces |
status | text | status |
subject | reference | subject |
