Getting Started
API
- PUTArchive Block
- DELArchive Form
- POSTCreate Form
- GETForm Path Exists
- GETForms Exist
- GETGet Consent Info
- GETGet Form
- GETGet Form Details
- GETGet Form Structure
- GETGet Form Submissions
- GETGet Forms With Status
- GETGet Patient Submissions
- PUTInsert Block
- PUTInsert Question
- GETList Forms
- GETList Forms
- PUTPatient Form Submission
- POSTPatient Responsibility
- GETPayers
- GETService Forms Exist
- PUTUpdate Form
- PUTUpdate Form Default Text
- POSTUpload File
- PUT
Tenant
Create Form
Copy
curl --request POST \
--url https://api.decodahealth.com/forms \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"id": "<string>",
"name": "<string>",
"pathName": "<string>",
"description": "<string>",
"blocks": []
}
'Copy
{
"id": "<string>",
"name": "<string>",
"pathName": "<string>",
"description": "<string>",
"blocks": []
}Forms
Create Form
POST
/
forms
Create Form
Copy
curl --request POST \
--url https://api.decodahealth.com/forms \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"id": "<string>",
"name": "<string>",
"pathName": "<string>",
"description": "<string>",
"blocks": []
}
'Copy
{
"id": "<string>",
"name": "<string>",
"pathName": "<string>",
"description": "<string>",
"blocks": []
}Headers
The tenant you are making this request on behalf of
Your api key
Body
application/json
Show child attributes
Show child attributes
Available options:
DYNAMIC, DEMOGRAPHICS, INSURANCE, PAYMENT_METHODS, MEDICAL_HISTORY blocks.questions
QuestionDetail[Union[Address, Date, Text, SingleSelect, MultiSelect, Toggle, Signature, FileUpload, PaymentMethod, Tag, Disclaimer, Statement, Document, Number, CalculatedScore]] · object[]
Show child attributes
Show child attributes
Available options:
ADDRESS, DATE, TEXT, NUMBER, TEXT_AREA, SINGLE_SELECT, RADIAL_SINGLE_SELECT, MULTI_SELECT, RADIAL_MULTI_SELECT, TOGGLE, SIGNATURE, FILE_UPLOAD, PHONE_NUMBER, EMAIL, PAYMENT_METHOD, TAG, DISCLAIMER, STATEMENT, DOCUMENT, FEET_INCHES_HEIGHT, POUNDS_WEIGHT, CALCULATED_SCORE Show child attributes
Show child attributes
Available options:
EQUALS, NOT_EQUALS, CONTAINS, YEARS_AGO_MINIMUM, YEARS_AGO_MAXIMUM, SUM Response
Successful Response
Show child attributes
Show child attributes
Available options:
DYNAMIC, DEMOGRAPHICS, INSURANCE, PAYMENT_METHODS, MEDICAL_HISTORY blocks.questions
QuestionDetail[Union[Address, Date, Text, SingleSelect, MultiSelect, Toggle, Signature, FileUpload, PaymentMethod, Tag, Disclaimer, Statement, Document, Number, CalculatedScore]] · object[]
Show child attributes
Show child attributes
Available options:
ADDRESS, DATE, TEXT, NUMBER, TEXT_AREA, SINGLE_SELECT, RADIAL_SINGLE_SELECT, MULTI_SELECT, RADIAL_MULTI_SELECT, TOGGLE, SIGNATURE, FILE_UPLOAD, PHONE_NUMBER, EMAIL, PAYMENT_METHOD, TAG, DISCLAIMER, STATEMENT, DOCUMENT, FEET_INCHES_HEIGHT, POUNDS_WEIGHT, CALCULATED_SCORE Show child attributes
Show child attributes
Available options:
EQUALS, NOT_EQUALS, CONTAINS, YEARS_AGO_MINIMUM, YEARS_AGO_MAXIMUM, SUM ⌘I