Documentation Index
Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
Use this file to discover all available pages before exploring further.
Properties
| Name | Required | Type | Description |
|---|
| identifier | No | Identifier[] | External Ids for this plan |
| instantiatesCanonical | No | canonical[] | Instantiates FHIR protocol or definition |
| instantiatesUri | No | uri[] | Instantiates external protocol or definition |
| basedOn | No | Reference<CarePlan>[] | Fulfills CarePlan |
| replaces | No | Reference<CarePlan>[] | CarePlan replaced by this CarePlan |
| partOf | No | Reference<CarePlan>[] | Part of referenced CarePlan |
| status | Yes | code | draft / active / on-hold / revoked / completed / entered-in-error / unknown |
| intent | Yes | code | proposal / plan / order / option |
| category | No | CodeableConcept[] | Type of plan |
| title | No | string | Human-friendly name for the care plan |
| description | No | string | Summary of nature of plan |
| subject | Yes | Reference<Patient / Group> | Who the care plan is for |
| encounter | No | Reference<Encounter> | Encounter created as part of |
| period | No | Period | Time period plan covers |
| created | No | dateTime | Date record was first recorded |
| author | No | Reference<Patient / Practitioner / PractitionerRole / Device / RelatedPerson / Organization / CareTeam> | Who is the designated responsible party |
| contributor | No | Reference<Patient / Practitioner / PractitionerRole / Device / RelatedPerson / Organization / CareTeam>[] | Who provided the content of the care plan |
| careTeam | No | Reference<CareTeam>[] | Who’s involved in plan? |
| addresses | No | Reference<Condition>[] | Health issues this plan addresses |
| supportingInfo | No | Reference<Resource>[] | Information considered as part of plan |
| goal | No | Reference<Goal>[] | Desired outcome of plan |
| activity | No | CarePlanActivity | Action to occur as part of plan |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - outcomeCodeableConcept | No | CodeableConcept[] | Results of the activity |
| - outcomeReference | No | Reference<Resource>[] | Appointment, Encounter, Procedure, etc. |
| - progress | No | Annotation[] | Comments about the activity status/progress |
| - reference | No | Reference<Appointment / CommunicationRequest / DeviceRequest / MedicationRequest / NutritionOrder / Task / ServiceRequest / VisionPrescription / RequestGroup> | Activity details defined in specific resource |
| - detail | No | CarePlanActivityDetail | In-line definition of activity |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - kind | No | code | Appointment / CommunicationRequest / DeviceRequest / MedicationRequest / NutritionOrder / Task / ServiceRequest / VisionPrescription |
| - instantiatesCanonical | No | canonical[] | Instantiates FHIR protocol or definition |
| - instantiatesUri | No | uri[] | Instantiates external protocol or definition |
| - code | No | CodeableConcept | Detail type of activity |
| - reasonCode | No | CodeableConcept[] | Why activity should be done or why activity was prohibited |
| - reasonReference | No | Reference<Condition / Observation / DiagnosticReport / DocumentReference>[] | Why activity is needed |
| - goal | No | Reference<Goal>[] | Goals this activity relates to |
| - status | Yes | code | not-started / scheduled / in-progress / on-hold / completed / cancelled / stopped / unknown / entered-in-error |
| - statusReason | No | CodeableConcept | Reason for current status |
| - doNotPerform | No | boolean | If true, activity is prohibiting action |
| - scheduled[x] | No | Timing, Period, string | When activity is to occur |
| - location | No | Reference<Location> | Where it should happen |
| - performer | No | Reference<Practitioner / PractitionerRole / Organization / RelatedPerson / Patient / CareTeam / HealthcareService / Device>[] | Who will be responsible? |
| - product[x] | No | CodeableConcept, Reference<Medication / Substance> | What is to be administered/supplied |
| - dailyAmount | No | Quantity | How to consume/day? |
| - quantity | No | Quantity | How much to administer/supply/consume |
| - description | No | string | Extra info describing activity to perform |
| note | No | Annotation[] | Comments about the plan |
Search Parameters
| Name | Type | Description | Expression |
|---|
| date | date | Time period plan covers | CarePlan.period |
| identifier | token | External Ids for this plan | CarePlan.identifier |
| patient | reference | Who the care plan is for | CarePlan.subject |
| activity-code | token | Detail type of activity | CarePlan.activity.detail.code |
| activity-date | date | Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x] | CarePlan.activity.detail.scheduled |
| activity-reference | reference | Activity details defined in specific resource | CarePlan.activity.reference |
| based-on | reference | Fulfills CarePlan | CarePlan.basedOn |
| care-team | reference | Who’s involved in plan? | CarePlan.careTeam |
| category | token | Type of plan | CarePlan.category |
| condition | reference | Health issues this plan addresses | CarePlan.addresses |
| encounter | reference | Encounter created as part of | CarePlan.encounter |
| goal | reference | Desired outcome of plan | CarePlan.goal |
| instantiates-canonical | reference | Instantiates FHIR protocol or definition | CarePlan.instantiatesCanonical |
| instantiates-uri | uri | Instantiates external protocol or definition | CarePlan.instantiatesUri |
| intent | token | proposal / plan / order / option | CarePlan.intent |
| part-of | reference | Part of referenced CarePlan | CarePlan.partOf |
| performer | reference | Matches if the practitioner is listed as a performer in any of the “simple” activities. (For performers of the detailed activities, chain through the activitydetail search parameter.) | CarePlan.activity.detail.performer |
| replaces | reference | CarePlan replaced by this CarePlan | CarePlan.replaces |
| status | token | draft / active / on-hold / revoked / completed / entered-in-error / unknown | CarePlan.status |
| subject | reference | Who the care plan is for | CarePlan.subject |
Inherited Properties
| Name | Required | Type | Description |
|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
