# Predoc Documentation > Documentation for Predoc ## API Reference - [Get Access Token](https://docs.predoc.ai/reference/authcontroller_signin_v1.md): Upon validation of the user's credentials, this endpoint will return a JWT token that can be used to authenticate subsequent requests to the Predoc API. This token should be included in the `Authorization` header of all requests to the Predoc API. The token is valid for 5 minutes and should be refreshed prior to expiration. - [Create Patient](https://docs.predoc.ai/reference/patientcontroller_createpatient_v2.md): Creates a new patient without a record request. - [Get Patient Information](https://docs.predoc.ai/reference/patientcontroller_getpatientinformation_v1.md): Gets the full information for the specified patient. If no patient is found with the corresponding ID, a 404 error will be returned. - [Patient Requests](https://docs.predoc.ai/reference/patientcontroller_getpatientrequests_v1.md): Gets the list of all requests for the patient regardless of status. This information can be used on the organization side to track the progress of specific requests. - [Search Patients by Information](https://docs.predoc.ai/reference/patientcontroller_searchpatientsbyinformation_v1.md): NOTE: Body usage is deprecated and will be removed in a future release. Please use query params instead. Gets the available patients from the Predoc application based on the provided search criteria. The patient IDs returned from this endpoint can be used to retrieve the patient’s full information via the `/patients/{patientId}` endpoint. If no patient is found with the corresponding PHI, the patient ID will be empty and a message will be in the response with any explanation. - [Update Patient Information](https://docs.predoc.ai/reference/patientcontroller_updatepatientinformation_v1.md): Updates the patient information while the patient is in an "Open" status. If any requests for the patient has progressed past the "Open" status, the patient information will be locked and no updates will be allowed. If the record is ineligible for updates, the API will return a message in the standard return object noting that update is not possible. - [Add Request to Existing Patient](https://docs.predoc.ai/reference/patientcontroller_addrequesttoexistingpatient_v1.md): Creates a new record retrieval request to the posted patient. The patient must already exist in the Predoc application. The request will be created with a status of “Creating” and until the request has been fully submitted to the Predoc platform and will be editable until the request progresses into a non-Open stat. The request ID will be returned in the response for reference with other endpoints. - [Close Previous-Provider Retrieval](https://docs.predoc.ai/reference/retrievalcontroller_closeretrieval_v1.md): Requests closure of a manual previous-provider retrieval by retrieval UUID. Closure is asynchronous and the retrieval status will update when finished. NOTE: Closing a previous-provider retrieval that has already been initiated will count as a billable event. - [Create Patient with Record Request V2](https://docs.predoc.ai/reference/requestcontroller_createrecordrequestv2_v2.md): The record request endpoint creates a request within the Predoc application for the specified patient’s information. This request is automatically associated with the requesting user’s organizational account and the status is able to be checked within the Predoc application by any of the organization’s users. The return of this endpoint is a record ID that allows for subsequent calls to check the status of the request via the partner API as well as fetch the returned documents programmatically. V2 introduces protection against creating duplicate patients with the same PII. - [Create Patient with Record Request](https://docs.predoc.ai/reference/requestcontroller_createrecordrequest_v1.md): The record request endpoint creates a request within the Predoc application for the specified patient’s information. This request is automatically associated with the requesting user’s organizational account and the status is able to be checked within the Predoc application by any of the organization’s users. The return of this endpoint is a record ID that allows for subsequent calls to check the status of the request via the partner API as well as fetch the returned documents programmatically. - [Get Previous-Provider Retrieval Status](https://docs.predoc.ai/reference/retrievalcontroller_getretrieval_v1.md): Gets the current status for a manual previous-provider retrieval by retrieval UUID. - [List of All Patient Record Requests](https://docs.predoc.ai/reference/requestcontroller_getlistofrecordrequests_v2.md): Calling this endpoint will return a list of all requests that are in the Predoc system. The reference IDs returned can be used in the Fetch Patient Records request to get the specified patient’s information. - [List of All Patient Record Requests](https://docs.predoc.ai/reference/requestcontroller_getlistofrecordrequestsv1_v1.md): Calling this endpoint will return a list of all requests that are in the Predoc system. The reference IDs returned can be used in the Fetch Patient Records request to get the specified patient’s information. - [List of Facesheet configs available](https://docs.predoc.ai/reference/requestcontroller_facesheetconfigs_v1.md): Calling this endpoint will return a list of facesheet configs available to to be passed to a patient request as additional parameter which will cause corresponding facesheet generation request to be submitted. - [Update Existing Patient Record Request](https://docs.predoc.ai/reference/requestcontroller_updateexistingrecordrequest_v1.md): If available, updates the specified patient record request with the provided information. The ability to update the record request will depend on the status of the request and is only available for requests that have not been started by the Predoc process. If the request is not able to be updated, the response will indicate that the update was not successful. - [Upload patient records](https://docs.predoc.ai/reference/recorduploadcontroller_uploadrecordv2_v2.md): Upload patient records to Predoc. V2 introduces protection against creating duplicate patients with the same PII. - [Upload an anonymous PDF record](https://docs.predoc.ai/reference/recorduploadcontroller_uploadanonymousrecord_v1.md): Upload a PDF record that is not yet associated to a patient profile. Accepts PDF files only, max 300MB. - [Get anonymous record request status](https://docs.predoc.ai/reference/recorduploadcontroller_getanonymousrecorduploadstatus_v1.md): Retrieves the processing status for an anonymous record upload request. - [Upload patient records](https://docs.predoc.ai/reference/recorduploadcontroller_uploadrecord_v1.md): Upload patient records to Predoc. - [Search Patient Documents](https://docs.predoc.ai/reference/patientcontroller_searchpatientdocuments_v2.md): Searches all available documents for the patient, based on the provided search criteria. Results follow the organization document set delivery mode. CANVAS_SET mode includes CANVAS_SET, PRESPLICED, and untagged historical records. SEGMENT_SET mode includes SEGMENT_SET, PRESPLICED, and untagged historical records. When the organization has no mode configured, CANVAS_SET behavior applies. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, categories, dates, and splice metadata are preserved as received. - [Search Patient Documents V1](https://docs.predoc.ai/reference/patientcontroller_searchpatientdocumentsv1_v1.md): Searches all available documents for the patient, based on the provided search criteria. Results follow the organization document set delivery mode. CANVAS_SET mode includes CANVAS_SET, PRESPLICED, and untagged historical records. SEGMENT_SET mode includes SEGMENT_SET, PRESPLICED, and untagged historical records. When the organization has no mode configured, CANVAS_SET behavior applies. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, categories, dates, and splice metadata are preserved as received. - [Available Patient Lab Results](https://docs.predoc.ai/reference/patientcontroller_getavailablepatientchemistries_v1.md): Gets all of the available lab result chemistries for the requested patient. Literal `|` separators are removed from these partner-facing display values. This endpoint can be used in conjunction with the `/patients/{patientId}/lab-results` endpoint to retrieve the available lab results for the patient. - [Get Patient Additional Records](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientadditionalrecords_v1-1.md): Gets a list of additional records for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received. - [Get Patient Documents](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientdocuments_v1.md): Gets a list of documents for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received. - [Get Patient Drug Allergies](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientdrugallergies_v1.md): Gets a list of drug allergies for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received. - [Get Patient Facesheets](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientfacesheets_v1.md): Gets a list of facesheets for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received. - [Get Patient HIE documents](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatienthiedocs_v1.md): Gets a list of HIE documents for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received. - [Get Patient Imaging Results](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientimagingresults_v1.md): Gets a list of imaging results for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received. - [Get Patient Medications](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientmedications_v1.md): Gets a list of medications for the patient by ID. - [Patient Lab Results](https://docs.predoc.ai/reference/patientcontroller_getpatientlabresultsbysearch_v1.md): NOTE: Body usage is deprecated and will be removed in a future release. Please use query params instead. Gets the specified lab result values for the requested patient. If no criteria are provided, all results on the patient profile will be returned. The list of available labs can be retrieved via the `/patients/{patientId}/lab-results/available` endpoint. Literal `|` separators are removed from returned lab display text and ignored when matching `searchChemistries`. - [Get Patient Lab Tests](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientlabtests_v1.md): Gets a list of lab tests for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received. - [Get Patient Other Records](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientotherrecords_v1.md): Gets a list of other records for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received. - [Get Patient Procedure Notes](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientprocedurenotes_v1.md): Gets a list of procedure notes for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received. - [Get Patient Provider Facility Notes](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientproviderfacilitynotes_v1.md): Gets a list of provider/facility notes for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received. - [Get Patient Vaccine & Immunization Records](https://docs.predoc.ai/reference/patientdocumentscontroller_getpatientvaccinerecords_v1.md): Gets a list of vaccine and immunization records for the patient by ID. These can be downloaded via their `url` property. Partner-facing document display text fields are returned without literal `|` separators. Identifiers, URLs, statuses, dates, splice metadata, and source metadata are preserved as received. - [Request Patient Clinical Summary](https://docs.predoc.ai/reference/patientcontroller_requestpatientclinicalsummary_v1.md): Creates a request for the clinical summary document for the requested patient that is generated by the Predoc platform.

