Base URL: /api/v1/,
Version: 1.1.0

Public APIs for patient-facing access to Hixny For You.

NOTE: that all authenticated APIs require XMLHttpRequest objects to set the withCredentials property to true when accessed from a different server.

If you don't set the flag for this kind of request, the cookie containing your session token will be ignored by the browser and the server will treat your requests as unauthenticated.

Default request content-types:
application/json
Default response content-types:
application/json
Schemes:
https

Summary

Use the links on this page to quickly navigate to specific sections on this page.

Tag: unauthenticated

OperationDescription
GET /_pingPing API
POST /auth/forgotpasswordPassword notification API
POST /auth/loginLogin API
POST /auth/logoutLogout API
GET /auth/statusLogin Status
POST /calendar/eventsAPI to get calendar events.

Tag: application

OperationDescription
GET /application/settingsApplication Settings
GET /languages/{appName}/{type}Get available languages for given application and type
POST /languages/sessionLanguageUpdate session language
GET /languagesApplication Languages
GET /registration/requiredFieldsRequired fields for registration

Tag: message

OperationDescription
GET /messages/{messageID}
POST /messages/{messageID}/archive
POST /messages/{messageID}/unarchive
GET /messages/{messageID}/attachments
POST /messages/archive
GET /messages/attachments/{attachmentID}
GET /messages/attachments/{attachmentID}/{filename}
GET /messages/folders/counts/unread
GET /messages/folders/{folderName}
POST /messages/forms/{formRequestID}Submit form
GET /messages/pharmacies/{pharmacyID}
POST /messages/search/locations
POST /messages/search/pharmacies
POST /messages/search/providers
POST /messages/search/recipients
POST /messages/send/appointmentConfirm
POST /messages/send/appointmentReject
POST /messages/send/appointmentRequestSend Appointment Request
POST /messages/send/generalQuestionAsk General Question
POST /messages/send/medicalQuestionAsk Medical Question
POST /messages/send/refillRequestMedication Refill Request
POST /messages/send/testResultRequestRequest test results
POST /messages/send/referralConfirm
POST /messages/send/referralReject
POST /messages/send/referralRequestSend Referral Request
POST /messages/send/replySend reply to a message
POST /messages/unarchive
GET /users/{userID}/appointmentPreference
GET /users/{userID}/apptPreference

Tag: user

OperationDescription
GET /users/{userID}/accountSummary
GET /users/{userID}/accountHistory
GET /users/{userID}/appointmentPreference
GET /users/{userID}/apptPreference
GET /users/{userID}/contactInfo
GET /users/{userID}/devices
POST /users/0/favoriteProviders
DELETE /users/0/favoriteProviders
GET /users/{userID}/proxyData
POST /users/0/changeEmail
POST /users/0/changePassword
GET /users/0/home
POST /users/0/logEvent
GET /users/0/securityQuestions
POST /users/0/securityQuestions
DELETE /users/0/securityQuestions
POST /users/0/switchEffectiveUser
GET /users/0/termsOfUse
POST /users/0/termsOfUse
POST /users/activateUser
POST /users/enroll
POST /users/forgotPassword
POST /users/forgotUsername
GET /users/loginPage
GET /users/passwordRequirements
POST /users/resetPassword
POST /users/validateActivationCode
POST /users/validateResetToken
POST /users/validateStagedUser
POST /users/validateSecurityAnswer
POST /users/validateUsername

Tag: authenticated

OperationDescription
POST /auth/delayedLogoutDelayed Logout API
POST /auth/logoutLogout API
POST /calendar/eventsAPI to get calendar events.

Tag: calendar

OperationDescription
POST /calendar/eventsAPI to get calendar events.

Tag: content

OperationDescription
GET /content/layout/{appName}/{documentID}
GET /content/popup/help/{appName}
POST /content/static/{appName}
GET /content/static/{appName}/{documentID}

Tag: document

OperationDescription
GET /documents/session
GET /documents/status/{documentID}
POST /documents/upload
GET /ehr/document/download/{documentID}Download a document representing the patient’s medical records.
By default, this only includes HTML and XML document formats, but the currently available formats can be listed by calling the /ehr/document/types API
GET /ehr/document/download/{documentID}/{filename}Download a document representing the patient’s medical records.
By default, this only includes HTML and XML document formats, but the currently available formats can be listed by calling the /ehr/document/types API.
This API is in place to support browsers that behave better for URLs that mimic static files.
GET /ehr/document/ehr/{ehrDocumentID}Download a document that is part of the patient’s medical records.
GET /ehr/document/ehr/{ehrDocumentID}/{filename}Download a document that is part of the patient’s medical records.
This API is in place to support browsers that behave better for URLs that mimic static files.
GET /ehr/document/startDownloadRequest the patient’s medical records be made available for download in the format specified by the type parameter. Optionally, medical record can be filtered based on startDate and endDate paramters.
GET /ehr/document/readyPoll to see if a requested download is available
POST /ehr/document/transmitRequest that the patient’s medical records be sent to a clinician
GET /ehr/document/types

Tag: ehr

OperationDescription
GET /ehr/category/advanceDirectives
GET /ehr/category/alerts
GET /ehr/category/allergies
GET /ehr/category/appointments
GET /ehr/category/carePlans
GET /ehr/category/contacts
GET /ehr/category/counts
GET /ehr/category/customObjects
GET /ehr/category/demographics
GET /ehr/category/deviceObservations
GET /ehr/category/diagnosis
GET /ehr/category/documents
GET /ehr/category/encounters
GET /ehr/category/familyHx
GET /ehr/category/goals
GET /ehr/category/healthConcerns
GET /ehr/category/immunizations
GET /ehr/category/insurance
GET /ehr/category/instructions
GET /ehr/category/labOrders
GET /ehr/category/medicalHx
GET /ehr/category/medications
GET /ehr/category/otherOrders
GET /ehr/category/physicalExams
GET /ehr/category/problems
GET /ehr/category/procedures
GET /ehr/category/programMemberships
GET /ehr/category/providers
GET /ehr/category/radOrders
GET /ehr/category/referrals
GET /ehr/category/socialHx
GET /ehr/category/vitals
GET /ehr/chartNames
GET /ehr/dates/{date}
GET /ehr/events
POST /ehr/labChart
GET /ehr/medications
GET /ehr/reference/{context}Search a third party content provider
GET /ehr/summary
POST /ehr/updateCounts
POST /ehr/vitalsChart

Tag: login

OperationDescription
POST /ehr/updateCounts
GET /users/loginPage
GET /users/passwordRequirements
POST /users/validateSecurityAnswer

Tag: forms

OperationDescription
GET /forms/definitionsRetrieve All Form Definitions
GET /forms/definitions/{application}Retrieve All Form Definitions by Application
GET /forms/definitions/{application}/{formKey}Retrieve Specific Form Definition
GET /forms/definitions/{application}/{formKey}/{formVersion}Retrieve Specific Form Definition Version
GET /forms/libraryRetrieve Public Form Library
POST /forms/data/{application}/unauthenticated/_submitSubmit Form Response (Unauthenticated)
GET /forms/data/{application}/{userType}/{userId}Retrieve intermediate form data
POST /forms/data/{application}/{userType}/{userId}Submit intermediate form data
POST /forms/data/{application}/{userType}/{userId}/_submitSubmit form directly
GET /forms/data/{application}/{formDataId}Retrieve intermediate form data
POST /forms/data/{application}/{formDataId}Submit intermediate form data
PUT /forms/data/{application}/{formDataId}Update intermediate form data
DELETE /forms/data/{application}/{formDataId}Delete intermediate form data
POST /messages/forms/{formRequestID}Submit form

Tag: library

OperationDescription
GET /library/{appName}/feeds
GET /library/{appName}/forms
GET /library/{appName}/news
GET /library/feeds
POST /library/feeds
DELETE /library/feeds

Paths

Ping API

GET /_ping

Tags:
unauthenticated

Simple API to test access
text/plain

default

You should get pong as a response

[
    {
        "default": "pong"
    }
]
                                                            

 

Application Settings

GET /application/settings

Tags:
application

Returns the application settings
Uses default content-types:
application/json

200 OK

Application Settings

APPLICATION:string
DisableMessageAppointment:boolean
DisableMessageReferral:boolean
DisableMessageRefill:boolean
DisableMessageTestRequest:boolean
DisableMessaging:boolean
DisableMessagingReplies:boolean
DisableSecurityQuestionPasswordReset:boolean
DisableSelfEnrollment:boolean
DisableWellnessAppointments:boolean
DisableWellnessCarePlan:boolean
DisableWellnessMyProviders:boolean
ORGANIZATION:string
default

Unexpected error

 

Delayed Logout API

POST /auth/delayedLogout

Tags:
authenticated

The delayed logout API will ends the patient’s current server-side session after a delay if there is no other API call in current session. The delay time is an application setting.

Uses default content-types:
application/json

204 No Content

Empty response indicates success

default

Unexpected error

Password notification API

POST /auth/forgotpassword

Tags:
unauthenticated

API for a patient to request a password reminder to be emailed to the email address for the account.

The account may be identified by username OR email address.

application/json

Fields needed to identify the user account.

Uses default content-types:
application/json

200 OK

Success is indicated by an empty return object.

default

Error

Login API

POST /auth/login

Tags:
unauthenticated

The login API accepts a username and password supplied in a JSON payload. Subsequent session tracking is performed via a cookie.

application/json

User’s username and password

Uses default content-types:
application/json

302 Found

HTTP 1.0: On successful login, redirected to auth/status

303 See Other

HTTP 1.1 or greater : On successful login, redirected to auth/status

default

Error

Logout API

POST /auth/logout

Tags:
authenticated,
unauthenticated

The logout API ends the patient’s current server-side session. It can be called when unauthenticated, but has no effect when not logged in.

Uses default content-types:
application/json

204 No Content

Empty response indicates success

default

Error

 

Login Status

GET /auth/status

Tags:
unauthenticated

The status API returns the login status for the current session.

Uses default content-types:
application/json

200 OK

Information about the session and the logged in user.

default

Error

 

API to get calendar events.

POST /calendar/events

Tags:
unauthenticated,
authenticated,
calendar

This API allows for events to be requested from the back end calendar, and allows the caller to specify the general structure to use for the returned events. The default behaviour is to return all events for the current month grouped by weeks and days, but other return structures can be requested.
When a patient is authenticated, the returned data will include any appointments for the requested time period that appear in the patient’s medical records.

application/json

All properties are optional, but an object MUST be supplied as an argument even if it’s empty.

Uses default content-types:
application/json

200 OK

List of calendar events in the format that was requested

default

Error

 

GET /content/layout/{appName}/{documentID}

Tags:
content

appNamepathstring , x ∈ {
workbench
}
documentIDDocument IDpathstring
langlanguagequerystring
Uses default content-types:
application/json

200 OK

Document Content

 

GET /content/popup/help/{appName}

Tags:
content

appNamepathstring , x ∈ {
public
,
workbench
}
areaDocument IDquerystring
keyKeyquerystring
langLanguagequerystring
Uses default content-types:
application/json

200 OK

Content

POST /content/static/{appName}

Tags:
content

Uses default content-types:
application/json

string

Content Keys

appNamepathstring , x ∈ {
public
,
workbench
}
langlanguagequerystring
Uses default content-types:
application/json

200 OK

Content for each key

GET /content/static/{appName}/{documentID}

Tags:
content

appNamepathstring , x ∈ {
public
,
workbench
}
documentIDDocument IDpathstring
langlanguagequerystring
Uses default content-types:
application/json

200 OK

Content

GET /documents/session

Tags:
document

List documents uploaded in this session

Uses default content-types:
application/json

200 OK

Document list

default

Unexpected error

GET /documents/status/{documentID}

