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 TypeAthena Response
ResponseMetaObject
ResponseMeta.DataModelString
ResponseMeta.EventTypeString
ResponseMeta.EventDateTimeString
ResponseMeta.TestBoolean
ResponseMeta.SourceString
ResponseMeta.Source.IDString
ResponseMeta.Source.NameString
ResponseNotes[]Array of Objects
ResponseNotes[].PatientObject
ResponseNotes[].Patient.Identifiers[]Array of Objects
ResponseNotes[].Patient.Identifiers[].IDStringpatientid
ResponseNotes[].Patient.Identifiers[].IDTypeStringEHRID
ResponseNotes[].VisitObject
ResponseNotes[].Visit.VisitNumberString
ResponseNotes[].FileNameString
ResponseNotes[].DocumentTypeStringdocumentclass
ResponseNotes[].DocumentIDStringclinicaldocumentid
ResponseNotes[].DocumentRouteString
ResponseNotes[].documentSourceString
ResponseNotes[].OservationDateString
ResponseNotes[].ServiceDateTimeStringcreateddate
ResponseNotes[].DocumentationDateTimeStringlastmodifieddate
ResponseNotes[].StatusString
ResponseNotes[].CreatedUserString
ResponseNotes[].LastModifiedUserString
ResponseNotes[].DocumentClassString
ResponseNotes[].ContentTypeStringcontenttype
ResponseNotes[].DocumentDescriptionString
ResponseNotes[].FileContentsStringdocumentdescription
ResponseNotes[].EncounterObject
ResponseNotes[].Encounter.EncounterNumberString
ResponseTotalCountNumerictotalcount