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>",
  "visitType": "at_home",
  "requestedTreatments": [
    "<string>"
  ],
  "appointmentTime": "2023-11-07T05:31:56Z",
  "patientEmail": "[email protected]",
  "patientPhone": "<string>"
}
'
{
  "id": "<string>",
  "patientId": "<string>",
  "spakinectGfeId": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "status": "Intake",
  "requestedTreatments": [
    "<string>"
  ],
  "patientDetails": {
    "firstName": "<string>",
    "lastName": "<string>",
    "name": "<string>",
    "dob": "<string>",
    "email": "<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>"
  },
  "visitLink": "<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 visit (appointment or in-person)

​
patientId
string
required
​
locationId
string
required
​
visitType
enum<string>
required

Type of Good Faith Exam visit.

Note: The enum values ("at_home" and "on_demand") represent the visit timing/delivery mode. AT_HOME indicates a scheduled virtual appointment that the patient completes at home. ON_DEMAND indicates an immediate in-person visit that can be completed on-demand at the clinic.

Available options:
at_home,
on_demand
​
requestedTreatments
string[]
required
​
appointmentTime
string<date-time> | null
​
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:
Intake,
Processing,
Pending Review,
Approved,
Rejected,
Completed,
Cancelled,
Cancelled by client
​
requestedTreatments
string[]
required
​
patientDetails
PatientDetailsInPerson · object
required

Patient details for in-person visits.

Note: This schema is used both for creating visits (where DOB is required by the service layer) and for parsing API responses from SpaKinect (where DOB may be null). The schema allows None to accommodate API responses, but the service layer validates DOB is present when creating visits.

​
updatedDate
string<date-time> | null
​
document
DocumentSummary · object
​
visitLink
string | null