getPatientDataRetrievalStatus

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Get the status of the document retrieval for a patient, including consent status, retrieval progress, and vectorization status.

Superseded by getPatientFlowProgress, which returns the same retrieval information plus the patient's consent status.

Responses

200 Patient document retrieval status Schema — OPTIONAL patientId string The patient's HealthEx ID retrievalId string A unique identifier for the data retrieval request. Will change whenever the user updates their data. dataRetrievalStatus string Possible values: [IN_PROGRESS, COMPLETE] Status indicating whether the data retrieval request is in progress or complete vectorizationStatus string Possible values: [IN_PROGRESS, COMPLETE, FAILED] Status indicating whether the data has been vectorized and is fully ready for AI-powered queries createdAt date-time The date and time the data retrieval request was created updatedAt object The date and time the data retrieval request was last updated locations object[] Array of healthcare locations that were or are being retrieved locationId string The ID of the healthcare location locationName object Human-readable name of the healthcare location dataRetrievalStatus string Possible values: [NOT_STARTED, IN_PROGRESS, COMPLETE, PARTIAL_COMPLETE, SKIPPED, ERROR, AUTHENTICATION_EXPIRED, AUTHENTICATION_NEEDED_NEW_FACILITY] Status of the retrieval for this specific location locationSource string Possible values: [TEFCA_DOCUMENT, TEFCA_ENDPOINT, USER_SELECTED, INTERNAL_TEST, HEALTHEX_EPIC] Indicates how this healthcare location was discovered updatedAt object The date and time the location's data was last updated documentCount number The number of documents retrieved from this location