Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Order

Order details

orderId

Unique ID for this order

status

Current order status

Sample
{ "orderId": "Example String", "status": "Example String" }

Tag

Custom tags containing references to other systems

name
String!,non-null

The name of the tag

value
String!,non-null

The value of the tag

Sample
{ "name": "Example String", "value": "Example String" }

ContactsProduct

productId

ID that uniquely maps to a manufacturer, brand, and model combination

manufacturer

Manufacturer name

brand

Brand name

schedule

Schedule name

type

Type name (Toric, Multi-Focal, etc.)

diameter

The width of the contact lens from edge to edge measured by millimeters

baseCurve

Indication of the curvature of the inside of the lens measured in millimeters

sphere

The amount of lens power measured in diopters (D), minus sign (–) for nearsighted, plus sign (+) for farsighted

axis

The lens meridian with no cylinder power, indicated by a value between 1 and 180 degrees

cylinder

The amount of lens power for astigmatism measured in diopters (D), minus sign (–) for nearsighted, plus sign (+) for farsighted

addition

The additional magnifying power that applies to the bottom portion of multifocal lenses to fix presbyopia

dominance

Indication of dominant or non-dominant eye

color

Color of the lens

packageSize

Number of lenses per package

quantity

Number of packages

Sample
{ "productId": "Example String", "manufacturer": "Example String", "brand": "Example String", "schedule": "Example String", "type": "Example String", "diameter": 40, "baseCurve": 40, "sphere": 40, "axis": 40, "cylinder": 40, "addition": 40, "dominance": "Example String", "color": "Example String", "packageSize": 40, "quantity": 40 }

ContactsProducts

Sample
{ "right": { "__typename": "ContactsProduct" }, "left": { "__typename": "ContactsProduct" } }

ContactsPrescription

fileId

File ID from uploadFile (conditionally required if doctor and patient are not set)

prescriptionId

Prescription ID

issueDate

Prescription issue date, if available

expirationDate

Prescription expiration date, if available

doctor

Doctor details (conditionally required if prescription file ID is not set)

patient

Patient details (conditionally required if prescription file ID is not set)

Details about the prescribed contacts

comments

Doctor-entered comments

Sample
{ "fileId": "Example String", "prescriptionId": "Example String", "issueDate": "Example String", "expirationDate": "Example String", "doctor": { "__typename": "Doctor" }, "patient": { "__typename": "Patient" }, "products": { "__typename": "ContactsProducts" }, "comments": "Example String" }
Referenced in

Contacts

Sample
{ "products": [ { "__typename": "ContactsProducts" } ], "prescription": { "__typename": "ContactsPrescription" } }

ContactsVerificationJob

Contacts verification job details

jobId

Unique ID for this job

status

Current job status

reason

Current job reason, if applicable

notes

Notes entered by Doctor and/or Visibly

contacts

Contacts details

tags

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Implements interfaces

ContactsJob

Contacts job interface

Sample
{ "jobId": "Example String", "status": "Example String", "reason": "Example String", "notes": "Example String", "contacts": { "__typename": "Contacts" }, "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

ContactsSuggestionJob

Contacts suggestion job details

jobId

Unique ID for this job

status

Current job status

reason

Current job reason, if applicable

notes

Notes entered by Doctor and/or Visibly

contacts

Contacts details

tags

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Implements interfaces

ContactsJob

Contacts job interface

Sample
{ "jobId": "Example String", "status": "Example String", "reason": "Example String", "notes": "Example String", "contacts": { "__typename": "Contacts" }, "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

Patient

Information about the patient

patientId

Patient ID

firstName

First name

middleName

Middle name

lastName

Last name

dateOfBirth

Date of birth in ISO 8601 format, i.e., YYYY-MM-DD

phoneNumber

Phone number

email

Email address

address

Street address #1

address2

Street address #2

city

City

state

State

zipCode

Zip code

Sample
{ "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" }

Interfaces

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview