GET api/v1/{EMRSystem}/Documents
Returns a list of documents or clinical notes for a given patient. FHIR connectors use the following resources for R4: DocumentReference.Search, Patient.Read, Practitioner.Read, and Encounter.Read.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
Gets or sets the user identifier. |
string |
Required |
| PatientId |
Gets or sets the patient identifier. |
string |
None. |
| EncounterId |
Gets or sets the encounter identifier. |
string |
None. |
| FromDateTime |
Gets or sets from date time. |
datetime |
None. |
| ToDateTime |
Gets or sets to date time. |
datetime |
None. |
| DocumentCategories |
Gets or sets the document categories. |
string |
None. |
| DocumentTypes |
Gets or sets the document types. |
string |
None. |
| NextPage |
Search page |
string |
None. |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Response Information
Collection of Document| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentId |
Gets or sets the document identifier. |
string |
None. |
| DocumentDateTime |
Gets or sets the document date time. |
datetime |
None. |
| LastUpdateDateTime |
Gets or sets the document last update date time. |
datetime |
None. |
| DocumentResultDateTime |
Gets or sets the document result date time. |
datetime |
None. |
| DocumentTitle |
Gets or sets the document title. |
string |
None. |
| DocumentType |
Gets or sets the document type. |
string |
None. |
| DocumentTypeId |
Gets or sets the document type Id. |
string |
None. |
| DocumentStatus |
Gets or sets the document status. |
string |
None. |
| PatientId |
Gets or sets the patient identifier. |
string |
None. |
| EncounterId |
Gets or sets the encounter identifier. |
string |
None. |
| EncounterType |
Gets or sets the encounter type. |
CodedObject |
None. |
| PatientClass |
Gets or sets the patient class. |
CodedObject |
None. |
| OrderId |
Gets or sets the order identifier. |
string |
None. |
| ActiveInd |
Gets or sets a value indicating whether [active ind]. |
boolean |
None. |
| AuthorName |
Gets or sets the name of the author. |
string |
None. |
| DocumentFormat |
Gets or sets the document format. |
string |
None. |
Response Codes
Http Status Code 200 - Indicates that the request was processed successfully.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
[
{
"DocumentId": "sample string 1",
"DocumentDateTime": "2025-12-12T21:05:50.1476261+00:00",
"LastUpdateDateTime": "2025-12-12T21:05:50.1477638+00:00",
"DocumentResultDateTime": "2025-12-12T21:05:50.1478783+00:00",
"DocumentTitle": "sample string 2",
"DocumentType": "sample string 3",
"DocumentTypeId": "sample string 4",
"DocumentStatus": "sample string 5",
"PatientId": "sample string 6",
"EncounterId": "sample string 7",
"EncounterType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OrderId": "sample string 8",
"ActiveInd": true,
"AuthorName": "sample string 9",
"DocumentFormat": "sample string 10"
},
{
"DocumentId": "sample string 1",
"DocumentDateTime": "2025-12-12T21:05:50.1476261+00:00",
"LastUpdateDateTime": "2025-12-12T21:05:50.1477638+00:00",
"DocumentResultDateTime": "2025-12-12T21:05:50.1478783+00:00",
"DocumentTitle": "sample string 2",
"DocumentType": "sample string 3",
"DocumentTypeId": "sample string 4",
"DocumentStatus": "sample string 5",
"PatientId": "sample string 6",
"EncounterId": "sample string 7",
"EncounterType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"PatientClass": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"OrderId": "sample string 8",
"ActiveInd": true,
"AuthorName": "sample string 9",
"DocumentFormat": "sample string 10"
}
]