POST Study/GetStudyByIuid?iuid={iuid}&dataSource={dataSource}

Request Information

URI Parameters

Name	Description	Type	Additional information
iuid		string	Required
dataSource		string	Required

Body Parameters

SCVSettings

Name	Type	Additional information
DataSourceName	string	None.
SCVLogin	string	None.
SCVPassword	string	None.
SCVDatabase	string	None.
SCVImageDirectory	string	None.
SCVDicomDatabase	string	None.
SCVSqlServer	string	None.
IsScvECVConfigured	boolean	None.
IsScvICVConfigured	boolean	None.
SCVReportTxtDir	string	None.
SCVCommonViewConfiguration	Collection of ExtraneousCommonViewConfiguration	None.

Request Formats

application/json, text/json

Sample:

{
  "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
    }
  ]
}

application/xml, text/xml

Sample:

<SCVSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Worklists">
  <DataSourceName>sample string 1</DataSourceName>
  <IsScvECVConfigured>true</IsScvECVConfigured>
  <IsScvICVConfigured>true</IsScvICVConfigured>
  <SCVCommonViewConfiguration xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.WebApi.Core.Models.MultiDataSource">
    <d2p1:ExtraneousCommonViewConfiguration>
      <d2p1:DateOfBirth>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:DateOfBirth>
      <d2p1:FirstName>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:FirstName>
      <d2p1:Gender>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:Gender>
      <d2p1:LastName>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:LastName>
      <d2p1:Match>1</d2p1:Match>
      <d2p1:MiddleName>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:MiddleName>
      <d2p1:PatientUid>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:PatientUid>
      <d2p1:SuffixName>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:SuffixName>
    </d2p1:ExtraneousCommonViewConfiguration>
    <d2p1:ExtraneousCommonViewConfiguration>
      <d2p1:DateOfBirth>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:DateOfBirth>
      <d2p1:FirstName>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:FirstName>
      <d2p1:Gender>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:Gender>
      <d2p1:LastName>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:LastName>
      <d2p1:Match>1</d2p1:Match>
      <d2p1:MiddleName>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:MiddleName>
      <d2p1:PatientUid>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:PatientUid>
      <d2p1:SuffixName>
        <d2p1:IncludeNumberOfChar>2</d2p1:IncludeNumberOfChar>
        <d2p1:IsConfigured>true</d2p1:IsConfigured>
      </d2p1:SuffixName>
    </d2p1:ExtraneousCommonViewConfiguration>
  </SCVCommonViewConfiguration>
  <SCVDatabase>sample string 4</SCVDatabase>
  <SCVDicomDatabase>sample string 6</SCVDicomDatabase>
  <SCVImageDirectory>sample string 5</SCVImageDirectory>
  <SCVLogin>sample string 2</SCVLogin>
  <SCVPassword>sample string 3</SCVPassword>
  <SCVReportTxtDir>sample string 10</SCVReportTxtDir>
  <SCVSqlServer>sample string 7</SCVSqlServer>
</SCVSettings>

Response Information

Resource Description

Study

Name	Description	Type	Additional information
Uuid	Gets or sets the unique identifier	string	None.
StudyStatusCode	Gets or sets the study status.	integer	None.
Modality	Gets or sets the modality.	string	None.
PatientUuid	Gets or sets the PatientUuid.	string	None.
PatientFullName	Gets or sets the PatientFullName.	string	None.
MRN	Gets or sets the MRN.	string	None.
HasReport	Gets or sets if the Study has a report.	boolean	None.
Reports	Gets or sets the list of reports	Collection of Report	None.
Procedure	Gets or sets the procedure	Procedure	None.
ProcedureDescription	Gets or sets the procedureDescription	string	None.
PerformedDate	Gets or sets the Date Performed	date	None.
LastModifiedTimestamp		date	None.
AccessionNumber	Gets or sets the Accession Number	string	None.
VisitNumber	Gets or sets the visit number - VISIT_NUMBER	string	None.
OrderId	Gets or sets the Order Number - RIS_Order_EUID	string	None.
SiteName	Gets or sets the siteName	string	None.
ssn		string	None.
DataSource		string	None.
IsValidForAR		boolean	None.
FolderName		string	None.
IsValidForArReport		boolean	None.
FolderDescription		string	None.
HasARReportInstance		boolean	None.
IsARProcedure		boolean	None.
OrgName		string	None.
DOB		date	None.
ExternalPatientID		string	None.
FirstName		string	None.
LastName		string	None.
MiddleName		string	None.
Suffix		string	None.
Gender		string	None.
PrimaryLocation		string	None.
Priority		string	None.
ReasonForExam		string	None.
ReferringPhysician		string	None.
RequestingPhysician		string	None.
SiteCode		string	None.
StudyId		string	None.
StudyTimeStamp		string	None.
VisitClass		string	None.
IsArchived		boolean	None.
IsCVMigrated		boolean	None.
DataSourceType		DataSourceType	None.
AttendingPhysician		string	None.
ReferringPhysicianPhone		string	None.
RequestingPhysicianPhone		string	None.
AttendingPhysicianPhone		string	None.
ReferringPhysicianPager		string	None.
RequestingPhysicianPager		string	None.
AttendingPhysicianPager		string	None.
AdmissionDate		date	None.
LastMenstruationDate		date	None.
Pregnancy		string	None.
CurrentLocation		string	None.
PatientAgeMonths		integer	None.
PatientAgeYears		integer	None.
LocaleIndependentDOB		date	None.

