Skip to content
reference
/
Mutations
/
submitContactPrescriptionVerificationRequest

GraphQL Overview

Download GraphQL schema
visibly-api.graphql

Queries

Overview

Mutations

Overview

savePatient

(patient)
Boolean

Save patient detailst

Arguments

patient
PatientInput!,non-nullrequired

Patient details

Return type

Boolean

The Boolean scalar type represents true or false.

Mutation sample
mutation savePatient($patient: PatientInput!) {
  savePatient(patient: $patient) 
}
Variables
{
  "patient": {
    "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"
  }
}
Response sample
{
  "data": true
}

saveContactsPrescription

(prescription)
Boolean

Save contacts prescription details

Arguments

prescription
ContactsPrescriptionInput!,non-nullrequired

Contacts prescription details

Return type

Boolean

The Boolean scalar type represents true or false.

Mutation sample
mutation saveContactsPrescription($prescription: ContactsPrescriptionInput!) {
  saveContactsPrescription(prescription: $prescription) 
}
Variables
{
  "prescription": {
    "fileId": "Example String",
    "prescriptionId": "Example String",
    "doctor": {
      "__typename": "DoctorInput"
    },
    "patient": {
      "__typename": "PatientInput"
    },
    "products": {
      "__typename": "ContactsProductsInput"
    }
  }
}
Response sample
{
  "data": true
}

saveGlassesPrescription

(prescription)
Boolean

Save glasses prescription details

Arguments

prescription
GlassesPrescriptionInput!,non-nullrequired

Glasses prescription details

Return type

Boolean

The Boolean scalar type represents true or false.

Mutation sample
mutation saveGlassesPrescription($prescription: GlassesPrescriptionInput!) {
  saveGlassesPrescription(prescription: $prescription) 
}
Variables
{
  "prescription": {
    "fileId": "Example String",
    "prescriptionId": "Example String",
    "doctor": {
      "__typename": "DoctorInput"
    },
    "patient": {
      "__typename": "PatientInput"
    },
    "corrections": [
      {
        "__typename": "GlassesLensesInput"
      }
    ]
  }
}
Response sample
{
  "data": true
}

startWorkflowdeprecated

(...args)
Workflow

Deprecation reason

Use startVisionTest.

Start a workflow utilizing one or more Visibly services

Arguments

name
String!,non-nullrequired

The name of the workflow to run

patient
PatientInput

Optional patient information

doctorId
String

Optional doctor Id

doctor
DoctorInput

Optional doctor information

products
[ContactProductInput]

Optional ordered products

prescriptions
[ContactProductInput]

Prescriptions pertinent to the ordered products

fileIds
[String]

File IDs from uploadFile for flat files containing prescription information

tags
[TagInput]

List of tags used to correlate this workflow with other systems

Return type

Workflow
workflowId
String!,non-null

Unique ID for this workflow

launchUrl
String

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

requestId
String

Unique ID for a prescription verification request if applicable

requestStatus
ContactPrescriptionVerificationRequestStatus

Current request status

jobId
String

Unique ID for a prescription verification job (conditionally available)

status
String

Current prescription verification job status (conditionally available)

updatedAt
String

Last date and time this request was updated

Mutation sample
mutation startWorkflow(
  $name: String!
  $patient: PatientInput
  $doctorId: String
  $doctor: DoctorInput
  $products: [ContactProductInput]
  $prescriptions: [ContactProductInput]
  $fileIds: [String]
  $tags: [TagInput]
) {
  startWorkflow(
    name: $name
    patient: $patient
    doctorId: $doctorId
    doctor: $doctor
    products: $products
    prescriptions: $prescriptions
    fileIds: $fileIds
    tags: $tags
  ) {
    workflowId 
    launchUrl 
    requestId 
    requestStatus 
    jobId 
    status 
    updatedAt 
  }
}
Variables
{
  "name": "Example String",
  "patient": {
    "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"
  },
  "doctorId": "Example String",
  "doctor": {
    "doctorId": "Example String",
    "doctorName": "Example String",
    "practiceName": "Example String",
    "phoneNumber": "Example String",
    "faxNumber": "Example String",
    "email": "Example String",
    "address": "Example String",
    "address2": "Example String",
    "city": "Example String",
    "state": "Example String",
    "zipCode": "Example String",
    "url": "Example String"
  },
  "products": [
    {
      "productId": "Example String",
      "eye": "RIGHT",
      "sphere": "Example String",
      "diameter": "Example String",
      "baseCurve": "Example String",
      "axis": "Example String",
      "cylinder": "Example String",
      "addition": "Example String",
      "dominance": "Example String",
      "color": "Example String",
      "packageSize": 40,
      "quantity": 40
    }
  ],
  "prescriptions": [
    {
      "productId": "Example String",
      "eye": "RIGHT",
      "sphere": "Example String",
      "diameter": "Example String",
      "baseCurve": "Example String",
      "axis": "Example String",
      "cylinder": "Example String",
      "addition": "Example String",
      "dominance": "Example String",
      "color": "Example String",
      "packageSize": 40,
      "quantity": 40
    }
  ],
  "fileIds": [
    "Example String"
  ],
  "tags": [
    {
      "name": "Example String",
      "value": "Example String"
    }
  ]
}
Response sample
{
  "data": {
    "workflowId": "Example String",
    "launchUrl": "Example String",
    "requestId": "Example String",
    "requestStatus": "NEW",
    "jobId": "Example String",
    "status": "Example String",
    "updatedAt": "Example String"
  }
}