Tags:
document

Get the status of document scan

documentIDpathstring
Uses default content-types:
application/json

200 OK

Document status

ScanStatus:string
ScanResult:string
default

Unexpected error

 

POST /documents/upload

Tags:
document

multipart/form-data

fileformDatafile
filenameformDatastring
Uses default content-types:
application/json

200 OK

Returns temporary document id

DocumentID:string
default

Unexpected error

GET /ehr/category/advanceDirectives

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Advance Directives

GET /ehr/category/alerts

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Alerts

 

GET /ehr/category/allergies

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Allergies

GET /ehr/category/appointments

Tags:
ehr

datequerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Appointments

GET /ehr/category/carePlans

Tags:
ehr

datequerystring
encquerystring
Uses default content-types:
application/json

200 OK

List of Care Plans

 

GET /ehr/category/contacts

Tags:
ehr

datequerystring
encquerystring
Uses default content-types:
application/json

200 OK

List of Contacts

 

GET /ehr/category/counts

Tags:
ehr

Get counts for EHR categories

tagsData tags to include in countsquerystring[]
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

Counts of all EHR categories

GET /ehr/category/customObjects

Tags:
ehr

datequerystring
encquerystring
Uses default content-types:
application/json

200 OK

List of Custom Objects

object

 

GET /ehr/category/demographics

Tags:
ehr

Uses default content-types:
application/json

200 OK

Patient’s Demographics

GET /ehr/category/deviceObservations

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Vitals

 

GET /ehr/category/diagnosis

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Diagnoses

 

GET /ehr/category/documents

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Documents

 

GET /ehr/category/encounters

Tags:
ehr

datequerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Encounters

 

GET /ehr/category/familyHx

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Family History entries

 

GET /ehr/category/goals

Tags:
ehr

HistoryStartStart datequerystring (date)
HistoryEndEnd datequerystring (date)
Uses default content-types:
application/json

200 OK

List all goals for the patient

 

GET /ehr/category/healthConcerns

Tags:
ehr

HistoryStartStart datequerystring (date)
HistoryEndEnd datequerystring (date)
Uses default content-types:
application/json

200 OK

List all health concerns for the patient

 

GET /ehr/category/immunizations

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Immunizations

 

GET /ehr/category/instructions

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Instructions

 

GET /ehr/category/insurance

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Insurance entries

 

GET /ehr/category/labOrders

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Lab Orders

 

GET /ehr/category/medicalHx

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Illness History entries

 

GET /ehr/category/medications

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Medications

GET /ehr/category/otherOrders

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Other Orders

 

GET /ehr/category/physicalExams

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Physical Exams

 

GET /ehr/category/problems

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Problems

 

GET /ehr/category/procedures

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Procedures

 

GET /ehr/category/programMemberships

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Memberships

GET /ehr/category/providers

Tags:
ehr

datequerystring
encquerystring
Uses default content-types:
application/json

200 OK

List of Providers

 

GET /ehr/category/radOrders

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Radiology Orders

 

GET /ehr/category/referrals

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Referrals

 

GET /ehr/category/socialHx

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Social History entries

GET /ehr/category/vitals

Tags:
ehr

datequerystring
encquerystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

List of Vitals

GET /ehr/chartNames

Tags:
ehr

Get names of all chartable, numeric observations and lab results

typequerystring , x ∈ {
all
,
obs
,
lab
}
Uses default content-types:
application/json

200 OK

Get list of chartable data

GET /ehr/dates/{date}

Tags:
ehr

dateDate in YYYY-MM-DD formatpathstring
Uses default content-types:
application/json

200 OK

List of entries in the patient’s medical records for the given date

Download a document representing the patient’s medical records.
By default, this only includes HTML and XML document formats, but the currently available formats can be listed by calling the /ehr/document/types API

GET /ehr/document/download/{documentID}

Tags:
document

documentIDDocument IDpathstring
text/html text/xml

200 OK

The document contents

 

Download a document representing the patient’s medical records.
By default, this only includes HTML and XML document formats, but the currently available formats can be listed by calling the /ehr/document/types API.
This API is in place to support browsers that behave better for URLs that mimic static files.

GET /ehr/document/download/{documentID}/{filename}

Tags:
document

documentIDDocument IDpathstring
filenameThe name of the file to downloadpathstring
text/html text/xml

200 OK

The document contents

 

Download a document that is part of the patient’s medical records.

GET /ehr/document/ehr/{ehrDocumentID}

Tags:
document

ehrDocumentIDDocument ID of a EHR documentpathstring
application/octet-stream application/pdf application/xml application/zip text/html text/plain text/rtf text/xml

200 OK

The document contents

Download a document that is part of the patient’s medical records.
This API is in place to support browsers that behave better for URLs that mimic static files.

GET /ehr/document/ehr/{ehrDocumentID}/{filename}

Tags:
document

ehrDocumentIDDocument ID of a EHR documentpathstring
filenameThe name of the EHR document file that is being requestedpathstring
application/octet-stream application/pdf application/xml application/zip text/html text/plain text/rtf text/xml

200 OK

The document contents

 

Poll to see if a requested download is available

GET /ehr/document/ready

Tags:
document

typeThe requested format of the patient’s medical records in the /ehr/document/startDownload API.querystring
startDateMatches specified in the /ehr/document/startDownload APIquerystring
endDateMatches specified in the /ehr/document/startDownload APIquerystring
Uses default content-types:
application/json

200 OK

Information to indicate if the document is available yet

 

Request the patient’s medical records be made available for download in the format specified by the type parameter. Optionally, medical record can be filtered based on startDate and endDate paramters.

GET /ehr/document/startDownload

Tags:
document

typeThe format to use for the patient’s medical records. This value should be a value from the Type field returned from the /ehr/document/types API.querystring
startDateFilter records before this date. Format yyyy-mm-ddquerystring
endDateFilter records after this date. Format yyyy-mm-ddquerystring
Uses default content-types:
application/json

200 OK

Document formatting has started, but may not be complete. If the return data doesn’t contain an ID, you need to poll the /ehr/document/ready API

Request that the patient’s medical records be sent to a clinician

POST /ehr/document/transmit

Tags:
document

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Result of transmission request

error:string
Error message if any errors occurred sending the patient’s records

GET /ehr/document/types

Tags:
document

short0 or 1. If 1, only returns short description and types of download formats otherwise full detailsquerystring
all0 or 1. If 1, get all document fieldsquerystring
Uses default content-types:
application/json

200 OK

Document Types

 

GET /ehr/events

Tags:
ehr

Get Date Event Counts and Encounters

tagsData tags to include in countsquerystring[]
startStart datequerystring (date)
endEnd datequerystring (date)
Uses default content-types:
application/json

200 OK

Date Events

POST /ehr/labChart

Tags:
ehr

 

GET /ehr/medications

Tags:
ehr

whichAll (‘all’) or Current Meds (default)querystring
refill1 – Only Refillable Medicationsquerystring
Uses default content-types:
application/json

200 OK

List of Medications

Search a third party content provider

GET /ehr/reference/{context}

Tags:
ehr

contextpathstring , x ∈ {
drug
,
diagnosis
,
lab
,
freetext
}
codeSystemWhich code system the supplied code is in. Examples include ‘ICD9CM’ and ‘SNOMEDCT’querystring
codeCode of the item being searchedquerystring
termFree text search termquerystring
Uses default content-types:
application/json

200 OK

Search Results

GET /ehr/summary

Tags:
ehr

Get EHR Summary

Uses default content-types:
application/json

200 OK

EHR Summary

 

POST /ehr/updateCounts

Tags:
ehr,
login

Get EHR updates for the current user and the patients for whom they have proxy access

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Principal Updates

default

Unexpected error

POST /ehr/vitalsChart

Tags:
ehr

Submit Form Response (Unauthenticated)

POST /forms/data/{application}/unauthenticated/_submit

Tags:
forms

Submit a form response for an unauthenticated user.

applicationpathstring
Uses default content-types:
application/json

204 No Content

Successful Form Submission

403 Forbidden

Form not accepting data.

default

Unexpected error

Delete intermediate form data

DELETE /forms/data/{application}/{formDataId}

Tags:
forms

Deletes unsubmitted intermediate form data

applicationpathstring
formDataIdpathinteger
Uses default content-types:
application/json

204 No Content

Successfully Deleted

404 Not Found

Form data not found.

default

Unexpected error

Retrieve intermediate form data

GET /forms/data/{application}/{formDataId}

Tags:
forms

applicationpathstring
formDataIdpathinteger
Uses default content-types:
application/json

200 OK

Unsubmitted Form Data

404 Not Found

Form data not found.

default

Unexpected error

Submit intermediate form data

POST /forms/data/{application}/{formDataId}

Tags:
forms

Updates intermediate form data for the specified ID and then submits it for processing

Uses default content-types:
application/json

applicationpathstring
formDataIdpathinteger
Uses default content-types:
application/json

200 OK

Unsubmitted Form Data

403 Forbidden

Form not accepting data.

404 Not Found

Form data not found.

default

Unexpected error

Update intermediate form data

PUT /forms/data/{application}/{formDataId}

Tags:
forms

Updates intermediate form data (identified by ID) without actually submitting the form

Uses default content-types:
application/json

applicationpathstring
formDataIdpathinteger
Uses default content-types:
application/json

200 OK

Unsubmitted Form Data

403 Forbidden

Form not accepting data.

404 Not Found

Form data not found.

default

Unexpected error

Retrieve intermediate form data

GET /forms/data/{application}/{userType}/{userId}

Tags:
forms

Returns a list of unsubmitted/partially completed forms for the identified user.

applicationpathstring
userTypepathstring
userIdpathinteger
Uses default content-types:
application/json

200 OK

Unsubmitted Form Data List

default

Unexpected error

Submit intermediate form data

POST /forms/data/{application}/{userType}/{userId}

Tags:
forms

Creates a new intermediate form data submission – saved to the server, but not yet submitted – for later use. Returns the same data, plus an ID for the intermediate form data record.

Uses default content-types:
application/json

applicationpathstring
userTypepathstring
userIdpathinteger
Uses default content-types:
application/json

200 OK

Unsubmitted Form Data

403 Forbidden

Form not accepting data.

default

Unexpected error

 

Submit form directly

POST /forms/data/{application}/{userType}/{userId}/_submit

Tags:
forms

Submits a form response directly.

Uses default content-types:
application/json

applicationpathstring
userTypepathstring
userIdpathinteger
Uses default content-types:
application/json

204 No Content

Successful Form Submission

403 Forbidden

Form not accepting data.

default

Unexpected error

 

Retrieve All Form Definitions

GET /forms/definitions

Tags:
forms

Returns a summary of all form definitions to which the current user has access for all applications.

Uses default content-types:
application/json

200 OK

Form Summary List

default

Unexpected error

Retrieve All Form Definitions by Application

GET /forms/definitions/{application}

Tags:
forms

Returns a summary of all form definitions to which the current user has access for a given application.

applicationpathstring
Uses default content-types:
application/json

200 OK

Form Summary List

default

Unexpected error

 

Retrieve Specific Form Definition

GET /forms/definitions/{application}/{formKey}

Tags:
forms

Returns the latest published form version for a given logical form key.

applicationpathstring
formKeypathstring
Uses default content-types:
application/json

302 Found

Redirect to Form Definition Version

Locationstring
404 Not Found

Form definition not found.

default

Unexpected error

Retrieve Specific Form Definition Version

GET /forms/definitions/{application}/{formKey}/{formVersion}

Tags:
forms

Returns a specific published form version for a given logical form key.

applicationpathstring
formKeypathstring
formVersionpathinteger
Uses default content-types:
application/json

200 OK

Form Definition

404 Not Found

Form version not found.

default

Unexpected error

Retrieve Public Form Library

GET /forms/library

Tags:
forms

Returns a hierarchy of forms available for users to submit, dependent on whether the user is currently authenticated.

Uses default content-types:
application/json

200 OK

Public Form Library

default

Unexpected error

 

Application Languages

GET /languages

Tags:
application

Returns the allowed languages. Also used to set session language

langLanguage code in language-locale format, e.g. ‘en’, ‘en-gb’, ‘pt-br’querystring
Uses default content-types:
application/json

200 OK

Available Languages and Session Language

AvailableLanguages:string
Comma delimited list of available languages

MatchedLanguage:string
default

Unexpected error

 

Update session language

POST /languages/sessionLanguage

Tags:
application

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Sessions Language

MatchedLanguage:string
Updated session language

default

Unexpected error

Get available languages for given application and type

GET /languages/{appName}/{type}

Tags:
application

appNamepathstring , x ∈ {
public
,
workbench
}
typepathstring , x ∈ {
content
,
help
}
Uses default content-types:
application/json

200 OK

Available Languages

Languages:string[]
Array of available language codes

string

default

Unexpected error

 

DELETE /library/feeds

Tags:
library

Uses default content-types:
application/json

Feed URL

Uses default content-types:
application/json

204 No Content

Empty response indicates success

default

Unexpected error

GET /library/feeds

Tags:
library

Get user feeds for the application

appApplication Name e.g: publicquerystring
Uses default content-types:
application/json

200 OK

List of available Feeds

default

Unexpected error

POST /library/feeds

Tags:
library

Subscribe user to feed

Uses default content-types:
application/json

Feed URL

Uses default content-types:
application/json

204 No Content

Empty response indicates success

default

Unexpected error

GET /library/{appName}/feeds

Tags:
library

Get Application News Channels

appNameApplication Name e.g: publicpathstring , x ∈ {
public
,
workbench
}
Uses default content-types:
application/json

200 OK

List of News Channels

default

Unexpected error

 

GET /library/{appName}/forms

Tags:
library

Get Application Forms

appNameApplication Name e.g: publicpathstring , x ∈ {
public
,
workbench
}
Uses default content-types:
application/json

200 OK

List of Forms

default

Unexpected error

GET /library/{appName}/news

Tags:
library

Get Application News

appNameApplication Name e.g: publicpathstring , x ∈ {
public
,
workbench
}
Uses default content-types:
application/json

200 OK

List of NewsFeeds and a hasFeeds flag

default

Unexpected error

POST /messages/archive

Tags:
message

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Message(s) archived. Nothing returned.

 

GET /messages/attachments/{attachmentID}

Tags:
message

attachmentIDpathstring
application/octet-stream application/pdf application/xml application/zip text/html text/plain text/rtf text/xml

200 OK

Download message attachment file

 

GET /messages/attachments/{attachmentID}/{filename}

Tags:
message

attachmentIDpathstring
filenamepathstring
application/octet-stream application/pdf application/xml application/zip text/html text/plain text/rtf text/xml

200 OK

Download message attachment file via a URL that mimics a static file.

GET /messages/folders/counts/unread

Tags:
message

Uses default content-types:
application/json

200 OK

Count of unread messages in all folders

 

GET /messages/folders/{folderName}

Tags:
message

folderNameInbox, Sent, Deleted, InboxArchive, SentArchivepathstring
Uses default content-types:
application/json

200 OK

List of messages in the requested folder

 

Submit form

POST /messages/forms/{formRequestID}

Tags:
message,
forms

Submits form data to message or to the form submission pipeline.

Uses default content-types:
application/json

Data for the form – format varies based on the form’s definition.

formRequestIDForm request idpathinteger
Uses default content-types:
application/json

202 Accepted

Submitted form

401 Unauthorized

Reached maximum number of submissions

404 Not Found

Form request not found

500 Internal Server Error

Form submission failed

default

Unexpected error

 

GET /messages/pharmacies/{pharmacyID}

Tags:
message

pharmacyIDPharmacy IDpathstring
Uses default content-types:
application/json

200 OK

Pharmacy

 

POST /messages/search/locations

Tags:
message

Uses default content-types:
application/json

The location search parameters

Uses default content-types:
application/json

200 OK

All locations matching the search criteria

children:object[]

POST /messages/search/pharmacies

Tags:
message

Uses default content-types:
application/json

The pharmacy search parameters

Uses default content-types:
application/json

200 OK

All pharmacies matching the search criteria

children:object[]

 

POST /messages/search/providers

Tags:
message

Uses default content-types:
application/json

Provider search parameters

Uses default content-types:
application/json

200 OK

All providers matching the search criteria

children:object[]

 

POST /messages/search/recipients

Tags:
message

Uses default content-types:
application/json

Recipient search parameters

Uses default content-types:
application/json

200 OK

All recipients matching the search criteria

children:object[]

 

POST /messages/send/appointmentConfirm

Tags:
message

Confirm an appointment

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Appointment Confirmed

 

POST /messages/send/appointmentReject

Tags:
message

Reject all the appointment times in a message

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Appointment Rejected

 

Send Appointment Request

POST /messages/send/appointmentRequest

Tags:
message

Send New Appointment Request Message

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Sent Message response

Ask General Question

POST /messages/send/generalQuestion

Tags:
message

Send message to ask general question

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Sent Message response

Ask Medical Question

POST /messages/send/medicalQuestion

Tags:
message

Send message to ask medical question

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Sent Message response

POST /messages/send/referralConfirm

Tags:
message

Confirm a referral appointment

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Referral Confirmed

POST /messages/send/referralReject

Tags:
message

Reject all the appointment times for a referral

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Referral Rejected

Send Referral Request

POST /messages/send/referralRequest

Tags:
message

Send Referral Request Message

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Sent Message response

Medication Refill Request

POST /messages/send/refillRequest

Tags:
message

Send message to request refill

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Sent Message response

Send reply to a message

POST /messages/send/reply

Tags:
message

Send reply to a message

Uses default content-types:
application/json

Contents of message reply

Uses default content-types:
application/json

200 OK

Send Message Response

 

Request test results

POST /messages/send/testResultRequest

Tags:
message

Send message get test results

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Sent Message response

 

POST /messages/unarchive

Tags:
message

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Message(s) unarchived. Nothing returned.

 

GET /messages/{messageID}

Tags:
message

messageIDpathstring
Uses default content-types:
application/json

200 OK

Message Details

POST /messages/{messageID}/archive

Tags:
message

messageIDA message IDpathstring
Uses default content-types:
application/json

200 OK

Message archived. Nothing returned.

GET /messages/{messageID}/attachments

Tags:
message

messageIDpathstring
Uses default content-types:
application/json

200 OK

List of message attachments

Attachments:object[]
error:string
default

Unexpected error

POST /messages/{messageID}/unarchive

Tags:
message

messageIDA message IDpathstring
Uses default content-types:
application/json

200 OK

Message unarchived. Nothing returned.

Required fields for registration

GET /registration/requiredFields

Tags:
application

Returns fields which are required for registration. Returns array of array. The outer array contains AND fields. The inner array contains OR fields.

Uses default content-types:
application/json

200 OK

Required Registration Fields

RequiredFields:string[][]
string[]

string

POST /users/0/changeEmail

Tags:
user

Update email address for logged on user

Uses default content-types:
application/json

Current Password and New Email for logged on user

Uses default content-types:
application/json

204 No Content

Empty response indicates success

default

Unexpected error

 

POST /users/0/changePassword

Tags:
user

Change Password for logged on user

Uses default content-types:
application/json

Current Password and New Password for logged on user

Uses default content-types:
application/json

200 OK

Password change success message

204 No Content

Empty response indicates success

default

Unexpected error

 

DELETE /users/0/favoriteProviders

Tags:
user

Remove provider from logged in effective user’s favorite providers list

Uses default content-types:
application/json

Recipient IDs of favorite provider

Uses default content-types:
application/json

200 OK

Result of removing favorite provider

Status:string
Success or Error description

POST /users/0/favoriteProviders

Tags:
user

Add favorite providers to logged in effective user’s favorite providers list

Uses default content-types:
application/json

Recipient IDs of favorite providers

integer

Uses default content-types:
application/json

200 OK

Result of adding new favorite provider

Status:string
Success or Error description

Success:boolean

 

GET /users/0/home

Tags:
user

Logged in user home page information

updatesqueryboolean
Uses default content-types:
application/json

200 OK

Home Page Data

default

Unexpected error

POST /users/0/logEvent

Tags:
user

Log an Audit Event

Uses default content-types:
application/json

Event details

Uses default content-types:
application/json

200 OK

Event Response

EventLogged:boolean
true if the event was logged successfully

error:string
error text if failed to log event

default

Unexpected error

DELETE /users/0/securityQuestions

Tags:
user

Delete security question

Uses default content-types:
application/json

Question ID

Uses default content-types:
application/json

204 No Content

Empty response indicates success

default

Unexpected error

GET /users/0/securityQuestions

Tags:
user

Uses default content-types:
application/json

200 OK

List of security questions for the current user

default

Unexpected error

POST /users/0/securityQuestions

Tags:
user

Add/Update security questions and answers

Uses default content-types:
application/json

Question ID and Answer

Uses default content-types:
application/json

200 OK

Security question requirements

default

Unexpected error

 

POST /users/0/switchEffectiveUser

Tags:
user

Switch to Proxy View

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Response of switching to proxy view

default

Unexpected error

 

GET /users/0/termsOfUse

Tags:
user

Uses default content-types:
application/json

200 OK

Get the current terms of use

default

Unexpected error

POST /users/0/termsOfUse

Tags:
user

Update acceptance of terms of use

Uses default content-types:
application/json

ID and Hash

Uses default content-types:
application/json

200 OK

Terms updated. No response

default

Unexpected error

 

POST /users/activateUser

Tags:
user

Activate Staged User

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Activate user response

default

Unexpected error

POST /users/enroll

Tags:
user

Enroll user request

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Response for enrollment request

default

Unexpected error

 

POST /users/forgotPassword

Tags:
user

Sent Forgot Password Request

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Response of Password reset request

default

Unexpected error

POST /users/forgotUsername

Tags:
user

Sent Forgot Username Request

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Empty success

default

Unexpected error

 

GET /users/loginPage

Tags:
user,
login

Login Page

Uses default content-types:
application/json

200 OK

Login Page

default

Unexpected error

GET /users/passwordRequirements

Tags:
login,
user

Get Password requirements

typequerystring , x ∈ {
answer
,
password
}
Uses default content-types:
application/json

200 OK

Password Requirements

POST /users/resetPassword

Tags:
user

Reset password. This works only after Reset Token is already set on the server in current session

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Empty success

default

Unexpected error

POST /users/validateActivationCode

Tags:
user

Validate activation code for new user

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Activation code validation response

default

Unexpected error

POST /users/validateResetToken

Tags:
user

Validate reset token sent to user via email or other mechanism

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Reset token validation response

default

Unexpected error

POST /users/validateSecurityAnswer

Tags:
user,
login

Check answer to security question. Must be called after /validateResetToken

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Security Answer Validation

default

Unexpected error

POST /users/validateStagedUser

Tags:
user

Validate staged user identification data

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Staged User validation response

default

Unexpected error

 

POST /users/validateUsername

Tags:
user

Validate user name for new user

Uses default content-types:
application/json

Uses default content-types:
application/json

200 OK

Username validation response

default

Unexpected error

 

GET /users/{userID}/accountHistory

Tags:
user

Get User Account History

userIDUser ID. 0 for current userpathstring
Uses default content-types:
application/json

200 OK

Account History

403 Forbidden

Denied access to user record

 

GET /users/{userID}/accountSummary

Tags:
user

Get User Account Summary

userIDUser ID. 0 for current userpathstring
Uses default content-types:
application/json

200 OK

Account Summary

403 Forbidden

Denied access to user record

 

GET /users/{userID}/appointmentPreference

Tags:
message,
user

Get User Appointment Preference

userIDUser ID. 0 for current userpathstring
Uses default content-types:
application/json

200 OK

User’s appointment preference

403 Forbidden

Denied access to user record

GET /users/{userID}/apptPreference

Tags:
message,
user

This API is deprecated. Please use appointmentPreference instead.

userIDUser ID. 0 for current userpathstring
Uses default content-types:
application/json

200 OK

User’s appointment preference

403 Forbidden

Denied access to user record

GET /users/{userID}/contactInfo

Tags:
user

Get user contact information default

userIDUser ID. 0 for current userpathstring
Uses default content-types:
application/json

200 OK

User’s contact information

403 Forbidden

Denied access to user record

GET /users/{userID}/devices

Tags:
user

Get User Validic device data

userIDUser ID. 0 for current userpathstring
Uses default content-types:
application/json

200 OK

Validic devices info

403 Forbidden

Denied access to user record

GET /users/{userID}/proxyData

Tags:
user

Get User proxy data

userIDUser ID. 0 for current userpathstring
Uses default content-types:
application/json

200 OK

Proxy Data

403 Forbidden

Denied access to user record

Schema definitions

 

AbstractAlert:

object

 

Alert:string
AlertType:string
Comments:string
EnteredAt:string
EnteredBy:string
EnteredTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FromTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Status:string
Timestamp:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ToTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:integer

AbstractOrder:

 

 

EHRCareProvider
AuthTime:string
Code:string
CodeSystem:string
Comments:string
Condition:string
ConfidentialityCode:string
ConsultingDepartment:string
Duration:string
EnteringOrganization:string
FillerAA:string
FillerID:string
Frequency:string
GroupAA:string
GroupID:string
Instructions:string
OrderCategory:string
OrderedBy:string
OrderGroup:string
OrderItem:string
OrderedItemDisplay:string
OrderQuantity:string
PlacerAA:string
PlacerID:string
Priority:string
ReassessmentTime:string
ReceivingLocation:string
ResultCopiesTo:object[]
Specimen:string
SpecimenCollTime:string
SpecimenRecTime:string
Status:string
VerifiedBy:string
VerifiedComments:string

AbstractProvider:

object

 

Address:string
City:string
Provider:string
ProviderAddress:string
ProviderName:string
ProviderPhone:string
State:string
Street:string
Zip:string

AbstractResultOrder:

 

 

Mapping of HS.SDA3.AbstractResultOrder for shared elements for resulted orders
EHRResult
AbstractOrder
ClinicalInfo:string
ParentFillerAA:string
ParentFillerID:string
ParentPlacerAA:string
ParentPlacerID:string
ParentResultNumeric:string
ParentResultObservation:string
ParentResultObsSubID:string
ParentResultObsText:string
ReasonForStudy:string

AccountHistoryEvent:

object

 

DisplayTime:string
DisplayType:string
Time:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

User:string
position:integer

AccountSummary:

object

 

CreateDate:string (date)
Email:string
MRN:string
Username:string

ActivateUserRequest:

object

 

Password:string
TermsAccepted:object
HashBase64:string
ID:integer
Terms:string
Username:string
passwordConfirm:string

ActivateUserResponse:

object

 

InactiveMinor:boolean
UserActivated:boolean
AnswerSecurityQuestions:boolean
error:string

Address:

object

 

Building:string
City:string
Country:string
Line1:string
Line2:string
PostalCode:string
State:string

Administration:

object

 

Amount:integer
Comments:string
ExpiryDate:string (date)
Location:string
LotNumber:string
Manufacturer:string
Provider:string
RefusalReason:string
Site:string
Status:string
Units:string

AdvanceDirective:

 

 

AdvanceDirectiveCategoryList:

object

 

AdvanceDirectives:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Alert:

 

 

AlertCategoryList:

object

 

Alerts:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Alias:

object

 

Name:string

Allergy:

object

 

Allergy:string
ATCCode:string
Category:string
Certainty:string
Comments:string
DiscoveryTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

EnteredAt:string
EnteredBy:string
EnteredTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FromTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

InactiveComments:string
InactiveTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

PatientAge:string
Provider:string
Reaction:string
Severity:string
Status:string
Timestamp:string
ToTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:integer

AllergyCategoryList:

object

 

Allergies:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

AppointmentCategoryList:

object

 

Appointments:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

AppointmentModel:

object

 

Appointments:object[]
ProxyOnly:integer

AppointmentOption:

object

 

Date:string (date)
Time:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Comments:string
Provider:string
Location:string
Address:string
BasicInstructions:string
ContactInformation:string
Directions:string
DirectionsLink:string
DisplayHours:string

AppointmentPreference:

object

 

Days:string
TimeSlot:string
HasDefault:boolean

AppointmentUpdateResponse:

object

 

text:string
error:string

AttachmentInfo:

object

 

AcceptsAttachments:boolean
AttachmentsWithoutMimeTypes:boolean
AttachmentFileTypes:object[]

AttendingProvider:

 

 

BasicUserData:

object

 

FirstName:string
LastName:string
FullName:string
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }
Proxies:object[]
ProxyFor:object[]

CalendarDay:

object

 

Date:string (date)
Date of event in YYYY-MM-DD format.

DisplayDate:string
Date of event in user-friendly format.

DayName:string
Name of the day.

DisplayDateFull:string
Date of event in a second user-friendly format that may include terms like “Yesterday” or “Today”.

Events:object[]
List of events that occur on this day.

CalendarEvent:

object

 

Date:string (date)
Date of event in YYYY-MM-DD format.

DayName:string
Name of the day.

DisplayDate:string
Date of event in user-friendly format.

DisplayDateFull:string
Date of event in a second user-friendly format that may include terms like “Yesterday” or “Today”.

DisplayNotice:string
Text that indicates something about the event’s state, e.g. a cancellation.

DisplayText:string
Short summary of the event.

Location:string
Location of the event.

Notice:string
Flag that indicates the state of the event.

Title:string
Name of the event.

CalendarEventRequest:

object

 

CalendarMonth:integer
, { x ∈ ℤ | 1 ≤ x ≤ 12 }
The month you wish to get events for.

CalendarYear:integer
The year you wish to get events for.

WeekCount:integer
The number of weeks you wish to see events for.

Format:string , x ∈ {
events
,
days
,
weeks
}
Indicate whether you want the calendar events in a flat list, grouped by day, or grouped by week. “week” is the default

MaxEvents:integer
, { x ∈ ℤ | x ≥ 0 }
Maximum number of events to return. Most useful for Format
= “events”.

CalendarEvents:

object

 

Title:string
Localized title that can be ignored.

DayOfWeek:string
Current day of the week.

DisplayRange:string
The date range being returned.

Weeks:object[]
List of weeks. Returned when Format = “weeks” or is not
specified.

Days:object[]
List of days. Returned when Format = “days”.

Events:object[]
List of events. Returned when Format = “events”.

CalendarWeek:

object

 

Days:object[]
A list of days in the week

CarePlan:

object

 

Code:string
CodeSystem:string
Description:string
EnteredAt:string
EnteredBy:string
EnteredTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FromTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Text:string
Timestamp:string
ToTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Type:string
UpdatedTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:integer

CarePlanCategoryList:

object

 

CarePlans:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

CatCount:

object

 

AdvanceDirectives:number
Alerts:number
Allergies:number
Appointments:number
CarePlans:number
Contacts:number
CurrentMedications:number
CustomObjects:number
Diagnoses:number
Documents:number
Encounters:number
FamilyHistories:number
Guarantors:number
Guardians:number
IllnessHistories:number
Immunizations:number
LabOrders:number
Medications:number
Observations:number
OtherOrders:number
PhysicalExams:number
Problems:number
Procedures:number
ProgramMemberships:number
Providers:number
RadOrders:number
RecentLabOrders:number
Referrals:number
SocialHistories:number

CategoryCounts:

object

 

LastLogin:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Last login date/time. Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

NewCounts:object[]
TotalCounts:object[]

ChartName:

object

 

Key:string
DisplayName:string
Type:string , x ∈ {
Lab
,
Observation
}

ChartRequest:

object

 

Biomarkers:string[]
Lab: Glucose,HGB,WBC,CO2,PLT Vitals: Heart Rate,BP sys,BP dias,Resp rate,Body temperature

string

ConfirmAppointmentRequest:

object

 

id:string
message id

which:string
inbox or outbox

SelectedOption:number
Selection Appointment Number

ConfirmReferralRequest:

 

 

ConsultingProvider:

 

 

Contact:

object

 

Address:string
AddressFromTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

AddressToTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

City:string
ContactType:string
Country:string
County:string
Date:string (date)
DateDisplay:string
DateOfBirth:string (date)
Email:string
EmergencyContact:string
EncounterNumber:string
EnteredAt:string
EnteredBy:string
EnteredTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ExternalID:string
FirstName:string
FromTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Gender:string
HomePhone:string
LastName:string
MobilePhone:string
Name:string
PatientAge:string
PrimaryContact:string
PrimaryLanguage:string
Relationship:string
State:string
Street:string
Time:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:string
ToTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

WorkPhone:string
Zip:string
key:integer

ContactCategoryList:

object

 

Contacts:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Content:

object

 

Version:string
actualHelpId:string
helpId:string
area:string
content:string
HTML content

id:string
content key

key:integer
type:string

DateDetails:

object

 

AdvanceDirectives:object[]
Alerts:object[]
Allergies:object[]
Appointments:object[]
CarePlans:object[]
Contacts:object[]
Date:string (date)
DateDisplay:string
DeviceObservations:object[]
Diagnoses:object[]
Documents:object[]
Encounters:object[]
FamilyHistories:object[]
Guarantors:object[]
Guardians:object[]
IllnessHistories:object[]
Immunizations:object[]
Instructions:object[]
Insurances:object[]
LabOrders:object[]
Medications:object[]
Observations:object[]
OtherOrders:object[]
PatientAge:string
PhysicalExams:object[]
Problems:object[]
Procedures:object[]
ProgramMemberships:object[]
Providers:object[]
RadOrders:object[]
Referrals:object[]
SocialHistories:object[]

Demographics:

object

 

Addresses:object[]
Aliases:object[]
BirthOrder:string
BirthPlace:string
BlankNameReason:string
Citizenship:string
Comments:string
CommunicationPref:string
Date:string (date)
DisplayDate:string
DateOfBirth:string (date)
DateOfBirthDisplay:string
DeathLocation:string
Email:string
EncounterNumber:string
EnteredAt:string
EnteredBy:string
EnteredTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Ethnicity:string
ExternalID:string
FirstName:string
FromTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Gender:string
HomePhone:string
Identifiers:object[]
ImmunizationRegDate:string
ImmunizationRegistry:string
IsDead:string
Languages:object[]
LastName:string
MaritalStatus:string
MiddleName:string
MobilePhone:string
MothersFullName:string
MothersMaidenName:string
Name:string
Occupation:string
PatientAge:string
PhotoURL:string
PrimaryLanguage:string
Protected:string
ProtectedDate:string
ProviderAtDeath:string
PublicityCode:string
PublicityDate:string
Races:object[]
Religion:string
SmokingStatus:string
Time:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

TimeOfDeath:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:string
ToTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

WorkPhone:string

DemographicsCategoryModel:

object

 

MRN:integer
Patient: Demographics
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Diagnosis:

object

 

Diagnosis:string
DiagnosisType:string
EnteredAt:string
EnteredBy:string
EnteredTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FromTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

IdentificationTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

OnsetTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Provider:string
Status:string
Timestamp:string
UpdatedTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:integer

DiagnosisCategoryList:

object

 

Diagnoses:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Document:

object

 

ContentHandling:string
ContentType:string
Date:string (date)
DateDisplay:string
DocumentID:string
DocumentName:string
DocumentNumber:string
DocumentType:string
EnteredAt:string
EnteredBy:string
EnteredTime:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Filename:string
FileType:string
InternalURL:string
PatientAge:string
Provider:string
Status:string
Time:string, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$
Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:string
key:integer

DocumentCategoryList:

object

 

Documents:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }
CSPToken:string
A token for use in subsequent requests as the CSPCHD token

DocumentProvider:

object

 

Provider:string
Role:string
Comment:string
EnteredBy:string
EnteredAt:string
EnteredOn:string
FromTime:string
ToTime:string
ActionCode:string
ActionScope:string
UpdatedOn:string
ExternalId:string
EncounterNumber:string

DocumentTransmitRequest:

object

 

DocumentType:string 
SendTo:string 
Subject:string
Message:string
StartDate:string
EndDate:string

Dosage:

object

 

DoseQuantity:integer
DoseUnits:string
Duration:string
DurationFactor:integer
Frequency:string
FrequencyFactor:integer
TestInstruction:string

DownloadFormats:

object

 

DefaultDownloadFormat:string
DownloadTypes:object[]

DownloadType:

object

 

Caption:string
Description:string
ShortDescription:string
Type:string
Enabled:string
Only if getting all fields

Transform:string
Only if getting all fields

ConfigItem:string
Only if getting all fields

DownloadFilename:string
Only if getting all fields

MimeType:string
Only if getting all fields

IntermediateFormatCode:string
Only if getting all fields

 

EHRAddress:

object

 

Address:string
AddressFromTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

AddressToTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

City:string
Country:string
County:string
State:string
Street:string
Zip:string

EHRAppointment:

object

 

Comments:string
EnteredAt:string
EnteredBy:string
EnteredTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FromTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Location:string
NoShow:string
OrderItem:string
Provider:string
Recommendation:string
ReferringProvider:string
Status:string
Timestamp:string
ToTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Type:string
UpdatedTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:integer

EHRCareProvider:

 

EHRAddress
Address:string
ProviderAddress:string
ProviderName:string
ProviderPhone:string
ProviderSpecialty:string

EHRDateEvents:

object

 

Events:object[]
ExcludedTags:string[]
string

HistoryEnd:string
HistoryStart:string
ProxyOnly:integer
tags:string[]
string

EHRElementFields:

 

EHRTimeElementFields
CustomPairs:string
EncounterNumber:string
EnteredAt:string
EnteredBy:string
EnteredTime:string
ExternalID:string
FromTime:string
Tags:string
ToTime:string
UpdatedTime:string
key:integer

EHRResult:

object

 

AuthorizationTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Content:string
ContentHandling:string
ContentType:string
DocumentID:string
DocumentName:string
DocumentNumber:string
DocumentURL:string
FileType:string
InternalURL:string
PerformedAt:string
ResultComments:string
ResultInterpretation:string
ResultItems:object[]
ResultStatus:string
ResultText:string
ResultTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ResultType:string
VerifiedBy:string

EHRSummary:

object

 

Alerts:object[]
Allergies:object[]
Appointments:object[]
CarePlans:object[]
Categories:string
Comma delimited ordered list of categories

DeviceObservations:object[]
Instructions:object[]
LabOrders:object[]
Observations:object[]
RadOrders:object[]
Referrals:object[]
ProxyOnly:integer

EHRTimeElementFields:

object

 

Date:string (date)
DateDisplay:string
PatientAge:string
Time:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:string

EmptyObject:

object

 

empty:string
Dummy property

Encounter:

object

 

Address:string
AdmissionType:string
AdmitReason:string
AdmittingProvider:string
AttendingProviders:object[]
ConsultingProviders:object[]
Date:string (date)
DateDisplay:string
Email:string
EmergencyAdmitTime:string (date)
EncounterNumber:string
EncounterType:string
EndTime:string (date)
EnteredAt:string
EnteredBy:string
EnteredTime:string (date)
FromTime:string (date)
Insurances:object[]
Location:string
PatientAge:string
Provider:string
Recommendations:object[]
Summary:string
Time:string (date)
Timestamp:string
ToTime:string (date)
key:integer

EncounterCategoryList:

object

 

Encounters:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

EncounterInfo:

object

 

Comments:string
DisplayComments:string
DisplayEndTime:string
DisplayProvider:string
DisplaySummary:string
Encounter:string
EncounterType:string
EndTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

EventType:string
HasDetails:string
IsMarker:string
Location:string
NonMatch:string
PatientAge:string
Summary:string
Time:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

EnrollUserRequest:

object

 

Address1:string
City:string
DateOfBirth:string (date)
DOB in yyyy-mm-dd format

Email:string
FirstName:string
LastName:string
MiddleName:string
MothersMaiderName:string
SSN:string
Sex:string
State:string
TermsAccepted:object
HashBase64:string
ID:integer
Terms:string
ZipCode:string

EnrollUserResponse:

object

 

RequestID:string
error:string

Error:

object

 

error:string

 

A user-friendly description of the actual error or problem. This may intentionally obfuscate the actual error.

errors:object[]
A list of more detailed internal error data

summary:string
A summary of the internal errors

Event:

object

 

ToBeDone:string

FamilyHistory:

object

 

Comments:string
Diagnosis:string
EnteredAt:string
EnteredBy:string
EnteredTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FamilyMember:string
Timestamp:string
UpdatedTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:integer

FamilyHistoryCategoryList:

object

 

FamilyHistories:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Feed:

object

 

Date:string (date)
Description:string
Feed:string
FeedTag:string
FeedTitle:string
Image:string
IsGlobal:boolean
Link:string
SSLConfiguration:string
Tag:string
Title:string
URL:string

FeedName:

object

 

FeedName:string

Feeds:

object

 

available:object[]
subscribedTo:object[]

ForgotPasswordRequest:

object

 

Username:string
ResetEmail:boolean
Set to true, if requesting Password reset email. This will allow user to bypass security questions

QuestionAnswered:boolean
Set to true, if the user answered security question and answer is listed under SecurityAnswer.

SecurityAnswer:string
Answer to security question

ForgotPasswordResponse:

object

 

SentEmail:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }
Set to 1, if the email is sent to user with password reset link

SecQuestionPasswordResetDisabled:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }
SecurityQuestion:string
Text of the security question (if available)

MayReset:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }
If 1, then proceed to enter new password page

error:string
Invalid answer to security question

ForgotUsernameRequest:

object

 

Email:string

Form:

object

 

URL:string
filename:string
id:string
image:string
rank:string
text:string
file:string
title:string

FormData:

object

 

data:string
Form data

formKey:string
Form Key

formVersion:integer
Form version

FormDefinition:

object

 

A form definition, consisting of a header with metadata and body that contains Form Definition Notation.

_class:string
Caché class name of datagram type

_Header:object
Form definition header containing metadata

_class:string
Caché class name of datagram type

_AcceptingData:boolean
If true, data may be submitted for the form (i.e., it is not for read-only display of data)

_AppState:string
Unused

_Application:string
Logical identifier of application in which the form may be used

_Author:string
Unused

_ConsumerID:string
Logical identifier of the form (formKey)

_CopiedFrom:string
VersionID of previous version on which this form is based

_DocPhase:string
Current phase of the form definition (e.g., draft/published)

_DocStatus:string
Current status of the form definition (e.g., draft/published)

_Exists:boolean
Set to false for forms that have been ‘soft’ deleted

_Frozen:boolean
If true, the definition cannot be modified (e.g., for published forms)

_GenusID:string
Part of the form’s unique identifier, in the format {application}||{formKey}

_IsActive:boolean
Set to true for the latest version of the form in a given phase (‘draft’ or ‘published’) and false for other versions.

_IsEmbedded:boolean
If true, the definition is of a form which may only be embedded in other forms and cannot stand alone.

_IsPublic:boolean
If true, the form definition is accessible to unauthenticated users.

_IsTemplate:boolean
Always true.

_ItemID:string
Global Unique Identifier (GUID) for the form definition version.

_ModelName:string
Always ‘HS-FormManager-Local-Document’

_Name:string
Display name for the form, computed based on the form definition. Irrelevant for embedded forms.

_ObjectVersion:integer
Version of the underlying object, used for optimistic concurrency control.

_RecordName:string
Always ‘Form’

_RevisionNumber:integer
Globally-incrementing (among all form definitions) ID of the form definition’s revision – part of the form definition’s unique identifier

_Summary:string
Optional longer description associated with the form

_TimeCreated:string
ODBC-format timestamp (UTC) at which the form definition version was created

_TimeModified:string
ODBC-format timestamp (UTC) at which the form definition version was last modified

_VersionHash:string
Hash of entire form definition object, usable to detect changes.

_VersionID:string
Unique identifier of the form definition object, consisting of {application}||{formKey}||{RevisionID}

_VersionNumber:integer
Version of the form definition that increments per Genus (application/formKey combination)

_Body:object
Form definition body wrapping the actual FDN for the form

_class:string
Caché class name of datagram type

FormDefinition:object
Form Definition Notation for the form

FormFolderItem:

object

 

Any item (folder or form reference) in a form hierarchy

_class:string , x ∈ {
Local.Form.DataGram.FolderRoot
,
Local.Form.DataGram.Folder
,
Local.Form.DataGram.FormReference

}

 

Caché class name of datagram type

_id:integer

 

Object ID of folder item

Description:string
Longer description for folder item

Title:string

 

Short title for folder item

ParentId:string
Object ID of parent folder item

PreviousSiblingId:string
Object ID of previous sibling in hierarchy

MoveToTop:boolean
True if this item should be moved to the top of its parent. (Irrelevant for GET.)

FormSubmission:

object

 

A retrieved form submission for a particular user.

ID:integer
Object ID of the staged form submission.

FormApplication:string

 

Application to which the form for which data is being submitted belongs.

FormKey:string

 

Logical identifier of the form for which form data is being submitted.

FormVersion:integer

 

Version of the form for which form data is being submitted.

Submitted:boolean
True if the form submission has been submitted.

FormSubmissionPayload:

object

 

Data in a form submission (or save of intermediate data) for a particular user.

id:integer
Object ID of the staged form submission.

formKey:string

 

Logical identifier of the form for which form data is being submitted.

formVersion:integer

 

Version of the form for which form data is being submitted.

data:object

 

Data for the form – format varies based on the form’s definition.

FormSummary:

object

 

Data in a form submission (or save of intermediate data) for a particular user.

FormKey:string

 

Form key of the form

GenusID:string

 

Genus ID of the form, in the format ||

Phases:object[]

 

List of phases for which a record exists, along with version-specific metadata.

object

DocPhase:string
Phase of the form document – ‘draft’ or ‘published’

Name:string
Friendly display name of the form, computed from the FDN.

VersionID:string
Specific version of the form, in the format ||||

Goal:

object

 

Authors:object[]
Description:string
Priority:string
Status:string
Target:string

GoalModel:

object

 

Goal:object[]
rowCount:integer

HealthConcern:

object

 

Authors:object[]
Description:string
Priority:string
Status:string

HealthConcernModel:

object

 

HealthConcern:object[]
rowCount:integer

History:

object

 

AdvanceDirectives:object[]
Allergies:object[]
Contacts:object[]
CurrentMedicationsCount:string
DisplayHistoryEnd:string
DisplayHistoryStart:string
Encounters:object[]
Events:object[]
HasLabs:string
HasMedications:string
HistoryEnd:string
HistoryStart:string
Immunizations:object[]
LabOrdersCount:string
MedicationsCount:string
NewEvents:object[]

HomeEvents:

object

 

Title:string
DayOfWeek:string
Current day of the week.

DisplayRange:string
The date range being returned.

Events:object[]

HomePageWelcome:

object

 

FirstName:string
LastName:string
MiddleName:string
LastLogin:string
Address:object
Address1:string
Address2:string
City:string
State:string
Zip:string

IDList:

object

 

id:string
ids:string[]
string

IllnessHistory:

object

 

Comments:string
Condition:string
EnteredAt:string
EnteredBy:string
EnteredTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FromTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Provider:string
Timestamp:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

VerifiedTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:integer

IllnessHistoryCategoryList:

object

 

IllnessHistories:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Immunization:

object

 

Address:string
Administrations:object[]
AuthTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

City:string
Code:string
CodeSystem:string
Comments:string
Condition:string
ConfidentialityCode:string
ConsultingDepartment:string
Country:string
County:string
Date:string (date)
DateDisplay:string
DoseForm:string
DoseQuantity:integer
DoseUnits:string
DrugATCCode:string
DrugBaseQuantity:integer
DrugBaseUnits:string
DrugCode:string
DrugCodeSystem:string
DrugForm:string
DrugGeneric:string
DrugIdentifier1:string
DrugIdentifier2:string
DrugLabelName:string
DrugName:string
DrugOfficialCode:string
DrugPackageSize:integer
DrugPackageSizeUnits:string
DrugProductName:string
DrugStrength:string
DrugStrengthQuantity:integer
DrugStrengthUnits:string
DrugType:string
Duration:string
EncounterNumber:string
EnteredAt:string
EnteredBy:string
EnteredTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

EnteringOrganization:string
ExternalID:string
FillerAA:string
FillerID:string
Frequency:string
FromTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

GroupAA:string
GroupID:string
Indication:string
Instructions:string
MaxDoseQuantity:string
Medication:string
MedicationTranslated:string
NumberOfRefills:string
OrderCategory:string
OrderGroup:string
OrderItem:string
OrderQuantity:integer
OrderedBy:string
OrderedItemDisplay:string
PatientAge:string
PharmacyStatus:string
PlacerAA:string
PlacerID:string
PrescriptionNumber:string
Priority:string
Provider:string
ProviderAddress:string
ProviderName:string
ProviderPhone:string
ProviderSpecialty:string
RateAmount:string
RateTimeUnit:integer
RateUnits:string
ReassessmentTime:string
ReceivingLocation:string
RefillDescription:string
RefillNumber:string
RefillsRemaining:string
Route:string
Specimen:string
SpecimenCollTime:string
SpecimenRecTime:string
State:string
Status:string
Street:string
StrengthVolume:string
StrengthVolumeUnits:string
Time:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:string
ToTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

VerifiedBy:string
VerifiedComments:string
Zip:string
key:integer

ImmunizationCategoryList:

object

 

Immunizations:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Instruction:

object

 

AdmittingProvider:string
AttendingProviders:object[]
ConsultingProviders:object[]
EnteredAt:string
EnteredBy:string
EnteredTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Location:string
Recommendation:string
ReferringProvider:string
Timestamp:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:integer

InstructionCategoryList:

object

 

Instructions:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Insurance:

object

 

Address:string
City:string
Country:string
County:string
EnteredAt:string
EnteredBy:string
FromTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

GroupName:string
GroupNumber:string
HomePhone:string
InsuranceCompany:string
InsurancePlan:string
Insured:string
MembershipNumber:string
PlanType:string
Relationship:string
State:string
Street:string
Timestamp:string
ToTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ToTimeDisplay:string
WorkPhone:string
Zip:string
key:integer

InsuranceCategoryList:

object

 

Insurances:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

InternalError:

object

 

error:string

 

The internal error message

code:string

 

The internal error code

domain:string
The internal error domain

params:string[]
Any specific values that triggered the error

string

errors:object[]

LabChartResponse:

object

 

FirstTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Earliest date/time for the lab results. Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

LastTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Latest date/time for the lab results. Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

children:object[]

LabChartValue:

object

 

Comments:string
DisplayName:string
OrderDisplayName:string
Range:string
Time:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Value:string
Units:string

LabOrderCategoryList:

object

 

LabOrders:object[]
ProxyOnly:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

LabResult:

object

 

Address:string
City:string
Code:string
CodeSystem:string
Country:string
Date:string (date)
DateDisplay:string
EncounterNumber:string
EnteredAt:string
EnteredBy:string
EnteredTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

EnteringOrganization:string
ExternalID:string
FillerID:string
FromTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

OrderCategory:string
OrderItem:string
OrderQuantity:string
OrderedBy:string
OrderedItemDisplay:string
PatientAge:string
PlacerID:string
Priority:string
Provider:string
ProviderAddress:string
ProviderName:string
ProviderPhone:string
ProviderSpecialty:string
ResultStatus:string
Specimen:string
SpecimenCollTime:string
SpecimenRecTime:string
State:string
Status:string
Street:string
Time:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:string
Zip:string
key:integer

LabResultChartSeries:

object

 

DisplaySummary:string
Translated name for lab result

FirstTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

"Date/time for the first lab result"
                                                    
Key:string
Biomarker key for lab result

LastTime:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

"Date/time for the last lab result"
                                                    
Series:object[]

Language:

object

 

PreferredLanguage:string
Time:string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Use:string

Local.Form.DataGram.Folder:

 

A folder in a form hierarchy

FormFolderItem
Items:object[]

 

Local.Form.DataGram.FolderRoot:

 

A root folder in a form hierarchy

Local.Form.DataGram.Folder
Key:string

 

Logical identifier of form hierarchy root

Local.Form.DataGram.FormReference:

 

A form reference in a form hierarchy

FormFolderItem
Application:string

 

Form application name

FormKey:string

 

Logical form identifier

LocationSearchParameters:

object

 

SearchKey:string
Search on ClinicalGroup’s Name and Address

MessageType:string , x ∈ {
all
,
appointment
,
general
,
medical
,
referral
,
refill
,
testresult

}

Optional – Only Search for location which can receive this message type

Specialty:string
Optional -Search specific specialy

LocationSearchResult:

object

 

Address:string
RecipientID:string
Name:string
ClinicalGroupID:string

LogEventRequest:

object

 

Action:string , x ∈ {
PageView
,
ActivateEnrollment

}

Page:string
Page path/name

Section:string
Section of the page , for Wellness Page

IsAPI:boolean
Flag used for ‘view’ events to indicate whether the view was performed in a different application that used APIs to retrieve the underlying data.

TokenLength:number
Token length when Action is ActivateEnrollment

Application:string , x ∈ {
public
,
wokbench

}

LoginCredentials:

object

 

Username:string
The username

Password:string
The password

IsPrivateDevice:boolean
Flag to indicate whether the current device is private and should not be subject to a short timeout

LoginData:

object

 

AnswerSecurityQuestions:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }
Flag to indicate whether the user needs to answer security questions or not

ChangePassword:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

 

Flag indicating whether the user needs to change his/her password.

ProxyFor:object[]
SessionTimeout:integer
, { x ∈ ℤ | x ≥ 1 }

 

Number of seconds for the default session timeout.

TermsAccepted:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }
Flag to indicate whether the user has accepted the current terms of use

UserData: BasicUserData

 

UserID:integer
User ID of current effective user. Null if the effective user is staged user.

StagedUserID:integer
Staged User ID of current effective user. Null if the effective user is activated user.

LoggedInUserID:integer
User ID of logged in user.

EffectiveUserID:integer
User ID of effective user

PatientName:string
Display name of effective user

LoggedIn:integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }
Flag to indicate whether the any user is logged in or not

LoginPage:

object

 

Events: HomeEvents
HomeSplash: Content
HomeWelcome: Content
News:object
children:object[]
hasFeeds:boolean

Medication:

object


Address:

string

Administrations:

object[]

AuthTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

City:

string

Code:

string

CodeSystem:

string

Comments:

string

Condition:

string

ConfidentialityCode:

string

ConsultingDepartment:

string

Country:

string

County:

string

Date:

string (date)

DateDisplay:

string

DosageSteps:

object[]

DoseForm:

string

DoseQuantity:

integer

DoseUnits:

string

DrugATCCode:

string

DrugBaseQuantity:

integer

DrugBaseUnits:

string

DrugCode:

string

DrugCodeSystem:

string

DrugForm:

string

DrugGeneric:

string

DrugIdentifier1:

string

DrugIdentifier2:

string

DrugLabelName:

string

DrugName:

string

DrugOfficialCode:

string

DrugPackageSize:

integer

DrugPackageSizeUnits:

string

DrugProductName:

string

DrugStrength:

string

DrugStrengthQuantity:

integer

DrugStrengthUnits:

string

DrugType:

string

Duration:

string

EncounterNumber:

string

EnteredAt:

string

EnteredBy:

string

EnteredTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

EnteringOrganization:

string

ExternalID:

string

FillerAA:

string

FillerID:

string

Frequency:

string

FromTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

GroupAA:

string

GroupID:

string

Indication:

string

Instructions:

string

IsCurrent:

integer

MaxDoseQuantity:

integer

MayRefill:

integer

Medication:

string

MedicationTranslated:

string

NumberOfRefills:

integer

OrderCategory:

string

OrderGroup:

string

OrderItem:

string

OrderQuantity:

integer

OrderedBy:

string

OrderedItemDisplay:

string

PatientAge:

integer

PharmacyStatus:

string

PlacerAA:

string

PlacerID:

string

PrescriptionNumber:

string

Priority:

string

Provider:

string

ProviderAddress:

string

ProviderName:

string

ProviderPhone:

string

ProviderSpecialty:

string

RateAmount:

integer

RateTimeUnit:

string

RateUnits:

string

ReassessmentTime:

string

ReceivingLocation:

string

RefillDescription:

string

RefillNumber:

integer

RefillsRemaining:

integer

Route:

string

Specimen:

string

SpecimenCollTime:

string

SpecimenRecTime:

string

State:

string

Status:

string

Street:

string

StrengthVolume:

integer

StrengthVolumeUnits:

string

Time:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:

string

ToTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

VerifiedBy:

string

VerifiedComments:

string

Zip:

string

key:

integer

MedicationCategoryList:

object


CurrentMedicationsCount:

integer

Medications:

object[]

MedicationsCount:

integer

Message:



DisplayTime:

string

id:

string

From:

string

ActualSender:

string

ToList:

object[]

To:

string

Semicolon delimited list

Subject:

string

Time:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

"2014-07-23 09:13:59.915074"
                                                    
HasAttachments:

boolean

IsRead:

boolean

NoReply:

boolean

Text:

string

Not included with folder messages

Type:

string , x ∈ {
AppointmentConfirmation
,
AppointmentRequest
,
Appointment
,
ReferralRequest
,
Referral
,
RefillRequest
,
Refill
,
TestRequest

}


Folder:

string

Inbox, Sent, InboxArchive, Sent Archive

Attachments:

object[]

CSPToken:

string

MessageAppointmentRequestBody:

object


AppointmentReason:

object

AppointmentFor:

string , x ∈ {
ISC_PRIMARY_CARE
,
ISC_LABWORK
,
ISC_SPECIALIST

}

AppointmentText:

string

AppointmentType:

string , x ∈ {
ISC_ANNUAL_PHYSICAL
,
ISC_NEW_CONCERN
,
ISC_FOLLOW_UP
,
ISC_OTHER
,
ISC_REFERRAL

}

AppointmentTime:

object

ClearDefault:

boolean

Days:

string , x ∈ {
ISC_MONDAY_MORNING
,
ISC_MONDAY_AFTERNOON
,
ISC_MONDAY_EVENING
,
ISC_TUESDAY_MORNING
,
ISC_TUESDAY_AFTERNOON
,
ISC_TUESDAY_EVENING
,
ISC_WEDNESDAY_MORNING
,
ISC_WEDNESDAY_AFTERNOON
,
ISC_WEDNESDAY_EVENING
,
ISC_THURSDAY_MORNING
,
ISC_THURSDAY_AFTERNOON
,
ISC_THURSDAY_EVENING
,
ISC_FRIDAY_MORNING
,
ISC_FRIDAY_AFTERNOON
,
ISC_FRIDAY_EVENING
,
ISC_SATURDAY_MORNING
,
ISC_SATURDAY_AFTERNOON
,
ISC_SATURDAY_EVENING
,
ISC_SUNDAY_MORNING
,
ISC_SUNDAY_AFTERNOON
,
ISC_SUNDAY_EVENING

}

IsDefault:

boolean

TimeSlot:

string , x ∈ {
ISC_MESSAGES_REQUEST_APPOINTMENT_NEXT_AVAILABLE
,
ISC_MESSAGES_REQUEST_APPOINTMENT_WITHIN_WEEK
,
ISC_MESSAGES_REQUEST_APPOINTMENT_WITHIN_TWO_WEEKS
,
ISC_MESSAGES_REQUEST_APPOINTMENT_WITHIN_NEXT_MONTH
,
ISC_MESSAGES_REQUEST_APPOINTMENT_WITHIN_TWO_MONTHS
,
ISC_MESSAGES_REQUEST_APPOINTMENT_WITHIN_THREE_MONTHS
,
ISC_MESSAGES_REQUEST_APPOINTMENT_WITHIN_SIX_MONTHS
,
ISC_MESSAGES_REQUEST_APPOINTMENT_WITHIN_ONE_YEAR

}

ContactInfo:

object

ClearDefault:

boolean

Extension:

integer (int32)

IsDefault:

boolean

PhoneNumber:

string

SendMessage:

integer (int32)

TimeToCall:

string , x ∈ {
ISC_MESSAGES_REQUEST_APPOINTMENT_CALL_MORNING
,
ISC_MESSAGES_REQUEST_APPOINTMENT_CALL_AFTERNOON
,
ISC_MESSAGES_REQUEST_APPOINTMENT_CALL_EVENING

}

VoiceMailOk:

boolean

Location:

integer (int32)

Provider:

integer (int32)

Subject:

string

To:

integer[]

integer (int32)

appointmentOptions:

object

alternateLocation:

boolean

previouslySeen:

boolean

seeDifferentProvider:

boolean

Attachments:

string[]

string

MessageAttachment:

object


ContentType:

string

Filename:

string

Size:

string

ID:

integer

MessageGeneralQuestionBody:

object


From:

string

Subject:

string

Text:

string

To:

string

Recipient ID

Attachments:

string[]

string

MessageMedicalQuestionBody:

object


From:

string

Subject:

string

Text:

string

To:

string

Recipient ID

Attachments:

string[]

string

MessageReferralRequestBody:

object


Subject:

string

Text:

string

To:

string[]

List of Recipient IDs

string

OriginalMessageID:

string

Optional – When creating a new request in the same thread as declined options

Location:

string

Optional – Location ID

Provider:

string

Optional – Provider ID

ReferralLocation:

string

ReferralProvider:

string

DeclinedOptions:

object[]

Attachments:

string[]

string

MessageRefillRequestBody:

object


Subject:

string

Text:

string

To:

string[]

List of Recipient IDs

string

Pharmacy:

string

Pharmacy ID

PharmacyText:

string

Alternate for Pharmacy ID

ContactType:

string

ContactInfo:

string

ContactInstructions:

string

MedicationText:

string

Free text medication refill request

Medications:

object[]

MessageReplyBody:

object


Subject:

string

Subject of message

Text:

string

Message text

OriginalID:

string

Message ID for the message being replied to

MessageSendResponse:

object


Error:

string

Set only if there is an error

Status:

string

Sent if message sent successfully

ToList:

string[]

List of recipients

string

MessageTo:

object


id:

string

name:

string

MimeTypes:

object


Name:

string

Types:

string[]

string

NewEvent:

object


AdvanceDirectives:

integer

Alerts:

integer

Allergies:

integer

Appointments:

integer

CarePlans:

integer

Contacts:

integer

CustomObjects:

integer

Date:

string (date)

DayOfWeek:

string

Diagnoses:

integer

Documents:

integer

Encounters:

object[]

FamilyHistories:

integer

Guarantors:

integer

Guardians:

integer

HasData:

integer

IllnessHistories:

integer

Immunizations:

integer

Insurances:

integer

LabOrders:

integer

Medications:

integer

Observations:

integer

OtherOrders:

integer

PhysicalExams:

integer

Problems:

integer

Procedures:

integer

ProgramMemberships:

integer

Providers:

integer

RadOrders:

integer

Referrals:

integer

SocialHistories:

integer

NewsFeed:

object


Date:

string (date)

Description:

string

Feed:

string

FeedTag:

string

FeedTitle:

string

Link:

string

Title:

string

NewsFeedModel:

object


Problems:

object[]

hasFeeds:

boolean

Observation:

object


Code:

string

CodeSystem:

string

Comment:

string

Count:

integer

Date:

string (date)

DateDisplay:

string

EncounterNumber:

string

EnteredAt:

string

EnteredBy:

string

EnteredTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ExternalID:

string

FromTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

GroupID:

string

Observation:

string

ObservationTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ObservationTranslated:

string

ObservationType:

string

ObservationUnits:

string

ObservationValue:

string

PatientAge:

string

Provider:

string

SourceImage:

string

Tags:

string[]

string

Time:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:

string

ToTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ValueCoded:

string

ValueTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:

integer

ObservationCategoryList:

object


Observations:

object[]

ProxyOnly:

integer

ObservationChartSeries:

object


DisplaySummary:

string

FirstTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Series:

object[]

ObservationChartValue:

object


Time:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Unit:

string

Value:

string

OtherOrderCategoryList:

object


OtherOrders:

object[]

ProxyOnly:

integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

OtherResult:

object


Code:

string

CodeSystem:

string

Date:

string (date)

DateDisplay:

string

EncounterNumber:

string

EnteredAt:

string

EnteredBy:

string

EnteredTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

EnteringOrganization:

string

FillerID:

string

FromTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

OrderItem:

string

OrderedItemDisplay:

string

PatientAge:

string

PlacerID:

string

Priority:

string

Status:

string

Time:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:

string

key:

integer

PasswordRequirements:

object


Regex:

string

Description:

string

PasswordResetRequest:

object


NOTE: Either Username OR Email should be supplied. As of this writing, this is not supported in Swagger 2.0.

Username:

string

The user’s username

Email:

string

The user’s email address

PatientDemographicAddress:

object


Address:

string

AddressFromTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

AddressToTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

City:

string

Country:

string

County:

string

State:

string

Street:

string

Zip:

string

PatientIdentifier:

object


AssigningAuthority:

string

AssigningAuthorityCode:

string

ISOAssigningAuthority:

string

Number:

integer

NumberType:

string

PatientProvider:

object


Address:

string

City:

string

EnteredAt:

string

EnteredBy:

string

EnteredTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ExpirationDate:

string (date)

Name:

string

Phone:

string

Role:

string

SimpleAddress:

string

State:

string

Street:

string

UpdatedTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Zip:

string

key:

integer

PatientProviderCategoryList:

object


Providers:

object[]

ProxyOnly:

integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

PatientUpdateCounts:

object


Appointments:

number

Encounters:

number

Instructions:

number

LabOrdersResult:

number

Medications:

number

Referals:

number

PatientUpdates:

object


EHRCounts:

object

CarePlans:

number

Categories:

string

Comma delimited ordered list of categories

MRN:

string

NewCounts:

PatientUpdateCounts

Category counts since last login

ProxyOnly:

boolean

RecentCounts:

PatientUpdateCounts

Category counts for last 90 days

error:

string

error loading patient EHR

retry:

boolean

If true, EHR was loaded not in time. Call /ehr/updateCountsFor

StagedUserID:

integer

UnreadMessageCount:

number

UserID:

number

Pharmacy:

object


Address:

Address

FaxNumber:

string

Name:

string

PharmacyID:

string

PhoneNumber:

string

RxFaxNumber:

string

id:

string

PharmacySearchParameters:

object


Name:

string

Full or Partial Name

SearchKey:

string

Partial or Full Name and/or Address

Address:

string

Partial or Full Address

City:

string

City Name or the begining characters of city name

Zip:

string

5 digit zipcode or the begining digits of zipcode

PharmacySearchResult:

object


Address:

Address

text:

string

Pharmacy Information

value:

string

Pharmacy ID

PhysicalExam:

object


Comments:

string

EnteredAt:

string

EnteredBy:

string

Exam:

string

ExamTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FromTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Observation:

string

ObservationValue:

string

Timestamp:

string

UpdatedTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:

integer

PhysicalExamCategoryList:

object


PhysicalExams:

object[]

ProxyOnly:

integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

PreferredContactDetails:

object


Extension:

string

PhoneNumber:

string

SendMessage:

boolean

TimeToCall:

string

VoiceMailOK:

string

HasDefault:

boolean

PrincipalUpdates:

object


PrincipalUpdates:

object[]

erros:

object[]

object

error:

string

EffectiveUserID:

string

Problem:

object


Category:

string

Code:

string

CodeSystem:

string

Comments:

string

Date:

string (date)

DateDisplay:

string

Details:

string

EncounterNumber:

string

EnteredAt:

string

EnteredBy:

string

EnteredTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FromTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

PatientAge:

string

Problem:

string

ProblemTranslated:

string

Provider:

string

Status:

string

Time:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:

string

ToTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:

integer

ProblemCategoryList:

object


Problems:

object[]

ProxyOnly:

integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Procedure:

object


Code:

string

CodeSystem:

string

Date:

string (date)

DateDisplay:

string

EncounterNumber:

string

EnteredAt:

string

EnteredBy:

string

EnteredTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ExternalID:

string

PatientAge:

string

Procedure:

string

ProcedureTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ProcedureTranslated:

string

Time:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:

string

key:

integer

ProcedureCategoryList:

object


Procedures:

object[]

ProxyOnly:

integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

ProgramMembership:

object


ProgramName:

string

Description:

string

EnteredAt:

string

EnteredBy:

string

EnteredTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FromTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:

string

ToTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:

integer

ProgramMembershipCategoryList:

object


ProgramMemberships:

object[]

ProxyOnly:

integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Provider:

object


ID:

number

Provider RecipienID

ProviderID:

number

Provider ID

FirstName:

string

MiddleNames:

string

LastName:

string

Suffix:

string

Title:

string

Specialties:

string[]

string

ProviderSearchParameters:

object


Name:

string

Search Provider’s name

Location:

string

Search Provider’s Clinical Group name and address

SearchKey:

string

Search Provider’s name, Clinical Group’s name and address, and provider’s specialties

OrgID:

string

Match Provider’s Organization ID

NotGroupID:

string

Exclude Providers with this Clinical Group

ClinicalGroup:

string

Clinical Group’s name

Specialty:

string

Specialty name

ProviderSearchResult:

object


ClinicalGroup:

LookupProviderClinicalGroup

Provider:

Provider

ProxyRelationship:

object


ProxyID:

integer

The ID of the proxy relationship itself.

UserID:

integer

The ID of the fully activated user that is the Proxy or Principal in the relationship.

StagedUserID:

integer

The ID of the partially activated user that is the Proxy or Principal in the relationship.

Relation:

string

Text string that describes the relationship.

"Mother"
                                                    
FirstName:

string

The first name of the Proxy or Principal patient.

LastName:

string

The last name of the Proxy or Principal patient.

DisplayName:

string

The full name of the Proxy or Principal patient.

Expired:

integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

Flag to indicate whether the relationship has expired.

Expiration:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

"2025-03-17T00:00:00.000Z"
                                                    
DisplayExpiration:

string

User-friendly expiration date.

"March 17, 2025"
                                                    
DateCreated:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

"2013-02-12T00:00:00.000Z"
                                                    
TimeCreated:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Time at which proxy relationship was created. Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

"2013-02-13T16:13:43.562Z"
                                                    
TimeCreatedDisplay:

string

Date when the proxy relationship was created in user-friendly format.

"February 2, 2013"
                                                    
DateModified:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

"2014-11-12T00:00:00.000Z"
                                                    
LastModified:

string

LastModifiedDisplay:

string

TimeModified:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

"2014-11-12T16:13:43.562Z"
                                                    
TimeModifiedDisplay:

string

Date when the proxy relationship was last modified in user-friendly format.

"November 12, 2014"
                                                    

ProxyRelationshipData:

object


Proxies:

object[]

ProxiesFor:

object[]

ProxyMode:

boolean

ProxyRelationshipDetails:

object


DateCreated:

string (date)

DateModified:

string (date)

DisplayExpiration:

string

DisplayName:

string

Expiration:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Expired:

boolean

FirstName:

string

LastModified:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

LastModifiedDisplay:

string

LastName:

string

ProxyID:

number

Relation:

string

StagedUserID:

number

TimeCreated:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

TimeCreatedDisplay:

string

UserID:

number

Race:

object


Race:

string

RadOrderCategoryList:

object


RadOrders:

object[]

ProxyOnly:

integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

RecipientSearchParameters:

object


Specialty:

string

Specialty

Location:

string

Location

Favorites:

boolean

Set to true to search only favorites

MessageType:

string , x ∈ {
all
,
appointment
,
general
,
medical
,
referral
,
refill
,
testresult

}

Select recipients who can receive this message type

SearchKey:

string

Text based search string for providers

RecipientSearchResult:



ClinicalGroup:

LookupProviderClinicalGroup

Provider:

Provider

Favorite:

integer

0/1

Recommendation:

object


Recommendation:

string

Referral:

object


Duration:

string

DurationFactor:

string

EnteredAt:

string

EnteredBy:

string

EnteredTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FromTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Organization:

string

Provider:

string

Reason:

string

ReferredOrganization:

string

ReferredProvider:

string

Timestamp:

string

ToTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:

integer

ReferralCategoryList:

object


Referrals:

object[]

ProxyOnly:

integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

ReferralUpdateResponse:



RefillMedication:

object


Address:

string

Administration:

object[]

AuthTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

City:

string

Code:

string

CodeSystem:

string

Comments:

string

Condition:

string

ConfidentialityCode:

string

ConsultingDepartment:

string

Country:

string

County:

string

DisplayGroup:

string

DosageSteps:

object[]

DoseForm:

string

DoseQuantity:

string

DoseUnits:

string

DrugATCCode:

string

DrugBaseQuantity:

string

DrugBaseUnits:

string

DrugCode:

string

DrugCodeSystem:

string

DrugForm:

string

DrugGeneric:

string

DrugIdentifier1:

string

DrugIdentifier2:

string

DrugLabelName:

string

DrugName:

string

DrugOfficialCode:

string

DrugPackageSize:

integer

DrugPackageSizeUnits:

string

DrugType:

string

Duration:

string

EnteringOrganization:

string

FillerAA:

string

FillerID:

string

Frequency:

string

FromTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

GroupAA:

string

GroupID:

string

Instructions:

string

IsCurrent:

integer

MayRefill:

integer

Medication:

string

NumberOfRefills:

integer

OrderCategory:

string

OrderGroup:

string

OrderItem:

string

OrderQuantity:

string

OrderedBy:

string

OrderedItemDisplay:

string

PlacerAA:

string

PlacerID:

string

Priority:

string

Provider:

string

ProviderAddress:

string

ProviderName:

string

ProviderPhone:

string

ProviderSpecialty:

string

ReassessmentTime:

string

ReceivingLocation:

string

RefillDescription:

string

RefillID:

string

RefillInProcess:

string

RefillIsRecent:

string

RefillNumber:

integer

RefillRequestID:

integer

RefillStatus:

string

RefillStatusDisplay:

string

RefillTimeProcessed:

string

RefillTimeSubmitted:

string

RefillsRemaining:

integer

Route:

string

Specimen:

string

SpecimenCollTime:

string

SpecimentRecTime:

string

State:

string

Status:

string

Street:

string

ToTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

VerifiedBy:

string

VerifiedComments:

string

Zip:

string

key:

integer

RefillMedicationModel:

object


RefillMedication:

object[]

rowCount:

integer

RefillRequestMedication:

object


FillerID:

string

PlacerID:

string

PrescriptionNumber:

string

Code:

string

CodeSystem:

string

MedicationTranslated:

string

DoseQuantity:

string

DoseUnits:

string

Frequency:

string

Route:

string

Provider:

string

RegisteredValidicDevice:

object


Sync:

boolean

Source:

string

Excerpt:

string

ExtraExcerpt:

string

Image:

string

UnsyncURL:

string

SyncURL:

string

KeyValue:

string

SelectValue:

string

BackgroundColor:

string

Title:

string

LastSynced:

string

RejectAppointmentRequest:

object


id:

string

message id

RejectReferralRequest:



ResetPasswordRequest:

object


Password:

string

New password

ResultItem:

object


AnalysisTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Code:

string

CodeSystem:

string

Comments:

string

Date:

string (date)

DateDisplay:

string

EncounterNumber:

string

EnteredAt:

string

EnteredBy:

string

EnteredTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ExternalID:

string

FromTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

IsNumeric:

integer

ObservationTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

ObservationValueType:

string

PatientAge:

string

PerformedAt:

string

ReferenceComment:

string

ReferenceRange:

string

ResultCodedValue:

string

ResultInterpretation:

string

ResultValue:

integer

ResultValueUnits:

string

Status:

string

SubID:

integer

Test:

string

TestTranslated:

string

Time:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Timestamp:

string

ToTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UpdatedTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

SecurityAnswerValidateRequest:

object


Answer:

string

SecurityAnswerValidateResponse:

object


valid:

boolean

SecurityQuestionData:

object


HaveAnswer:

boolean

ID:

number

Lang:

string

Question:

string

QuestionID:

number

SecurityQuestionList:

object


MinimumSecurityQuestionCount:

number

QuestionCount:

number

Questions:

object[]

QuestionsAnswered:

number

UserID:

number

SecurityQuestionUpdateRequest:

object


SecurityAnswers:

object[]

object

ID:

number

Question ID

Answer:

string

SecurityQuestionUpdateResponse:

object


RequiredAnswerCount:

number

error:

string

errors:

string[]

Question specific errors

string

SessionLanguageUpdate:

object


Language:

string

Language code. Required

Application:

string , x ∈ {
public
,
workbench

}

Application name. This is optional, default is ‘public’

Type:

string , x ∈ {
content
,
help

}

Type. This is optional, default is ‘content’

SocialHistory:

object


Comments:

string

EnteredAt:

string

EnteredBy:

string

EnteredTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

FromTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

Habit:

string

HabitQuantity:

string

Status:

string

UpdatedTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

key:

integer

SocialHistoryCategoryList:

object


SocialHistories:

object[]

ProxyOnly:

integer
, { x ∈ ℤ | 0 ≤ x ≤ 1 }

SupportContact:

object


Address:

object

Address:

string

AddressFromTime:

integer

AddressToTime:

string

City:

string

Country:

integer

County:

string

Extension:

string

State:

integer

Street:

string

Zip:

string

ContactInfo:

object

Email:

string

Extension:

string

HomePhone:

string

MobilePhone:

string

WorkPhone:

string

ContactType:

string

DateOfBirth:

string

EmergencyStatus:

string

Extension:

string

FirstName:

string

Gender:

string

Identifiers:

object[]

LastName:

string

PrimaryContact:

string

PrimaryLanguage:

string

Relationship:

string

SwitchProxyRequest:

object


TargetUserID:

string

Proxy User ID. Leave blank to switch back to self

TargetStagedUserID:

string

Proxy User ID. Leave blank to switch back to self

SwitchProxyResponse:

object


UserID:

integer

User ID of current effective user. Null if the effective user is staged user.

StagedUserID:

integer

Staged User ID of current effective user. Null if the effective user is activated user.

LoggedInUserID:

integer

User ID of logged in user.

EffectiveUserID:

integer

User ID of effective user

PatientName:

string

error:

string

TermsOfUse:

object


ID:

string

HashBase64:

string

Terms:

string

Only needed for GET operations.

TestResultRequestBody:

object


Subject:

string

Text:

string

To:

string[]

List of Recipient IDs

string

DateOfTest:

string (date)

ThirdPartySearchResponse:

object


CodeSystem:

string

Results:

object[]

SearchCaption:

string

SearchValue:

string

ThirdPartySearchResult:

object


Content:

string

LinkCaption:

string

Rank:

string

Title:

string

URL:

string

ToBeDone:

object


TBD:

string

to be done

UnreadMessageCountResponse:

object


Deleted:

number

Inbox:

number

InboxArchive:

number

Sent:

number

SentArchive:

number

UpdateCountRequest:

object


LastLogin:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Last login date/time. Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

UserUpdate:

boolean

Principals:

object[]

object

UserID:

string

StagedUserID:

string

UpdateEmailRequest:

object


Password:

string

Email:

string

Reason:

string

UpdatePasswordRequest:

object


CurrentPassword:

string

NewPassword:

string

UploadDocument:



ScanResult:

string

ScanStatus:

string

DocumentType:

string

UserAccessDenied:

object


error:

string

ErrorCode:

string

ValidateActivationCodeRequest:

object


Token:

string

SSN:

string

MothersMaidenName:

string

Passphrase:

string

DateOfBirth:

string (date)

DOB in yyyy-mm-dd format. Required

ValidateActivationCodeResponse:

object


TermsAccepted:

boolean

PerformSecondaryIdentification:

boolean

Flag to indicate whether secondary identification is required or not

SecondaryIdentificationData:

string[]

string

error:

string

ValidateResetTokenRequest:

object


ResetToken:

string

ValidateResetTokenResponse:

object


valid:

boolean

SecurityQuestion:

string

Text of Security question if available

Usernames:

string

If there is no security question, then the username

ValidateStagedUserRequest:

object


DateOfBirth:

string

MothersMaidenName:

string

Passphrase:

string

SSN:

string

Token:

string

ValidateStagedUserResponse:

object


IdentityConfirmed:

boolean

field:

string

Data field with matching problem

error:

string

ValidateUsernameRequest:

object


Username:

string

ValidateUsernameResponse:

object


valid:

boolean

ValidicDeviceDetails:

object


RegisteredDevices:

object[]

AppCount:

number

VitalsChartResponse:

object


FirstTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

"Earliest time for the selected results"
                                                    
LastTime:

string

, must match ^(\d{4}-\d{2}-\d{2})( \d{2}:\d{2}:\d{2}(\.d{1,6})?)?$

Format is YYYY-MM-DD[ HH:MI:SS[.FFFFFF]]. YYYY is a four-digit year. MM is a two-digit month number (01-12; 01 = January). DD is a two-digit day of month (01-31). HH is the hour, specified as 00-23. MI is the minute, specified as 00-59. SS is the second, specified as 00-59. FFFFFF is between 0 and 6 digits specifying the fractional seconds. The date, YYYY-MM-DD, is required but the timestamp, HH:MI:SS, is optional. Fractional seconds are only processed when the time is included, and are always optional.

"Latest time for the selected results"
                                                    
children:

object[]