Query Response
Description
This is the format of the response you will receive for a Order:Query.
API endpoints for Order Query Response
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/order/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 | Athena Response |
---|---|---|---|
QueryResponse | Meta | Object | |
QueryResponse | Meta.DataModel | String | Order |
QueryResponse | Meta.EventType | String | QueryResponse |
QueryResponse | Meta.Raw | Array | |
QueryResponse | Meta.Source | Object | |
QueryResponse | Meta.Source.ID | String | |
QueryResponse | Meta.Source.Name | String | |
QueryResponse | Meta.Destinations[] | Array of Objects | |
QueryResponse | Meta.Destinations[].ID | String | |
QueryResponse | Meta.Destinations[].Name | String | |
QueryResponse | Meta.Logs[] | Array of Objects | |
QueryResponse | Meta.Logs[].ID | String | |
QueryResponse | Meta.Logs[].AttemptID | String | |
QueryResponse | Message | Object | |
QueryResponse | Message.ID | String | |
QueryResponse | Transmission | Object | |
QueryResponse | Transmission.ID | String | |
QueryResponse | FacilityCode | String | |
QueryResponse | Orders[] | Array of Objects | |
QueryResponse | Orders[].Patient | Object | |
QueryResponse | Orders[].Patient.Identifiers[] | Array of Objects | |
QueryResponse | Orders[].Patient.Identifiers[].ID | String | patientid |
QueryResponse | Orders[].Patient.Identifiers[].IDType | String | EHRID |
QueryResponse | Orders[].Visit | Object | |
QueryResponse | Orders[].VisitNumber | String | |
QueryResponse | Orders[].Encounter | Object | |
QueryResponse | Orders[].EncounterNumber | String | |
QueryResponse | Orders[].ID | String | orderid |
QueryResponse | Orders[].ApplicationOrderID | String | |
QueryResponse | Orders[].Status | String | status |
QueryResponse | Orders[].TransactionDateTime | Date Time | createddatetime |
QueryResponse | Orders[].CollectionDateTime | Date Time | lastmodifieddatetime |
QueryResponse | Orders[].Specimen | Object | |
QueryResponse | Orders[].Specimen.Source | String | |
QueryResponse | Orders[].Specimen.BodySite | String | |
QueryResponse | Orders[].Specimen.ID | String | |
QueryResponse | Orders[].Procedure | Object | |
QueryResponse | Orders[].Procedure.Code | String | |
QueryResponse | Orders[].Procedure.Codeset | String | |
QueryResponse | Orders[].Procedure.Description | String | |
QueryResponse | Orders[].Provider | Object | |
QueryResponse | Orders[].Provider.NPI | String | |
QueryResponse | Orders[].Provider.ID | String | providerid |
QueryResponse | Orders[].Provider.IDType | String | EHRID |
QueryResponse | Orders[].Provider.FirstName | String | |
QueryResponse | Orders[].Provider.LastName | String | |
QueryResponse | Orders[].Provider.Credentials | Array of Strings | |
QueryResponse | Orders[].Provider.Address | Object | |
QueryResponse | Orders[].Provider.Address.StreetAddress | String | |
QueryResponse | Orders[].Provider.Address.City | String | |
QueryResponse | Orders[].Provider.Address.State | String | |
QueryResponse | Orders[].Provider.Address.ZIP | String | |
QueryResponse | Orders[].Provider.Address.County | String | |
QueryResponse | Orders[].Provider.Address.Country | String | |
QueryResponse | Orders[].Provider.EmailAddresses[] | Array of Strings | |
QueryResponse | Orders[].Provider.PhoneNumber | Object | |
QueryResponse | Orders[].Provider.PhoneNumber.Office | String | |
QueryResponse | Orders[].Provider.Location | Object | |
QueryResponse | Orders[].Provider.Location.Type | String | |
QueryResponse | Orders[].Provider.Location.Facility | String | |
QueryResponse | Orders[].Provider.Location.Department | String | |
QueryResponse | Orders[].Provider.Location.Room | String | |
QueryResponse | Orders[].ResultCopyProviders | Array | |
QueryResponse | Orders[].OrderingFacility | Object | |
QueryResponse | Orders[].OrderingFacility.Name | String | |
QueryResponse | Orders[].OrderingFacility.Address | Object | |
QueryResponse | Orders[].OrderingFacility.Address.StreetAddress | String | |
QueryResponse | Orders[].OrderingFacility.Address.City | String | |
QueryResponse | Orders[].OrderingFacility.Address.State | String | |
QueryResponse | Orders[].OrderingFacility.Address.ZIP | String | |
QueryResponse | Orders[].OrderingFacility.Address.County | String | |
QueryResponse | Orders[].OrderingFacility.Address.Country | String | |
QueryResponse | Orders[].OrderingFacility.PhoneNumber | String | |
QueryResponse | Orders[].Priority | String | priority (high ==1,normal ==2) |
QueryResponse | Orders[].Comments | String | documentdescription |
QueryResponse | Orders[].Notes[] | Array of Strings | internalnote |
QueryResponse | Orders[].Diagnoses[] | Array of Objects | |
QueryResponse | Orders[].Diagnoses[].Code | String | |
QueryResponse | Orders[].Diagnoses[].Codeset | String | |
QueryResponse | Orders[].Diagnoses[].Name | String | |
QueryResponse | Orders[].Diagnoses[].Type | String | |
QueryResponse | Orders[].Diagnoses[].DocumentedDateTime | Date Time | |
QueryResponse | Orders[].ClinicalInfo[] | Array of Objects | |
QueryResponse | Orders[].ClinicalInfo[].Code | String | |
QueryResponse | Orders[].ClinicalInfo[].Codeset | String | |
QueryResponse | Orders[].ClinicalInfo[].Description | String | |
QueryResponse | Orders[].ClinicalInfo[].Value | String | |
QueryResponse | Orders[].ClinicalInfo[].Units | String | |
QueryResponse | Orders[].ClinicalInfo[].Abbreviation | String | |
QueryResponse | Orders[].ClinicalInfo[].Notes[] | Array of Strings | |
QueryResponse | Orders[].OrderType | String | ordertype |