Query Response

Description

This is the response to the PatientSearch Query.

API endpoints for Query Response

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/patient-search/query-response.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Intraconnects Unified Model

Event Type	IntraConnects Response	Data Type	Open EPIC Response
Response	Meta	Object
Response	Meta.DataModel	String	PatientSearch
Response	Meta.EventType	String	Response
Response	Meta.Raw	Array
Response	Meta.Source	String
Response	Meta.Source.ID	String
Response	Meta.Source.Name	String
Response	Patient	Object
Response	Patient.Identifiers[]	Array of Objects
Response	Patient.Identifiers[].ID	String	resource.id / resource.identifier[].value
Response	Patient.Identifiers[].IDType	String	EHRID
Response	Patient.Demographics	Object
Response	Patient.Demographics.FirstName	String	resource.name[].given[]
Response	Patient.Demographics.MiddleName	String
Response	Patient.Demographics.LastName	String	resource.name[].family
Response	Patient.Demographics.DOB	String	resource.birthDate
Response	Patient.Demographics.SSN	String
Response	Patient.Demographics.Sex	String	resource.gender
Response	Patient.Demographics.Race	String
Response	Patient.Demographics.IsHispanic	Boolean
Response	Patient.Demographics.Religion	String
Response	Patient.Demographics.MaritalStatus	String	resource.maritalStatus.text
Response	Patient.Demographics.IsDeceased	Boolean
Response	Patient.Demographics.DeathDateTime	String
Response	Patient.Demographics.PhoneNumber	Object
Response	Patient.Demographics.PhoneNumber.Home	String	telecom[].value (use == home)
Response	Patient.Demographics.PhoneNumber.Office	String	telecom[].value (use == )work
Response	Patient.Demographics.PhoneNumber.Mobile	String
Response	Patient.Demographics.EmailAddresses[]	Array of Strings
Response	Patient.Demographics.Language	String	---
Response	Patient.Demographics.Citizenship[]	Array
Response	Patient.Demographics.Address	Object
Response	Patient.Demographics.Address.StreetAddress	String	resource.address[].line[]
Response	Patient.Demographics.Address.City	String	resource.address[].city
Response	Patient.Demographics.Address.State	String	resource.address[].state
Response	Patient.Demographics.Address.ZIP	String	resource.address[].postalCode
Response	Patient.Demographics.Address.County	String
Response	Patient.Demographics.Address.Country	String	resource.address[].country
Response	Patient.Notes[]	Array
Response	Patient.Contacts[]	Array of Objects
Response	Patient.Contacts[].FirstName	String
Response	Patient.Contacts[].MiddleName	String
Response	Patient.Contacts[].LastName	String
Response	Patient.Contacts[].Address	Object
Response	Patient.Contacts[].Address.StreetAddress	String
Response	Patient.Contacts[].Address.City	String
Response	Patient.Contacts[].Address.State	String
Response	Patient.Contacts[].Address.ZIP	String
Response	Patient.Contacts[].Address.County	String
Response	Patient.Contacts[].Address.Country	String
Response	Patient.Contacts[].PhoneNumber	Object
Response	Patient.Contacts[].PhoneNumber.Home	String
Response	Patient.Contacts[].PhoneNumber.Office	String
Response	Patient.Contacts[].PhoneNumber.Mobile	String
Response	Patient.Contacts[].RelationToPatient	String
Response	Patient.Contacts[].EmailAddresses[]	Array of Strings
Response	Patient.Contacts[].Roles[]	Array
Response	Patient.PCP	Object
Response	Patient.PCP.NPI	String
Response	Patient.PCP.ID	String
Response	Patient.PCP.IDType	String
Response	Patient.PCP.FirstName	String
Response	Patient.PCP.LastName	String
Response	Patient.PCP.Credentials[]	Array
Response	Patient.PCP.Address	Object
Response	Patient.PCP.Address.StreetAddress	String
Response	Patient.PCP.Address.City	String
Response	Patient.PCP.Address.State	String
Response	Patient.PCP.Address.ZIP	String
Response	Patient.PCP.Address.County	String
Response	Patient.PCP.Address.Country	String
Response	Patient.PCP.EmailAddresses[]	Array of Strings
Response	Patient.PCP.PhoneNumber	Object
Response	Patient.PCP.PhoneNumber.Office	String
Response	Patient.PCP.Location	Object
Response	Patient.PCP.Location.Type	String
Response	Patient.PCP.Location.Facility	String
Response	Patient.PCP.Location.Department	Numeric
Response	Patient.PCP.Location.Room	String
Response	Patient.Guarantor	Object
Response	Patient.Guarantor.Number	String
Response	Patient.Guarantor.FirstName	String
Response	Patient.Guarantor.MiddleName	String
Response	Patient.Guarantor.LastName	String
Response	Patient.Guarantor.SSN	String
Response	Patient.Guarantor.DOB	String
Response	Patient.Guarantor.Sex	String
Response	Patient.Guarantor.Spouse	Object
Response	Patient.Guarantor.Spouse.FirstName	String
Response	Patient.Guarantor.Spouse.LastName	String
Response	Patient.Guarantor.Address	Object
Response	Patient.Guarantor.Address.StreetAddress	String
Response	Patient.Guarantor.Address.City	String
Response	Patient.Guarantor.Address.State	String
Response	Patient.Guarantor.Address.ZIP	String
Response	Patient.Guarantor.Address.County	String
Response	Patient.Guarantor.Address.Country	String
Response	Patient.Guarantor.PhoneNumber	Object
Response	Patient.Guarantor.PhoneNumber.Home	String
Response	Patient.Guarantor.PhoneNumber.Business	String
Response	Patient.Guarantor.PhoneNumber.Mobile	String
Response	Patient.Guarantor.EmailAddresses[]	Array of Strings
Response	Patient.Guarantor.Type	String
Response	Patient.Guarantor.RelationToPatient	String
Response	Patient.Guarantor.Employer	Object
Response	Patient.Guarantor.Employer.Name	String
Response	Patient.Guarantor.Employer.Address	Object
Response	Patient.Guarantor.Employer.Address.StreetAddress	String
Response	Patient.Guarantor.Employer.Address.City	String
Response	Patient.Guarantor.Employer.Address.State	String
Response	Patient.Guarantor.Employer.Address.ZIP	String
Response	Patient.Guarantor.Employer.Address.County	String
Response	Patient.Guarantor.Employer.Address.Country	String
Response	Patient.Guarantor.Employer.PhoneNumber	String
Response	Patient.Insurances[]	Array of objects
Response	Patient.Insurances[].Plan	Object
Response	Patient.Insurances[].Plan.ID	String
Response	Patient.Insurances[].Plan.IDType	String
Response	Patient.Insurances[].Plan.Name	String
Response	Patient.Insurances[].Plan.Type	String
Response	Patient.Insurances[].MemberNumber	String
Response	Patient.Insurances[].Company	Object
Response	Patient.Insurances[].Company.ID	String
Response	Patient.Insurances[].Company.IDType	String
Response	Patient.Insurances[].Company.Name	String
Response	Patient.Insurances[].Company.Address	Object
Response	Patient.Insurances[].Company.Address.StreetAddress	String
Response	Patient.Insurances[].Company.Address.City	String
Response	Patient.Insurances[].Company.Address.State	String
Response	Patient.Insurances[].Company.Address.ZIP	String
Response	Patient.Insurances[].Company.Address.County	String
Response	Patient.Insurances[].Company.Address.Country	String
Response	Patient.Insurances[].Company.PhoneNumber	String
Response	Patient.Insurances[].GroupNumber	String
Response	Patient.Insurances[].GroupName	String
Response	Patient.Insurances[].EffectiveDate	String
Response	Patient.Insurances[].ExpirationDate	String
Response	Patient.Insurances[].PolicyNumber	String
Response	Patient.Insurances[].Priority	String
Response	Patient.Insurances[].AgreementType	String
Response	Patient.Insurances[].CoverageType	String
Response	Patient.Insurances[].Insured	Object
Response	Patient.Insurances[].Insured.Identifiers[]	Array
Response	Patient.Insurances[].Insured.LastName	String
Response	Patient.Insurances[].Insured.MiddleName	String
Response	Patient.Insurances[].Insured.FirstName	String
Response	Patient.Insurances[].Insured.SSN	String
Response	Patient.Insurances[].Insured.Relationship	String
Response	Patient.Insurances[].Insured.DOB	String
Response	Patient.Insurances[].Insured.Sex	String
Response	Patient.Insurances[].Insured.Address	Object
Response	Patient.Insurances[].Insured.Address.StreetAddress	String
Response	Patient.Insurances[].Insured.Address.City	String
Response	Patient.Insurances[].Insured.Address.State	String
Response	Patient.Insurances[].Insured.Address.ZIP	String
Response	Patient.Insurances[].Insured.Address.County	String
Response	Patient.Insurances[].Insured.Address.Country	String