Skip to main content
POST
/
spakinect
/
gfe
Create Gfe Request
curl --request POST \
  --url https://api.decodahealth.com/spakinect/gfe \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "patientId": "<string>",
  "locationId": "<string>",
  "appointmentTime": "2023-11-07T05:31:56Z",
  "requestedTreatments": [
    "<string>"
  ],
  "patientEmail": "[email protected]",
  "patientPhone": "<string>"
}
'
{
  "id": "<string>",
  "patientId": "<string>",
  "spakinectGfeId": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "status": "Processing",
  "requestedTreatments": [
    "<string>"
  ],
  "patientDetails": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "name": "<string>",
    "phone": "<string>"
  },
  "updatedDate": "2023-11-07T05:31:56Z",
  "document": {
    "id": "<string>",
    "patientId": "<string>",
    "filePath": "<string>",
    "fileType": "<string>",
    "title": "<string>",
    "summary": "<string>",
    "docType": "LAB",
    "signatureUrl": "<string>"
  }
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Body

application/json

Request to create a new Good Faith Exam appointment

​
patientId
string
required
​
locationId
string
required
​
appointmentTime
string<date-time>
required
​
requestedTreatments
string[]
required
​
patientEmail
string<email> | null
​
patientPhone
string | null

Response

Successful Response

Detailed Good Faith Exam information including SpaKinect data

​
id
string
required
​
patientId
string
required
​
spakinectGfeId
string
required
​
createdDate
string<date-time>
required
​
status
enum<string>
required

Status values for Good Faith Exam visits from SpaKinect API

Available options:
Processing,
Pending Review,
Approved,
Rejected,
Completed,
Cancelled,
Cancelled by client
​
requestedTreatments
string[]
required
​
patientDetails
PatientDetails · object
required
​
updatedDate
string<date-time> | null
​
document
DocumentSummary · object