Document Type - Corrective Lens
The Document Type - Corrective Lens, documents eye-specific measurements, track measurements over time, and documents an end-to-end vision correction exam.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
Get list of corrective lens documents for patient
GET
/v1/{practiceid}/patients/{patientid}/documents/correctivelens
Retrieve list of corrective Len documents of a specific patient
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
showdeleted
boolean
By default, deleted documents are not listed. Set to list these.
status
string
The status of the task to filter document results.
departmentid
integer
The athenaNet department id.
encounterid
integer
Show only documents attached to this encounter.
documentsubclass
string
The document subclass to filter document results.
limit
integer
Number of entries to return (default 1500, max 5000)
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
appointmentid
integer
The appointment ID for this document
assignedto
string
Person the document is assigned to
clinicalproviderid
integer
The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies.
correctivelensid
integer
ID of a correctivelens document.
createddate
string
Date the document was created. Please use createddatetime instead.
createddatetime
string
Date/Time (ISO 8601) the document was created
deleteddatetime
string
Date/time (ISO 8601) the document was deleted
departmentid
string
Department for the document
diagnosislist
array
Diagnoses for this document
documentclass
string
Class of document
documentdescription
string
Description of the document type
documentroute
string
Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource
string
Explains where this document originated.
documentsubclass
string
Specific type of document
documenttype
string
The description for this document
documenttypeid
integer
The ID of the description for this document
encounterid
string
Encounter ID
expirationdate
string
The expiration date of a correctivelens order.
externalaccessionid
string
The external accession ID for this document. Format depends on the system the ID belongs to.
futuresubmitdate
string
The future submit date in the format mm/dd/yyyy.
glassestypeid
integer
ID for the glasses type.
internalaccessionid
string
The internal accession ID for this document. Format depends on the system the ID belongs to.
internalnote
string
The 'Internal Note' attached to this document
lastmodifieddatetime
string
Date/time (ISO 8601) the document was last modified
leftrefraction
object
A set of refraction measurements for the left eye.
nearpupillarydistance
string
The distance between the patient's pupils, measured in millimeters, for the purposes of near vision. This is used only for multifocal lenses (e.g., bifocal, progessive).
notetoclinicalprovider
string
A note to send to the pharmacy.
observationdatetime
string
Date/time (ISO 8601) the observation was taken
orderingmode
string
Ordering Mode for a prescription. One of Prescribe, Adminster, Dispense
patientnote
string
External note for the patient.
priority
string
Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid
integer
Provider ID for this document
pupillarydistance
string
The distance between the patient's pupils, measured in millimeters. This is the only pupillary distance measurement for single-vision lenses. For multifocal lenses (e.g., bifocal, progessive), this represents the pupillary distance measurement for the purposes of distance vision.
receivernote
string
The external note sent to the receiving facility
rightrefraction
object
A set of refraction measurements for the right eye.
status
string
Status of the document
subject
string
Subject of the document
tietoorderid
integer
Order ID of the order this document is tied to, if any
Example Code