POST Worklist/FetchNextStudy?identifier={identifier}&clientID={clientID}

Retrieves the next study item having the given name and matching the criteria in the request.

Request Information

URI Parameters

Name	Description	Type	Additional information
identifier	Worklist Name	string	Required
clientID	Unique client identification number.	string	Required

Body Parameters

Parameters required to filter,sort and get next study item

WorklistFetchNextStudyRequest

Name	Description	Type	Additional information
TargetDataSources	Gets or sets the TargetDataSources.	Collection of string	None.
OffsetCriteria	Gets or sets the filters.	Collection of ListFilter	None.
Sorts	Gets or sets the sorts.	Collection of ListSort	None.
Skip	Gets or sets a value indicating whether this is skip.	boolean	None.
PickFromTop	Gets or sets a value indicating whether [pick from top].	boolean	None.
Filters	Gets or sets the query filters.	Collection of ListFilter	None.
StudyUid		integer	None.
UserLogin	Gets or sets the user login.	string	None.
WorklistType	Gets or sets the worklist type indicating whether this request is for a QBE ,Legacy.	WorklistType	None.
Culture	Gets or sets the client culture.	string	None.
GetNonDicomContent		boolean	None.
VnaSetting		VnaSettings	None.
SCVSetting		SCVSettings	None.
EpiphanySetting		EpiphanySettings	None.

Request Formats

application/json, text/json

Sample:

{
  "TargetDataSources": [
    "sample string 1",
    "sample string 2"
  ],
  "OffsetCriteria": [
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Value": "sample string 3",
      "ValueList": [
        "sample string 1",
        "sample string 2"
      ],
      "SecondValue": "sample string 4",
      "IsLocalizable": true,
      "Group": 6,
      "DataType": "sample string 7"
    },
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Value": "sample string 3",
      "ValueList": [
        "sample string 1",
        "sample string 2"
      ],
      "SecondValue": "sample string 4",
      "IsLocalizable": true,
      "Group": 6,
      "DataType": "sample string 7"
    }
  ],
  "Sorts": [
    {
      "Column": "sample string 1",
      "Direction": 1
    },
    {
      "Column": "sample string 1",
      "Direction": 1
    }
  ],
  "Skip": true,
  "PickFromTop": true,
  "Filters": [
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Value": "sample string 3",
      "ValueList": [
        "sample string 1",
        "sample string 2"
      ],
      "SecondValue": "sample string 4",
      "IsLocalizable": true,
      "Group": 6,
      "DataType": "sample string 7"
    },
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Value": "sample string 3",
      "ValueList": [
        "sample string 1",
        "sample string 2"
      ],
      "SecondValue": "sample string 4",
      "IsLocalizable": true,
      "Group": 6,
      "DataType": "sample string 7"
    }
  ],
  "StudyUid": 3,
  "UserLogin": "sample string 4",
  "WorklistType": 0,
  "Culture": "sample string 5",
  "GetNonDicomContent": true,
  "VnaSetting": {
    "QidoApiBaseUrl": "sample string 1",
    "RestApiBaseUrl": "sample string 2",
    "VnaHostName": "sample string 3",
    "VnaAuthorizationUser": "sample string 4",
    "VnaAuthorizationPassword": "sample string 5",
    "ClientSecret": "sample string 6",
    "TargetOrganizationName": "sample string 7",
    "RetrieveCacheExpirationMinutes": 8,
    "FinalizedStatusCode": 9,
    "DataSourceName": "sample string 10",
    "VnaUserAgent": "sample string 11",
    "IsVnaECVConfigured": true,
    "IsVnaICVConfigured": true,
    "VNAAuthMode": 0
  },
  "SCVSetting": {
    "DataSourceName": "sample string 1",
    "SCVLogin": "sample string 2",
    "SCVPassword": "sample string 3",
    "SCVDatabase": "sample string 4",
    "SCVImageDirectory": "sample string 5",
    "SCVDicomDatabase": "sample string 6",
    "SCVSqlServer": "sample string 7",
    "IsScvECVConfigured": true,
    "IsScvICVConfigured": true,
    "SCVReportTxtDir": "sample string 10",
    "SCVCommonViewConfiguration": [
      {
        "LastName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "FirstName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "PatientUid": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "SuffixName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "MiddleName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "Gender": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "DateOfBirth": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "Match": 1
      },
      {
        "LastName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "FirstName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "PatientUid": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "SuffixName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "MiddleName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "Gender": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "DateOfBirth": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "Match": 1
      }
    ]
  },
  "EpiphanySetting": {
    "DatabaseProperties": {
      "Username": "sample string 1",
      "Password": "sample string 2",
      "Hostname": "sample string 3",
      "Port": 4,
      "Schema": "sample string 5",
      "MaxCacheSize": 6
    },
    "CommonViewConfiguration": [
      {
        "LastName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "FirstName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "PatientUid": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "SuffixName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "MiddleName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "Gender": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "DateOfBirth": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "Match": 1
      },
      {
        "LastName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "FirstName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "PatientUid": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "SuffixName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "MiddleName": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "Gender": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "DateOfBirth": {
          "IsConfigured": true,
          "IncludeNumberOfChar": 2
        },
        "Match": 1
      }
    ],
    "isEpiphanyCommonViewEnabled": true,
    "BaseUri": "sample string 2"
  }
}

Response Information

Resource Description

WorklistFetchNextStudyResult

Name	Description	Type	Additional information
Succeeded	Gets or sets a value indicating whether this is succeeded.	boolean	None.
EndOfList	Gets or sets a value indicating whether [end of list].	boolean	None.
NextStudy	Gets or sets the next study.	IStudy	None.

Response Formats

application/json, text/json

Sample:

{
  "Succeeded": true,
  "EndOfList": true,
  "NextStudy": null
}

application/xml, text/xml

Sample:

<WorklistFetchNextStudyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Worklists">
  <Version xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:_Build>-1</d2p1:_Build>
    <d2p1:_Major>0</d2p1:_Major>
    <d2p1:_Minor>0</d2p1:_Minor>
    <d2p1:_Revision>-1</d2p1:_Revision>
  </Version>
  <EndOfList>true</EndOfList>
  <NextStudy xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.DAL.Model.Worklist.KnownType" i:nil="true" />
  <Succeeded>true</Succeeded>
</WorklistFetchNextStudyResult>