{
 "openapi": "3.1.0",
 "info": {
  "title": "Clinical Documentation (EHR)",
  "version": "20261030b",
  "description": "A signed note is the legal record: it is never edited, only addended."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "notes": {
    "type": "object",
    "required": [
     "patient_id"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "note_no": {
      "type": "string",
      "description": "Note no",
      "readOnly": true
     },
     "patient_id": {
      "type": "string",
      "format": "uuid",
      "description": "Patient"
     },
     "encounter_id": {
      "type": "string",
      "format": "uuid",
      "description": "Encounter"
     },
     "department_id": {
      "type": "string",
      "format": "uuid",
      "description": "Department"
     },
     "author_id": {
      "type": "string",
      "format": "uuid",
      "description": "Author"
     },
     "template_id": {
      "type": "string",
      "format": "uuid",
      "description": "Template"
     },
     "note_type": {
      "type": "string",
      "description": "Type"
     },
     "subjective": {
      "type": "string",
      "description": "Subjective"
     },
     "objective": {
      "type": "string",
      "description": "Objective"
     },
     "assessment": {
      "type": "string",
      "description": "Assessment"
     },
     "plan": {
      "type": "string",
      "description": "Plan"
     },
     "content": {
      "type": "string",
      "description": "Free text"
     },
     "status": {
      "type": "string",
      "description": "Status",
      "readOnly": true
     },
     "signed_at": {
      "type": "string",
      "format": "date-time",
      "description": "Signed at",
      "readOnly": true
     },
     "signed_by": {
      "type": "string",
      "format": "uuid",
      "description": "Signed by",
      "readOnly": true
     },
     "cosign_required": {
      "type": "boolean",
      "description": "Requires cosignature"
     },
     "cosigned_by": {
      "type": "string",
      "format": "uuid",
      "description": "Cosigned by",
      "readOnly": true
     },
     "cosigned_at": {
      "type": "string",
      "format": "date-time",
      "description": "Cosigned at",
      "readOnly": true
     },
     "addends_note_id": {
      "type": "string",
      "format": "uuid",
      "description": "Addends note id",
      "readOnly": true
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/ehr/notes": {
   "get": {
    "summary": "list notes",
    "operationId": "list_notes_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create notes",
    "operationId": "create_notes_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ehr/notes/{id}": {
   "get": {
    "summary": "get notes",
    "operationId": "get_notes_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change notes",
    "operationId": "change_notes_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete notes",
    "operationId": "delete_notes_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ehr/notes/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_notes_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ehr/notes/{id}/sign": {
   "post": {
    "summary": "Sign",
    "operationId": "action_notes_0_6",
    "description": "Body keys: providerId",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ehr/notes/{id}/addendum": {
   "post": {
    "summary": "Addendum",
    "operationId": "action_notes_0_6",
    "description": "Body keys: content*, providerId",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}