Response Formats

application/json, text/json

Sample:

{
  "Uuid": "sample string 1",
  "StudyStatusCode": 2,
  "Modality": "sample string 3",
  "PatientUuid": "sample string 4",
  "PatientFullName": "sample string 5",
  "MRN": "sample string 6",
  "HasReport": true,
  "Reports": [
    {
      "Uuid": "sample string 1",
      "Content": "sample string 2",
      "Finalized": "2025-12-12T21:23:15",
      "Saved": "2025-12-12T21:23:15",
      "CreatorUuid": "sample string 3",
      "ReportTypeUuid": "sample string 4",
      "ReportStatusId": 5,
      "Mg": [
        {
          "Uuid": "sample string 1",
          "Label": "sample string 2",
          "ReportContent": "sample string 3",
          "Code": "sample string 4"
        },
        {
          "Uuid": "sample string 1",
          "Label": "sample string 2",
          "ReportContent": "sample string 3",
          "Code": "sample string 4"
        }
      ]
    },
    {
      "Uuid": "sample string 1",
      "Content": "sample string 2",
      "Finalized": "2025-12-12T21:23:15",
      "Saved": "2025-12-12T21:23:15",
      "CreatorUuid": "sample string 3",
      "ReportTypeUuid": "sample string 4",
      "ReportStatusId": 5,
      "Mg": [
        {
          "Uuid": "sample string 1",
          "Label": "sample string 2",
          "ReportContent": "sample string 3",
          "Code": "sample string 4"
        },
        {
          "Uuid": "sample string 1",
          "Label": "sample string 2",
          "ReportContent": "sample string 3",
          "Code": "sample string 4"
        }
      ]
    }
  ],
  "Procedure": {
    "Uuid": "sample string 1",
    "Code": "sample string 2",
    "IsBiradRequired": true,
    "FirstTemplate": {
      "Uuid": "sample string 1",
      "Label": "sample string 2",
      "Content": "sample string 3"
    },
    "SecondTemplate": {
      "Uuid": "sample string 1",
      "Label": "sample string 2",
      "Content": "sample string 3"
    }
  },
  "ProcedureDescription": "sample string 8",
  "PerformedDate": "2025-12-12T21:23:15",
  "LastModifiedTimestamp": "2025-12-12T21:23:15",
  "AccessionNumber": "sample string 9",
  "VisitNumber": "sample string 10",
  "OrderId": "sample string 11",
  "SiteName": "sample string 12",
  "ssn": "sample string 13",
  "DataSource": "sample string 14",
  "IsValidForAR": true,
  "FolderName": "sample string 16",
  "IsValidForArReport": true,
  "FolderDescription": "sample string 18",
  "HasARReportInstance": true,
  "IsARProcedure": true,
  "OrgName": "sample string 21",
  "DOB": "2025-12-12T21:23:15",
  "ExternalPatientID": "sample string 22",
  "FirstName": "sample string 23",
  "LastName": "sample string 24",
  "MiddleName": "sample string 25",
  "Suffix": "sample string 26",
  "Gender": "sample string 27",
  "PrimaryLocation": "sample string 28",
  "Priority": "sample string 29",
  "ReasonForExam": "sample string 30",
  "ReferringPhysician": "sample string 31",
  "RequestingPhysician": "sample string 32",
  "SiteCode": "sample string 33",
  "StudyId": "sample string 34",
  "StudyTimeStamp": "sample string 35",
  "VisitClass": "sample string 36",
  "IsArchived": true,
  "IsCVMigrated": true,
  "DataSourceType": 0,
  "AttendingPhysician": "sample string 39",
  "ReferringPhysicianPhone": "sample string 40",
  "RequestingPhysicianPhone": "sample string 41",
  "AttendingPhysicianPhone": "sample string 42",
  "ReferringPhysicianPager": "sample string 43",
  "RequestingPhysicianPager": "sample string 44",
  "AttendingPhysicianPager": "sample string 45",
  "AdmissionDate": "2025-12-12T21:23:15",
  "LastMenstruationDate": "2025-12-12T21:23:15",
  "Pregnancy": "sample string 46",
  "CurrentLocation": "sample string 47",
  "PatientAgeMonths": 1,
  "PatientAgeYears": 1,
  "LocaleIndependentDOB": "2025-12-12T21:23:15"
}

