Query
Description
The PatientSearch query is used to search for a patient record match using a subset of patient demographic information. This query is often used to retrieve specific identifiers required for subsequent calls on a patient's chart. The subset of demographic information typically includes patient's name, date of birth, gender, and other relevant identifiers such as social security number, medical record number, or patient ID.
API endpoints for Query
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/patient-search/query.
Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.
Intraconnect Unified Model
Event Type | IntraConnects Request | Data Type | Request |
---|---|---|---|
Query | Meta | Object | |
Query | Meta.DataModel | String | PatientSearch |
Query | Meta.EventType | String | Query |
Query | Meta.Test | Boolean | |
Query | Meta.Source | Object | |
Query | Meta.Source.ID | String | |
Query | Meta.Source.Name | String | |
Query | Patient | Object | |
Query | Patient.Identifiers[] | Array of Objects | |
Query | Patient.Identifiers[].ID | String | |
Query | Patient.Identifiers[].IDType | String | |
Query | Patient.Demographics | Object | |
Query | Patient.Demographics.FirstName | String | firstName |
Query | Patient.Demographics.LastName | String | lastName |
Query | Patient.Demographics.MiddleName | String | |
Query | Patient.Demographics.DOB | String | dateOfBirth |
Query | Patient.Demographics.SSN | String | |
Query | Patient.Demographics.Sex | String | sex |
Query | Patient.Demographics.Race | String | |
Query | Patient.Demographics.IsHispanic | Boolean | |
Query | Patient.Demographics.Religion | String | |
Query | Patient.Demographics.MaritalStatus | String | |
Query | Patient.Demographics.IsDeceased | Boolean | |
Query | Patient.Demographics.DeathDateTime | String | |
Query | Patient.Demographics.PhoneNumber | Object | |
Query | Patient.Demographics.PhoneNumber.Home | String | |
Query | Patient.Demographics.PhoneNumber.Office | String | |
Query | Patient.Demographics.PhoneNumber.Mobile | String | |
Query | Patient.Demographics.EmailAddresses[] | Array of Strings | |
Query | Patient.Demographics.Language | String | |
Query | Patient.Demographics.Citizenship[] | Array of Strings | |
Query | Patient.Demographics.Address | Object | |
Query | Patient.Demographics.Address.StreetAddress | String | |
Query | Patient.Demographics.Address.City | String | |
Query | Patient.Demographics.Address.State | String | |
Query | Patient.Demographics.Address.ZIP | String | |
Query | Patient.Demographics.Address.County | String | |
Query | Patient.Demographics.Address.Country | String | |
Query | Patient.Notes[] | Array of Strings |