GET api/patientSharedFiles/search?patientExternalId={patientExternalId}&creationDateOperator={creationDateOperator}&creationDate1={creationDate1}&creationDate2={creationDate2}&displayName={displayName}&fileName={fileName}&patientComments={patientComments}&status={status}&alreadySent={alreadySent}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of patient shared files.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
patientExternalId

ID of the patient in the integrating system

string

Default value is empty string ("")

creationDateOperator

Operator used to filter the list based on the creation date of the file. Possible values: NotCompare (equals to empty string ""), Equals, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Between, DifferentThan.

string

Default value is empty string ("")

creationDate1

Date1 to filter the list by creation date of the document.

date

None.

creationDate2

Date2 to filter the list by creation date of the document. Only used if creationDateOperator is Between.

date

None.

displayName

Filter the list by the display-name of the file. The system will find files containing the supplied value.

string

Default value is empty string ("")

fileName

Filter the list by the name of the file. The system will find files containing the supplied value.

string

Default value is empty string ("")

patientComments

Filter the list by the patient comments. The system will find files containing the supplied value.

string

Default value is empty string ("")

status

Filter the list by file status. Possible values: New, Processed. Do no send any value to get all files.

string

Default value is empty string ("")

alreadySent

If False, the list will return only new results (not yet sent to the integrating system). Use this parameter to avoid getting the same records on every call. See also the POST api/PatientSharedFilesSent.

boolean

None.

page

Page number requested (search results are paginated).

integer

Default value is 1

itemsPerPage

Items to return on each page. See page parameter above.

integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfPatientSharedFileModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.

ItemsPerPage

integer

None.

CurrentPage

integer

None.

TotalPages

integer

None.

FirstRowOnPage

integer

None.

LastRowOnPage

integer

None.

Rows

Collection of PatientSharedFileModel

None.

Response Formats

application/json, text/json

Sample:
{
  "totalItems": 1,
  "itemsPerPage": 2,
  "currentPage": 3,
  "totalPages": 4,
  "firstRowOnPage": 5,
  "lastRowOnPage": 6,
  "rows": [
    {
      "id": 1,
      "patientExternalId": "sample string 2",
      "portalCreated": "2019-02-23T02:14:41.9259234-05:00",
      "displayName": "sample string 4",
      "fileName": "sample string 5",
      "patientComments": "sample string 6",
      "status": "sample string 7",
      "alreadySent": true,
      "sentOn": "2019-02-23T02:14:41.9259234-05:00",
      "downloadUrl": "sample string 9",
      "apiUrl": "sample string 10"
    },
    {
      "id": 1,
      "patientExternalId": "sample string 2",
      "portalCreated": "2019-02-23T02:14:41.9259234-05:00",
      "displayName": "sample string 4",
      "fileName": "sample string 5",
      "patientComments": "sample string 6",
      "status": "sample string 7",
      "alreadySent": true,
      "sentOn": "2019-02-23T02:14:41.9259234-05:00",
      "downloadUrl": "sample string 9",
      "apiUrl": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:
<ListModelOfPatientSharedFileModelq_Pvgcs2B xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Patients.PatientSharedFiles">
    <d2p1:PatientSharedFileModel>
      <d2p1:AlreadySent>true</d2p1:AlreadySent>
      <d2p1:ApiUrl>sample string 10</d2p1:ApiUrl>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:DownloadUrl>sample string 9</d2p1:DownloadUrl>
      <d2p1:FileName>sample string 5</d2p1:FileName>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:PatientComments>sample string 6</d2p1:PatientComments>
      <d2p1:PatientExternalId>sample string 2</d2p1:PatientExternalId>
      <d2p1:PortalCreated>2019-02-23T02:14:41.9259234-05:00</d2p1:PortalCreated>
      <d2p1:SentOn>2019-02-23T02:14:41.9259234-05:00</d2p1:SentOn>
      <d2p1:Status>sample string 7</d2p1:Status>
    </d2p1:PatientSharedFileModel>
    <d2p1:PatientSharedFileModel>
      <d2p1:AlreadySent>true</d2p1:AlreadySent>
      <d2p1:ApiUrl>sample string 10</d2p1:ApiUrl>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:DownloadUrl>sample string 9</d2p1:DownloadUrl>
      <d2p1:FileName>sample string 5</d2p1:FileName>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:PatientComments>sample string 6</d2p1:PatientComments>
      <d2p1:PatientExternalId>sample string 2</d2p1:PatientExternalId>
      <d2p1:PortalCreated>2019-02-23T02:14:41.9259234-05:00</d2p1:PortalCreated>
      <d2p1:SentOn>2019-02-23T02:14:41.9259234-05:00</d2p1:SentOn>
      <d2p1:Status>sample string 7</d2p1:Status>
    </d2p1:PatientSharedFileModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfPatientSharedFileModelq_Pvgcs2B>