openapi: 3.2.0
info:
title: LKCloud LK Patient Data Link API
description: Ellkay Api documentation 6.6 Ellkay api
contact:
name: Ellkay
url: https://ellkay.com
email: ''
version: '6.6'
x-logo:
url: ./logo.png
altText: Ellkay Logo
servers:
- url: https://services.lkcloud.com
description: prod url
tags:
- name: LKPatientDataLink
description: PatientDataLink endpoint
paths:
/LKPatientDataLink/BeginGetUpdatedPatients:
post:
tags:
- LKPatientDataLink
summary: BeginGetUpdatedPatients
description: 'The BeginGetUpdatedPatients endpoint initiates the process to get updated patients in a specified date range, providing a next token for pagination purposes.
See error codes guide for instructions on paged error handling'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.BeginGetUpdatedPatientsSwaggerRequest'
example:
request:
startDate: '2023-12-31T00:00:00+00:00'
endDate: '2023-01-01T00:00:00+00:00'
providerId: '35473'
facilityId: '253562'
limit: 10
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PagedResult'
example:
nextToken: eyJSZXF1ZXN0SWQiOiJyV0lDdWp2d01CaEpvOXRaM2pON2U0QT09IiwiVG9rZW4iOiJwMHZwMEQ2OVZHRitEWHdvRExfSFUwTlE9PSJ9
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkBeginGetUpdatedPatients
x-operation-id-source: derived
/LKPatientDataLink/CloseEncounter:
post:
tags:
- LKPatientDataLink
summary: CloseEncounter
description: Close an encounter. Only supported for specific EHRs and limited encounter types.
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.CloseEncounterSwaggerRequest'
example:
request:
patientId: '1442678381000620'
encounterId: '1481732394050560'
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.CloseEncounterResult'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkCloseEncounter
x-operation-id-source: derived
/LKPatientDataLink/CreateEncounter:
post:
tags:
- LKPatientDataLink
summary: CreateEncounter
description: Creates a new encounter
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.CreateEncounterSwaggerRequest'
example:
request:
dateTime: '2023-08-01T00:00:00+00:00'
patient:
id: '1442678381000620'
facility:
id: '8'
provider:
id: '442'
comments: Simple text comment
reason:
id: '1'
reasonText: Encounter Reason Text
resource:
id: '519'
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.CreateEncounterResult'
example:
encounterId: '737846'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkCreateEncounter
x-operation-id-source: derived
/LKPatientDataLink/GetAllergies:
post:
tags:
- LKPatientDataLink
summary: GetAllergies
description: The GetAllergies endpoint returns a list of allergies for a patient, including details such as the date, comments, encounter ID, patient ID, allergen, reaction, and severity.
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetAllergiesSwaggerRequest'
example:
patientId: null
request:
patientId: '1225794122051060'
dateRange:
start: '2010-01-01T00:00:00+00:00'
end: '2014-01-07T00:00:00+00:00'
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetAllergiesResult'
example:
- date: 02/22/2020 00:00:00
created: 08/31/1984 14:20:00
modified: 08/31/1984 14:20:00
comments: Allergies trigger immune responses.
encounterId: '14281667'
patientId: '13267256'
physicianId: '13268163'
isAllergic: '1'
onsetDate: 08/31/1984 14:20:00
allergen: Lidocaine
reaction: Anaphylaxis
type: DA
severity: Moderate
codeSystemId: NDC
allergyCode: '10135057396'
id: '2946748'
legacyallergictoid: '455637'
updatedBy: '73268163'
updatedDate: 08/31/1984 14:20:00
reactionCode: '5409'
reactionCodeSystemID: '56984'
custom:
source: Manual Entry
note: Initial diagnosis from ER visit
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetAllergies
x-operation-id-source: derived
/LKPatientDataLink/GetDiagnoses:
post:
tags:
- LKPatientDataLink
summary: GetDiagnoses
description: The GetDiagnoses endpoint returns a list of diagnoses for a patient, including details such as code system ID, diagnosis code, description, and various status and date information.
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetDiagnosisSwaggerRequest'
example:
patientId: null
request:
patientId: '50846134'
dateRange:
start: '1984-08-31T00:00:00+00:00'
end: '1984-09-30T00:00:00+00:00'
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetDiagnosesResult'
example:
- legacyRowId: '34980152'
codeSystemId: ICD10
mapped: '0'
updatedBy: Marcus, Will
updatedDate: 08/31/1984 14:20:00
bcpFlag: '0'
icd10: M54.5
snomedCode: '279439007'
lifeCycle: Active Treatment
processId: '59871524'
xmlComments: xmlcomments
physicianId: '279007439'
original_StatusDescription: Diagnosed with Hypertension
legacyRowStatusDescription: Previously Active
rowState: Unchanged
deltaIdentifier: 08/31/1984 14:20:00
laterality: Unspecified
status: Active
resolvedBy: '59848124'
createDt: 08/31/1984 14:20:00
dateRecorded: 08/31/1984 14:20:00
srcCreateDate: 08/31/1984 14:20:00
srcModifiedDate: 08/31/1984 14:20:00
textType: '0'
miscText: misctext
comments: comments
encounterId: '49848130'
patientId: '50846134'
code: M51.26
description: Low back pain due to displacement of intervertebral disc
resolvedDate: 08/31/1984 14:20:00
onsetDate: 08/31/1984 14:20:00
result: Normal
udv: ml
accessLevel: '0'
custom:
reviewStatus: Peer Reviewed
clinicianNote: Continue monitoring blood sugar levels
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetDiagnoses
x-operation-id-source: derived
/LKPatientDataLink/GetEncounterNoteBody:
post:
tags:
- LKPatientDataLink
summary: GetEncounterNoteBody
description: 'The GetEncounterNoteBody endpoint returns the body of an encounter note, including details such as note ID, name, date, patient ID, provider, and file format.
If the original content is in HTML format, it will be converted to a PDF unless this option is disabled in the configuration. Structured documents will be returned in HTML format.'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetEncounterNoteBodySwaggerRequest'
example:
patientId: '41170010'
encounterNoteId: '38762828'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetEncounterNoteBodyResult'
example:
id: '38762828'
name: Office Visit
date: /Date(-62135448687934)/
patientId: '41170010'
fileFormat: txt
provider:
lastName: Shwaiki
firstName: Wassim
npi: '1013115039'
id: '456128'
body: eyJhbGxlcmdpZXMiOltdLCJeyJ==
pages: null
custom:
source: Manual Entry
note: Initial diagnosis from ER visit
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetEncounterNoteBody
x-operation-id-source: derived
/LKPatientDataLink/GetEncounterNotes:
post:
tags:
- LKPatientDataLink
summary: GetEncounterNotes
description: The GetEncounterNotes endpoint provides a list of encounter notes, each containing details such as note ID, encounter ID, name, date, patient ID, and provider.
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetEncounterNotesSwaggerRequest'
example:
range:
start: /Date(1420070400000)/
end: /Date(1640908800000)/
patientId: '41170010'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetEncounterNotesResult'
example:
notes:
- id: '78254726'
encounterId: '38762828'
name: Office Visit
date: /Date(-62135448687934)/
fileFormat: txt
provider:
lastName: Shwaiki
firstName: Wassim
npi: '1013115039'
id: '456128'
patientId: '41170010'
custom:
source: Manual Entry
note: Initial diagnosis from ER visit
status:
code: Final
source: Finalized
- id: '93842892'
encounterId: '21903745'
name: Office Visit
date: /Date(-62135448929528)/
fileFormat: txt
provider:
lastName: Shwaiki
firstName: Wassim
npi: '1013115039'
id: '456128'
patientId: '41170010'
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
status:
code: Amended
source: Updated
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetEncounterNotes
x-operation-id-source: derived
/LKPatientDataLink/GetEncounters:
post:
tags:
- LKPatientDataLink
summary: GetEncounters
description: The GetEncounters endpoint returns a list of encounters for a patient and/or within a date range, including details such as encounter ID, date, type, physician ID, and location code.
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetEncountersSwaggerRequest'
example:
patientId: '20022339'
dateStart: '2019-08-01T00:00:00'
dateEnd: '2019-12-31T00:00:00'
request:
patientId: '20022339'
appointmentID: '13215'
dateRange:
start: '2019-08-01T00:00:00+00:00'
end: '2019-12-31T00:00:00+00:00'
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetEncountersResult'
example:
- date: 8/19/2009 14:20:00 AM -05:00
created: 8/19/2009 14:20:00 AM -05:00
modified: 8/19/2009 14:20:00 AM -05:00
comments: Follow-up from 2008
encounterId: '869852'
patientId: '20022339'
title: NewPatient
encounterDate: 8/19/2009 14:20:00 AM -05:00
admitDate: '2020-01-01T08:00:00-05:00'
dischargeDate: '2020-01-01T08:30:00-05:00'
locationCode: '22'
physicianId: '30019609'
updatedBy: Amili, Mat
updated: 8/19/2009 14:20:00 AM -05:00
type: follow up type
encounterTypeCode: '44055'
encounterTypeCodeSystemID: '95591'
encounterClass: '34679'
encounterNumber: '35694'
appointmentIDs:
- '13215'
encounterStatus: null
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
- date: 8/19/2009 14:20:00 AM -05:00
created: 8/19/2009 14:20:00 AM -05:00
modified: 8/19/2009 14:20:00 AM -05:00
comments: New patient, transferred from so and so
encounterId: '869856'
patientId: '20022339'
title: NewPatient
encounterDate: 8/19/2009 14:20:00 AM -05:00
admitDate: '2020-01-02T08:00:00-05:00'
dischargeDate: '2020-01-02T08:30:00-05:00'
locationCode: '22'
physicianId: '30019609'
updatedBy: Aed, Phill
updated: 8/19/2009 14:20:00 AM -05:00
type: NewPatient
encounterTypeCode: '73415'
encounterTypeCodeSystemID: '28564'
encounterClass: '71980'
encounterNumber: '35694'
appointmentIDs:
- '13215'
encounterStatus: null
custom:
reviewStatus: Peer Reviewed
clinicianNote: Continue monitoring blood sugar levels
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetEncounters
x-operation-id-source: derived
/LKPatientDataLink/GetFamilyHistory:
post:
tags:
- LKPatientDataLink
summary: GetFamilyHistory
description: Get patient family history
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetFamilyHistorySwaggerRequest'
example:
request:
patientId: '468297'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetFamilyHistoryResult'
example:
patientId: '468297'
relatives:
- relation:
code: CHLDADOPT
source: Adopted Child
sourceText: null
conditions:
- condition:
code: '109006'
codeSystemId: 2.16.840.1.113883.4.642.3.161
display: Anxiety disorder of childhood OR adolescence
physicianId: '13268163'
encounterId: '14281667'
dateRecorded: '2025-06-20T14:45:00+00:00'
status:
admitFlag: Admit
sourceStatus: 'Yes'
custom:
ageAtOnset: 10 years
severity: Mild
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetFamilyHistory
x-operation-id-source: derived
/LKPatientDataLink/GetImmunizations:
post:
tags:
- LKPatientDataLink
summary: GetImmunizations
description: The GetImmunizations endpoint returns a list of immunizations for a patient, including details such as date, vaccine, status, and administering physician.
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetImmunizationsSwaggerRequest'
example:
patientId: null
request:
patientId: '17306710'
dateRange:
start: '2019-11-01T00:00:00+00:00'
end: '2019-11-25T00:00:00+00:00'
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetImmunizationsResult'
example:
- date: 11/5/2019 14:20:00
created: 11/5/2019 14:20:00
modified: 6/4/2020 14:20:00
comments: null
encounterId: '13260056'
patientId: '17306710'
physicianId: '67873491'
status: '1'
vaccine: Boostrix or Adacel (Tdap, 7 yrs and older)
dateAdministered: 6/4/2020 14:20:00
timeAdministered: '14:57'
vaccineCode: '295853'
lotNumber: ALLERGY
site: Left Arm
route: SC Subcutaneous
dose: '0.500'
strength: 0.25 mL
unit: cc
manufacturer: GlaxoSmithKline
dueDate: 11/5/2019 14:20:00
expirationDate: 6/5/2021 14:20:00
cptCode: '90715'
cvxCode: '115'
manufacturerCode: PFR
locationCode: PCN
administeredBy: 'Ramirez, Donna '
id: F7C78594-8EB0-44CD-B14A-62A6B0EB0666
updatedBy: dramirez
updated: 6/4/2020 14:20:00
custom:
source: Manual Entry
note: Initial diagnosis from ER visit
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetImmunizations
x-operation-id-source: derived
/LKPatientDataLink/GetLabResults:
post:
tags:
- LKPatientDataLink
summary: GetLabResults
description: 'The GetLabResults endpoint provides a list of lab results for a patient, including details such as order number, test name, result value, units, range, and status.
This API provides a list of items, with each item containing specific lab result data.It''s important to note that a single lab test might generate multiple items in the list. For instance, a blood panel could include several results, such as White Blood Count, Red Blood Count, and others.'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetLabResultsSwaggerRequest'
example:
patientId: null
request:
patientId: '67267056'
dateRange:
start: '1984-08-01T00:00:00+00:00'
end: '1984-10-07T00:00:00+00:00'
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetLabResultsResult'
example:
- orderNumber: '20278619'
orderDate: 11/23/2023 08:15:00
orderTestName: Glucose
resultName: Glucose
resultDate: '2023-11-23T10:30:00'
value: '85'
units: mg/dL
range: 70-100 mg/dL
abnormalFlag: N
resultStatus: F
observationNotes: Fasting glucose result.
encounterId: '78450156'
testCode:
coding:
- code: 2345-7
codeSystemId: http://loinc.org
display: Glucose [Mass/volume] in Serum or Plasma
resultCode:
coding:
- code: 2345-7
codeSystemId: http://loinc.org
display: Glucose [Mass/volume] in Serum or Plasma
patientId: '67267056'
dateRecorded: 11/23/2023 10:35:00
accessionNumber: XY123456
diagnosticSectionCode: LAB
diagnosticSectionName: Laboratory Tests
sequence: '1'
interpretation: null
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
collectionStartDate: '2023-11-23T07:45:00'
collectionEndDate: '2023-11-23T07:50:00'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetLabResults
x-operation-id-source: derived
/LKPatientDataLink/GetMedicalHistory:
post:
tags:
- LKPatientDataLink
summary: GetMedicalHistory
description: Get patient medical history
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetMedicalHistorySwaggerRequest'
example:
request:
patientId: '349267'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetMedicalHistoryResult'
example:
patientId: '349267'
conditions:
- condition:
code: '250.0'
codeSystemId: 2.16.840.1.113883.6.90
display: diabetes with no complications
note: note-from-dr
dateRecorded: '2020-09-04T08:30:00-04:00'
physicianId: '13268163'
encounterId: '14281667'
onSetDate: '2025-01-20T14:45:00+00:00'
status:
admitFlag: Admit
sourceStatus: 'Yes'
custom:
severity: High
onsetAge: '45'
- condition:
code: Z3A11
codeSystemId: 2.16.840.1.113883.6.90
display: 11 weeks gestation of pregnancy
note: note-from-dr
dateRecorded: '2020-09-04T08:30:00-04:00'
physicianId: '13268163'
encounterId: '14281667'
onSetDate: '2025-06-20T14:45:00+00:00'
status:
admitFlag: Admit
sourceStatus: 'Yes'
custom:
severity: N/A
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetMedicalHistory
x-operation-id-source: derived
/LKPatientDataLink/GetMedications:
post:
tags:
- LKPatientDataLink
summary: GetMedications
description: The GetMedications endpoint returns a list of medications for a patient, including details such as medication name, dosage, instructions, start date, and physician ID.
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetMedicationSwaggerRequest'
example:
patientId: null
request:
patientId: '13220757'
dateRange:
start: '1984-08-31T00:00:00+00:00'
end: '1984-10-30T00:00:00+00:00'
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetMedicationsResult'
example:
- date: 08/31/1984 14:20:00
created: 08/31/1984 14:20:00
modified: 08/31/1984 14:20:00
comments: Monitor for side effects regularly
encounterId: '15305482'
patientId: '13220757'
physicianId: '93045782'
medication: Norco 10 mg-325 mg tablet
dosage: 10 mg-325 mg
dosageUnit: TABLET
direction: take 1 tablet by oral route for pain
startDate: 08/31/1984 14:20:00
stopDate: ' 09/30/1984 14:20:00'
stopReason: Completed course
active: '1'
doseQuantity: '10'
doseUnit: Tablets
doseRoute: ORAL
doseTiming: '15:44'
doseNotes: taking as directed
dispense: Dispense 30 tablets, take one daily
dispenseUnit: Tablet
refills: '0'
ndcCode: '00023602201'
codeSystemId: NDC
drugCode: '270128'
pharmacyId: '15920482'
id: '53942691'
updatedBy: Probst, Charles
updated: 08/31/1984 14:20:00
isPrescription: M
mappedMedication: null
srcstatus: active
custom:
notes: Initial prescription
priority: High
- date: 09/15/1990 09:30:00
created: 09/15/1990 09:30:00
modified: 09/15/1990 09:30:00
comments: Take with food to avoid stomach upset
encounterId: '15305483'
patientId: '13220758'
physicianId: '93045783'
medication: Amoxicillin 500 mg capsule
dosage: 500 mg
dosageUnit: CAPSULE
direction: take 1 capsule twice daily
startDate: 09/15/1990 09:30:00
stopDate: 10/15/1990 09:30:00
stopReason: Completed course
active: '1'
doseQuantity: '60'
doseUnit: Capsules
doseRoute: ORAL
doseTiming: 09:30
doseNotes: avoid alcohol while taking
dispense: Dispense 60 capsules, take two daily
dispenseUnit: Capsule
refills: '2'
ndcCode: 00093102001
codeSystemId: NDC
drugCode: '450982'
pharmacyId: '15920483'
id: '53942692'
updatedBy: Smith, John
updated: 09/15/1990 09:30:00
isPrescription: P
mappedMedication: null
srcstatus: active
custom:
notes: Antibiotic treatment
priority: Medium
- date: 01/20/2000 08:00:00
created: 01/20/2000 08:00:00
modified: 01/20/2000 08:00:00
comments: Monitor blood pressure regularly
encounterId: '15305484'
patientId: '13220759'
physicianId: '93045784'
medication: Lisinopril 20 mg tablet
dosage: 20 mg
dosageUnit: TABLET
direction: take 1 tablet daily in the morning
startDate: 01/20/2000 08:00:00
stopDate: 02/20/2000 08:00:00
stopReason: Completed course
active: '1'
doseQuantity: '30'
doseUnit: Tablets
doseRoute: ORAL
doseTiming: 08:00
doseNotes: take with water
dispense: Dispense 30 tablets, take one daily
dispenseUnit: Tablet
refills: '1'
ndcCode: 00078012345
codeSystemId: NDC
drugCode: '781245'
pharmacyId: '15920484'
id: '53942693'
updatedBy: Johnson, Emily
updated: 01/20/2000 08:00:00
isPrescription: 'true'
mappedMedication: null
srcstatus: active
custom:
notes: Blood pressure management
priority: High
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetMedications
x-operation-id-source: derived
/LKPatientDataLink/GetOphthalmologyObservations:
post:
tags:
- LKPatientDataLink
summary: GetOphthalmologyObservations
description: Retrieves ophthalmology data for the specified patient
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetOphthalmologyObservationsSwaggerRequest'
example:
patientId: '3647232'
dateRange:
start: '2025-01-01T00:00:00+00:00'
end: '2025-12-01T00:00:00+00:00'
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.Ophthalmologydata'
example:
patientId: '3647232'
ophthalmicVisits:
- encounterId: 042A5F42-E72C-481E-B6F4-AF009E8448E7
encounterDate: '2025-01-06T11:39:00+00:00'
visualAcuity:
id: 603a823e-86c6-4fa0-9741-37980ad7ca2e
date: '2026-08-06T13:24:14.6957306-04:00'
visionMethod: Snellen Chart
dominantEye: Right
createdBy: Dr. Smith
createdDate: '2026-08-05T13:24:14.6957324-04:00'
updatedBy: Dr. Smith
updatedDate: '2026-08-06T13:24:14.6957333-04:00'
eyes:
od:
correctionType: Corrected
superPh: 'Yes'
superPhMod: With Filter
comments: Patient responded well to correction.
distance:
dvaSc: 20/60
dvaScMod: Blurred
dvaCc: 20/25
dvaCcMod: Clear
dvaPhSc: 20/30
dvaPhScMod: Improved
dvaPhCc: 20/20
dvaPhCcMod: Optimal
intermediate:
intVaSc: 20/50
intVaScMod: Blurred
intVaCc: 20/30
intVaCcMod: Clear
other: Tested with computer screen at 70cm
near:
nvaSc: 20/80
nvaScMod: Difficulty reading
nvaCc: 20/40
nvaCcMod: Improved with correction
nvaPhSc: 20/60
nvaPhScMod: Slight improvement
nvaPhCc: 20/30
nvaPhCcMod: Significantly better
other: Tested using Jaeger chart at 14 inches
os:
correctionType: Uncorrected
superPh: 'No'
superPhMod: N/A
comments: Blurred at near.
distance:
dvaSc: 20/80
dvaScMod: Blurred
dvaCc: 20/40
dvaCcMod: Clear
dvaPhSc: 20/50
dvaPhScMod: Slight improvement
dvaPhCc: 20/30
dvaPhCcMod: Improved with correction
intermediate:
intVaSc: 20/80
intVaScMod: Slight difficulty
intVaCc: 20/50
intVaCcMod: Improved with correction
other: Tested with computer screen at 80cm
near:
nvaSc: 20/100
nvaScMod: Significant blur
nvaCc: 20/50
nvaCcMod: Clear with correction
nvaPhSc: 20/60
nvaPhScMod: Improved slightly
nvaPhCc: 20/40
nvaPhCcMod: Clear with pinhole
other: Tested with handheld text at 14 inc hes
ou:
correctionType: Corrected
superPh: 'Yes'
comments: Both eyes showed significant improvement with correction.
distance:
dvaSc: 20/30
dvaCc: 20/20
intermediate:
intVaSc: 20/60
intVaCc: 20/40
near:
nvaSc: 20/80
nvaCc: 20/40
additionalTests:
- testType: Glare
level: Moderate
eyes:
od:
value: 20/40
os:
value: 20/30
refractionData:
id: RX-2025-001
date: '2025-05-05T10:00:00+00:00'
createdBy: Dr. Williams
createdDate: '2025-05-05T10:05:00+00:00'
updatedBy: Dr. Williams
updatedDate: '2025-05-05T10:10:00+00:00'
lensometry:
comments: Worn glasses measured for comparison
od:
sphere: '-2.00'
cylinder: '-0.75'
axis: '180'
add: '+2.00'
prism1: '1.0'
base1: Out
prism2: '0.5'
base2: Up
os:
sphere: '-1.75'
cylinder: '-0.50'
axis: '170'
add: '+2.00'
prism1: '0.5'
base1: In
prism2: '0.25'
base2: Down
autoRefraction:
comments: Performed using NIDEK ARK-1s
od:
sphere: '-1.75'
cylinder: '-0.50'
axis: '175'
add: '+1.50'
dva: 20/25
nva: J2
os:
sphere: '-2.00'
cylinder: '-0.75'
axis: '90'
add: '+1.25'
dva: 20/30
nva: J3
manifestRefraction:
comments: Patient is showing signs of mild astigmatism
od:
sphere: '-1.00'
cylinder: '-0.75'
axis: '180'
add: '+1.50'
prism1: '2.00'
base1: BI
prism2: '1.00'
base2: BO
dva: 20/25
dvaMod: '0.5'
nva: J2
nvaMod: J3
os:
sphere: '-1.50'
cylinder: '-1.00'
axis: '90'
add: '+2.00'
prism1: '1.50'
base1: BO
prism2: '0.50'
base2: BU
dva: 20/30
dvaMod: '0.75'
nva: J3
nvaMod: J4
ou:
dva: 20/25
dvaMod: '0.50'
nva: J2
nvaMod: J3
npa: 10 cm
npc: 6 cm
cycloplegicRefraction:
comments: Cycloplegic refraction performed to assess refractive error without accommodation.
od:
sphere: '-1.50'
cylinder: '-0.75'
axis: '180'
add: '+2.00'
prism1: '1.50'
base1: BO
prism2: '0.50'
base2: BI
dvaSc: 20/25
dvaScMod: '0.25'
dvaCc: 20/20
dvaCcMod: '0.00'
nvaSc: J4
nvaScMod: J5
nvaCc: J3
nvaCcMod: J2
os:
sphere: '-1.50'
cylinder: '-0.75'
axis: '180'
add: '+2.00'
prism1: '1.50'
base1: BO
prism2: '0.50'
base2: BI
dvaSc: 20/25
dvaScMod: '0.25'
dvaCc: 20/20
dvaCcMod: '0.00'
nvaSc: J4
nvaScMod: J5
nvaCc: J3
nvaCcMod: J2
ou:
dvaSc: 20/25
dvaScMod: '0.25'
dvaCc: 20/20
dvaCcMod: '0.00'
nvaSc: J4
nvaScMod: J5
nvaCc: J3
nvaCcMod: J2
intraocularPressure:
- id: '12345'
date: '2025-05-05T10:00:00+00:00'
method: Tonometry
measuredBy: Dr. Smith
measeureDateTime: '2025-05-05T10:15:00+00:00'
comments: Patient had mild discomfort during measurement
refusalReason: Patient refused dilation due to anxiety
createdBy: Admin
createdDate: '2025-05-05T09:00:00+00:00'
updatedBy: Admin
updatedDate: '2025-05-05T10:30:00+00:00'
od:
dilated: true
iopKPa: '2.0'
iopMmHg: '15'
baselineIop: '18'
reductionIop: 16%
targetIop: '14'
os:
dilated: true
iopKPa: '2.1'
iopMmHg: '16'
baselineIop: '19'
reductionIop: 15%
targetIop: '15'
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetOphthalmologyObservations
x-operation-id-source: derived
/LKPatientDataLink/GetProblems:
post:
tags:
- LKPatientDataLink
summary: GetProblems
description: The GetProblems endpoint provides a list of problems for a patient, including details such as problem name, code, status, date, and physician ID.
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetProblemsSwaggerRequest'
example:
patientId: null
request:
patientId: '14277017'
dateRange:
start: '1984-08-01T00:00:00+00:00'
end: '1984-09-07T00:00:00+00:00'
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetProblemsResult'
example:
- date: 08/31/1984 14:20:00
created: 08/31/1984 14:20:00
modified: 08/31/1984 14:20:00
comments: Patient reports chronic back pain
encounterId: '19326582'
patientId: '14277017'
physicianId: '155'
code: D68.69
problem: Hypercoagulable state, secondary
result: Secondary hypercoagulable state due to surgery
status: '1'
resolvedBy: David, Miln
resolvedDate: 08/31/1984 14:20:00
onSetDate: 08/31/1984 14:20:00
lifeCycle: Active
id: '583909'
codeSystemId: ICD10
updatedBy: Lowe, Tom
updated: 08/31/1984 14:20:00
problemAssessment: Patient presents with chronic hypertension, controlled with medicatio
icd10: D68.69
snomedCode: '76592001'
severity: Moderate
custom:
reviewStatus: Pending cardiologist review
followUp: Scheduled in 2 weeks
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetProblems
x-operation-id-source: derived
/LKPatientDataLink/GetProcedures:
post:
tags:
- LKPatientDataLink
summary: GetProcedures
description: The GetProcedures endpoint returns a list of procedures for a patient, including details such as procedure code, name, date, status, and performing physician.
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetProceduresSwaggerRequest'
example:
patientId: null
request:
patientId: '13567156'
dateRange:
start: '1984-08-01T00:00:00+00:00'
end: '1984-08-31T00:00:00+00:00'
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetProceduresResult'
example:
- createDt: 08/31/1984 14:20:00
dateRecorded: 08/31/1984 14:20:00
srcCreateDate: 08/31/1984 14:20:00
srcModifiedDate: 08/31/1984 14:20:00
encounterId: '24568521'
patientId: '13567156'
orderingPhysicianId: '987654321'
physicianId: '987654321'
dueDate: 08/31/1984 14:20:00
procedureCode: '295986'
procedureName: Spirometry
icdCode: R06.02
cptCode: '295986'
performedDate: 08/31/1984 14:20:00
status: '1'
comments: comments
performingPhysician: Emily, Davis
location: '24'
procedureType: OV
procedurOutCome: Successful
icdCode2: M54.5
icdCode3: F41.9
icdCode4: M54.2
modifierCode1: '25'
modifierCode2: '52'
modifierCode3: '34'
modifierCode4: '56'
quantity: '10'
udv: mg
deltaidentifier: 08/31/1984 14:20:00
legacyrowId: '139086'
updatedBy: John, Mate
updatedDate: 08/31/1984 14:20:00
bcpFlag: '0'
processid: '795890'
xmlComments: xml-comments
legacyRowStatusDescription: Open
rowState: '0'
mapped: '0'
accessLevel: '0'
codeSystemId: ICD-9
custom:
source: Manual Entry
note: Initial diagnosis from ER visit
loincCode: 19868-9
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetProcedures
x-operation-id-source: derived
/LKPatientDataLink/GetSocialHistory:
post:
tags:
- LKPatientDataLink
summary: GetSocialHistory
description: Get patient social history
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetSocialHistorySwaggerRequest'
example:
request:
patientId: '493186'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetSocialHistoryResult'
example:
patientId: '493186'
questions:
- question:
code: SH001
codeSystemId: SOCIAL_HISTORY
display: Do you smoke?
response:
code: 'YES'
codeSystemId: RESPONSE
display: 'Yes'
note: Patient reports occasional smoking on weekends.
updated: '2025-06-20T14:45:00+00:00'
admitFlag: Y
physicianId: '13268163'
encounterId: '14281667'
dateRecorded: '2025-06-20T14:45:00+00:00'
status:
admitFlag: Admit
sourceStatus: 'Yes'
custom:
frequency: Occasional
duration: 5 years
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetSocialHistory
x-operation-id-source: derived
/LKPatientDataLink/GetSurgicalHistory:
post:
tags:
- LKPatientDataLink
summary: GetSurgicalHistory
description: Get patient surgical history
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetSurgicalHistorySwaggerRequest'
example:
request:
patientId: '486137'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetSurgicalHistoryResult'
example:
patientId: '486137'
procedures:
- procedure:
code: '33275'
codeSystemId: 2.16.840.1.113883.6.12
display: Transcatheter removal of permanent leadless pacemaker
datePerformed: '2020-09-04T08:30:00-04:00'
physicianId: null
encounterId: null
dateRecorded: null
status: null
complications: null
custom:
complications: None
hospitalStayDays: '3'
- procedure:
code: 0510T
codeSystemId: 2.16.840.1.113883.6.12
display: Removal of sinus tarsi implant
datePerformed: '2020-09-04T08:30:00-04:00'
physicianId: '13268163'
encounterId: '14281667'
dateRecorded: '2025-06-20T14:45:00+00:00'
status:
admitFlag: Admit
sourceStatus: 'Yes'
complications: Minor infection
custom:
complications: Minor infection
anesthesiaType: General
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetSurgicalHistory
x-operation-id-source: derived
/LKPatientDataLink/GetVitals:
post:
tags:
- LKPatientDataLink
summary: GetVitals
description: The GetVitals endpoint returns a list of vital signs for a patient, including details such as blood pressure, temperature, heart rate, weight, height, and other vitals.
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetVitalsSwaggerRequest'
example:
patientId: null
request:
patientId: '33465056'
dateRange:
start: '1984-08-01T00:00:00+00:00'
end: '1984-08-31T00:00:00+00:00'
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetVitalsResult'
example:
- bpStanding: 120/80 mmHg
bpSitting: 120/80 mmHg
bpSupine: 120/80 mmHg
date: 08/31/1984 14:20:00
created: 08/31/1984 14:20:00
modified: 08/31/1984 14:20:00
comments: comments
encounterId: '17289617'
patientId: '33465056'
physicianId: '13265161'
temperature: '99.3'
heartRate: '72'
weight: '130'
height: '63'
spo2: '98'
respiration: '16'
bmi: '23.03'
headCircumference: '40'
timeRecorded: 08/31/1984 14:20:00
neckCircumference: '35'
waistCircumference: '88'
pulse: '72'
id: '81477211'
updatedBy: Guinn, Rachelle
updated: 08/31/1984 14:20:00
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetVitals
x-operation-id-source: derived
/LKPatientDataLink/GetVitalsDefinition:
post:
tags:
- LKPatientDataLink
summary: GetVitalsDefinition
description: The GetVitalsDefinition endpoint provides a list of vital definitions, including details such as ID, display name, minimum and maximum values, and unit of measurement.
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetVitalsDefinitionSwaggerRequest'
example:
request: {}
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetVitalsDefinitionResult'
example:
vitals:
- id: '211'
display: Temp
min: '85'
max: '108'
uom: F
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
- id: '213'
display: HR
min: '10'
max: '300'
uom: /min
custom:
reviewedBy: Dr. Peter Elan
technician: Stive Ouad
- id: '212'
display: BP
min: 20/10
max: 300/200
uom: mm Hg
custom:
reviewedBy: Dr. James Martin
technician: George Clear
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkGetVitalsDefinition
x-operation-id-source: derived
/LKPatientDataLink/NextGetUpdatedPatients:
post:
tags:
- LKPatientDataLink
summary: NextGetUpdatedPatients
description: 'The NextGetUpdatedPatients endpoint retrieves the next set of updated patient records using the initial token from BeginGetUpdatedPatients. The returned data includes details such as patient ID, name, phone numbers, email, physician IDs, and date of birth.
The response also includes a token for the next page, which should be passed to the NextGetUpdatedPatients endpoint.For guidance on handling errors in paginated responses, refer to the error codes guide.'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.NextGetUpdatedPatientsSwaggerRequest'
example:
token:
nextToken: eyJSZXF1ZXN0SWQiOiJyaVBmdHdMWm9IUmNVNlhMR25ZQ2dvUT09IiwiVG9rZW4iOiJwMHBrcTdURmhvcXdoTzZyNmpUdVpJRGc9PSJ9
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetUpdatedPatientsPagedResult'
example:
items:
- patientId: '83472793'
chartNumber: '6734829'
lastName: Kop
firstName: Peter
mobilePhone: '1236243674'
homePhone: '2552322321'
email: peter.kop@gmail.com
physicianIds:
- '28392938'
- '73847848'
- '938484742'
dateOfBirth: 08-31-1989
updated: '2024-03-07T14:45:00+00:00'
zipCode: '07601'
created: '2024-01-01T00:00:00.112'
nextToken: eyJSZXF1ZXN0SWQiOiJyaVBmdHdMWm9IUmNVNlhMR25ZQ2dvUT09IiwiVG9rZW4iOiJwMHBrcTdURmhvcXdoTzZyNmpUdVpJRGc9PSJ9
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkNextGetUpdatedPatients
x-operation-id-source: derived
/LKPatientDataLink/PostVitals:
post:
tags:
- LKPatientDataLink
summary: PostVitals
description: Post a collection of patient vital readings
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Swagger.SwaggerRequests.LKPDL.PostVitalsSwaggerRequest'
example:
request:
encounterId: '891'
note: Patient's temperature is within normal range
patient:
id: '14426783'
vitals:
- id: '211'
value: '100'
- id: '213'
value: '80'
date: '2023-08-01T00:00:00-04:00'
custom:
reviewedBy: Dr. Alice Grey
technician: John Smith
rawRequest: null
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.PostVitalsResult'
example: {}
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/LKCloudConnect.Contracts.LKCloudConnectFault'
operationId: postLKPatientDataLinkPostVitals
x-operation-id-source: derived
components:
schemas:
LKCloudConnect.Contracts.PatientDataLink.CreateEncounterResult:
type: object
properties:
encounterId:
type: string
description: Encounter id from target system
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.OphthalmicVisit:
type: object
properties:
encounterId:
type: string
description: Encounter id of the visit
encounterDate:
type: string
description: Encounter Date. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
visualAcuity:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuity'
description: Visual acuity measurements recorded during the encounter
refractionData:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.RefractionData'
description: Refraction data collected during the encounter, including manifest, cycloplegic, or auto-refraction results
intraocularPressure:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.IntraocularPressure'
description: Array of intraocular pressure (IOP) readings taken during the encounter
additionalProperties: false
description: List of ophthalmic visits associated with the patient
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityIntermediateOD:
type: object
properties:
intVaSc:
type: string
description: Intermediate Without Correction of OD
intVaScMod:
type: string
description: Intermediate Without Correction modifier value of OD
intVaCc:
type: string
description: Intermediate With Correction of OD
intVaCcMod:
type: string
description: Intermediate With Correction modifier value of OD
other:
type: string
description: Intermediate other value of OD
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.LensometryOS:
type: object
properties:
sphere:
type: string
description: Corrects nearsightedness (-) or farsightedness (+) for OS
cylinder:
type: string
description: Corrects astigmatism (uneven curvature of the cornea) for OS
axis:
type: string
description: Specifies the angle (0°–180°) where astigmatism is located for OS
add:
type: string
description: The additional magnifying power for near vision (used in bifocals, progressives, or reading glasses) for OS
prism1:
type: string
description: prism diopters base out (shifts image outward)
base1:
type: string
description: Indicates direction of the prism's effect for OS
prism2:
type: string
description: prism 2 diopters base out (shifts image outward)
base2:
type: string
description: Indicates direction of the prism's effect for OS
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetDiagnosesRequest:
required:
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: Patient id to query
dateRange:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.DateRange'
description: Date Range uses encounter date or date recorded
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.TestCodeData:
type: object
properties:
coding:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.CodeDetail'
description: Test codes
additionalProperties: false
description: Lab Test Code
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityNearOD:
type: object
properties:
nvaSc:
type: string
description: Visual Near Distance Without Correction of OD
nvaScMod:
type: string
description: Visual Near Distance Without Correction modifier of OD
nvaCc:
type: string
description: Visual Acuity Near With Correction of OD
nvaCcMod:
type: string
description: Visual Acuity Near With Correction modifier of OD
nvaPhSc:
type: string
description: PinHole Near Without Correction of OD
nvaPhScMod:
type: string
description: PinHole Near Without Correction modifier of OD
nvaPhCc:
type: string
description: PinHole Near With Correction of OD
nvaPhCcMod:
type: string
description: PinHole Near With Correction modifier of OD
other:
type: string
description: Visual Acuity Other Near of OD
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.NextGetUpdatedPatientsSwaggerRequest:
type: object
properties:
token:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PagedResult'
description: Next page token
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityEyesOS:
type: object
properties:
correctionType:
type: string
description: Correction type like Uncorrected Corrected of OS
superPh:
type: string
description: Super pinhole refers to a refined or enhanced version of the traditional pinhole occluder used during an eye exam of OS
superPhMod:
type: string
description: Superpinhole modifier value of OS
comments:
type: string
description: Notes for OS
distance:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityDistanceOS'
description: Visual acuity measurement for the OS at a distance
intermediate:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityIntermediateOS'
description: Visual acuity measurement for the OS at an intermediate distance
near:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityNearOS'
description: Visual acuity measurement for the OS at near distance
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetMedicationSwaggerRequest:
type: object
properties:
patientId:
type: string
description: 'Obsolete: Use request.patientId instead'
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetMedicationsRequest'
description: Get medications request
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.VitalDefinition:
type: object
properties:
id:
type: string
description: Target system id for the vital
display:
type: string
description: Label for the vital
min:
type: string
description: Minimum accepted value for the vital entry
max:
type: string
description: Maximum accepted value for the vital entry
uom:
type: string
description: Units of measurement applied to the vital value
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
description: Metadata entry constraints for a particular vital
LKCloudConnect.Contracts.PatientDataLink.GetVitalsDefinitionRequest:
type: object
additionalProperties: false
description: Request for a list of vital definitions needed for writing vitals back to the target system
LKCloudConnect.Contracts.PatientDataLink.EncounterNote:
type: object
properties:
id:
type: string
description: Encounter note id
encounterId:
type: string
description: Encounter id
name:
type: string
description: Encounter note name
date:
type: string
description: Encounter note date in Microsoft JSON format eg /Date(635040000000)/
format: date-time
example: /Date(635040000000)/
fileFormat:
type: string
description: 'Encounter note file format
`Pdf` `Html` `Text` `Rtf`'
provider:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.Provider'
description: Encounter note provider
patientId:
type: string
description: Encounter note patient id
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
status:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.EncounterStatus'
description: Encounter note status object representing the normalized lifecycle state of the note along with the original status value received from the source.
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetAllergiesRequest:
required:
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: Patient id to query
dateRange:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.DateRange'
description: Date Range uses encounter date or date recorded
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetVitalsRequest:
required:
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: Patient id to query
dateRange:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.DateRange'
description: Date Range uses encounter date or date recorded
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetEncountersRequest:
required:
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: Patient id to get encounters for
example: '123456'
appointmentID:
type: string
description: Appointment id to get encounters for
example: '865412'
dateRange:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.DateRange'
description: Start DateTime to get encounters for
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.EncounterStatus:
type: object
properties:
code:
enum:
- Unknown
- Registered
- Partial
- Preliminary
- Final
- Amended
- Corrected
- Appended
- Cancelled
- EnteredInError
- Deprecated
type: string
description: ELLKAY defined standardized code representing the encounter note status.
source:
type: string
description: Original encounter note status value as received from the source system.
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetLabResultsSwaggerRequest:
type: object
properties:
patientId:
type: string
description: 'Obsolete: Use request.patientId instead'
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetLabResultsRequest'
description: Get lab results request
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetFamilyHistoryResult:
type: object
properties:
patientId:
type: string
description: Patient id associated with the family history data
relatives:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.RelativeFamilyHistoryData'
description: Family history data object
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.ResultCodeData:
type: object
properties:
coding:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.CodeDetail'
description: Result codes
additionalProperties: false
description: Lab Result Code
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.AutoRefractionOS:
type: object
properties:
sphere:
type: string
description: The Sphere value from autorefraction tells you the overall power needed to correct your eye’s focusing ability — specifically for myopia (nearsightedness) or hyperopia (farsightedness)
cylinder:
type: string
description: Strength of astigmatism correction (usually negative in auto readings) for OS
axis:
type: string
description: Specifies the angle (0°–180°) where astigmatism is located for OS
add:
type: string
description: The additional magnifying power for near vision (used in bifocals, progressives, or reading glasses) for OS
dva:
type: string
description: Measures your eye’s natural refractive error when looking at a far point (usually a virtual object 6 meters or 20 feet away)
nva:
type: string
description: Some autorefractors can measure accommodative response (focusing ability for near objects)
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityNearOU:
type: object
properties:
nvaSc:
type: string
description: Visual Near Distance Without Correction of OU
nvaCc:
type: string
description: Visual Acuity Near With Correction of OU
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetMedicationsRequest:
required:
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: Patient id to query
dateRange:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.DateRange'
description: Date Range uses encounter date or date recorded
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetVitalsDefinitionResult:
type: object
properties:
vitals:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.VitalDefinition'
description: List of vitals that can be added
additionalProperties: false
description: Definition of what can be added for a vital entry
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityDistanceOD:
type: object
properties:
dvaSc:
type: string
description: Visual Acuity Distance Without Correction of OD
dvaScMod:
type: string
description: Visual Acuity Distance Without Correction modifier of OD
dvaCc:
type: string
description: Visual Acuity Distance With Correction of OD
dvaCcMod:
type: string
description: Visual Acuity Distance With Correction modifier of OD
dvaPhSc:
type: string
description: PinHole Distance Without Correction of OD
dvaPhScMod:
type: string
description: PinHole Distance Without Correction modifier of OD
dvaPhCc:
type: string
description: PinHole Distance With Correction of OD
dvaPhCcMod:
type: string
description: PinHole Distance With Correction modifier of OD
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetMedicalHistoryResult:
type: object
properties:
patientId:
type: string
description: Patient id associated with response data
conditions:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.MedicalCondition'
description: Array of medical conditions
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetFamilyHistorySwaggerRequest:
type: object
properties:
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetFamilyHistoryRequest'
description: Request object
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.AutoRefractionOD:
type: object
properties:
sphere:
type: string
description: The Sphere value from autorefraction tells you the overall power needed to correct your eye’s focusing ability — specifically for myopia (nearsightedness) or hyperopia (farsightedness)
cylinder:
type: string
description: Strength of astigmatism correction (usually negative in auto readings) for OD
axis:
type: string
description: Specifies the angle (0°–180°) where astigmatism is located for OD
add:
type: string
description: The additional magnifying power for near vision (used in bifocals, progressives, or reading glasses) for OD
dva:
type: string
description: Measures your eye’s natural refractive error when looking at a far point (usually a virtual object 6 meters or 20 feet away)
nva:
type: string
description: Some autorefractors can measure accommodative response (focusing ability for near objects)
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityAdditionalTest:
type: object
properties:
testType:
enum:
- Glare
- Ram
type: string
description: The type of additional test performed (e.g. Glare, Ram)
level:
type: string
description: Visual acuity level helps determine how much your vision is affected by bright or blinding light or direct sunlight
eyes:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityAdditionalTestEyes'
description: Visual acuity measurements for each eye during the additional test
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.LensometryOD:
type: object
properties:
sphere:
type: string
description: Corrects nearsightedness (-) or farsightedness (+) for OD
cylinder:
type: string
description: Corrects astigmatism (uneven curvature of the cornea) for OD
axis:
type: string
description: Specifies the angle (0°–180°) where astigmatism is located for OD
add:
type: string
description: The additional magnifying power for near vision (used in bifocals, progressives, or reading glasses) for OD
prism1:
type: string
description: prism diopters base out (shifts image outward)
base1:
type: string
description: Indicates direction of the prism's effect for OD
prism2:
type: string
description: prism 2 diopters base out (shifts image outward)
base2:
type: string
description: Indicates direction of the prism's effect for OD
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetDiagnosesResult:
type: object
properties:
legacyRowId:
type: string
description: Legacy row id
codeSystemId:
type: string
description: Code system id
mapped:
type: string
description: Diagnoses mapped code
updatedBy:
type: string
description: Who last updated the record
updatedDate:
type: string
description: Record last updated datetime eg "08/31/1984 14:20:00"
bcpFlag:
type: string
description: Bcp Flag
icd10:
type: string
description: Icd10 code
snomedCode:
type: string
description: Diagnosis snomed code
lifeCycle:
type: string
description: Diagnosis life cycle
processId:
type: string
description: Process id
xmlComments:
type: string
description: Optional system-specific comments in XML format
physicianId:
type: string
description: Physician id
original_StatusDescription:
type: string
description: Original status description
legacyRowStatusDescription:
type: string
description: Legacy row status description
rowState:
type: string
description: The row state
deltaIdentifier:
type: string
description: Delta identifier string
laterality:
type: string
description: Laterality
status:
type: string
description: Diagnosis status
resolvedBy:
type: string
description: What resolved the diagnosis
createDt:
type: string
description: Create date string eg "08/31/1984 14:20:00"
dateRecorded:
type: string
description: Date the diagnosis was recorded eg "08/31/1984 14:20:00"
srcCreateDate:
type: string
description: Date the record was recorded in target system eg "08/31/1984 14:20:00"
srcModifiedDate:
type: string
description: Date the record was modified in target system eg "08/31/1984 14:20:00"
textType:
type: string
description: Diagnosis text type
miscText:
type: string
description: Miscellaneous text
comments:
type: string
description: Diagnosis comments
encounterId:
type: string
description: Encounter id
patientId:
type: string
description: Patient id
code:
type: string
description: Diagnosis code
description:
type: string
description: Diagnosis description
resolvedDate:
type: string
description: Diagnosis resolution date eg "08/31/1984 14:20:00"
onsetDate:
type: string
description: Diagnosis onset date eg "08/31/1984 14:20:00"
result:
type: string
description: Result text
udv:
type: string
description: Unit dose vial text
accessLevel:
type: string
description: Access level text
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.IntraocularPressure:
type: object
properties:
id:
type: string
description: Unique identifier for each examination
date:
type: string
description: Date of the examination. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
method:
type: string
description: The method or device used to measure the IOP (e.g., Tonometry, Goldmann, air puff)
measuredBy:
type: string
description: The ID of the technician who recorded or performed the IOP measurement
measeureDateTime:
type: string
description: The date on which the IOP measurement was taken. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
comments:
type: string
description: Any additional comments or notes regarding the measurement, e.g., patient condition, technical issues
refusalReason:
type: string
description: Reason for not dilating
createdBy:
type: string
description: User or provider name who created the record
createdDate:
type: string
description: Date when this record was created in the source system. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
updatedBy:
type: string
description: User or provider name who updated the record
updatedDate:
type: string
description: Date and time when the record was last updated. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
od:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.IntraocularPressureOD'
description: Intraocular pressure measurement for the OD
os:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.IntraocularPressureOS'
description: Intraocular pressure measurement for the OS
additionalProperties: false
description: Represents an intraocular pressure (IOP) examination record for a patient
LKCloudConnect.Contracts.PatientDataLink.EncounterProvider:
type: object
properties:
id:
type: string
description: Provider id
additionalProperties: false
description: Encounter provider
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetEncounterNoteBodySwaggerRequest:
required:
- encounterNoteId
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: Patient id of the request
encounterNoteId:
minLength: 1
type: string
description: Encounter note id to query
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetProblemsSwaggerRequest:
type: object
properties:
patientId:
type: string
description: 'Obsolete: Use request.patientId instead'
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetProblemsRequest'
description: Get problems request
additionalProperties: false
LKCloudConnect.Contracts.Bridge.MappedCode:
type: object
properties:
code:
type: string
description: Our mapped code (If one is available)
source:
type: string
description: System-specific code
sourceText:
type: string
description: System-specific free text when additional free text is allowed, usually found with “other” fields
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityDistanceOS:
type: object
properties:
dvaSc:
type: string
description: Visual Acuity Distance Without Correction of OS
dvaScMod:
type: string
description: Visual Acuity Distance Without Correction modifier of OS
dvaCc:
type: string
description: Visual Acuity Distance With Correction of OS
dvaCcMod:
type: string
description: Visual Acuity Distance With Correction modifier of OS
dvaPhSc:
type: string
description: PinHole Distance Without Correction of OD
dvaPhScMod:
type: string
description: PinHole Distance Without Correction modifier of OS
dvaPhCc:
type: string
description: PinHole Distance With Correction of OS
dvaPhCcMod:
type: string
description: PinHole Distance With Correction modifier of OS
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.SurgicalHistoryProcedure:
type: object
properties:
procedure:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.CodeDetail'
description: Procedure code detail
datePerformed:
type: string
description: Date the procedure was performed. (DateTimeOffset) eg 2019-01-01T00:00:00+00:00
format: date-time
example: '2019-01-01T00:00:00+00:00'
physicianId:
type: string
description: Unique identifier of the physician associated with the recorded history data.
encounterId:
type: string
description: Unique identifier of the encounter associated with the recorded history data.
dateRecorded:
type: string
description: 'The date and time when the history information was documented in the system.
(DateTimeOffset) eg 2019-01-01T00:00:00+00:00'
format: date-time
example: '2019-01-01T00:00:00+00:00'
status:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.HistoryStatusDetail'
description: Shows the detailed status of the patient's history information.
complications:
type: string
description: Records any complications related to the patient's surgical history.
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityIntermediateOU:
type: object
properties:
intVaSc:
type: string
description: Intermediate Without Correction of OU
intVaCc:
type: string
description: Intermediate With Correction of OU
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityEyesOU:
type: object
properties:
correctionType:
type: string
description: Correction type like Uncorrected Corrected of OU
superPh:
type: string
description: Super pinhole refers to a refined or enhanced version of the traditional pinhole occluder used during an eye exam of OU
comments:
type: string
description: Notes for OU
distance:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityDistanceOU'
description: Visual acuity measurement for the OU at a distance
intermediate:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityIntermediateOU'
description: Visual acuity measurement for the OU at an intermediate distance
near:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityNearOU'
description: Visual acuity measurement for the OU at near distance
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetProblemsRequest:
required:
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: Patient id to query
dateRange:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.DateRange'
description: Date Range uses encounter date or date recorded
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetUpdatedPatientsPagedResult.Patient:
type: object
properties:
patientId:
type: string
description: Patient id
chartNumber:
type: string
description: Chart number
lastName:
type: string
description: Patient last name
firstName:
type: string
description: Patient first name
mobilePhone:
type: string
description: Mobile phone number
homePhone:
type: string
description: Home phone number
email:
type: string
description: Patient email
physicianIds:
type: array
items:
type: string
description: Array of physician IDs
dateOfBirth:
type: string
description: Patient date of birth eg "08-31-1984"
updated:
type: string
description: Date the patient was last updated eg "2019-01-01T00:00:00+00:00"
zipCode:
type: string
description: Patient zip code
created:
type: string
description: Patient created date eg 2019-01-01T00:00:00.112
format: date-time
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.Provider:
type: object
properties:
lastName:
type: string
description: Last name of provider
firstName:
type: string
description: First name of provider
npi:
type: string
description: NPI of provider
id:
type: string
description: Id of provider
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.BeginGetUpdatedPatientsRequest:
required:
- endDate
- startDate
type: object
properties:
startDate:
minLength: 1
type: string
description: 'Start date of request date range e.g. 2019-01-01T00:00:00+00:00
If no date is provided, field will default to 1900-01-01T00:00:00+00:00'
example: '2019-01-01T00:00:00+00:00'
endDate:
minLength: 1
type: string
description: 'End date of request date range e.g. 2019-02-01T00:00:00+00:00
If no date is provided, field will set to current date'
example: '2019-02-01T00:00:00+00:00'
providerId:
type: string
description: Provider Id filter
example: '123456'
facilityId:
type: string
description: Facility Id filter
example: '123456'
limit:
type: integer
description: Maximum number of results per page
format: int32
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.CycloplegicRefractionOS:
type: object
properties:
sphere:
type: string
description: Cycloplegic sphere:after the cycloplegic drops take effect, the sphere value will indicate the true refractive error of the eye without the influence of accommodation
cylinder:
type: string
description: Cylinder in cycloplegic refraction measure astigmatism and is crucial in determining the true refractive error once accommodation is paralyzed
axis:
type: string
description: If a person has astigmatism, the axis value place the cylindrical power in the correct orientation
add:
type: string
description: Cycloplegic refraction helps determine the true near prescription after the eye's focusing mechanism has been paralyzed
prism1:
type: string
description: The cycloplegic refraction process determine how much prism might be needed to correct any binocular vision issues
base1:
type: string
description: The Base of the prism correction is critical in ensuring proper alignment of the eyes after cycloplegic refraction
prism2:
type: string
description: The cycloplegic refraction process determine how much prism might be needed to correct any binocular vision issues
base2:
type: string
description: The Base of the prism correction is critical in ensuring proper alignment of the eyes after cycloplegic refraction
dvaSc:
type: string
description: The refractive error is measured to see how nearsighted (myopic) or farsighted (hyperopic) a person is, without any corrective lenses in place
dvaScMod:
type: string
description: Modifiers in cycloplegic refraction are adjustments made to the basic refractive error based on other factors. These adjustments are calculated during the refraction process but without the application of lenses for correction
dvaCc:
type: string
description: Measurement of refractive error for seeing far objects under cycloplegia (with correction)
dvaCcMod:
type: string
description: Additional corrections like prism, base direction, or vertex distance adjustments
nvaSc:
type: string
description: An assessment of how much refractive power is needed for clear near vision (e.g., reading, close-up work) while the eye is cyclopleged and no glasses or contacts are being used
nvaScMod:
type: string
description: Modifiers are additional elements that influence the final prescription or diagnosis but are measured without applying corrective lenses during the test
nvaCc:
type: string
description: How well the patient sees up close (e.g., reading) while wearing their current correction
nvaCcMod:
type: string
description: Additional adjustments like Add, prism, or base that enhance near vision or correct binocular issues
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.GetOphthalmologyObservationsRequest:
required:
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: Unique identifier of the patient whose ophthalmology data is being requested
dateRange:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.DateRange'
description: Specifies the start and end dates for the period within which ophthalmology observations should be retrieved
additionalProperties: false
description: Request model to retrieve ophthalmology data for a specific patient
LKCloudConnect.Contracts.PatientDataLink.GetSurgicalHistoryRequest:
type: object
properties:
patientId:
type: string
description: 'Patient id to query
Required'
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetImmunizationsRequest:
required:
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: Patient id to query
dateRange:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.DateRange'
description: Date Range uses encounter date or date recorded
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.ManifestRefractionOD:
type: object
properties:
sphere:
type: string
description: Nearsightedness / farsightedness of OD
cylinder:
type: string
description: Power to correct astigmatism Always paired with an axis
axis:
type: string
description: Describes where the cylinder power is applied for OD
add:
type: string
description: Used for near vision in presbyopic patients Usually between +0.75 and +3.00 D
prism1:
type: string
description: Store eye alignment issues, like double vision or muscle imbalance Can be vertical, horizontal, or oblique
base1:
type: string
description: Tells where the prism is oriented to shift images like BI,BO,BU and BD
prism2:
type: string
description: store eye alignment issues, like double vision or muscle imbalance Can be vertical, horizontal, or oblique
base2:
type: string
description: Tells where the prism is oriented to shift images like BI,BO,BU and BD
dva:
type: string
description: Measures your prescription for seeing clearly at far distances for OD
dvaMod:
type: string
description: Measures your prescription for seeing clearly at far distances modifier for OD
nva:
type: string
description: Near refraction is used to create the necessary prescription for multifocal lenses for OD
nvaMod:
type: string
description: Manifest near refraction modifier refers to an adjustment made to the prescription based on subjective feedback and additional measurements to improve near vision clarity
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.CloseEncounterRequest:
required:
- encounterId
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: The ID of the patient whose encounter needs to be closed/locked
encounterId:
minLength: 1
type: string
description: The ID of the encounter that needs to be closed/locked
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetEncounterNotesResult:
type: object
properties:
notes:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.EncounterNote'
description: Array of encounter notes
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.PostVitalsRequest:
required:
- patient
type: object
properties:
encounterId:
type: string
description: The encounter id to associate vitals with
note:
type: string
description: Note associated with vital
patient:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.VitalsPatient'
description: The patient to attach vitals to
vitals:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.VitalEntry'
description: A list of vitals to insert into a patient's record
date:
type: string
description: Date associated with vital. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
example: '2019-01-01T00:00:00+00:00'
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
description: Information needed to insert a vitals record into the EMR
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityAdditionalTestEyesOD:
type: object
properties:
value:
type: string
description: This test shows eye's vision is affected by test type of OD
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetVitalsSwaggerRequest:
type: object
properties:
patientId:
type: string
description: 'Obsolete: Use request.patientId instead'
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetVitalsRequest'
description: get vitals request
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetSocialHistoryResult:
type: object
properties:
patientId:
type: string
description: Patient id
questions:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.SocialHistoryQuestion'
description: Patient social history questions including category, question and response and any available codes
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.IntraocularPressureOS:
type: object
properties:
dilated:
type: boolean
description: Dilation Status
iopKPa:
type: string
description: kPa is an alternative unit for measuring IOP, short for kilopascal, used by some devices
iopMmHg:
type: string
description: Intraocular pressure value, usually in mmHg (millimeters of mercury) OS left eye
baselineIop:
type: string
description: Initial, untreated IOP measurement
reductionIop:
type: string
description: IOP reduction needed to reach the target IOP, usually calculated as a percentage decrease from the baseline IOP
targetIop:
type: string
description: Desired level of intraocular pressure (IOP) a doctor aims to achieve through treatment, based on a patient's individual condition
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetEncountersSwaggerRequest:
type: object
properties:
patientId:
type: string
description: 'Patient id to get encounters for
Deprecated. Use request.patientId instead.'
deprecated: true
dateStart:
type: string
description: 'Start date of request date range e.g. 2019-01-01T00:00:00
Deprecated. Use request.DateRange.Start instead.'
format: date-time
deprecated: true
dateEnd:
type: string
description: 'End date of request date range e.g. 2019-02-01T00:00:00
Deprecated. Use request.DateRange.End instead.'
format: date-time
deprecated: true
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetEncountersRequest'
description: Request to get encounters for
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetUpdatedPatientsPagedResult:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetUpdatedPatientsPagedResult.Patient'
description: Patients returned
nextToken:
type: string
description: The token needed for the next API call
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetVitalsDefinitionSwaggerRequest:
type: object
properties:
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetVitalsDefinitionRequest'
description: Request object
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetSocialHistoryRequest:
type: object
properties:
patientId:
type: string
description: 'Patient id to query
Required'
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.HistoryStatusDetail:
type: object
properties:
admitFlag:
enum:
- Admit
- Denied
type: string
description: The status of the patient's history information, indicating whether it has been admitted or not.
sourceStatus:
type: string
description: Holds the original status value as provided by the source system.
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.Autorefraction:
type: object
properties:
comments:
type: string
description: AutoRefraction comments
od:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.AutoRefractionOD'
description: Auto-refraction results for the OD
os:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.AutoRefractionOS'
description: Auto-refraction results for the OS
additionalProperties: false
description: Represents the results and comments of an auto-refraction test
LKCloudConnect.Contracts.PatientDataLink.CloseEncounterResult:
type: object
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetAllergiesSwaggerRequest:
type: object
properties:
patientId:
type: string
description: 'Obsolete: Use request.patientId instead'
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetAllergiesRequest'
description: Get allergies request
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.PostVitalsResult:
type: object
additionalProperties: false
description: result of adding a vital to a patient's record
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.CycloplegicRefractionOU:
type: object
properties:
dvaSc:
type: string
description: The refractive error is measured to see how nearsighted (myopic) or farsighted (hyperopic) a person is, without any corrective lenses in place
dvaScMod:
type: string
description: Modifiers in cycloplegic refraction are adjustments made to the basic refractive error based on other factors. These adjustments are calculated during the refraction process but without the application of lenses for correction
dvaCc:
type: string
description: Measurement of refractive error for seeing far objects under cycloplegia (with correction)
dvaCcMod:
type: string
description: Additional corrections like prism, base direction, or vertex distance adjustments
nvaSc:
type: string
description: An assessment of how much refractive power is needed for clear near vision (e.g., reading, close-up work) while the eye is cyclopleged and no glasses or contacts are being used
nvaScMod:
type: string
description: Modifiers are additional elements that influence the final prescription or diagnosis but are measured without applying corrective lenses during the test
nvaCc:
type: string
description: How well the patient sees up close (e.g., reading) while wearing their current correction
nvaCcMod:
type: string
description: Additional adjustments like Add, prism, or base that enhance near vision or correct binocular issues
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityEyesOD:
type: object
properties:
correctionType:
type: string
description: Correction type like Uncorrected Corrected of OD
superPh:
type: string
description: Super pinhole refers to a refined or enhanced version of the traditional pinhole occluder used during an eye exam of OD
superPhMod:
type: string
description: Superpinhole modifier value of OD
comments:
type: string
description: Notes for OD
distance:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityDistanceOD'
description: Visual acuity measurement for the OD at a distance
intermediate:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityIntermediateOD'
description: Visual acuity measurement for the OD at an intermediate distance
near:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityNearOD'
description: Visual acuity measurement for the OD at near distance
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.Lensometry:
type: object
properties:
comments:
type: string
description: Lensometry Refraction comments
od:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.LensometryOD'
description: Lensometry refraction results for the OD
os:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.LensometryOS'
description: Lensometry refraction results for the OS
additionalProperties: false
description: Represents the lensometry refraction results and related comments
LKCloudConnect.Contracts.PatientDataLink.EncounterResource:
type: object
properties:
id:
type: string
description: Resource id associated with this encounter
additionalProperties: false
description: Resource to attach to a create encounter
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetProceduresSwaggerRequest:
type: object
properties:
patientId:
type: string
description: 'Obsolete: Use request.patientId instead'
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetProceduresRequest'
description: get procedures request
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.IntraocularPressureOD:
type: object
properties:
dilated:
type: boolean
description: Dilation Status
iopKPa:
type: string
description: kPa is an alternative unit for measuring IOP, short for kilopascal, used by some devices
iopMmHg:
type: string
description: Intraocular pressure value, usually in mmHg (millimeters of mercury) OD right eye
baselineIop:
type: string
description: Initial, untreated IOP measurement
reductionIop:
type: string
description: IOP reduction needed to reach the target IOP, usually calculated as a percentage decrease from the baseline IOP
targetIop:
type: string
description: Desired level of intraocular pressure (IOP) a doctor aims to achieve through treatment, based on a patient's individual condition
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.CreateEncounterSwaggerRequest:
type: object
properties:
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.CreateEncounterRequest'
description: Request object
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.Ophthalmologydata:
type: object
properties:
patientId:
type: string
description: Patient Id
ophthalmicVisits:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.OphthalmicVisit'
description: List of ophthalmic visits associated with the patient
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
description: Represents the ophthalmology data for a specific patient
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.BeginGetUpdatedPatientsSwaggerRequest:
type: object
properties:
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.BeginGetUpdatedPatientsRequest'
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetLabResultsRequest:
required:
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: Patient id to query
dateRange:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.DateRange'
description: Date Range uses order date and result date
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.CycloplegicRefractionOD:
type: object
properties:
sphere:
type: string
description: Cycloplegic sphere:after the cycloplegic drops take effect, the sphere value will indicate the true refractive error of the eye without the influence of accommodation
cylinder:
type: string
description: Cylinder in cycloplegic refraction measure astigmatism and is crucial in determining the true refractive error once accommodation is paralyzed
axis:
type: string
description: If a person has astigmatism, the axis value place the cylindrical power in the correct orientation
add:
type: string
description: Cycloplegic refraction helps determine the true near prescription after the eye's focusing mechanism has been paralyzed
prism1:
type: string
description: The cycloplegic refraction process determine how much prism might be needed to correct any binocular vision issues
base1:
type: string
description: The Base of the prism correction is critical in ensuring proper alignment of the eyes after cycloplegic refraction
prism2:
type: string
description: The cycloplegic refraction process determine how much prism might be needed to correct any binocular vision issues
base2:
type: string
description: The Base of the prism correction is critical in ensuring proper alignment of the eyes after cycloplegic refraction
dvaSc:
type: string
description: The refractive error is measured to see how nearsighted (myopic) or farsighted (hyperopic) a person is, without any corrective lenses in place
dvaScMod:
type: string
description: Modifiers in cycloplegic refraction are adjustments made to the basic refractive error based on other factors. These adjustments are calculated during the refraction process but without the application of lenses for correction
dvaCc:
type: string
description: Measurement of refractive error for seeing far objects under cycloplegia (with correction)
dvaCcMod:
type: string
description: Additional corrections like prism, base direction, or vertex distance adjustments
nvaSc:
type: string
description: An assessment of how much refractive power is needed for clear near vision (e.g., reading, close-up work) while the eye is cyclopleged and no glasses or contacts are being used
nvaScMod:
type: string
description: Modifiers are additional elements that influence the final prescription or diagnosis but are measured without applying corrective lenses during the test
nvaCc:
type: string
description: How well the patient sees up close (e.g., reading) while wearing their current correction
nvaCcMod:
type: string
description: Additional adjustments like Add, prism, or base that enhance near vision or correct binocular issues
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetImmunizationsSwaggerRequest:
type: object
properties:
patientId:
type: string
description: 'Obsolete: Use request.patientId instead'
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetImmunizationsRequest'
description: Get immunization request
additionalProperties: false
LKCloudConnect.Contracts.PagedResult:
type: object
properties:
nextToken:
type: string
description: The token needed for the next API call
additionalProperties: false
description: PagesResult object containing the next token string
LKCloudConnect.Contracts.PatientDataLink.EncounterReason:
type: object
properties:
id:
type: string
description: Reason id
reasonText:
type: string
description: Reason text - some EHR supports only free text for reason
additionalProperties: false
description: Encounter reason
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetOphthalmologyObservationsSwaggerRequest:
type: object
properties:
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.GetOphthalmologyObservationsRequest'
description: Request object
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityNearOS:
type: object
properties:
nvaSc:
type: string
description: Visual Near Distance Without Correction of OS
nvaScMod:
type: string
description: Visual Near Distance Without Correction modifier of OS
nvaCc:
type: string
description: Visual Acuity Near With Correction of OS
nvaCcMod:
type: string
description: Visual Acuity Near With Correction modifier of OS
nvaPhSc:
type: string
description: PinHole Near Without Correction of OS
nvaPhScMod:
type: string
description: PinHole Near Without Correction modifier of OS
nvaPhCc:
type: string
description: PinHole Near With Correction of OS
nvaPhCcMod:
type: string
description: PinHole Near With Correction modifier of OS
other:
type: string
description: Visual Acuity Other Near of OS
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetEncounterNotesSwaggerRequest:
required:
- patientId
type: object
properties:
range:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetEncounterNotesDateRange'
description: Date range filter
patientId:
minLength: 1
type: string
description: Patient id of the request
example: '1'
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetFamilyHistoryRequest:
type: object
properties:
patientId:
type: string
description: 'Patient id to query
Required'
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetSocialHistorySwaggerRequest:
type: object
properties:
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetSocialHistoryRequest'
description: Get social history request object
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetSurgicalHistorySwaggerRequest:
type: object
properties:
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetSurgicalHistoryRequest'
description: Get GetSurgicalHistory request object
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.VitalEntry:
type: object
properties:
id:
type: string
description: System-specific vital id (represents different vital entries like BP, HR, etc.)
value:
type: string
description: Vital reading value
additionalProperties: false
description: A single vital sign reading
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityDistanceOU:
type: object
properties:
dvaSc:
type: string
description: Visual Acuity Distance Without Correction of OU
dvaCc:
type: string
description: Visual Acuity Distance With Correction of OU
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.EncounterDocumentPage:
type: object
properties:
pageId:
type: string
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetEncounterNoteBodyResult:
type: object
properties:
id:
type: string
description: Encounter note id
name:
type: string
description: Encounter note name
date:
type: string
description: Date of encounter note in microsoft JSON format eg /Date(635040000000)/
format: date-time
example: /Date(635040000000)/
patientId:
type: string
description: Patient id
fileFormat:
type: string
description: 'File format of encounter note
`Pdf` `Html` `Text` `Rtf`'
provider:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.Provider'
description: Provider for encounter note
body:
type: string
description: Body of encounter note
pages:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.EncounterDocumentPage'
description: Contains document page ids
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.ManifestRefractionOU:
type: object
properties:
dva:
type: string
description: Measures your prescription for seeing clearly at far distances for OU
dvaMod:
type: string
description: Measures your prescription for seeing clearly at far distances modifier for OU
nva:
type: string
description: Near refraction is used to create the necessary prescription for multifocal lenses for OU
nvaMod:
type: string
description: Manifest near refraction modifier refers to an adjustment made to the prescription based on subjective feedback and additional measurements to improve near vision clarity
npa:
type: string
description: 'Near Point of Accommodation: closest distance at which the eye can maintain clear focus on an object. It reflects the maximum accommodative ability of the eye.'
npc:
type: string
description: Near Point of Convergence:closest point at which the eyes can maintain binocular single vision before one eye deviates outward (loses alignment)
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.MappedMedication:
type: object
properties:
code:
type: string
codeSystemId:
type: string
display:
type: string
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.CycloplegicRefraction:
type: object
properties:
comments:
type: string
description: Cycloplegic Refraction comments
od:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.CycloplegicRefractionOD'
description: Cycloplegic refraction results for the OD
os:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.CycloplegicRefractionOS'
description: Cycloplegic refraction results for the OS
ou:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.CycloplegicRefractionOU'
description: Cycloplegic refraction results for the OU
additionalProperties: false
description: Represents the cycloplegic refraction exam results and related comments
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.ManifestRefraction:
type: object
properties:
comments:
type: string
description: Manifest Refraction comments
od:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.ManifestRefractionOD'
description: Manifest refraction results for the OD
os:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.ManifestRefractionOS'
description: Manifest refraction results for the OS
ou:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.ManifestRefractionOU'
description: Manifest refraction results for the OU
additionalProperties: false
description: Represents the manifest refraction results and related comments
LKCloudConnect.Contracts.PatientDataLink.GetProceduresResult:
type: object
properties:
createDt:
type: string
description: Create date eg "08/31/1984 14:20:00"
dateRecorded:
type: string
description: Date procedure recorded eg "08/31/1984 14:20:00"
srcCreateDate:
type: string
description: Source created date eg "08/31/1984 14:20:00"
srcModifiedDate:
type: string
description: Source modified date eg "08/31/1984 14:20:00"
encounterId:
type: string
description: Encounter id
patientId:
type: string
description: Patient id
orderingPhysicianId:
type: string
description: Ordering physician id
physicianId:
type: string
description: Physician id
dueDate:
type: string
description: Procedures due date eg "08/31/1984 14:20:00"
procedureCode:
type: string
description: Procedure code
procedureName:
type: string
description: Procedure name
icdCode:
type: string
description: Icd code
cptCode:
type: string
description: CPT code
performedDate:
type: string
description: Date procedure performed eg "08/31/1984 14:20:00"
status:
type: string
description: Procedure status string
comments:
type: string
description: Procedure comments
performingPhysician:
type: string
description: Performing physician
location:
type: string
description: Procedure location
procedureType:
type: string
description: Procedure type
procedurOutCome:
type: string
description: Procedure outcome
icdCode2:
type: string
description: Icd code 2
icdCode3:
type: string
description: Icd code 3
icdCode4:
type: string
description: Icd code 4
modifierCode1:
type: string
description: Modifier code 1
modifierCode2:
type: string
description: Modifier code 2
modifierCode3:
type: string
description: Modifier code 3
modifierCode4:
type: string
description: Modifier code 4
quantity:
type: string
description: Quantity string
udv:
type: string
description: Udv string
deltaidentifier:
type: string
description: Delta identifier
legacyrowId:
type: string
description: Legacy row id
updatedBy:
type: string
description: Who updated the record
updatedDate:
type: string
description: The date the record was updated last eg "08/31/1984 14:20:00"
bcpFlag:
type: string
description: Bcp flag
processid:
type: string
description: Process id
xmlComments:
type: string
description: Xml comments
legacyRowStatusDescription:
type: string
description: legacy row status description
rowState:
type: string
description: RowState
mapped:
type: string
description: Mapped text
accessLevel:
type: string
description: Access level text
codeSystemId:
type: string
description: Procedure code system Id
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
loincCode:
type: string
description: The LOINC code associated with the procedure
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetMedicalHistorySwaggerRequest:
type: object
properties:
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetPastMedicalHistoryRequest'
description: Request object
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.CreateEncounterRequest:
required:
- dateTime
- patient
type: object
properties:
dateTime:
type: string
description: DateTime associated with this encounter. (DateTimeOffset) eg 2019-01-01T00:00:00+00:00
format: date-time
example: '2019-01-01T00:00:00+00:00'
patient:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.EncounterPatient'
description: Patient associated with this encounter
facility:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.EncounterFacility'
description: Facility associated with this encounter
provider:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.EncounterProvider'
description: Provider associated with this encounter
comments:
type: string
description: Comments / notes for encounter (not a progress note)
reason:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.EncounterReason'
description: Reason associated with this encounter
resource:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.EncounterResource'
description: Resource associated with this encounter
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
description: Create an Encounter request.
LKCloudConnect.Contracts.PatientDataLink.CodeDetail:
type: object
properties:
code:
type: string
description: Code
codeSystemId:
type: string
description: Code system id
display:
type: string
description: Display text
additionalProperties: false
description: Detail about a code, including the code, the display, and the code system id
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.GetDiagnosisSwaggerRequest:
type: object
properties:
patientId:
type: string
description: 'Obsolete: Use request.patientId instead'
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.GetDiagnosesRequest'
description: Get diagnoses request
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetProblemsResult:
type: object
properties:
date:
type: string
description: Problem noted date eg "08/31/1984 14:20:00"
created:
type: string
description: Problem record created date eg "08/31/1984 14:20:00"
modified:
type: string
description: Date last modified eg "08/31/1984 14:20:00"
comments:
type: string
description: Problems comments
encounterId:
type: string
description: Encounter id
patientId:
type: string
description: Patient id
physicianId:
type: string
description: Physician id
code:
type: string
description: Problem code
problem:
type: string
description: Problem text
result:
type: string
description: Result of problem
status:
type: string
description: Status of problem
resolvedBy:
type: string
description: What resolved the problem
resolvedDate:
type: string
description: Date problem was resolved eg "08/31/1984 14:20:00"
onSetDate:
type: string
description: Onset date of the problem eg "08/31/1984 14:20:00"
lifeCycle:
type: string
description: 'Lifecycle of the problem
`ACTIVE` `CHRONIC` `ACUTE` `INACTIVE` `RESOLVED`'
id:
type: string
description: Id of the problem
codeSystemId:
type: string
description: Code system id
updatedBy:
type: string
description: Who updated the record
updated:
type: string
description: Date the record was updated eg "08/31/1984 14:20:00"
problemAssessment:
type: string
description: Assessment of the problem
icd10:
type: string
description: Icd10 code
snomedCode:
type: string
description: SNOMED code for the problem
severity:
type: string
description: 'Severity of problem. For example: critical, medium, or low'
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetProceduresRequest:
required:
- patientId
type: object
properties:
patientId:
minLength: 1
type: string
description: Patient id to query
dateRange:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.DateRange'
description: Date Range uses encounter date or date recorded
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.SocialHistoryQuestion:
type: object
properties:
question:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.CodeDetail'
description: Detail about the question asked to the patient
response:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.CodeDetail'
description: Detail about about the patient response
note:
type: string
description: Additional note, if available
updated:
type: string
description: Last updated date and time. (DateTimeOffset) eg 2019-01-01T00:00:00+00:00
format: date-time
example: '2019-01-01T00:00:00+00:00'
admitFlag:
type: string
description: Indicates whether any Social History admitted by patient or not.
physicianId:
type: string
description: Unique identifier of the physician associated with the recorded history data.
encounterId:
type: string
description: Unique identifier of the encounter associated with the recorded history data.
dateRecorded:
type: string
description: 'The date and time when the history information was documented in the system.
(DateTimeOffset) eg 2019-01-01T00:00:00+00:00'
format: date-time
example: '2019-01-01T00:00:00+00:00'
status:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.HistoryStatusDetail'
description: Shows the detailed status of the patient's history information.
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.DateRange:
required:
- end
- start
type: object
properties:
start:
type: string
description: Date range start. (DateTimeOffset) e.g. 2019-01-01T00:00:00.112+00:00
format: date-time
example: '2001-01-01T13:00:00.112+00:00'
end:
type: string
description: Date range end. (DateTimeOffset) e.g. 2019-01-01T00:00:00.112+00:00
format: date-time
example: '2001-12-31T13:00:00.112+00:00'
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.RelativeFamilyHistoryData:
type: object
properties:
relation:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.Bridge.MappedCode'
description: 'Relationship code
Will attempt to map to one of these codes:
`Self` `Spouse` `Child` `Other`'
conditions:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.ConditionData'
description: Array of condition data
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetLabResultsResult:
type: object
properties:
orderNumber:
type: string
description: Order number
orderDate:
type: string
description: Order date eg "08/31/1984 14:20:00"
orderTestName:
type: string
description: Order test name
resultName:
type: string
description: Result name
resultDate:
type: string
description: Result Date e.g. 2019-01-01T00:00:00
format: date-time
example: '2019-01-01T00:00:00'
value:
type: string
description: Result Value
units:
type: string
description: Units string
range:
type: string
description: Lab results range
abnormalFlag:
type: string
description: Abnormal flag
resultStatus:
type: string
description: Result status
observationNotes:
type: string
description: Observation notes
encounterId:
type: string
description: Encounter id
testCode:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.TestCodeData'
description: Lab result Test code.
resultCode:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.ResultCodeData'
description: Lab result Results code.
patientId:
type: string
description: Patient id
dateRecorded:
type: string
description: Date when the lab result was recorded eg "08/31/1984 14:20:00"
accessionNumber:
type: string
description: A unique identifier for an order, used in Medical Information Systems like a laboratory information system (LIS)
diagnosticSectionCode:
type: string
description: The section code of the diagnostic service where the observation was performed
diagnosticSectionName:
type: string
description: The section name of the diagnostic service where the observation was performed
sequence:
type: string
description: Identifies sequence in which order tests are performed
interpretation:
type: string
description: Interpretation of lab result given by Physician or Lab in-charge
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
collectionStartDate:
type: string
description: The start date and time when the specimen collection began
format: date-time
collectionEndDate:
type: string
description: The end date and time when the specimen collection completed
format: date-time
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuity:
type: object
properties:
id:
type: string
description: Unique identifier for each examination
date:
type: string
description: Date of the examination. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
visionMethod:
type: string
description: visual acuity testing methods
dominantEye:
type: string
description: Dominant eye
createdBy:
type: string
description: User or provider name who created the record
createdDate:
type: string
description: Date when this record was created in the source system. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
updatedBy:
type: string
description: User or provider name who updated the record
updatedDate:
type: string
description: Date and time when the record was last updated. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
eyes:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityEyes'
description: Visual acuity measurements for each eye
additionalTests:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityAdditionalTest'
description: Additional tests performed during the examination
additionalProperties: false
description: Certain EMR/EHR systems allow recording of Visual Acuity and Refraction observations both with correction (CC) and without correction (SC). For these systems, our API contract includes explicit field-to-field mappings for each type. However, for EMR/EHR systems that do not distinguish between corrected and uncorrected observations, we will default to mapping those observations to the without correction (SC) fields in our data model.
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityEyes:
type: object
properties:
od:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityEyesOD'
description: Visual acuity measurements for the OD
os:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityEyesOS'
description: Visual acuity measurements for the OD
ou:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityEyesOU'
description: Visual acuity measurements for the OD
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.RefractionData:
type: object
properties:
id:
type: string
description: Unique identifier for each examination
date:
type: string
description: EncounterDate. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
createdBy:
type: string
description: User or provider name who created the record
createdDate:
type: string
description: Date when this record was created in the source system. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
updatedBy:
type: string
description: User or provider name who updated the record
updatedDate:
type: string
description: Date and time when the record was last updated. (DateTimeOffset) e.g. 2019-01-01T00:00:00+00:00
format: date-time
lensometry:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.Lensometry'
description: Lensometry refraction results related to the patient
autoRefraction:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.Autorefraction'
description: Auto-refraction results for the patient, including the right and left eye measurements
manifestRefraction:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.ManifestRefraction'
description: Manifest refraction results, including measurements for the right and left eyes
cycloplegicRefraction:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.CycloplegicRefraction'
description: Cycloplegic refraction results, including measurements for the right and left eyes
additionalProperties: false
description: 'Represents the refraction data for an ophthalmology examination, including various refraction methods.
Certain EMR/EHR systems allow recording of Visual Acuity and Refraction observations both with correction (CC) and without correction (SC). For these systems, our API contract includes explicit field-to-field mappings for each type. However, for EMR/EHR systems that do not distinguish between corrected and uncorrected observations, we will default to mapping those observations to the without correction (SC) fields in our data model.'
LKCloudConnect.Contracts.PatientDataLink.GetVitalsResult:
type: object
properties:
bpStanding:
type: string
description: Standing blood pressure
bpSitting:
type: string
description: Sitting blood pressure
bpSupine:
type: string
description: Supine blood pressure
date:
type: string
description: Vital recorded date eg "08/31/1984 14:20:00"
created:
type: string
description: Vital created date eg "08/31/1984 14:20:00"
modified:
type: string
description: Date last modified eg "08/31/1984 14:20:00"
comments:
type: string
description: Vitals comments
encounterId:
type: string
description: Encounter id
patientId:
type: string
description: Patient id
physicianId:
type: string
description: Physician id
temperature:
type: string
description: Patient temperature
heartRate:
type: string
description: Patient heart rate
weight:
type: string
description: Patient weight
height:
type: string
description: Patient height
spo2:
type: string
description: Patient Spo2
respiration:
type: string
description: Patient respiration
bmi:
type: string
description: Patient BMI
headCircumference:
type: string
description: Patient head circumference
timeRecorded:
type: string
description: Time vitals recorded eg "08/31/1984 14:20:00"
neckCircumference:
type: string
description: Patient Neck circumference
waistCircumference:
type: string
description: Patient waist circumference
pulse:
type: string
description: Patient pulse
id:
type: string
description: Vitals id
updatedBy:
type: string
description: Who updated the record last
updated:
type: string
description: Date record updated last eg "08/31/1984 14:20:00"
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetMedicationsResult:
type: object
properties:
date:
type: string
description: Medication date eg "08/31/1984 14:20:00"
created:
type: string
description: Medication date created eg "08/31/1984 14:20:00"
modified:
type: string
description: Record last modified datetime eg "08/31/1984 14:20:00"
comments:
type: string
description: Medications comments
encounterId:
type: string
description: Encounter id
patientId:
type: string
description: Patient id
physicianId:
type: string
description: Physician id
medication:
type: string
description: Medication
dosage:
type: string
description: 'Dosage of a particular medication. Can be numeric or free-text. Sometimes dosages are available with unit information.
80 mg'
dosageUnit:
type: string
description: 'Unit of a particular medication(mg, gm, etc.). This unit may already exists in Dosage.
mggm'
direction:
type: string
description: Medications directions
startDate:
type: string
description: Start date of medication eg "08/31/1984 14:20:00"
stopDate:
type: string
description: Stop date of medication eg "08/31/1984 14:20:00"
stopReason:
type: string
description: Reason for stopping medication
active:
type: string
description: Medication active
doseQuantity:
type: string
description: 'Numeric quantity of medication (example: 90 tablets - for 3 months, 50 mg tab or 180 Tablets for 3 months 25mg)
90180'
doseUnit:
type: string
description: 'Unit of a particular medication(mg, gm, etc.). This unit may already exists in Dosage.
mggm'
doseRoute:
type: string
description: Dose route
doseTiming:
type: string
description: Dose timing
doseNotes:
type: string
description: Dosage notes
dispense:
type: string
description: Medication dispense
dispenseUnit:
type: string
description: Medication dispense unit
refills:
type: string
description: Medication refills
ndcCode:
type: string
description: NDC code
codeSystemId:
type: string
description: Code system id
drugCode:
type: string
description: The drug code
pharmacyId:
type: string
description: Pharmacy id
id:
type: string
description: Medication id
updatedBy:
type: string
description: Who last updated the record
updated:
type: string
description: Date updated last eg "08/31/1984 14:20:00"
isPrescription:
type: string
description: 'Indicates whether the medication is a prescription drug or not.
This field returns the raw string value provided by the source system.'
mappedMedication:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.MappedMedication'
description: MappedCode mapped by LiveMapping
srcstatus:
type: string
description: Medication Srcstatus
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.EncounterFacility:
type: object
properties:
id:
type: string
description: Facility id
additionalProperties: false
description: Facility to attach to a create encounter
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityIntermediateOS:
type: object
properties:
intVaSc:
type: string
description: Intermediate Without Correction of OS
intVaScMod:
type: string
description: Intermediate Without Correction modifier value of OS
intVaCc:
type: string
description: Intermediate With Correction of OD
intVaCcMod:
type: string
description: Intermediate With Correction modifier value of OS
other:
type: string
description: Intermediate other value of OS
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.ConditionData:
type: object
properties:
condition:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.CodeDetail'
description: Condition details
physicianId:
type: string
description: Unique identifier of the physician associated with the recorded history data.
encounterId:
type: string
description: Unique identifier of the encounter associated with the recorded history data.
dateRecorded:
type: string
description: 'The date and time when the history information was documented in the system.
(DateTimeOffset) eg 2019-01-01T00:00:00+00:00'
format: date-time
example: '2019-01-01T00:00:00+00:00'
status:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.HistoryStatusDetail'
description: Shows the detailed status of the patient's history information.
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.ManifestRefractionOS:
type: object
properties:
sphere:
type: string
description: Nearsightedness / farsightedness of OS
cylinder:
type: string
description: Power to correct astigmatism Always paired with an axis
axis:
type: string
description: Describes where the cylinder power is applied for OS
add:
type: string
description: Used for near vision in presbyopic patients Usually between +0.75 and +3.00 D
prism1:
type: string
description: Store eye alignment issues, like double vision or muscle imbalance Can be vertical, horizontal, or oblique
base1:
type: string
description: Tells where the prism is oriented to shift images like BI,BO,BU and BD
prism2:
type: string
description: store eye alignment issues, like double vision or muscle imbalance Can be vertical, horizontal, or oblique
base2:
type: string
description: Tells where the prism is oriented to shift images like BI,BO,BU and BD
dva:
type: string
description: Measures your prescription for seeing clearly at far distances for OS
dvaMod:
type: string
description: Measures your prescription for seeing clearly at far distances modifier for OS
nva:
type: string
description: Near refraction is used to create the necessary prescription for multifocal lenses for OS
nvaMod:
type: string
description: Manifest near refraction modifier refers to an adjustment made to the prescription based on subjective feedback and additional measurements to improve near vision clarity
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetEncounterNotesDateRange:
required:
- end
- start
type: object
properties:
start:
type: string
description: Encounter notes datetime range start eg /Date(635040000000)
format: date-time
example: /Date(635040000000)/
end:
type: string
description: Encounter notes datetime range end eg /Date(635040000000)
format: date-time
example: /Date(635040000000)
additionalProperties: false
LKCloudConnect.Contracts.LKCloudConnectFault:
type: object
properties:
message:
type: string
description: Error message
example: Target system credentials are invalid
detail:
type: string
description: Additional error detail
recoverySteps:
type: string
description: Error recovery steps
example: Contact support to update credentials
handle:
type: string
description: Our unique message id, you should provide this when you open a support ticket
example: 3e4d0b7f-e3fa-4462-9cc3-860be812d696
errorCode:
type: string
description: Error code, please see error code section of the guide for details
example: Unauthorized
type:
type: string
description: Error type
additionalProperties: false
description: LKCloud Connect Fault
LKCloudConnect.Contracts.PatientDataLink.GetAllergiesResult:
type: object
properties:
date:
type: string
description: Allergy date eg "08/31/1984 14:20:00"
created:
type: string
description: Allergy created date eg "08/31/1984 14:20:00"
modified:
type: string
description: Allergy last modified date eg "08/31/1984 14:20:00"
comments:
type: string
description: Comments
encounterId:
type: string
description: Encounter id
patientId:
type: string
description: Patient id
physicianId:
type: string
description: Physician id
isAllergic:
type: string
description: Whether patient is allergic or not
onsetDate:
type: string
description: Actual date on which Allergy was identified eg "08/31/1984 14:20:00"
allergen:
type: string
description: The allergen
reaction:
type: string
description: Reaction
type:
type: string
description: Allergy type
severity:
type: string
description: Severity of allergy
codeSystemId:
type: string
description: Code system id
allergyCode:
type: string
description: Allergy code
id:
type: string
description: Allergy system specific id
legacyallergictoid:
type: string
description: Legacy allergy id
updatedBy:
type: string
description: User name who updated the record
updatedDate:
type: string
description: Date on which record was updated eg "08/31/1984 14:20:00"
reactionCode:
type: string
description: Code of reaction from recorded allergen
reactionCodeSystemID:
type: string
description: CodeSystemID of reaction from recorded allergen
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetEncountersResult:
type: object
properties:
date:
type: string
description: Encounter datetime e.g. "08/31/1984 14:20:00 AM -05:00"
created:
type: string
description: Encounter datetime created e.g. "08/31/1984 14:20:00 AM -05:00"
modified:
type: string
description: Encounter date modified e.g. "08/31/1984 14:20:00 AM -05:00"
comments:
type: string
description: Comments / notes for encounter (not a progress note)
encounterId:
type: string
description: Encounter id
patientId:
type: string
description: Id of patient affiliated with this encounter
title:
type: string
description: Encounter title
encounterDate:
type: string
description: Encounter date e.g. "08/31/1984 14:20:00 AM -05:00"
admitDate:
type: string
description: Datetime the patient is admitted. (DateTimeOffset) e.g. "2020-01-01T08:00:00-05:00"
format: date-time
example: '2020-01-01T08:00:00-05:00'
dischargeDate:
type: string
description: Datetime the patient is discharged. (DateTimeOffset) e.g. "2020-01-01T08:30:00-05:00"
format: date-time
example: '2020-01-01T08:30:00-05:00'
locationCode:
type: string
description: Location code
physicianId:
type: string
description: Practitioner affiliated with this encounter
updatedBy:
type: string
description: Who last updated the encounter record
updated:
type: string
description: Encounter last modified date e.g. "08/31/1984 14:20:00 AM -05:00"
type:
type: string
description: Encounter type
encounterTypeCode:
type: string
description: Code representing the encounter type
encounterTypeCodeSystemID:
type: string
description: Id of the system this type code belongs to
encounterClass:
type: string
description: Classification of encounter, e.g. outpatient or emergency
encounterNumber:
type: string
description: System-specific number assigned to the encounter for identification
appointmentIDs:
type: array
items:
type: string
description: Ids for appointments affiliated with this encounter
encounterStatus:
type: string
description: Status of this encounter
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.CloseEncounterSwaggerRequest:
type: object
properties:
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.CloseEncounterRequest'
description: Request object
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetImmunizationsResult:
type: object
properties:
date:
type: string
description: Date e.g. "01/20/2022 14:20:00"
created:
type: string
description: Date created e.g. "01/20/2022 14:20:00"
example: 01/20/2022 14:20:00
modified:
type: string
description: Date last modified e.g. "01/20/2022 14:20:00"
example: 01/20/2022 14:20:00
comments:
type: string
description: Immunization comments
encounterId:
type: string
description: Encounter id
patientId:
type: string
description: Patient Id
physicianId:
type: string
description: Physician Id
status:
type: string
description: Status of immunization
vaccine:
type: string
description: Vaccine string
dateAdministered:
type: string
description: Date the immunization was administered e.g. "01/20/2022 14:20:00"
example: 01/20/2022
timeAdministered:
type: string
description: The time the immunization was administered
vaccineCode:
type: string
description: Vaccine code string
lotNumber:
type: string
description: Lot number string
site:
type: string
description: Site the immunization was administered
route:
type: string
description: The route of immunization
dose:
type: string
description: The dose administered
strength:
type: string
description: Strength of immunization
unit:
type: string
description: unit of immunization
manufacturer:
type: string
description: Manufacturer of immunization
dueDate:
type: string
description: Due date of immunization e.g. "01/20/2022 14:20:00"
expirationDate:
type: string
description: Expiration date of immunization e.g. "01/20/2022 14:20:00"
cptCode:
type: string
description: CPT code string
cvxCode:
type: string
description: CVX code string
manufacturerCode:
type: string
description: Manufacturer code string
locationCode:
type: string
description: Location code string
administeredBy:
type: string
description: Who administered the immunization
id:
type: string
description: Immunization Id
updatedBy:
type: string
description: Who updated the record last
updated:
type: string
description: Date record last updated e.g. "01/20/2022 14:20:00"
example: 01/20/2022 14:20:00
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Swagger.SwaggerRequests.LKPDL.PostVitalsSwaggerRequest:
type: object
properties:
request:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.PostVitalsRequest'
description: Request object
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityAdditionalTestEyes:
type: object
properties:
od:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityAdditionalTestEyesOD'
description: Visual acuity measurements for the OD during the additional test
os:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityAdditionalTestEyesOS'
description: Visual acuity measurements for the OS during the additional test
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.GetPastMedicalHistoryRequest:
type: object
properties:
patientId:
type: string
description: 'Patient id to query
Required'
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.EncounterPatient:
required:
- id
type: object
properties:
id:
minLength: 1
type: string
description: Patient id
additionalProperties: false
description: Encounter patient
LKCloudConnect.Contracts.PatientDataLink.GetSurgicalHistoryResult:
type: object
properties:
patientId:
type: string
description: Patient id
procedures:
type: array
items:
$ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.SurgicalHistoryProcedure'
description: Array of history of surgical procedures data
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.MedicalCondition:
type: object
properties:
condition:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.CodeDetail'
description: Code detail of condition
note:
type: string
description: Note for medical condition
dateRecorded:
type: string
description: Date recorded. (DateTimeOffset) eg 2019-01-01T00:00:00+00:00
format: date-time
example: '2019-01-01T00:00:00+00:00'
physicianId:
type: string
description: Unique identifier of the physician associated with the recorded history data.
encounterId:
type: string
description: Unique identifier of the encounter associated with the recorded history data.
onSetDate:
type: string
description: 'The date and time when the patient''s condition started.
(DateTimeOffset) eg 2019-01-01T00:00:00+00:00'
format: date-time
example: '2019-01-01T00:00:00+00:00'
status:
allOf:
- $ref: '#/components/schemas/LKCloudConnect.Contracts.PatientDataLink.HistoryStatusDetail'
description: Shows the detailed status of the patient's history information.
custom:
type: object
additionalProperties:
type:
- string
- 'null'
description: System-specific data for special cases
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.OpthalmologyModels.VisualAcuityAdditionalTestEyesOS:
type: object
properties:
value:
type: string
description: This test shows eye's vision is affected by test type of OS
additionalProperties: false
LKCloudConnect.Contracts.PatientDataLink.VitalsPatient:
required:
- id
type: object
properties:
id:
minLength: 1
type: string
description: Patient id
additionalProperties: false
description: Patient id vital is being recorded for
x-provenance:
method: searched
source: https://lkcloud-api.readme.io/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://lkcloud-api.readme.io/reference/post_lkappointments-beginsearchappointments.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-editappointment.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-getappointment.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-getappointments.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-getappointmentslot.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-getappointmentstatuses.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-getappointmenttypes.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-getfacilities.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-getopenappointmentslots.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-getphysicians.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-getscheduleappointmenttypes.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-nextsearchappointments.md
- https://lkcloud-api.readme.io/reference/post_lkappointments-scheduleappointment.md
- https://lkcloud-api.readme.io/reference/post_lkbridge-getadvancedirectives.md
- https://lkcloud-api.readme.io/reference/post_lkbridge-getbridgeinfo.md
- https://lkcloud-api.readme.io/reference/post_lkbridge-getguarantor.md
- https://lkcloud-api.readme.io/reference/post_lkbridge-getpatient.md
- https://lkcloud-api.readme.io/reference/post_lkbridge-getpatientalerts.md
- https://lkcloud-api.readme.io/reference/post_lkbridge-getpatientreportingdata.md
- https://lkcloud-api.readme.io/reference/post_lkbridge-getpatientsummary.md
- https://lkcloud-api.readme.io/reference/post_lkbridge-getreferrals.md
- https://lkcloud-api.readme.io/reference/post_lkbridge-smartsearch.md
- https://lkcloud-api.readme.io/reference/post_lkcharges-getchargestatus.md
- https://lkcloud-api.readme.io/reference/post_lkcharges-sendcharge.md
- https://lkcloud-api.readme.io/reference/post_lkdocuments-createdocument.md
- https://lkcloud-api.readme.io/reference/post_lkdocuments-getdocument.md
- https://lkcloud-api.readme.io/reference/post_lkdocuments-getdocumenttypes.md
- https://lkcloud-api.readme.io/reference/post_lkdocuments-getpatientdocuments.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-createemployer.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getcodeset.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getcollectionbuckets.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getemployers.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getemploymentstatuses.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getencounterreasons.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getethnicities.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getgenderidentities.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getinsurances.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getlanguages.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getmaritalstatuses.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getpharmacies.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getraces.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getrelationships.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-getsexualorientations.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-searchpharmacies.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-searchpractitioners.md
- https://lkcloud-api.readme.io/reference/post_lkmasterlist-searchresources.md
- https://lkcloud-api.readme.io/reference/post_lkpatientbalance-applypayment.md
- https://lkcloud-api.readme.io/reference/post_lkpatientbalance-beginsearchclaims.md
- https://lkcloud-api.readme.io/reference/post_lkpatientbalance-getaccount.md
- https://lkcloud-api.readme.io/reference/post_lkpatientbalance-getbalance.md
- https://lkcloud-api.readme.io/reference/post_lkpatientbalance-getbalancesummary.md
- https://lkcloud-api.readme.io/reference/post_lkpatientbalance-getbillingalert.md
- https://lkcloud-api.readme.io/reference/post_lkpatientbalance-getpatientcollectionbuckets.md
- https://lkcloud-api.readme.io/reference/post_lkpatientbalance-nextsearchclaims.md
- https://lkcloud-api.readme.io/reference/post_lkpatientbalance-updatebillingalert.md
- https://lkcloud-api.readme.io/reference/post_lkpatientbalance-updatepatientcollectionbucket.md
- https://lkcloud-api.readme.io/reference/post_lkpatientbalance-voidpayment.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-begingetupdatedpatients.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-closeencounter.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-createencounter.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getallergies.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getdiagnoses.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getencounternotebody.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getencounternotes.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getencounters.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getfamilyhistory.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getimmunizations.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getlabresults.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getmedicalhistory.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getmedications.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getophthalmologyobservations.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getproblems.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getprocedures.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getsocialhistory.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getsurgicalhistory.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getvitals.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-getvitalsdefinition.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-nextgetupdatedpatients.md
- https://lkcloud-api.readme.io/reference/post_lkpatientdatalink-postvitals.md
- https://lkcloud-api.readme.io/reference/post_updatepatient-updatepatientservice-svc-createpatient.md
- https://lkcloud-api.readme.io/reference/post_updatepatient-updatepatientservice-svc-createreferral.md
- https://lkcloud-api.readme.io/reference/post_updatepatient-updatepatientservice-svc-updateadvancedirective.md
- https://lkcloud-api.readme.io/reference/post_updatepatient-updatepatientservice-svc-updatepatient.md
- https://lkcloud-api.readme.io/reference/post_updatepatient-updatepatientservice-svc-updatepatientreportingdata.md
- https://lkcloud-api.readme.io/reference/post_updatepatient-updatepatientservice-svc-updatereferral.md
merge:
pages: 85
deduped: 158
conflicts_kept_first: 0