Visit Booking Service (1.0.0)

Download OpenAPI specification:Download

Visit Booking Service

Visit Booking

Booking a visit for a patient

queued-guest-visit

request a new queued guest visit

request a new queued guest visit.

query Parameters

product

required

string

Default: "DCIntSched"

Enum: "DCIntSched" "Other"

identifies the source system calling the queued guest visit creation endpoint

header Parameters

correlationId

string <uuid>

Unique id to correlate call logs between our microservices

Request Body schema: application/json
required

Queued guest visit request

	object individual acting as a Patient proxy - i.e. a guardian or helper to the patient; required when visitDetails declaration is 'other'
required	object or object or object or object
required	object general patient fields
required	object
	Array of objects customer defined data for display and reporting purposes

Responses

Request samples

Payload

Content type

application/json

{"actor": {"firstName": "string",
"lastName": "string",
"middleName": "string",
"suffixName": "string",
"phone": "string",
"relationshipToPatient": "Guardian",
"gender": "male",
"dateOfBirth": "^\\dddd-\\dd-\\dd$",
"email": "string"
},
"billingInfo": {"paymentMethod": "insurance",
"declaration": "self",
"insuranceType": "manual",
"insuranceProviderId": "string",
"insuranceMemberId": "string",
"insuranceGroupNumber": "^$"
},
"patient": {"firstName": "string",
"middleName": "string",
"lastName": "string",
"suffixName": "string",
"email": "string",
"phone": "string",
"ssn": "stri",
"gender": "male",
"dateOfBirth": "^\\dddd-\\dd-\\dd$",
"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
}
},
"visitDetails": {"acceptedTerms": true,
"assessmentToolUsed": "ada",
"assignmentQualifiers": ["pediatric"
],
"attributionIds": "string",
"brand": "string",
"declaration": "self",
"interpreterLanguage": "ase",
"stateLicensure": "WA",
"scheduledDepartment": {"scheduledDepartmentId": "string",
"scheduledEhr": "string"
},
"traveling": false,
"urgency": 0,
"visitReason": "string",
"visitTypeName": "virtual",
"initialStatus": "requested",
"detectedLanguage": "en-US"
},
"additionalDetails": [{"key": "string",
"value": "string"
}
]
}

Response samples

200
400
401
500