{
"description": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.",
"_filename": "CarePlan.json",
"package_name": "hl7.fhir.r4.id.core",
"date": "2019-11-01T09:29:23+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2022-01-10T02:29:09.318+00:00"
},
"publisher": "Health Level Seven International (Patient Care)",
"fhirVersion": "4.0.1",
"name": "CarePlan",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "CarePlan",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Clinical.Care Provision"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "patient"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pc"
} ],
"status": "draft",
"id": "356791d2-0122-469f-a253-d39fc21ada05",
"kind": "resource",
"url": "https://fhir.kemkes.go.id/r4/StructureDefinition/CarePlan",
"version": "4.0.1",
"differential": {
"element": [ {
"id": "CarePlan",
"path": "CarePlan",
"alias": [ "Care Team" ],
"short": "Healthcare plan for patient or group",
"mapping": [ {
"map": "Request",
"identity": "workflow"
}, {
"map": "Act[classCode=PCPR, moodCode=INT]",
"identity": "rim"
} ],
"definition": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions."
}, {
"path": "CarePlan.identifier",
"requirements": "Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.",
"definition": "Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"short": "External Ids for this plan",
"mapping": [ {
"map": "Request.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "PTH-3",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"id": "CarePlan.identifier",
"comment": "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"isSummary": true
}, {
"id": "CarePlan.instantiatesCanonical",
"path": "CarePlan.instantiatesCanonical",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/Questionnaire", "http://hl7.org/fhir/StructureDefinition/Measure", "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/OperationDefinition" ]
} ],
"short": "Instantiates FHIR protocol or definition",
"mapping": [ {
"map": "Request.instantiatesCanonical",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=DEFN].target",
"identity": "rim"
} ],
"isSummary": true,
"definition": "The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan."
}, {
"id": "CarePlan.instantiatesUri",
"path": "CarePlan.instantiatesUri",
"type": [ {
"code": "uri"
} ],
"short": "Instantiates external protocol or definition",
"comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"mapping": [ {
"map": "Request.instantiatesUri",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=DEFN].target",
"identity": "rim"
} ],
"isSummary": true,
"definition": "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan."
}, {
"path": "CarePlan.basedOn",
"requirements": "Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.",
"definition": "A care plan that is fulfilled in whole or in part by this care plan.",
"short": "Fulfills CarePlan",
"mapping": [ {
"map": "Request.basedOn",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": true
} ],
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan" ]
} ],
"alias": [ "fulfills" ],
"id": "CarePlan.basedOn",
"isSummary": true
}, {
"path": "CarePlan.replaces",
"requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.",
"definition": "Completed or terminated care plan whose function is taken by this new care plan.",
"short": "CarePlan replaced by this CarePlan",
"mapping": [ {
"map": "Request.replaces",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": true
} ],
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan" ]
} ],
"alias": [ "supersedes" ],
"id": "CarePlan.replaces",
"comment": "The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.",
"isSummary": true
}, {
"id": "CarePlan.partOf",
"path": "CarePlan.partOf",
"type": [ {
"code": "Reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": true
} ],
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan" ]
} ],
"short": "Part of referenced CarePlan",
"comment": "Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.",
"isSummary": true,
"definition": "A larger care plan of which this particular care plan is a component or step."
}, {
"path": "CarePlan.status",
"requirements": "Allows clinicians to determine whether the plan is actionable or not.",
"min": 1,
"definition": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"isModifier": true,
"short": "draft | active | on-hold | revoked | completed | entered-in-error | unknown",
"mapping": [ {
"map": "Request.status {uses different ValueSet}",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "PTH-5",
"identity": "v2"
}, {
"map": ".statusCode planned = new active = active completed = completed",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/request-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanStatus"
} ],
"description": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record."
},
"max": "1",
"id": "CarePlan.status",
"comment": "The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.",
"isModifierReason": "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true
}, {
"path": "CarePlan.intent",
"requirements": "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.",
"min": 1,
"definition": "Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.",
"isModifier": true,
"short": "proposal | plan | order | option",
"mapping": [ {
"map": "Request.intent",
"identity": "workflow"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanIntent"
} ],
"description": "Codes indicating the degree of authority/intentionality associated with a care plan."
},
"max": "1",
"id": "CarePlan.intent",
"comment": "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.",
"isModifierReason": "This element changes the interpretation of all descriptive attributes. For example \"the time the request is recommended to occur\" vs. \"the time the request is authorized to occur\" or \"who is recommended to perform the request\" vs. \"who is authorized to perform the request\"",
"isSummary": true
}, {
"path": "CarePlan.category",
"requirements": "Used for filtering what plan(s) are retrieved and displayed to different types of users.",
"definition": "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.",
"short": "Type of plan",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/care-plan-category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanCategory"
} ],
"description": "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", etc."
},
"id": "CarePlan.category",
"comment": "There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.",
"isSummary": true
}, {
"id": "CarePlan.title",
"max": "1",
"path": "CarePlan.title",
"type": [ {
"code": "string"
} ],
"short": "Human-friendly name for the care plan",
"isSummary": true,
"definition": "Human-friendly name for the care plan."
}, {
"path": "CarePlan.description",
"requirements": "Provides more detail than conveyed by category.",
"definition": "A description of the scope and nature of the plan.",
"short": "Summary of nature of plan",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "CarePlan.description",
"isSummary": true
}, {
"path": "CarePlan.subject",
"min": 1,
"definition": "Identifies the patient or group whose intended care is described by the plan.",
"short": "Who the care plan is for",
"mapping": [ {
"map": "Request.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "PID-3",
"identity": "v2"
}, {
"map": ".participation[typeCode=PAT].role[classCode=PAT]",
"identity": "rim"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"alias": [ "patient" ],
"max": "1",
"id": "CarePlan.subject",
"isSummary": true
}, {
"path": "CarePlan.encounter",
"definition": "The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.",
"short": "Encounter created as part of",
"mapping": [ {
"map": "Request.context",
"identity": "workflow"
}, {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "Associated PV1",
"identity": "v2"
}, {
"map": ".",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ]
} ],
"max": "1",
"id": "CarePlan.encounter",
"comment": "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.",
"isSummary": true
}, {
"path": "CarePlan.period",
"requirements": "Allows tracking what plan(s) are in effect at a particular time.",
"definition": "Indicates when the plan did (or is intended to) come into effect and end.",
"short": "Time period plan covers",
"mapping": [ {
"map": "Request.occurrence[x]",
"identity": "workflow"
}, {
"map": "FiveWs.planned",
"identity": "w5"
}, {
"map": "GOL-7 / GOL-8",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"alias": [ "timing" ],
"max": "1",
"id": "CarePlan.period",
"comment": "Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).",
"isSummary": true
}, {
"path": "CarePlan.created",
"definition": "Represents when this particular CarePlan record was created in the system, which is often a system-generated date.",
"short": "Date record was first recorded",
"mapping": [ {
"map": "Request.authoredOn",
"identity": "workflow"
}, {
"map": "FiveWs.recorded",
"identity": "w5"
}, {
"map": ".participation[typeCode=AUT].time",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"alias": [ "authoredOn" ],
"max": "1",
"id": "CarePlan.created",
"isSummary": true
}, {
"path": "CarePlan.author",
"definition": "When populated, the author is responsible for the care plan. The care plan is attributed to the author.",
"short": "Who is the designated responsible party",
"mapping": [ {
"map": "Request.requester",
"identity": "workflow"
}, {
"map": "FiveWs.author",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam" ]
} ],
"max": "1",
"id": "CarePlan.author",
"comment": "The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.",
"isSummary": true
}, {
"id": "CarePlan.contributor",
"path": "CarePlan.contributor",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam" ]
} ],
"short": "Who provided the content of the care plan",
"comment": "Collaborative care plans may have multiple contributors.",
"definition": "Identifies the individual(s) or organization who provided the contents of the care plan."
}, {
"id": "CarePlan.careTeam",
"path": "CarePlan.careTeam",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CareTeam" ]
} ],
"short": "Who's involved in plan?",
"mapping": [ {
"map": "Request.performer {similar but does not entail CareTeam}",
"identity": "workflow"
}, {
"map": "FiveWs.actor",
"identity": "w5"
} ],
"definition": "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.",
"requirements": "Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions."
}, {
"path": "CarePlan.addresses",
"requirements": "Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like \"at risk for hypertension\" or \"fall risk\".) Also scopes plans - multiple plans may exist addressing different concerns.",
"definition": "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.",
"short": "Health issues this plan addresses",
"mapping": [ {
"map": "Request.reasonReference",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "PRB-4",
"identity": "v2"
}, {
"map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition" ]
} ],
"id": "CarePlan.addresses",
"comment": "When the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance.",
"isSummary": true
}, {
"id": "CarePlan.supportingInfo",
"path": "CarePlan.supportingInfo",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"short": "Information considered as part of plan",
"comment": "Use \"concern\" to identify specific conditions addressed by the care plan.",
"mapping": [ {
"map": "Request.supportingInfo",
"identity": "workflow"
} ],
"definition": "Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.",
"requirements": "Identifies barriers and other considerations associated with the care plan."
}, {
"id": "CarePlan.goal",
"path": "CarePlan.goal",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Goal" ]
} ],
"short": "Desired outcome of plan",
"comment": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"mapping": [ {
"map": "GOL.1",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode<=OBJ].",
"identity": "rim"
} ],
"definition": "Describes the intended objective(s) of carrying out the care plan.",
"requirements": "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians."
}, {
"id": "CarePlan.activity",
"path": "CarePlan.activity",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Action to occur as part of plan",
"mapping": [ {
"map": "{no mapping\nNOTE: This is a list of contained Request-Event tuples!}",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=COMP].target",
"identity": "rim"
} ],
"constraint": [ {
"key": "cpl-3",
"human": "Provide a reference or detail, not both",
"xpath": "not(exists(f:detail)) or not(exists(f:reference))",
"source": "http://hl7.org/fhir/StructureDefinition/CarePlan",
"severity": "error",
"expression": "detail.empty() or reference.empty()"
} ],
"definition": "Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.",
"requirements": "Allows systems to prompt for performance of planned activities, and validate plans against best practice."
}, {
"id": "CarePlan.activity.outcomeCodeableConcept",
"path": "CarePlan.activity.outcomeCodeableConcept",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Results of the activity",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/care-plan-activity-outcome",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanActivityOutcome"
} ],
"description": "Identifies the results of the activity."
},
"comment": "Note that this should not duplicate the activity status (e.g. completed or in progress).",
"definition": "Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not)."
}, {
"id": "CarePlan.activity.outcomeReference",
"path": "CarePlan.activity.outcomeReference",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"short": "Appointment, Encounter, Procedure, etc.",
"comment": "The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.",
"mapping": [ {
"map": "{Event that is outcome of Request in activity.reference}",
"identity": "workflow"
}, {
"map": ".inboundRelationship[typeCode=FLFS].source",
"identity": "rim"
} ],
"definition": "Details of the outcome or action resulting from the activity. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).",
"requirements": "Links plan to resulting actions."
}, {
"id": "CarePlan.activity.progress",
"path": "CarePlan.activity.progress",
"type": [ {
"code": "Annotation"
} ],
"short": "Comments about the activity status/progress",
"comment": "This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.",
"mapping": [ {
"map": "NTE?",
"identity": "v2"
}, {
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value",
"identity": "rim"
} ],
"definition": "Notes about the adherence/status/progress of the activity.",
"requirements": "Can be used to capture information about adherence, progress, concerns, etc."
}, {
"path": "CarePlan.activity.reference",
"requirements": "Details in a form consistent with other applications and contexts of use.",
"definition": "The details of the proposed activity represented in a specific resource.",
"short": "Activity details defined in specific resource",
"mapping": [ {
"map": "{Request that resulted in Event in activity.actionResulting}",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=COMP].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Appointment", "http://hl7.org/fhir/StructureDefinition/CommunicationRequest", "http://hl7.org/fhir/StructureDefinition/DeviceRequest", "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "http://hl7.org/fhir/StructureDefinition/NutritionOrder", "http://hl7.org/fhir/StructureDefinition/Task", "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "http://hl7.org/fhir/StructureDefinition/VisionPrescription", "http://hl7.org/fhir/StructureDefinition/RequestGroup" ]
} ],
"max": "1",
"id": "CarePlan.activity.reference",
"condition": [ "cpl-3" ],
"comment": "Standard extension exists ([resource-pertainsToGoal](extension-resource-pertainstogoal.html)) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. \rThe goal should be visible when the resource referenced by CarePlan.activity.reference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should *not* point to this CarePlan using the \"basedOn\" element. i.e. Requests that are part of a CarePlan are not \"based on\" the CarePlan."
}, {
"path": "CarePlan.activity.detail",
"requirements": "Details in a simple form for generic care plan systems.",
"definition": "A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.",
"short": "In-line definition of activity",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "CarePlan.activity.detail",
"condition": [ "cpl-3" ]
}, {
"path": "CarePlan.activity.detail.kind",
"requirements": "May determine what types of extensions are permitted.",
"definition": "A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.",
"short": "Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription",
"mapping": [ {
"map": ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanActivityKind"
} ],
"description": "Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity."
},
"max": "1",
"id": "CarePlan.activity.detail.kind"
}, {
"id": "CarePlan.activity.detail.instantiatesCanonical",
"path": "CarePlan.activity.detail.instantiatesCanonical",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/Questionnaire", "http://hl7.org/fhir/StructureDefinition/Measure", "http://hl7.org/fhir/StructureDefinition/OperationDefinition" ]
} ],
"short": "Instantiates FHIR protocol or definition",
"mapping": [ {
"map": "Request.instantiatesCanonical",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=DEFN].target",
"identity": "rim"
} ],
"definition": "The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.",
"requirements": "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity."
}, {
"id": "CarePlan.activity.detail.instantiatesUri",
"path": "CarePlan.activity.detail.instantiatesUri",
"type": [ {
"code": "uri"
} ],
"short": "Instantiates external protocol or definition",
"comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"mapping": [ {
"map": "Request.instantiatesUri",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=DEFN].target",
"identity": "rim"
} ],
"definition": "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.",
"requirements": "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity."
}, {
"path": "CarePlan.activity.detail.code",
"requirements": "Allows matching performed to planned as well as validation against protocols.",
"definition": "Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.",
"short": "Detail type of activity",
"mapping": [ {
"map": "Request.code",
"identity": "workflow"
}, {
"map": "OBR-4 / RXE-2 / RXO-1 / RXD-2",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/procedure-code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanActivityType"
} ],
"description": "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter."
},
"max": "1",
"id": "CarePlan.activity.detail.code",
"comment": "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead."
}, {
"id": "CarePlan.activity.detail.reasonCode",
"path": "CarePlan.activity.detail.reasonCode",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Why activity should be done or why activity was prohibited",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanActivityReason"
} ],
"description": "Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as \"general wellness\", prophylaxis, surgical preparation, etc."
},
"comment": "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.",
"mapping": [ {
"map": "Request.reasonCode",
"identity": "workflow"
} ],
"definition": "Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited."
}, {
"id": "CarePlan.activity.detail.reasonReference",
"path": "CarePlan.activity.detail.reasonReference",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"short": "Why activity is needed",
"comment": "Conditions can be identified at the activity level that are not identified as reasons for the overall plan.",
"mapping": [ {
"map": "Request.reasonReference",
"identity": "workflow"
} ],
"definition": "Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan."
}, {
"id": "CarePlan.activity.detail.goal",
"path": "CarePlan.activity.detail.goal",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Goal" ]
} ],
"short": "Goals this activity relates to",
"mapping": [ {
"map": ".outboundRelationship[typeCode<=OBJ].",
"identity": "rim"
} ],
"definition": "Internal reference that identifies the goals that this activity is intended to contribute towards meeting.",
"requirements": "So that participants know the link explicitly."
}, {
"path": "CarePlan.activity.detail.status",
"requirements": "Indicates progress against the plan, whether the activity is still relevant for the plan.",
"min": 1,
"definition": "Identifies what progress is being made for the specific activity.",
"isModifier": true,
"short": "not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error",
"mapping": [ {
"map": "Request.status",
"identity": "workflow"
}, {
"map": "ORC-5?",
"identity": "v2"
}, {
"map": ".statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanActivityStatus"
} ],
"description": "Codes that reflect the current state of a care plan activity within its overall life cycle."
},
"max": "1",
"id": "CarePlan.activity.detail.status",
"comment": "Some aspects of status can be inferred based on the resources linked in actionTaken. Note that \"status\" is only as current as the plan was most recently updated. \nThe unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the activity.",
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the activity should not be treated as valid"
}, {
"id": "CarePlan.activity.detail.statusReason",
"max": "1",
"path": "CarePlan.activity.detail.statusReason",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Reason for current status",
"comment": "Will generally not be present if status is \"complete\". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.",
"mapping": [ {
"map": "Request.statusReason",
"identity": "workflow"
} ],
"definition": "Provides reason why the activity isn't yet started, is on hold, was cancelled, etc."
}, {
"path": "CarePlan.activity.detail.doNotPerform",
"requirements": "Captures intention to not do something that may have been previously typical.",
"definition": "If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.",
"isModifier": true,
"short": "If true, activity is prohibiting action",
"mapping": [ {
"map": "Request.doNotPerform",
"identity": "workflow"
}, {
"map": "actionNegationInd",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"meaningWhenMissing": "If missing indicates that the described activity is one that should be engaged in when following the plan.",
"max": "1",
"id": "CarePlan.activity.detail.doNotPerform",
"comment": "This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.",
"isModifierReason": "If true this element negates the specified action. For example, instead of a request for a procedure, it is a request for the procedure to not occur."
}, {
"id": "CarePlan.activity.detail.scheduled[x]",
"max": "1",
"path": "CarePlan.activity.detail.scheduled[x]",
"type": [ {
"code": "Timing"
}, {
"code": "Period"
}, {
"code": "string"
} ],
"short": "When activity is to occur",
"mapping": [ {
"map": "Request.occurrence[x]",
"identity": "workflow"
}, {
"map": "TQ1",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
} ],
"definition": "The period, timing or frequency upon which the described activity is to occur.",
"requirements": "Allows prompting for activities and detection of missed planned activities."
}, {
"path": "CarePlan.activity.detail.location",
"requirements": "Helps in planning of activity.",
"definition": "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.",
"short": "Where it should happen",
"mapping": [ {
"map": "OBR-24(???!!)",
"identity": "v2"
}, {
"map": ".participation[typeCode=LOC].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"max": "1",
"id": "CarePlan.activity.detail.location",
"comment": "May reference a specific clinical location or may identify a type of location."
}, {
"id": "CarePlan.activity.detail.performer",
"path": "CarePlan.activity.detail.performer",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Device" ]
} ],
"short": "Who will be responsible?",
"comment": "A performer MAY also be a participant in the care plan.",
"mapping": [ {
"map": "Request.performer",
"identity": "workflow"
}, {
"map": "PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8",
"identity": "v2"
}, {
"map": ".participation[typeCode=PFM]",
"identity": "rim"
} ],
"definition": "Identifies who's expected to be involved in the activity.",
"requirements": "Helps in planning of activity."
}, {
"id": "CarePlan.activity.detail.product[x]",
"max": "1",
"path": "CarePlan.activity.detail.product[x]",
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Medication", "http://hl7.org/fhir/StructureDefinition/Substance" ]
} ],
"short": "What is to be administered/supplied",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-codes",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanProduct"
} ],
"description": "A product supplied or administered as part of a care plan activity."
},
"mapping": [ {
"map": "RXE-2 / RXO-1 / RXD-2",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRD].role",
"identity": "rim"
} ],
"definition": "Identifies the food, drug or other product to be consumed or supplied in the activity."
}, {
"path": "CarePlan.activity.detail.dailyAmount",
"requirements": "Allows rough dose checking.",
"definition": "Identifies the quantity expected to be consumed in a given day.",
"short": "How to consume/day?",
"mapping": [ {
"map": "RXO-23 / RXE-19 / RXD-12",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"alias": [ "daily dose" ],
"max": "1",
"id": "CarePlan.activity.detail.dailyAmount"
}, {
"id": "CarePlan.activity.detail.quantity",
"max": "1",
"path": "CarePlan.activity.detail.quantity",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"short": "How much to administer/supply/consume",
"mapping": [ {
"map": "RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity",
"identity": "rim"
} ],
"definition": "Identifies the quantity expected to be supplied, administered or consumed by the subject."
}, {
"id": "CarePlan.activity.detail.description",
"max": "1",
"path": "CarePlan.activity.detail.description",
"type": [ {
"code": "string"
} ],
"short": "Extra info describing activity to perform",
"mapping": [ {
"map": "NTE?",
"identity": "v2"
}, {
"map": ".text",
"identity": "rim"
} ],
"definition": "This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc."
}, {
"id": "CarePlan.note",
"path": "CarePlan.note",
"type": [ {
"code": "Annotation"
} ],
"short": "Comments about the plan",
"mapping": [ {
"map": "Request.note",
"identity": "workflow"
}, {
"map": "NTE?",
"identity": "v2"
}, {
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value",
"identity": "rim"
} ],
"definition": "General notes about the care plan not covered elsewhere.",
"requirements": "Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}