Guest Referral Input

Input representation of the request to create a patient referral record based on a guest user’s input.

Here’s an example request to create a patient referral from the OOTB web form filled by a guest user.

Here’s an example request to create a patient referral with the provided performers and requesters in the OOTB guest web form.

NameTypeDescriptionRequired or OptionalAvailable Version
captchaTokenCaptcha Token InputGoogle captcha verification token.
Because the referral information comes from a web form, this API expects a captcha token for security reasons. The guest referral API calls the Google API to verify the provided captcha.
A Google captcha token is valid only for 2 minutes.
Required60.0
patientRecord Fields Input[]Account details of the patient being referred.Required60.0
performerRecord Fields Input[]List of healthcare providers who perform the service.
You can provide a maximum of 5 provider IDs in a request.
Optional60.0
referralRecord Fields Input[]Referral information.Required60.0
referralDetailsReferral Detail Input[]Patient details, such as, insurance, and health condition.Optional60.0
referralNotesStringReferral notes.Optional60.0
requesterRecord Fields Input[]Information about the provider requesting the service. A requester can be an Account, Asset, Healthcare Provider, or a CareRegisteredDevice object.
If the requester is new, provide information to create an account.
Optional60.0