Entity: Care Plan

Summary of interactions

Create

MDM T02/care plan

Plans

/v1/treatmentPlans

Read

Plans

/v2-beta/careplans/[patientId]
/treatmentPlans/forPatient/[id]
/v1/treatmentPlans/mine

Update

MDM T02/care plan

Plans

Delete

Entity: Care Plan - Extends: Data Point

Name String

The name of the care plan.

OBX-3.2 (MDM T02/care plan)
OBX-3.5 (MDM T02/care plan)

Shown.

Created Timestamp Timestamp

The timestamp when the care plan was first created.

TXA-4.1 (MDM T02/care plan)

Shown.

Last Edited Timestamp Timestamp

The timestamp when the care plan was last edited.

TXA-4.1 (MDM T02/care plan)

Shown.

Review Date Timestamp

When the care plan is due to be reviewed.

Shown.

Action Plan String or Binary

The main body of the care plan.

This can be plaintext, HTML or a PDF file.

OBX-5.5 (MDM T02/care plan)

Shown.

Green String

An explanation of what to expect when the condition is under control.

This can be plaintext or HTML.

Shown.

Amber String

An explanation of what might need attention.

This can be plaintext or HTML.

Shown.

Red String

An explanation of what needs urgent attention.

This can be plaintext or HTML.

Shown.

Creator Ref: [[User.Public ID]]

If applicable, the user who created the care plan.

Shown.

Status Enum

• INDRAFT

• ACTIVE

Shown.

Entity: Care Plan Attachment - Extends: Data Point

Is Main Content Boolean

Whether or not this attachment represents the Action Plan.

The UI automatically shows this appropriately.

Entity: Care Plan Template

ID String

An ID for this template.

Status Enum

• ACTIVE

• INDRAFT

• INACTIVE

Entity: Care Plan Metric

ID String

An ID for this metric.

Type Enum

• LAB_TEST

• MEASUREMENT

• SYMPTOM

Name String

A display name for the metric.

Data Type ID String

An identifier which uniquely identifies the specific data type instance. For example, this would be the ID of the relevant LOINC test entry for a metric type of LAB_TEST.

Summary of interactions

Create

A Professional can export a care plan, or a Team Coordinator can export a care plan for a Professional to receive.

Read

A Professional can view exported care plans.

Update

Delete

Entity: Care Plan Export - Extends: Data Point

Export Date Timestamp

When the export was requested.

The date portion of the timestamp is shown.

Name String

An automatically generated name for this export.

This is used as the name of the file to be downloaded.

Exporter Ref: [[User.Public ID]]

The user who requested the export.

The name of the exporter is shown.

Content Binary

The content of the export.

The content is available for download.