Partial Transcription Repository
API Contract
REST
/api/v1/partial-transcriptions
7 endpoints
GET
/api/v1/partial-transcriptions/api/v1/partial-transcriptions
List all stored partial transcriptions
Public
Response Example
{
"data": [
{
"partial_id": "pt-aa11",
"draft_id": "draft-88ab12",
"field_id": "field_visit_notes",
"text": "Patient reported improved mobility since last",
"saved_at": "2026-03-26T09:45:50Z"
},
{
"partial_id": "pt-aa12",
"draft_id": "draft-88ab12",
"field_id": "field_observations",
"text": "No adverse reactions noted during",
"saved_at": "2026-03-26T09:46:10Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 2
}
}
GET
/api/v1/partial-transcriptions/api/v1/partial-transcriptions/:id
Get a specific partial transcription by its ID
Public
Response Example
{
"partial_id": "pt-aa11",
"draft_id": "draft-88ab12",
"field_id": "field_visit_notes",
"text": "Patient reported improved mobility since last",
"saved_at": "2026-03-26T09:45:50Z"
}
POST
/api/v1/partial-transcriptions/api/v1/partial-transcriptions
Save a partial transcription for a draft field (creates or overwrites)
Public
Request Example
{
"draft_id": "draft-88ab12",
"field_id": "field_visit_notes",
"text": "Patient reported improved mobility since last visit. No pain reported."
}
Response Example
{
"partial_id": "pt-aa13",
"draft_id": "draft-88ab12",
"field_id": "field_visit_notes",
"text": "Patient reported improved mobility since last visit. No pain reported.",
"saved_at": "2026-03-26T11:40:00Z"
}
PUT
/api/v1/partial-transcriptions/api/v1/partial-transcriptions/:id
Update the text of an existing partial transcription
Public
Request Example
{
"text": "Patient reported improved mobility since last visit. No pain reported. Gait is steady."
}
Response Example
{
"partial_id": "pt-aa13",
"draft_id": "draft-88ab12",
"field_id": "field_visit_notes",
"text": "Patient reported improved mobility since last visit. No pain reported. Gait is steady.",
"updated_at": "2026-03-26T11:41:00Z"
}
DELETE
/api/v1/partial-transcriptions/api/v1/partial-transcriptions/:id
Delete a single partial transcription record
Public
Response Example
{
"partial_id": "pt-aa13",
"deleted": true
}
POST
/api/v1/partial-transcriptions/api/v1/partial-transcriptions/commit
Commit a partial transcription for a draft+field to the main form and clear the partial
Public
Request Example
{
"draft_id": "draft-88ab12",
"field_id": "field_visit_notes"
}
Response Example
{
"draft_id": "draft-88ab12",
"field_id": "field_visit_notes",
"committed_text": "Patient reported improved mobility since last visit. No pain reported. Gait is steady.",
"committed_at": "2026-03-26T11:42:00Z",
"partial_cleared": true
}
DELETE
/api/v1/partial-transcriptions/api/v1/partial-transcriptions/drafts/:draft_id
Clear all partial transcriptions for an entire draft (e.g. on cancel)
Public
Response Example
{
"draft_id": "draft-88ab12",
"cleared": true,
"fields_cleared": [
"field_visit_notes",
"field_observations"
]
}