TRANXACT.AI Help

EHR · Clinical

Care Planning

The plan, its goals and who is accountable. Goals carry a measure and a target.

Type REST10 operationsBase path /api/ehr/care-plansPublished as /api/v1/care-plans

Download specification (OpenAPI 3.1) Screen: Care Planning

Overview

PackageEHR
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold EHR › Care Planning on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableehr.care_plans · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

10 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ehr/care-plansList care planning

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "plan_no": "PLA-000001",
      "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "plan_type": "chronic_care",
      "primary_diagnosis": "text",
      "responsible_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "care_coordinator_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "start_date": "2026-10-30",
      "review_date": "2026-10-30",
      "end_date": "2026-10-30",
      "status": "draft",
      "summary": "text",
      "created_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ehr/care-plans?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ehr/care-plans/{id}Read one care plans

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_no": "PLA-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_type": "chronic_care",
  "primary_diagnosis": "text",
  "responsible_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "care_coordinator_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "start_date": "2026-10-30",
  "review_date": "2026-10-30",
  "end_date": "2026-10-30",
  "status": "draft",
  "summary": "text",
  "created_at": "2026-10-30T09:00:00Z"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/ehr/care-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/care-plansCreate a care plans

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
patient_iduuidYesPatient
plan_typetextNoType
Allowed: chronic_care post_acute behavioral rehabilitation palliative preventive discharge transition
primary_diagnosistextNoPrimary diagnosis
responsible_provider_iduuidNoResponsible provider
care_coordinator_iduuidNoCare coordinator
start_datedateNoStarts
review_datedateNoReview on
end_datedateNoEnds
statustextNoStatus
Allowed: draft active on_hold completed cancelled
summarytextNoSummary

Sample body

{
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_type": "chronic_care",
  "primary_diagnosis": "text",
  "responsible_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "care_coordinator_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_no": "PLA-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_type": "chronic_care",
  "primary_diagnosis": "text",
  "responsible_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "care_coordinator_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "start_date": "2026-10-30",
  "review_date": "2026-10-30",
  "end_date": "2026-10-30",
  "status": "draft",
  "summary": "text",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/care-plans" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","plan_type":"chronic_care","primary_diagnosis":"text","responsible_provider_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","care_coordinator_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/ehr/care-plans/{id}Change a care plans

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
patient_iduuidYesPatient
plan_typetextNoType
Allowed: chronic_care post_acute behavioral rehabilitation palliative preventive discharge transition
primary_diagnosistextNoPrimary diagnosis
responsible_provider_iduuidNoResponsible provider
care_coordinator_iduuidNoCare coordinator
start_datedateNoStarts
review_datedateNoReview on
end_datedateNoEnds
statustextNoStatus
Allowed: draft active on_hold completed cancelled
summarytextNoSummary

Sample body

{
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_type": "chronic_care"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_no": "PLA-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "plan_type": "chronic_care",
  "primary_diagnosis": "text",
  "responsible_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "care_coordinator_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "start_date": "2026-10-30",
  "review_date": "2026-10-30",
  "end_date": "2026-10-30",
  "status": "draft",
  "summary": "text",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ehr/care-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","plan_type":"chronic_care"}'
DELETE/api/ehr/care-plans/{id}Delete a care plans

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/ehr/care-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/care-plans/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/care-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/ehr/care-plans/{parentId}/goalsGoals

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ehr/care-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/goals" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/care-plans/{parentId}/goalsGoals

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/care-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/goals" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/ehr/care-plans/{parentId}/goals/{lineId}Goals

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ehr/care-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/goals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/ehr/care-plans/{parentId}/goals/{lineId}Goals

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/ehr/care-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/goals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a care plans, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
plan_notextread onlyPlan no
patient_iduuidread, writePatient
plan_typetextread, writeType
Allowed: chronic_care post_acute behavioral rehabilitation palliative preventive discharge transition
primary_diagnosistextread, writePrimary diagnosis
responsible_provider_iduuidread, writeResponsible provider
care_coordinator_iduuidread, writeCare coordinator
start_datedateread, writeStarts
review_datedateread, writeReview on
end_datedateread, writeEnds
statustextread, writeStatus
Allowed: draft active on_hold completed cancelled
summarytextread, writeSummary
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold EHR › Care Planning for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.