application/xml, text/xml

Sample:

<Study xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Study">
  <AccessionNumber>sample string 9</AccessionNumber>
  <AdmissionDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-13T03:23:15.4015929Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-360</d2p1:OffsetMinutes>
  </AdmissionDate>
  <AttendingPhysician>sample string 39</AttendingPhysician>
  <AttendingPhysicianPager>sample string 45</AttendingPhysicianPager>
  <AttendingPhysicianPhone>sample string 42</AttendingPhysicianPhone>
  <CurrentLocation>sample string 47</CurrentLocation>
  <DOB xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-13T03:23:15.4015929Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-360</d2p1:OffsetMinutes>
  </DOB>
  <DataSource>sample string 14</DataSource>
  <DataSourceType>Synapse</DataSourceType>
  <ExternalPatientID>sample string 22</ExternalPatientID>
  <FirstName>sample string 23</FirstName>
  <FolderDescription>sample string 18</FolderDescription>
  <FolderName>sample string 16</FolderName>
  <Gender>sample string 27</Gender>
  <HasARReportInstance>true</HasARReportInstance>
  <HasReport>true</HasReport>
  <IsARProcedure>true</IsARProcedure>
  <IsArchived>true</IsArchived>
  <IsCVMigrated>true</IsCVMigrated>
  <IsValidForAR>true</IsValidForAR>
  <IsValidForArReport>true</IsValidForArReport>
  <LastMenstruationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-13T03:23:15.4015929Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-360</d2p1:OffsetMinutes>
  </LastMenstruationDate>
  <LastModifiedTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-13T03:23:15.4015929Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-360</d2p1:OffsetMinutes>
  </LastModifiedTimestamp>
  <LastName>sample string 24</LastName>
  <LocaleIndependentDOB xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-13T03:23:15.4015929Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-360</d2p1:OffsetMinutes>
  </LocaleIndependentDOB>
  <MRN>sample string 6</MRN>
  <MiddleName>sample string 25</MiddleName>
  <Modality>sample string 3</Modality>
  <OrderId>sample string 11</OrderId>
  <OrgName>sample string 21</OrgName>
  <PatientAgeMonths>1</PatientAgeMonths>
  <PatientAgeYears>1</PatientAgeYears>
  <PatientFullName>sample string 5</PatientFullName>
  <PatientUuid>sample string 4</PatientUuid>
  <PerformedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-13T03:23:15.4015929Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-360</d2p1:OffsetMinutes>
  </PerformedDate>
  <Pregnancy>sample string 46</Pregnancy>
  <PrimaryLocation>sample string 28</PrimaryLocation>
  <Priority>sample string 29</Priority>
  <Procedure>
    <Code>sample string 2</Code>
    <FirstTemplate xmlns:d3p1="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Reports">
      <d3p1:Content>sample string 3</d3p1:Content>
      <d3p1:Label>sample string 2</d3p1:Label>
      <d3p1:Uuid>sample string 1</d3p1:Uuid>
    </FirstTemplate>
    <IsBiradRequired>true</IsBiradRequired>
    <SecondTemplate xmlns:d3p1="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Reports">
      <d3p1:Content>sample string 3</d3p1:Content>
      <d3p1:Label>sample string 2</d3p1:Label>
      <d3p1:Uuid>sample string 1</d3p1:Uuid>
    </SecondTemplate>
    <Uuid>sample string 1</Uuid>
  </Procedure>
  <ProcedureDescription>sample string 8</ProcedureDescription>
  <ReasonForExam>sample string 30</ReasonForExam>
  <ReferringPhysician>sample string 31</ReferringPhysician>
  <ReferringPhysicianPager>sample string 43</ReferringPhysicianPager>
  <ReferringPhysicianPhone>sample string 40</ReferringPhysicianPhone>
  <Reports xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Reports">
    <d2p1:Report>
      <d2p1:Content>sample string 2</d2p1:Content>
      <d2p1:CreatorUuid>sample string 3</d2p1:CreatorUuid>
      <d2p1:Finalized>2025-12-12T21:23:15.4015929-06:00</d2p1:Finalized>
      <d2p1:Mg>
        <d2p1:Birad>
          <d2p1:Code>sample string 4</d2p1:Code>
          <d2p1:Label>sample string 2</d2p1:Label>
          <d2p1:ReportContent>sample string 3</d2p1:ReportContent>
          <d2p1:Uuid>sample string 1</d2p1:Uuid>
        </d2p1:Birad>
        <d2p1:Birad>
          <d2p1:Code>sample string 4</d2p1:Code>
          <d2p1:Label>sample string 2</d2p1:Label>
          <d2p1:ReportContent>sample string 3</d2p1:ReportContent>
          <d2p1:Uuid>sample string 1</d2p1:Uuid>
        </d2p1:Birad>
      </d2p1:Mg>
      <d2p1:ReportStatusId>5</d2p1:ReportStatusId>
      <d2p1:ReportTypeUuid>sample string 4</d2p1:ReportTypeUuid>
      <d2p1:Saved>2025-12-12T21:23:15.4015929-06:00</d2p1:Saved>
      <d2p1:Uuid>sample string 1</d2p1:Uuid>
    </d2p1:Report>
    <d2p1:Report>
      <d2p1:Content>sample string 2</d2p1:Content>
      <d2p1:CreatorUuid>sample string 3</d2p1:CreatorUuid>
      <d2p1:Finalized>2025-12-12T21:23:15.4015929-06:00</d2p1:Finalized>
      <d2p1:Mg>
        <d2p1:Birad>
          <d2p1:Code>sample string 4</d2p1:Code>
          <d2p1:Label>sample string 2</d2p1:Label>
          <d2p1:ReportContent>sample string 3</d2p1:ReportContent>
          <d2p1:Uuid>sample string 1</d2p1:Uuid>
        </d2p1:Birad>
        <d2p1:Birad>
          <d2p1:Code>sample string 4</d2p1:Code>
          <d2p1:Label>sample string 2</d2p1:Label>
          <d2p1:ReportContent>sample string 3</d2p1:ReportContent>
          <d2p1:Uuid>sample string 1</d2p1:Uuid>
        </d2p1:Birad>
      </d2p1:Mg>
      <d2p1:ReportStatusId>5</d2p1:ReportStatusId>
      <d2p1:ReportTypeUuid>sample string 4</d2p1:ReportTypeUuid>
      <d2p1:Saved>2025-12-12T21:23:15.4015929-06:00</d2p1:Saved>
      <d2p1:Uuid>sample string 1</d2p1:Uuid>
    </d2p1:Report>
  </Reports>
  <RequestingPhysician>sample string 32</RequestingPhysician>
  <RequestingPhysicianPager>sample string 44</RequestingPhysicianPager>
  <RequestingPhysicianPhone>sample string 41</RequestingPhysicianPhone>
  <SiteCode>sample string 33</SiteCode>
  <SiteName>sample string 12</SiteName>
  <StudyId>sample string 34</StudyId>
  <StudyStatusCode>2</StudyStatusCode>
  <StudyTimeStamp>sample string 35</StudyTimeStamp>
  <Suffix>sample string 26</Suffix>
  <Uuid>sample string 1</Uuid>
  <VisitClass>sample string 36</VisitClass>
  <VisitNumber>sample string 10</VisitNumber>
  <ssn>sample string 13</ssn>
</Study>