To check the status of this request, use the `/documents/{documentId}` endpoint where the document ID is the patientSummaryRequestId returned in the response from this request.

Source documents are selected by the requested categories and date range only; the organization document set delivery mode does not filter summary source documents. - [Document Status Request](https://docs.predoc.ai/reference/documentcontroller_getpatientclinicalsummary_v1.md): Requests the status of the specified document. The document ID is returned in the response from the request to retrieve the patient summary.

Valid Values

- [Create Webhook Configuration](https://docs.predoc.ai/reference/webhookconfigurationcontroller_createwebhookconfiguration_v1.md): The create webhook configuration endpoint creates a webhook configuration within the Predoc application for the user. - [List Webhook Configurations](https://docs.predoc.ai/reference/webhookconfigurationcontroller_listwebhookconfigurations_v1.md): The list webhook configurations endpoint lists all webhook configurations within the Predoc application for the user. - [Update Webhook Configuration](https://docs.predoc.ai/reference/webhookconfigurationcontroller_updatewebhookconfiguration_v1.md): The update webhook configuration endpoint updates a webhook configuration within the Predoc application for the user. - [Delete Webhook Configuration](https://docs.predoc.ai/reference/webhookconfigurationcontroller_deletewebhookconfiguration_v1.md): The delete webhook configuration endpoint deletes a webhook configuration within the Predoc application for the user. ## Changelog - [Partner API v1.4.1 🚀 Retrieval API Enhancements](https://docs.predoc.ai/changelog/partner-api-v141.md) - [Partner API v1.4.0](https://docs.predoc.ai/changelog/partner-api-v140.md) - [Partner API v1.2.0](https://docs.predoc.ai/changelog/partner-api-v120.md) - [Partner API v1.1.0](https://docs.predoc.ai/changelog/partner-api-v110.md)