CarePlan

Trial Use 2 Clinical — Care Provision

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.

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/CarePlan

Interaction	Method	Path
Read	GET	/fhir/R4/CarePlan/[id]
Vread	GET	/fhir/R4/CarePlan/[id]/_history/[vid]
Update	PUT	/fhir/R4/CarePlan/[id]
Patch	PATCH	/fhir/R4/CarePlan/[id]
Delete	DELETE	/fhir/R4/CarePlan/[id]
Create	POST	/fhir/R4/CarePlan
Search	GET	/fhir/R4/CarePlan
History	GET	/fhir/R4/CarePlan/[id]/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	External Ids for this plan
instantiatesCanonical	canonical	0..*	Instantiates FHIR protocol or definition
instantiatesUri	uri	0..*	Instantiates external protocol or definition
basedOn	Reference	0..*	Fulfills CarePlan
replaces	Reference	0..*	CarePlan replaced by this CarePlan
partOf	Reference	0..*	Part of referenced CarePlan
status	code	1..1	draft | active | on-hold | revoked | completed | entered-in-error | unknown modifier
intent	code	1..1	proposal | plan | order | option modifier
category	CodeableConcept	0..*	Type of plan
title	string	0..1	Human-friendly name for the care plan
description	string	0..1	Summary of nature of plan
subject	Reference	1..1	Who the care plan is for
encounter	Reference	0..1	Encounter created as part of
period	Period	0..1	Time period plan covers
created	dateTime	0..1	Date record was first recorded
author	Reference	0..1	Who is the designated responsible party
contributor	Reference	0..*	Who provided the content of the care plan
careTeam	Reference	0..*	Who's involved in plan?
addresses	Reference	0..*	Health issues this plan addresses
supportingInfo	Reference	0..*	Information considered as part of plan
goal	Reference	0..*	Desired outcome of plan
activity	BackboneElement	0..*	Action to occur as part of plan
note	Annotation	0..*	Comments about the plan

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
activity-code	string	http://hl7.org/fhir/SearchParameter/CarePlan-activity-code
activity-date	string	http://hl7.org/fhir/SearchParameter/CarePlan-activity-date
activity-reference	string	http://hl7.org/fhir/SearchParameter/CarePlan-activity-reference
based-on	string	http://hl7.org/fhir/SearchParameter/CarePlan-based-on
care-team	string	http://hl7.org/fhir/SearchParameter/CarePlan-care-team
category	string	http://hl7.org/fhir/SearchParameter/CarePlan-category
condition	string	http://hl7.org/fhir/SearchParameter/CarePlan-condition
date	string	http://hl7.org/fhir/SearchParameter/clinical-date
encounter	string	http://hl7.org/fhir/SearchParameter/CarePlan-encounter
goal	string	http://hl7.org/fhir/SearchParameter/CarePlan-goal
identifier	string	http://hl7.org/fhir/SearchParameter/clinical-identifier
instantiates-canonical	string	http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-canonical
instantiates-uri	string	http://hl7.org/fhir/SearchParameter/CarePlan-instantiates-uri
intent	string	http://hl7.org/fhir/SearchParameter/CarePlan-intent
part-of	string	http://hl7.org/fhir/SearchParameter/CarePlan-part-of
patient	string	http://hl7.org/fhir/SearchParameter/clinical-patient
performer	string	http://hl7.org/fhir/SearchParameter/CarePlan-performer
replaces	string	http://hl7.org/fhir/SearchParameter/CarePlan-replaces
status	string	http://hl7.org/fhir/SearchParameter/CarePlan-status
subject	string	http://hl7.org/fhir/SearchParameter/CarePlan-subject

Reference

• Official FHIR R4 spec: CarePlan
• Maturity: Trial Use 2 (FMM 2).