Post Order

Overview

This channel is responsible for receiving order requests via HTTP and forwarding unique orders to the VannahPacs.

Order Submission

Request URL: http://192.168.2.10:6663

Note. Use the IP Address of the PACS Server with the Port above.

Request Body (JSON):

Below is an example of a complete request body:

{
  "AccessionNumber": "AN7722014890",
  "PatientName": "TEMBO^BRIAN^CHILOMBO",
  "PatientID": "ZM55901",
  "PatientBirthDate": "19870527",
  "PatientSex": "M",
  "ReferringPhysicianName": "ZULU^MERCY^TENDANI",
  "AdmissionID": "ZM378",
  "RequestingPhysician": "MWAPE^ALICK^NKHONYA",
  "RequestedProcedureDescription": "Chest X-Ray",
  "ScheduledProcedureStepSequence": [
    {
      "Modality": "CR",
      "ScheduledStationName": "XRAY_BAY_1",
      "ScheduledProcedureStepLocation": "GENERAL_RADIOLOGY",
      "ScheduledProcedureStepDescription": "Chest X-Ray AP View"
    }
  ],
  "RequestedProcedurePriority": "ROUTINE"
}

The body of the request must be a JSON object containing the order details. Below is a description of each field.

Field	Type	Description	Example
AccessionNumber	String	A unique identifier for the imaging study. This number is crucial for tracking the order throughout the entire radiology workflow.	"AN7722014890"
PatientName	String	The full name of the patient, formatted as LASTNAME^FIRSTNAME^MIDDLENAME.	"TEMBO^BRIAN^CHILOMBO"
PatientID	String	The patient's unique medical record number (MRN) or other institutional identifier.	"ZM55901"
PatientBirthDate	String	The patient's date of birth in YYYYMMDD format.	"19870527"
PatientSex	String	The patient's gender (M for Male, F for Female, O for Other).	"M"
ReferringPhysicianName	String	The name of the physician who requested the procedure.	"ZULU^MERCY^TENDANI"
AdmissionID	String	An optional identifier for the patient's hospital admission, if applicable.	"ZM378"
RequestingPhysician	String	The physician placing the order in the system. May differ from the referring physician.	"MWAPE^ALICK^NKHONYA"
RequestedProcedureDescription	String	A high-level description of the ordered procedure.	"Chest X-Ray"
ScheduledProcedureStepSequence	Array	An array of objects, where each object defines a specific step of the procedure.	[...]
...Modality	String	The imaging modality to be used (e.g., CR for Computed Radiography, CT, MR).	"CR"
...ScheduledStationName	String	The specific imaging device or room where the procedure is scheduled.	"XRAY_BAY_1"
...ScheduledProcedureStepLocation	String	The clinical department or location for the procedure.	"GENERAL_RADIOLOGY"
...ScheduledProcedureStepDescription	String	A detailed description of the specific view or part of the procedure.	"Chest X-Ray AP View"
RequestedProcedurePriority	String	The urgency of the procedure. Common values are ROUTINE, STAT (urgent), or ASAP.	"ROUTINE"

Expected Responses

After a successful transmission to VannahPacs, the channel returns the following HTTP responses basing on what is sent:

(1) A New Doctor's Order has been sent to PACS

{
    "status": "successfully",
    "message": "Order sent to PACS"
}

(2) The Doctor's Order already exists in PACS

{
    "status": "failed",
    "message": "Request not sent: This order has already been scheduled."
}

(3) The Doctor's Order doesn't meet the required criteria to be sent to PACS. List of fields with values that must be present are PatientID, PatientName, PatientSex, PatientBirthDate and AccessionNumber.

{
    "status": "failed",
    "message": "Request not sent: Missing required data fields: PatientName"
}

(4) The Doctor's Order is missing the required scheduled procedure step array.This is a must to be there in the JSON Object because it tells the system what scan or test needs to be done, so the imaging machine and PACS know exactly what to schedule and perform for the patient.

{
    "status": "failed",
    "message": "Request not sent: Missing required procedure detail block."
}

(5) The Doctor's Order is missing the ScheduledProcedureStepDescription that describes what procedure or exam should be done (for example, “CT Brain without contrast” or “Chest X-Ray”).

{
    "status": "failed",
    "message": "Request not sent: Missing required data fields: ScheduledProcedureStepDescription"
}