Sign in

v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB
/api/v1/form-filling/session

Get form-filling structured data

Returns structured medical form output for a completed form-filling session.

get/api/v1/form-filling/session/{ambient_session_id}/structured-data

Path parameters

ambient_session_idstring required

Form-filling session ID. The path parameter is named ambient_session_id, but this value identifies the form-filling session, not an ambient clinical documentation session. Use the ID returned from Create Form filling Session, or the UUID you supplied in that request.

Headers

sdp_provider_idstring
Example:provider-123

Optional for standard partners.

Required for:

  • Bearer authentication. Use the same provider_id returned by the Login or Register API.
  • Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Response

Request succeeded.

Example response

{
  "structured_data": {
    "generated_values": [
      {
        "correlation_id": "20965414-929a-4f71-a3e5-b92bec07d086",
        "created_at": "2026-01-01T00:00:00Z",
        "data": {},
        "form_template_id": "019d4cdc-9319-7d81-ae2e-fd6de7f1b4f0-template",
        "id": "019d4cdc-9319-7d81-ae2e-fd6de7f1b4f0",
        "metadata": {},
        "patient_id": "patient-123",
        "status": "MEDICAL_FORM_STATUS_COMPLETED",
        "title": "Adult Vitals",
        "type": "VITALS_ASSESSMENT"
      }
    ],
    "non_generated_values": [
      {
        "form_template_id": "019d4cdc-9319-7d81-ae2e-fd6de7f1b4f0"
      }
    ]
  }
}