Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

FileUpload

Attributes of the file to be uploaded

id
String!,non-null

Unique File ID

name
String!,non-null

Full file name provided by the user

type
FileType!,non-null

File type corresponds directly with the MIME type (and often the file extension)

uploadUrl
String!,non-null

Signed URL enabling file upload via HTTP PUT with 15-minute expiration

Sample
{ "id": "Example String", "name": "Example String", "type": "BMP", "uploadUrl": "Example String" }

ContactPrescriptionVerificationRequest

Contact prescription verification request information

id
String!,non-null

Unique ID for this request

Current request status

expirationDate

Prescription expiration date if it is available

comments

Comments entered by Doctor and/or Visibly

updatedAt
String!,non-null

Last date and time this request was updated

Sample
{ "id": "Example String", "status": "NEW", "expirationDate": "Example String", "comments": "Example String", "updatedAt": "Example String" }

ContactPrescriptionVerificationJob

Contact prescription verification request information

jobId

Unique ID for this job

status

Current job status

reason

Current job reason, if applicable

notes

Notes entered by Doctor and/or Visibly

issueDate

Prescription issue date, if available

expirationDate

Prescription expiration date, if available

Prescriptions pertinent to the ordered products (inclusive of changes required)

tags

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Sample
{ "jobId": "Example String", "status": "Example String", "reason": "Example String", "notes": "Example String", "issueDate": "Example String", "expirationDate": "Example String", "prescriptions": [ { "__typename": "ContactPrescription" } ], "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

GlassesPrescriptionVerificationJob

Glasses prescription 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

issueDate

Prescription issue date, if available

expirationDate

Prescription expiration date, if available

tags

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

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

PrescriptionRenewal

Prescription renewal information

workflowId

Workflow ID associated with this prescription renewal

status

Current status

reason

Current reason, if applicable

issueDate

Prescription issue date, if available

expirationDate

Prescription expiration date, if available

Prescriptions pertinent to the ordered products (inclusive of changes required)

tags

List of tags used to correlate this renewal with other systems

updatedAt

Last date and time this renewal was updated

Sample
{ "workflowId": "Example String", "status": "Example String", "reason": "Example String", "issueDate": "Example String", "expirationDate": "Example String", "prescriptions": [ { "__typename": "ContactPrescription" } ], "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

Workflow

Start Workflow Request information

workflowId
String!,non-null

Unique ID for this workflow

launchUrl

If applicable, the launch URL for the first step in this workflow

requestId

Unique ID for a prescription verification request if applicable

Current request status

jobId

Unique ID for a prescription verification job (conditionally available)

status

Current prescription verification job status (conditionally available)

updatedAt

Last date and time this request was updated

Sample
{ "workflowId": "Example String", "launchUrl": "Example String", "requestId": "Example String", "requestStatus": "NEW", "jobId": "Example String", "status": "Example String", "updatedAt": "Example String" }

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

Interfaces

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview