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

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:



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:



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[]