Get Form
curl --request GET \
--url https://api.decodahealth.com/forms/by-path/{form_path} \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/forms/by-path/{form_path}"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/forms/by-path/{form_path}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/forms/by-path/{form_path}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/forms/by-path/{form_path}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.decodahealth.com/forms/by-path/{form_path}")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/forms/by-path/{form_path}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"patientId": "<string>",
"blocks": [
{
"blockType": "DYNAMIC",
"name": "<string>",
"position": 123,
"id": "<string>",
"answers": [
{
"question": {
"id": "<string>",
"blockId": "<string>",
"formId": "<string>",
"position": 123,
"questionType": "ADDRESS",
"required": true,
"data": {
"name": "<string>",
"description": "<string>",
"chartEntryLabel": "<string>"
},
"isArchived": false,
"mappingKey": "<string>",
"measurementFieldId": "<string>",
"externalId": "<string>",
"conditions": []
},
"measurementValueId": "<string>",
"data": "<unknown>"
}
],
"description": "<string>"
}
],
"description": "<string>",
"completed": true,
"isCompleted": false,
"expiresAt": "2023-11-07T05:31:56Z",
"isExpired": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Forms
Get Form
Get a form (with any prior answers for the patient) by its path name and completion status.
The requesting provider is the sender for {provider.*}: this route serves Fill In
Person and the tip screen, where the member of staff at the screen is the one putting
the form in front of the patient. Optional rather than required so the route’s auth
surface is unchanged — with nobody in scope the resolver falls back to the recorded
assignment, and refuses if there is none.
GET
/
forms
/
by-path
/
{form_path}
Get Form
curl --request GET \
--url https://api.decodahealth.com/forms/by-path/{form_path} \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/forms/by-path/{form_path}"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/forms/by-path/{form_path}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/forms/by-path/{form_path}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/forms/by-path/{form_path}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.decodahealth.com/forms/by-path/{form_path}")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/forms/by-path/{form_path}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"patientId": "<string>",
"blocks": [
{
"blockType": "DYNAMIC",
"name": "<string>",
"position": 123,
"id": "<string>",
"answers": [
{
"question": {
"id": "<string>",
"blockId": "<string>",
"formId": "<string>",
"position": 123,
"questionType": "ADDRESS",
"required": true,
"data": {
"name": "<string>",
"description": "<string>",
"chartEntryLabel": "<string>"
},
"isArchived": false,
"mappingKey": "<string>",
"measurementFieldId": "<string>",
"externalId": "<string>",
"conditions": []
},
"measurementValueId": "<string>",
"data": "<unknown>"
}
],
"description": "<string>"
}
],
"description": "<string>",
"completed": true,
"isCompleted": false,
"expiresAt": "2023-11-07T05:31:56Z",
"isExpired": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Response
Successful Response

