Skip to main content

Query Response

Description

This is the response format for a Notes Query.

API endpoints for Notes Query Response

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

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

IntraConnects Unified Model

Event TypeIntraConnects ResponseData TypeOpen EPIC Response
QueryResponseMetaObject
QueryResponseMeta.DataModelString
QueryResponseMeta.EventTypeString
QueryResponseMeta.EventDateTimeString
QueryResponseMeta.TestBoolean
QueryResponseMeta.SourceString
QueryResponseMeta.Source.IDString
QueryResponseMeta.Source.NameString
QueryResponseNotes[]Array of Objects
QueryResponseNotes[].PatientObject
QueryResponseNotes[].Patient.Identifiers[]Array of Objects
QueryResponseNotes[].Patient.Identifiers[].IDStringpatientid
QueryResponseNotes[].Patient.Identifiers[].IDTypeStringEHRID
QueryResponseNotes[].VisitObject
QueryResponseNotes[].Visit.VisitNumberStringresource.context.encounter[].reference
QueryResponseNotes[].FileNameString
QueryResponseNotes[].DocumentTypeStringresource.content[].attachement.contentType (PDF)
QueryResponseNotes[].DocumentIDStringresource.id
QueryResponseNotes[].DocumentRouteString
QueryResponseNotes[].documentSourceString
QueryResponseNotes[].OservationDateString
QueryResponseNotes[].ServiceDateTimeStringresource.date
QueryResponseNotes[].DocumentationDateTimeString
QueryResponseNotes[].StatusStringresource.status
QueryResponseNotes[].CreatedUserStringresource.author[].reference
QueryResponseNotes[].LastModifiedUserString
QueryResponseNotes[].DocumentClassStringresource.category[].coding[].display
QueryResponseNotes[].ContentTypeStringresource.content[].attachment.contentType
QueryResponseNotes[].DocumentDescriptionString
QueryResponseNotes[].FileContentsStringresource.content[].attchment.url
QueryResponseNotes[].EncounterObject
QueryResponseNotes[].Encounter.EncounterNumberString
QueryResponseTotalCountNumeric