v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

Form Submissions

Create a multi-tenant form submission (v2)

Creates a canonical form submission and fans out practitioner/facility crosswalk creation to multiple tenants in parallel. Returns per-tenant results with an aggregated status of success, partial_success, or failed. GCS document uploads are dispatched as Cloud Tasks asynchronously.

post/v2/forms/submissions

Headers

tenant-idstring required

Owning tenant (organization) identifier

Request body

{"stackTrail":"components:schemas:CreateMultiTenantFormSubmissionRequest:properties:data","oasType":"schema","type":"unknown","description":"A flexible object for storing any data related to a form submission. May contain practitionerData or facilityData (but not both) as nested objects, plus submissionPdfUrl, supportingDocuments, and any other form fields.","example":{}}

tenantIdsstring[] required

List of tenant IDs to fan out to. Must contain at least one entry.

optionsobject

Per-tenant options controlling crosswalk creation. Keys are tenant IDs. Tenants absent from this map default to createPractitioner=false and createFacility=false.

Example request

{
  "data": {},
  "tenantIds": [
    "tenant_blue_cross",
    "tenant_presbyterian"
  ],
  "options": {
    "tenant_blue_cross": {
      "createPractitioner": true,
      "createFacility": false
    }
  }
}

Response

Canonical form submission created. Per-tenant results in tenantResults. HTTP 201 is returned even on partial_success or failed fan-out outcomes.

formSubmissionIdstring

Unique identifier of the canonical form submission record

statusstring

Aggregated status across all tenants: success, partial_success, or failed

gcsUploadStartedboolean

Reserved for GCS document upload dispatch. Always false in this release; will reflect actual Cloud Task dispatch in a follow-up PR.

Example response

{
  "formSubmissionId": "sub_a1b2c3d4",
  "status": "partial_success",
  "tenantResults": [
    {
      "tenantId": "tenant_blue_cross",
      "status": "success",
      "certifyId": "certify_pract_001",
      "errorCode": "DOWNSTREAM_VALIDATION_ERROR",
      "errorMessage": "Missing required payer field"
    }
  ]
}