CarePlan search-type

Request Fields and Example
category
[string]

Type of plan

date
[string]

Time period plan covers

patient
[string]

Who the care plan is for

status
[string]

draft | active | on-hold | revoked | completed | entered-in-error | unknown

post/CarePlan/_search
Response Fields and Example
resourceType
required, string

Identifies the type of the resource

Value: Bundle
type
required, string

Identifies this bundle as a response to a search

Value: searchset
total
required, number

The total number of matches

entry
[CarePlan, Other]

A resource matching the search criteria or related to a matching resource

Any of:
resource
required, object

A matching CarePlan resource that corresponds to the search parameters

resourceType
required, string

Identifies the type of the resource

Value: CarePlan
text
required, object

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

status
required, string

The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

Possible Values: generated, extensions, additional, empty
div
required, 

The actual narrative content, a stripped down version of XHTML.

status
required, string

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

Possible Values: draft, active, on-hold, revoked, completed, entered-in-error, unknown
intent
required, string

Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

Possible Values: proposal, plan, order, option
category
required, [AssessPlan, Other]

Type of plan.

Any of:
coding
required, [object]
system
required, string
Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
code
required, string
Value: assess-plan
subject
required, object

Who care plan is for.

Must be a resource of type Patient.

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

reference
string

A sequence of Unicode characters

_reference
object

Extensions for reference

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

type
string

String of characters used to identify a name or a resource

_type
object

Extensions for type

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

identifier
object

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

use

The purpose of this identifier.

Possible Values: usual, official, temp, secondary, old
_use
object

Extensions for use

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

type
object

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

coding
[object]

A reference to a code defined by a terminology system.

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

system
string

String of characters used to identify a name or a resource

_system
object

Extensions for system

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

version
string

A sequence of Unicode characters

_version
object

Extensions for version

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

code
string

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

_code
object

Extensions for code

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

display
string

A sequence of Unicode characters

_display
object

Extensions for display

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

userSelected
boolean

Value of "true" or "false"

_userSelected
object

Extensions for userSelected

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

text
string

A sequence of Unicode characters

_text
object

Extensions for text

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

system
string

String of characters used to identify a name or a resource

_system
object

Extensions for system

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

value
string

A sequence of Unicode characters

_value
object

Extensions for value

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

period
object

Time period during which identifier is/was valid for use.

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

start
string

A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

_start
object

Extensions for start

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

end
string

A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

_end
object

Extensions for end

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

display
string

A sequence of Unicode characters

_display
object

Extensions for display

id
string

A sequence of Unicode characters

extension
[object]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id
string

A sequence of Unicode characters

url
string

String of characters used to identify a name or a resource

valueBase64Binary
string

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

search
required, object

Information about the search process that lead to the creation of this entry.

mode
required, string

Identifies the CarePlan as matching the search parameters

Value: match