care plans

Create Care Plan

post
/organizations/{organizationId}/fhir/4/CarePlan

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.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a CarePlan resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)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.
instantiatesCanonicalarray(canonical)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.
instantiatesUriarray(uri)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.
basedOnarray(Reference)A care plan that is fulfilled in whole or in part by this care plan.
replacesarray(Reference)Completed or terminated care plan whose function is taken by this new care plan.
partOfarray(Reference)A larger care plan of which this particular care plan is a component or step.
statuscodeIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intentcodeIndicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
categoryarray(CodeableConcept)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.
titlestringHuman-friendly name for the care plan.
descriptionstringA description of the scope and nature of the plan.
subject*ReferenceIdentifies the patient or group whose intended care is described by the plan.
encounterReferenceThe Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.
periodPeriodIndicates when the plan did (or is intended to) come into effect and end.
createddateTimeRepresents when this particular CarePlan record was created in the system, which is often a system-generated date.
authorReferenceWhen populated, the author is responsible for the care plan. The care plan is attributed to the author.
contributorarray(Reference)Identifies the individual(s) or organization who provided the contents of the care plan.
careTeamarray(Reference)Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
addressesarray(Reference)Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
supportingInfoarray(Reference)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.
goalarray(Reference)Describes the intended objective(s) of carrying out the care plan.
activityarray(CarePlan_Activity)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.
notearray(Annotation)General notes about the care plan not covered elsewhere.

Response

Patch Care Plan

patch
/organizations/{organizationId}/fhir/4/CarePlan/{resourceId}

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.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a CarePlan resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)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.
instantiatesCanonicalarray(canonical)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.
instantiatesUriarray(uri)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.
basedOnarray(Reference)A care plan that is fulfilled in whole or in part by this care plan.
replacesarray(Reference)Completed or terminated care plan whose function is taken by this new care plan.
partOfarray(Reference)A larger care plan of which this particular care plan is a component or step.
statuscodeIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intentcodeIndicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
categoryarray(CodeableConcept)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.
titlestringHuman-friendly name for the care plan.
descriptionstringA description of the scope and nature of the plan.
subject*ReferenceIdentifies the patient or group whose intended care is described by the plan.
encounterReferenceThe Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.
periodPeriodIndicates when the plan did (or is intended to) come into effect and end.
createddateTimeRepresents when this particular CarePlan record was created in the system, which is often a system-generated date.
authorReferenceWhen populated, the author is responsible for the care plan. The care plan is attributed to the author.
contributorarray(Reference)Identifies the individual(s) or organization who provided the contents of the care plan.
careTeamarray(Reference)Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
addressesarray(Reference)Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
supportingInfoarray(Reference)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.
goalarray(Reference)Describes the intended objective(s) of carrying out the care plan.
activityarray(CarePlan_Activity)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.
notearray(Annotation)General notes about the care plan not covered elsewhere.

Response

Read Care Plan

get
/organizations/{organizationId}/fhir/4/CarePlan/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Care Plan

get
/organizations/{organizationId}/fhir/4/CarePlan/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Care Plan

get
/organizations/{organizationId}/fhir/4/CarePlan/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Care Plan

delete
/organizations/{organizationId}/fhir/4/CarePlan/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Care Plan

get
/organizations/{organizationId}/fhir/4/CarePlan

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activity-codestring
activity-datestring
activity-referencestring
based-onstring
care-teamstring
categorystring
conditionstring
datestring
encounterstring
goalstring
identifierstring
instantiates-canonicalstring
instantiates-uristring
intentstring
part-ofstring
patientstring
performerstring
replacesstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Care Plan

get
/organizations/{organizationId}/fhir/4/CarePlan/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Care Plan

post
/organizations/{organizationId}/fhir/4/CarePlan/_search

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.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
activity-codestring
activity-datestring
activity-referencestring
based-onstring
care-teamstring
categorystring
conditionstring
datestring
encounterstring
goalstring
identifierstring
instantiates-canonicalstring
instantiates-uristring
intentstring
part-ofstring
patientstring
performerstring
replacesstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a CarePlan resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)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.
instantiatesCanonicalarray(canonical)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.
instantiatesUriarray(uri)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.
basedOnarray(Reference)A care plan that is fulfilled in whole or in part by this care plan.
replacesarray(Reference)Completed or terminated care plan whose function is taken by this new care plan.
partOfarray(Reference)A larger care plan of which this particular care plan is a component or step.
statuscodeIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intentcodeIndicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
categoryarray(CodeableConcept)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.
titlestringHuman-friendly name for the care plan.
descriptionstringA description of the scope and nature of the plan.
subject*ReferenceIdentifies the patient or group whose intended care is described by the plan.
encounterReferenceThe Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.
periodPeriodIndicates when the plan did (or is intended to) come into effect and end.
createddateTimeRepresents when this particular CarePlan record was created in the system, which is often a system-generated date.
authorReferenceWhen populated, the author is responsible for the care plan. The care plan is attributed to the author.
contributorarray(Reference)Identifies the individual(s) or organization who provided the contents of the care plan.
careTeamarray(Reference)Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
addressesarray(Reference)Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
supportingInfoarray(Reference)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.
goalarray(Reference)Describes the intended objective(s) of carrying out the care plan.
activityarray(CarePlan_Activity)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.
notearray(Annotation)General notes about the care plan not covered elsewhere.

Response

Update Care Plan

put
/organizations/{organizationId}/fhir/4/CarePlan/{resourceId}

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.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a CarePlan resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)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.
instantiatesCanonicalarray(canonical)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.
instantiatesUriarray(uri)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.
basedOnarray(Reference)A care plan that is fulfilled in whole or in part by this care plan.
replacesarray(Reference)Completed or terminated care plan whose function is taken by this new care plan.
partOfarray(Reference)A larger care plan of which this particular care plan is a component or step.
statuscodeIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intentcodeIndicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
categoryarray(CodeableConcept)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.
titlestringHuman-friendly name for the care plan.
descriptionstringA description of the scope and nature of the plan.
subject*ReferenceIdentifies the patient or group whose intended care is described by the plan.
encounterReferenceThe Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.
periodPeriodIndicates when the plan did (or is intended to) come into effect and end.
createddateTimeRepresents when this particular CarePlan record was created in the system, which is often a system-generated date.
authorReferenceWhen populated, the author is responsible for the care plan. The care plan is attributed to the author.
contributorarray(Reference)Identifies the individual(s) or organization who provided the contents of the care plan.
careTeamarray(Reference)Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
addressesarray(Reference)Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
supportingInfoarray(Reference)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.
goalarray(Reference)Describes the intended objective(s) of carrying out the care plan.
activityarray(CarePlan_Activity)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.
notearray(Annotation)General notes about the care plan not covered elsewhere.

Response