care plans

Create Care Plan

post
/organizations/{organizationId}/fhir/3/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/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringCarePlanThis is a CarePlan resource
identifierarray(Identifier)This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definitionarray(Reference)Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.
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.
statusstringdraft|active|suspended|completed|entered-in-error|cancelled|unknownIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intentstringproposal|plan|order|optionIndicates 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 CarePlan.
descriptionstringA description of the scope and nature of the plan.
subject*ReferenceIdentifies the patient or group whose intended care is described by the plan.
contextReferenceIdentifies the original context in which this particular CarePlan was created.
periodPeriodIndicates when the plan did (or is intended to) come into effect and end.
authorarray(Reference)Identifies the individual(s) or ogranization who is responsible for the content 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 co-morbidities, 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/3/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*stringCarePlanThis is a CarePlan resource
identifierarray(Identifier)This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definitionarray(Reference)Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.
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.
statusstringdraft|active|suspended|completed|entered-in-error|cancelled|unknownIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intentstringproposal|plan|order|optionIndicates 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 CarePlan.
descriptionstringA description of the scope and nature of the plan.
subject*ReferenceIdentifies the patient or group whose intended care is described by the plan.
contextReferenceIdentifies the original context in which this particular CarePlan was created.
periodPeriodIndicates when the plan did (or is intended to) come into effect and end.
authorarray(Reference)Identifies the individual(s) or ogranization who is responsible for the content 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 co-morbidities, 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/3/CarePlan/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Care Plan

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

Request

Headers

content-type*stringapplication/jsonapplication/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/3/CarePlan/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Care Plan

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Care Plan

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

Request

Headers

content-type*stringapplication/jsonapplication/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
contextstring
datestring
definitionstring
encounterstring
goalstring
identifierstring
intentstring
part-ofstring
patientstring
performerstring
replacesstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Care Plan

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

Request

Headers

content-type*stringapplication/jsonapplication/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/3/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
contextstring
datestring
definitionstring
encounterstring
goalstring
identifierstring
intentstring
part-ofstring
patientstring
performerstring
replacesstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringCarePlanThis is a CarePlan resource
identifierarray(Identifier)This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definitionarray(Reference)Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.
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.
statusstringdraft|active|suspended|completed|entered-in-error|cancelled|unknownIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intentstringproposal|plan|order|optionIndicates 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 CarePlan.
descriptionstringA description of the scope and nature of the plan.
subject*ReferenceIdentifies the patient or group whose intended care is described by the plan.
contextReferenceIdentifies the original context in which this particular CarePlan was created.
periodPeriodIndicates when the plan did (or is intended to) come into effect and end.
authorarray(Reference)Identifies the individual(s) or ogranization who is responsible for the content 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 co-morbidities, 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/3/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/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCarePlanThis is a CarePlan resource
identifierarray(Identifier)This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
definitionarray(Reference)Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.
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.
statusstringdraft|active|suspended|completed|entered-in-error|cancelled|unknownIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
intentstringproposal|plan|order|optionIndicates 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 CarePlan.
descriptionstringA description of the scope and nature of the plan.
subject*ReferenceIdentifies the patient or group whose intended care is described by the plan.
contextReferenceIdentifies the original context in which this particular CarePlan was created.
periodPeriodIndicates when the plan did (or is intended to) come into effect and end.
authorarray(Reference)Identifies the individual(s) or ogranization who is responsible for the content 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 co-morbidities, 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