fulfillOrderdeprecated

(...args)
Order

Deprecation reason

Use submitOrder

Fulfill order

Arguments

orderedAt
String!,non-nullrequired

Date and time when the order was placed in ISO 8601 format

customer
CustomerInput!,non-nullrequired

Customer information

shipping
ShippingInput!,non-nullrequired

Shipping details

items
[ItemInput]

Items in the order

tags
[TagInput]

List of tags

Return type

Order
orderId
String

Unique ID for this order

status
String

Current order status

Mutation sample
mutation fulfillOrder(
  $orderedAt: String!
  $customer: CustomerInput!
  $shipping: ShippingInput!
  $items: [ItemInput]
  $tags: [TagInput]
) {
  fulfillOrder(
    orderedAt: $orderedAt
    customer: $customer
    shipping: $shipping
    items: $items
    tags: $tags
  ) {
    orderId 
    status 
  }
}
Variables
{
  "orderedAt": "Example String",
  "customer": {
    "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"
  },
  "shipping": {
    "method": "Example String",
    "address": {
      "__typename": "ShippingAddressInput"
    }
  },
  "items": [
    {
      "type": "GLASSES",
      "itemId": "Example String",
      "description": "Example String",
      "comment": "Example String",
      "glasses": {
        "__typename": "GlassesItemInput"
      },
      "lensReplacement": {
        "__typename": "LensReplacementItemInput"
      },
      "contacts": {
        "__typename": "ContactsItemInput"
      }
    }
  ],
  "tags": [
    {
      "name": "Example String",
      "value": "Example String"
    }
  ]
}
Response sample
{
  "data": {
    "orderId": "Example String",
    "status": "Example String"
  }
}

submitContactPrescriptionVerificationRequestdeprecated

(...args)
ContactPrescriptionVerificationRequest

Deprecation reason

Use verifyContactsPrescription.

Submit a contact prescription verification request

Arguments

patient
PatientInput!,non-nullrequired

Patient information

doctorId
String

The doctor ID from the doctors query (conditionally required if doctor is not set)

doctor
DoctorInput

Doctor details (conditionally required if doctorId is not set)

products
[ContactProductInput]!,non-nullrequired

Ordered products

prescriptions
[ContactProductInput]

Prescriptions pertinent to the ordered products (conditionally required if fileIds is not set)

fileIds
[String]

File IDs from uploadFile for flat files containing prescription information (conditionally required if prescriptions is not set)

tags
[String]

Optional list of tags used to correlate this request with other systems

Return type

ContactPrescriptionVerificationRequest
id
String!,non-null

Unique ID for this request

status
ContactPrescriptionVerificationRequestStatus!,non-null

Current request status

expirationDate
String

Prescription expiration date if it is available

comments
String

Comments entered by Doctor and/or Visibly

updatedAt
String!,non-null

Last date and time this request was updated

Mutation sample
mutation submitContactPrescriptionVerificationRequest(
  $patient: PatientInput!
  $doctorId: String
  $doctor: DoctorInput
  $products: [ContactProductInput]!
  $prescriptions: [ContactProductInput]
  $fileIds: [String]
  $tags: [String]
) {
  submitContactPrescriptionVerificationRequest(
    patient: $patient
    doctorId: $doctorId
    doctor: $doctor
    products: $products
    prescriptions: $prescriptions
    fileIds: $fileIds
    tags: $tags
  ) {
    id 
    status 
    expirationDate 
    comments 
    updatedAt 
  }
}
Variables
{
  "patient": {
    "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"
  },
  "doctorId": "Example String",
  "doctor": {
    "doctorId": "Example String",
    "doctorName": "Example String",
    "practiceName": "Example String",
    "phoneNumber": "Example String",
    "faxNumber": "Example String",
    "email": "Example String",
    "address": "Example String",
    "address2": "Example String",
    "city": "Example String",
    "state": "Example String",
    "zipCode": "Example String",
    "url": "Example String"
  },
  "products": [
    {
      "productId": "Example String",
      "eye": "RIGHT",
      "sphere": "Example String",
      "diameter": "Example String",
      "baseCurve": "Example String",
      "axis": "Example String",
      "cylinder": "Example String",
      "addition": "Example String",
      "dominance": "Example String",
      "color": "Example String",
      "packageSize": 40,
      "quantity": 40
    }
  ],
  "prescriptions": [
    {
      "productId": "Example String",
      "eye": "RIGHT",
      "sphere": "Example String",
      "diameter": "Example String",
      "baseCurve": "Example String",
      "axis": "Example String",
      "cylinder": "Example String",
      "addition": "Example String",
      "dominance": "Example String",
      "color": "Example String",
      "packageSize": 40,
      "quantity": 40
    }
  ],
  "fileIds": [
    "Example String"
  ],
  "tags": [
    "Example String"
  ]
}
Response sample
{
  "data": {
    "id": "Example String",
    "status": "NEW",
    "expirationDate": "Example String",
    "comments": "Example String",
    "updatedAt": "Example String"
  }
}

Directives

Overview

Objects

Overview

Interfaces

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview