Clinical Queries

Interactive examples coming soon...

allergies :: [Allergy]

ArgumentTypeDescription
patientIdID!

complication :: Complication

ArgumentTypeDescription
idID!ID of resource to lookup

complications :: 

ArgumentTypeDescription
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

customPatientFieldValues :: [CustomPatientFieldValue]

ArgumentTypeDescription
limitInt
offsetInt
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

diagnostics :: [Diagnostic]

ArgumentTypeDescription
clientIdID
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

encounter :: Encounter

ArgumentTypeDescription
idID!ID of resource to lookup

encounterProducts :: [EncounterProduct]

ArgumentTypeDescription
clientIdID
limitInt
locationIdID
offsetInt
patientIdID
providerIdID
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

encounterSummary :: String

ArgumentTypeDescription
encounterIdID!
locationIdID
only[String]

encounterTypes :: [EncounterType]

ArgumentTypeDescription
locationIdID
onlyEnabledBoolean

encounters :: [Encounter]

Search for encounters by patient id, org id, and status

ArgumentTypeDescription
clientIdID
historicalIdString
limitInt
locationIdID
offsetInt
patientIdID
providerIdID
signedBoolean
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime
viewerOnlyBoolean

encountersUpdatedSince :: [Encounter]

Poll for a list of encounters updated since a specific datetime

ArgumentTypeDescription
updatedAtDateTime!

immunization :: Immunization

ArgumentTypeDescription
idID!ID of resource to lookup

immunizationPdf :: String

Get immunizations PDF

ArgumentTypeDescription
isLatestBoolean
locationIdID!
patientIdID!

immunizations :: [Immunization]

Get immunizations

ArgumentTypeDescription
clientIdID
isRabiesBoolean
limitInt
offsetInt
patientIdID
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

immunizationsDue :: [Immunization]

ArgumentTypeDescription
limitInt
locationIdID!
offsetInt
showSilencedBoolean
withinDaysInt

lapsingPatients :: [Patient]

ArgumentTypeDescription
limitInt
locationIdID!
offsetInt

mandatoryConsentForms :: [String]

ArgumentTypeDescription
encounterIdID!

medicalRecordsSummary :: String

ArgumentTypeDescription
endNaiveDateTime
includeDocumentsBoolean
includeExamsBoolean
includeLabResultsBoolean
includeNotesBoolean
includePrivateBoolean
includeTasksBoolean
patientIdID!
startNaiveDateTime

medication :: Medication

ArgumentTypeDescription
idID!ID of resource to lookup

medications :: [Medication]

Lookup a patient's medication by status

ArgumentTypeDescription
clientIdID
hasRefillsBoolean
limitInt
offsetInt
patientIdID
statusMedicationStatus
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

patient :: Patient

ArgumentTypeDescription
idID!ID of resource to lookup

patientComplication :: PatientComplication

ArgumentTypeDescription
idID!ID of resource to lookup

patientConsentForms :: [ClientConsent]

ArgumentTypeDescription
clientIdID
patientIdID!

patientDocument :: PatientDocument

ArgumentTypeDescription
idID!ID of resource to lookup

patientLabel :: String

ArgumentTypeDescription
idID!
locationIdID!
typeString

patientProtocols :: [PatientProtocol]

ArgumentTypeDescription
endDateDate
endDueDateDate
limitInt
offsetInt
startDateDate
startDueDateDate

patientQrCode :: String

ArgumentTypeDescription
idID!

patientTag :: PatientTag

ArgumentTypeDescription
idID!ID of resource to lookup

patientTags :: 

ArgumentTypeDescription
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

patients :: 

Retrieve a list of all patients at your org

ArgumentTypeDescription
filtersPatientFiltersFilter the patients return by field
limitIntLimit the number of results (defaults to nil)
offsetIntFor pagination, offset the return values by a number (defaults to 0 / no offset)
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

problems :: [Patient]

ArgumentTypeDescription
limitInt
offsetInt
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

rabiesCertificate :: String

ArgumentTypeDescription
locationIdID
patientIdID!

rabiesCertificates :: [String]

ArgumentTypeDescription
ids[]
locationIdID
patientIdID!

searchDiagnoses :: [Diagnosis]

Search diagnoses by term

ArgumentTypeDescription
limitInt!
termString!

searchEmailAttachments :: [EmailAttachment]

ArgumentTypeDescription
encounterIdID!Encounter ID to attach the xray to
fromEmailsString!Used to search from field of emails
locationIdID!Location to use for the gmail account
subjectString!Used to Search subject of emails

searchMacros :: [Macro]

ArgumentTypeDescription
limitInt
locationIdID
termString!

totalPatients :: Int

No arguments.

treatments :: [Treatment]

ArgumentTypeDescription
clientIdID
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

vitals :: [Vitals]

Historical vitals

ArgumentTypeDescription
appointmentIdID
encounterIdID
fromDateTime
limitInt
offsetInt
patientIdID
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

vitalsTemplate :: [VitalDatum]

Format for vitals

ArgumentTypeDescription
appointmentIdID