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 Type	IntraConnects Response	Data Type	Nextgen Response
QueryResponse	Meta	Object
QueryResponse	Meta.DataModel	String
QueryResponse	Meta.EventType	String
QueryResponse	Meta.EventDateTime	String
QueryResponse	Meta.Test	Boolean
QueryResponse	Meta.Source	String
QueryResponse	Meta.Source.ID	String
QueryResponse	Meta.Source.Name	String
QueryResponse	Notes[]	Array of Objects
QueryResponse	Notes[].Patient	Object
QueryResponse	Notes[].Patient.Identifiers[]	Array of Objects
QueryResponse	Notes[].Patient.Identifiers[].ID	String	personId
QueryResponse	Notes[].Patient.Identifiers[].IDType	String	EHRID
QueryResponse	Notes[].Visit	Object
QueryResponse	Notes[].Visit.VisitNumber	String	encounterId
QueryResponse	Notes[].FileName	String
QueryResponse	Notes[].DocumentType	String	noteType
QueryResponse	Notes[].DocumentID	String	id
QueryResponse	Notes[].DocumentRoute	String
QueryResponse	Notes[].documentSource	String
QueryResponse	Notes[].OservationDate	String
QueryResponse	Notes[].ServiceDateTime	String
QueryResponse	Notes[].DocumentationDateTime	String
QueryResponse	Notes[].Status	String
QueryResponse	Notes[].CreatedUser	String	createdBy
QueryResponse	Notes[].LastModifiedUser	String
QueryResponse	Notes[].DocumentClass	String
QueryResponse	Notes[].ContentType	String
QueryResponse	Notes[].DocumentDescription	String
QueryResponse	Notes[].FileContents	String	noteNarrative
QueryResponse	Notes[].Encounter	Object
QueryResponse	Notes[].Encounter.EncounterNumber	String
QueryResponse	TotalCount	Numeric