v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

Form Submissions

Create a new form submission

Creates a new form submission. When createPractitioner is true, also creates or links a practitioner (using data.practitionerData) and a portal crosswalk; returns the form submission response with certifyId and providerCreated. Form submission is created first; on failure the request fails without creating a practitioner.

post/forms/submissions

Query parameters

createFacilityboolean

When true, creates a facility; response includes certifyId and facilityCreated in addition to form submission data.

createPractitionerboolean

When true, creates a practitioner from data.practitionerData and a portal crosswalk; response includes certifyId and providerCreated in addition to form submission data.

Headers

tenant-idstring required

Tenant (organization) identifier

Request body

{"stackTrail":"components:schemas:CreateFormSubmissionRequest:properties:data","oasType":"schema","type":"unknown","description":"A flexible object for storing any data related to a form submission. This can include details about the form, the submitted data, and metadata about the submission process.","example":{}}

Example request

{
  "data": {}
}

Response

Form submission created successfully. When createPractitioner is true, the response includes all form submission fields plus certifyId (tenant crosswalk identifier) and providerCreated (true if a new practitioner was created, false if the practitioner already existed).

idstring

The unique identifier for the form submission

organizationIdstring

The unique identifier for the client organization within Certify

{"stackTrail":"components:schemas:FormSubmissionResponseDto:properties:mappedData","oasType":"schema","type":"unknown","description":"The mapped responses for the form submission. The structure of this object is flexible and can vary based on the form and its fields.","example":{"personalInformation":{"lastName":"Smith","firstName":"Karen","middleName":"Ann","suffix":"Jr.","npi":1010000226,"caqhId":12345678,"dateOfBirth":"1961-04-26","highmarkId":"123456789","practitionerType":"Medical Doctor","degree":"Medical Doctor","primarySpecialty":"Internal Medicine","primarySpecialtyRole":"PCP","secondarySpecialty":"Infectious Disease","secondarySpecialtyRole":"Specialist","credentialingContactEmailAddress":"credentialing@altoonaprimarycare.com","credentialingContactName":"John Doe"},"primaryPracticeLocation":{"buildingLocation":"Altoona Medical Suites","groupNpi":1010000655,"addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"Altoona","state":"PA","zip":"16601","zipExt":"1234","county":"Blair County","fips":"42013"},"credentialingAddress":{"sameAsPrimaryPracticeLocation":true,"buildingLocation":"Altoona Medical Suites","addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"Altoona","state":"PA","zip":"16601","zipExt":"1234","county":"Blair County","fips":"42013","phoneNumber":"555-555-5555","phoneExtension":"123"}}}

{"stackTrail":"components:schemas:FormSubmissionResponseDto:properties:submissionData","oasType":"schema","type":"unknown","description":"The raw responses for the form submission. The structure of this object is flexible and can vary based on the form and its fields.","example":{}}

{"stackTrail":"components:schemas:FormSubmissionResponseDto:properties:submissionPdf","oasType":"schema","type":"unknown","description":"The PDF document of the form submission, if available","example":{}}

{"stackTrail":"components:schemas:FormSubmissionResponseDto:properties:form","oasType":"schema","type":"unknown","description":"Information about the form associated with the submission","example":{}}

formVersionIdstring

The id of the version of the form used for this submission

createdAtstring

The date and time when the form submission was created

createdBystring

The identifier of the user or system that created the submission

updatedAtstring

The date and time when the form submission was last updated

Example response

{
  "id": "d453006f-30e2-4a01-841d-962579531c25",
  "mappedData": {
    "personalInformation": {
      "lastName": "Smith",
      "firstName": "Karen",
      "middleName": "Ann",
      "suffix": "Jr.",
      "npi": 1010000226,
      "caqhId": 12345678,
      "dateOfBirth": "1961-04-26",
      "highmarkId": "123456789",
      "practitionerType": "Medical Doctor",
      "degree": "Medical Doctor",
      "primarySpecialty": "Internal Medicine",
      "primarySpecialtyRole": "PCP",
      "secondarySpecialty": "Infectious Disease",
      "secondarySpecialtyRole": "Specialist",
      "credentialingContactEmailAddress": "credentialing@altoonaprimarycare.com",
      "credentialingContactName": "John Doe"
    },
    "primaryPracticeLocation": {
      "buildingLocation": "Altoona Medical Suites",
      "groupNpi": 1010000655,
      "addressLine1": "Address Line 1",
      "addressLine2": "Address Line 2",
      "city": "Altoona",
      "state": "PA",
      "zip": "16601",
      "zipExt": "1234",
      "county": "Blair County",
      "fips": "42013"
    },
    "credentialingAddress": {
      "sameAsPrimaryPracticeLocation": true,
      "buildingLocation": "Altoona Medical Suites",
      "addressLine1": "Address Line 1",
      "addressLine2": "Address Line 2",
      "city": "Altoona",
      "state": "PA",
      "zip": "16601",
      "zipExt": "1234",
      "county": "Blair County",
      "fips": "42013",
      "phoneNumber": "555-555-5555",
      "phoneExtension": "123"
    }
  },
  "submissionData": {},
  "submissionPdf": {},
  "submittedBy": {
    "email": "user@example.com",
    "user": {}
  },
  "form": {},
  "formVersionId": "e4dea7d7-6023-4c64-b0f1-777dd0266a02",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-01T12:00:00Z"
}