Orders
Register Testkit Order
Orders
Register Testkit Order
POST
/
v3
/
order
/
testkit
/
register
x-vital-api-key
string
*
x-vital-api-key
Required
string
Vital Team API Key
object
*
user_id
string
*
user_id
Required
string
sample_id
string
*
sample_id
Required
string
patient_details
object
*
patient_details
Required
object
first_name
string
*
first_name
Required
string
last_name
string
*
last_name
Required
string
dob
string
*
dob
Required
string
gender
enum<string>
*
gender
Required
enum<string>
phone_number
string
*
phone_number
Required
string
email
string
*
email
Required
string
patient_address
object
*
patient_address
Required
object
receiver_name
string
receiver_name
string
first_line
string
*
first_line
Required
string
second_line
string
second_line
string
city
string
*
city
Required
string
state
string
*
state
Required
string
zip
string
*
zip
Required
string
country
string
*
country
Required
string
phone_number
string
phone_number
string
physician
object
physician
object
first_name
string
*
first_name
Required
string
last_name
string
*
last_name
Required
string
email
string
email
string
npi
string
*
npi
Required
string
licensed_states
array
licensed_states
array
health_insurance
object
health_insurance
object
front_image
Front Image · object
front_image
object
An image of the front of the patient insurance card.
content
file
*
content
Required
file
content_type
enum<string>
*
content_type
Required
enum<string>
back_image
Back Image · object
back_image
object
An image of the back of the patient insurance card.
content
file
*
content
Required
file
content_type
enum<string>
*
content_type
Required
enum<string>
patient_signature_image
Patient Signature Image · object
patient_signature_image
object
An image of the patient signature for health insurance billing.
content
file
*
content
Required
file
content_type
enum<string>
*
content_type
Required
enum<string>
subjective
string
subjective
string
Textual description of what are the patient symptoms and attempted treatments.
assessment_plan
string
assessment_plan
string
Textual description of what are the physician assessments and testing plans.
payor_code
string
payor_code
string
Unique identifier representing a specific Health Insurance.
insurance_id
string
insurance_id
string
Insurance unique number assigned to a patient, usually present on the insurance card.
responsible_relationship
enum<string>
responsible_relationship
enum<string>
Relationship between the patient and the insurance contractor. Values can be (Self, Spouse, Other Relationship).
responsible_details
object
responsible_details
object
Responsible details when the value of responsible_relationship is not 'Self'.
first_name
string
*
first_name
Required
string
last_name
string
*
last_name
Required
string
address
object
*
address
Required
object
first_line
string
*
first_line
Required
string
second_line
string
second_line
string
country
string
*
country
Required
string
zip
string
*
zip
Required
string
city
string
*
city
Required
string
state
string
*
state
Required
string
phone_number
string
*
phone_number
Required
string
phone_type
string
phone_type
string
diagnosis_codes
array
diagnosis_codes
array
Diagnosis codes for insurance billing.
consents
array
consents
array
Authorizations
x-vital-api-key
string
headerrequiredVital Team API Key
Body
application/json
user_id
string
requiredsample_id
string
requiredpatient_details
object
requiredpatient_address
object
requiredphysician
object | null
health_insurance
object | null
consents
object[]
Response
200 - application/json
order
object
requiredstatus
string
requiredmessage
string
required