POST Orders/CopyOrderToStudy

Request Information

URI Parameters

None.

Body Parameters

Order
NameDescriptionTypeAdditional information
MRN

string

None.

Name

string

None.

SchedProcStepDescription

string

None.

AccessionNumber

string

None.

OrderNumber

string

None.

SchedProcStepStartDate

string

None.

Modality

string

None.

Owner

string

None.

FirstName

string

None.

LastName

string

None.

MiddleInitial

string

None.

BirthDate

string

None.

Sex

string

None.

OtherPatientFN

string

None.

SSN

string

None.

Priority

string

None.

ReasonForExam

string

None.

ReferringNPI

string

None.

ReferringPhysician

string

None.

Status

string

None.

StudyInstanceUID

string

None.

SchedProcStepLocation

string

None.

AdmittingDiagnosis

string

None.

Source

string

None.

StudyDateInt

string

None.

StatusCode

string

None.

RequestingPhysician

string

None.

SchedProcStepID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "MRN": "sample string 1",
  "Name": "sample string 2",
  "SchedProcStepDescription": "sample string 3",
  "AccessionNumber": "sample string 4",
  "OrderNumber": "sample string 5",
  "SchedProcStepStartDate": "sample string 6",
  "Modality": "sample string 7",
  "Owner": "sample string 8",
  "FirstName": "sample string 9",
  "LastName": "sample string 10",
  "MiddleInitial": "sample string 11",
  "BirthDate": "sample string 12",
  "Sex": "sample string 13",
  "OtherPatientFN": "sample string 14",
  "SSN": "sample string 15",
  "Priority": "sample string 16",
  "ReasonForExam": "sample string 17",
  "ReferringNPI": "sample string 18",
  "ReferringPhysician": "sample string 19",
  "Status": "sample string 20",
  "StudyInstanceUID": "sample string 21",
  "SchedProcStepLocation": "sample string 22",
  "AdmittingDiagnosis": "sample string 23",
  "Source": "sample string 24",
  "StudyDateInt": "sample string 25",
  "StatusCode": "sample string 26",
  "RequestingPhysician": "sample string 27",
  "SchedProcStepID": "sample string 28"
}

application/xml, text/xml

Sample:
<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PicomRest.PicomWeb">
  <AccessionNumber>sample string 4</AccessionNumber>
  <AdmittingDiagnosis>sample string 23</AdmittingDiagnosis>
  <BirthDate>sample string 12</BirthDate>
  <FirstName>sample string 9</FirstName>
  <LastName>sample string 10</LastName>
  <MRN>sample string 1</MRN>
  <MiddleInitial>sample string 11</MiddleInitial>
  <Modality>sample string 7</Modality>
  <Name>sample string 2</Name>
  <OrderNumber>sample string 5</OrderNumber>
  <OtherPatientFN>sample string 14</OtherPatientFN>
  <Owner>sample string 8</Owner>
  <Priority>sample string 16</Priority>
  <ReasonForExam>sample string 17</ReasonForExam>
  <ReferringNPI>sample string 18</ReferringNPI>
  <ReferringPhysician>sample string 19</ReferringPhysician>
  <RequestingPhysician>sample string 27</RequestingPhysician>
  <SSN>sample string 15</SSN>
  <SchedProcStepDescription>sample string 3</SchedProcStepDescription>
  <SchedProcStepID>sample string 28</SchedProcStepID>
  <SchedProcStepLocation>sample string 22</SchedProcStepLocation>
  <SchedProcStepStartDate>sample string 6</SchedProcStepStartDate>
  <Sex>sample string 13</Sex>
  <Source>sample string 24</Source>
  <Status>sample string 20</Status>
  <StatusCode>sample string 26</StatusCode>
  <StudyDateInt>sample string 25</StudyDateInt>
  <StudyInstanceUID>sample string 21</StudyInstanceUID>
</Order>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Order'.

Response Information

Resource Description

Study
NameDescriptionTypeAdditional information
Patient

Patient

None.

StudyDate

string

None.

StudyDesc

string

None.

Acc

string

None.

MRN

string

None.

ReadPhys

string

None.

ReaderId

string

None.

Source

string

None.

Status

string

None.

StatusColor

string

None.

Mod

string

None.

Modalities

string

None.

Owner

string

None.

SUID

string

None.

StudyDateInt

integer

None.

FollowUpDate

integer

None.

FollowUpDateString

string

None.

ServerDirName

string

None.

ServerDirName_ForWeb

string

None.

Procedure

string

None.

ArchiveInfo

string

None.

Remarks

string

None.

AccountType

string

None.

Notes

string

None.

RefPhys

string

None.

RefId

string

None.

Height

decimal number

None.

Weight

decimal number

None.

Priority

string

None.

OrderNum

string

None.

OrderingPhys

string

None.

Reason

string

None.

Diagnosis

string

None.

Location

string

None.

CPTCodes

Collection of string

None.

ICDCodes

Collection of string

None.

PrivateAlerts

string

None.

Tech

string

None.

Followup

string

None.

Bodypart

string

None.

examcode

string

None.

imageNum

string

None.

Dose

decimal number

None.

Unread

string

None.

OnlineStatus

integer

None.

SearchParam

Search

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'PicomRest.PicomWeb.Study'. Path 'Patient.StudyList'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'PicomRest.PicomWeb.Study'. Path 'Patient.StudyList'.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[PicomRest.PicomWeb.Study, PicomRest, Version=1.0.0.5, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[PicomRest.PicomWeb.Study, PicomRest, Version=1.0.0.5, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.