Skip to main content
PATCH
/
spakinect
/
gfe
/
{gfe_id}
/
cancel
Cancel Gfe
curl --request PATCH \
  --url https://api.decodahealth.com/spakinect/gfe/{gfe_id}/cancel \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "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

Path Parameters

​
gfe_id
string
required

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