GET api/v1/{EMRSystem}/SurgicalCases/{SurgicalCaseId}

Returns surgical case by surgical case id

Status: Beta

URI Parameters

Name	Description	Type	Additional information
EMRSystem	The emr system.	EMRSystem	None.
SurgicalCaseId	Gets or sets surgical case id.	string	Required
UserId	Gets or sets the user identifier.	string	Required
IncludeBody	Flag to determine if surgical reports are included.	boolean	None.
IncludeSurgicalDetails	Flag to determine if surgical details are included.	boolean	None.

Header Parameters

Name	Description	Type	Additional information
LoginId	Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Password	Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
EmrInstance	Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
ApplicationName	Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers.	string	Required if using application keys
ApplicationKey	Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers.	string	Data type: Password Required if using application keys
AuthorizationToken	Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers.	string	None.
RequestVerboseLogging	Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers.	boolean	None.

Response Information

UdmSurgicalCaseResponse

Name	Description	Type	Additional information
AdministeredBloodProducts	Gets or sets the to administered blood products.	Collection of AdministeredBloodProduct	None.
AnesthesiaStaffCost	Gets or sets the anesthesia staff cost.	string	None.
AnesthesiaType	Gets or sets the anesthesia type.	CodedObject	None.
AnesthesiaTypeLocations	Gets or sets the anesthesia type locations.	Collection of AnesthesiaTypeLocation	None.
ASAClass	Gets or sets the to ASA class.	CodedObject	None.
CaseBlocks	Gets or sets the case blocks.	Collection of CaseBlock	None.
CaseClass	Gets or sets the case class.	CodedObject	None.
CaseCreationDateTime	Gets or sets the case creation datetime.	datetime	None.
CaseDelays	Gets or sets the case delays.	Collection of CaseDelay	None.
CleanUpDuration	Gets or sets the cleanup duration.	Duration	None.
Complexity	Gets or sets the complexity.	CodedObject	None.
CreatedUpdatedDateTime	Gets or sets the created updated datetime.	datetime	None.
Encounter	Gets or sets the encounter.	Encounter	None.
EstimatedBloodLoss	Gets or sets the estimated blood loss.	string	None.
EstimatedBloodLossUnit	Gets or sets the estimated blood loss unit.	CodedObject	None.
IsAddOn	Gets or sets the is add on value.	boolean	None.
IsFirstCase	Gets or sets the is first case value.	boolean	None.
NumberOfPanels	Gets or sets the number of panels.	string	None.
OperatingRoomId	Gets or sets the operating room identifier.	string	None.
OperatingRoomName	Gets or sets the operating room name.	string	None.
Patient	Gets or sets the patient.	BasePatient	None.
PendingStatus	Gets or sets the pending status.	CodedObject	None.
PreOpAppointments	Gets or sets the to pre-op appointments.	Collection of PreOpAppointment	None.
PreOpPreperations	Gets or sets the to pre-op preperations.	Collection of PreOpPreperation	None.
ProgressStatus	Gets or sets the progress status.	CodedObject	None.
ProjectedStartDateTime	Gets or sets the case projected start datetime.	datetime	None.
ProjectedEndDateTime	Gets or sets the case projected end datetime.	datetime	None.
SchedulingStatus	Gets or sets the scheduling status.	CodedObject	None.
SetUpDuration	Gets or sets the setup duration.	Duration	None.
SurgeonCost	Gets or sets the surgeon cost.	string	None.
SurgeryStartDateTime	Gets or sets the to surgery start datetime.	datetime	None.
SurgeryEndDateTime	Gets or sets the to surgery end datetime.	datetime	None.
SurgicalCaseId	Gets or sets the surgical case identifier.	string	None.
SurgicalCaseName	Gets or sets the surgical case name.	string	None.
SurgicalDetails	Gets or sets the surgical details.	Collection of FormValues	None.
SurgicalEvents	Gets or sets the surgical events.	Collection of SurgicalEvent	None.
SurgicalProcedures	Gets or sets the surgical procedures.	Collection of SurgicalProcedure	None.
SurgicalReports	Gets or sets the surgical reports.	Collection of SurgicalReport	None.
SurgicalService	Gets or sets the surgical service.	CodedObject	None.
SurgicalStaff	Gets or sets the surgical staff.	Collection of SurgicalStaff	None.
SurgicalStaffCost	Gets or sets the surgical staff cost.	string	None.
TimeOut	Gets or sets the time out.	TimeOut	None.
TotalCost	Gets or sets the total cost.	string	None.
TotalDuration	Gets or sets the total duration.	Duration	None.

Response Codes

Http Status Code 200 - Indicates that the request was processed successfully.

Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.

Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.

Http Status Code 403 - Indicates that there is an issue with the request UserId.

Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.

Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.

Response Formats

application/json

{
  "AdministeredBloodProducts": [
    {
      "BloodProduct": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EstimatedAmount": "sample string 1",
      "Unit": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "BloodProduct": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EstimatedAmount": "sample string 1",
      "Unit": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ],
  "AnesthesiaStaffCost": "sample string 1",
  "AnesthesiaType": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "AnesthesiaTypeLocations": [
    {
      "AnesthesiaLocation": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "AnesthesiaType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "AnesthesiaLocation": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "AnesthesiaType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ],
  "ASAClass": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "CaseBlocks": [
    {
      "BlockDuration": {
        "DurationUnit": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Time": "sample string 1"
      },
      "BlockType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "Surgeon": {
        "Name": "sample string 1",
        "NPI": "sample string 2",
        "UserId": "sample string 3",
        "ProviderId": "sample string 4"
      },
      "SurgeonGroup": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "SurgicalService": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "BlockDuration": {
        "DurationUnit": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Time": "sample string 1"
      },
      "BlockType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "Surgeon": {
        "Name": "sample string 1",
        "NPI": "sample string 2",
        "UserId": "sample string 3",
        "ProviderId": "sample string 4"
      },
      "SurgeonGroup": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "SurgicalService": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ],
  "CaseClass": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "CaseCreationDateTime": "2025-12-12T20:53:13.6885811+00:00",
  "CaseDelays": [
    {
      "DelayComment": "sample string 1",
      "DelayDuration": {
        "DurationUnit": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Time": "sample string 1"
      },
      "DelayReason": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "DelayComment": "sample string 1",
      "DelayDuration": {
        "DurationUnit": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Time": "sample string 1"
      },
      "DelayReason": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ],
  "CleanUpDuration": {
    "DurationUnit": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "Time": "sample string 1"
  },
  "Complexity": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "CreatedUpdatedDateTime": "2025-12-12T20:53:13.688985+00:00",
  "Encounter": {
    "EncounterId": "sample string 1",
    "EncounterType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "PatientClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "EncounterDateTime": "2025-12-12T20:53:13.6914097+00:00",
    "DischargeDateTime": "2025-12-12T20:53:13.691412+00:00",
    "FinancialNumber": "sample string 2",
    "Location": {
      "BedId": "sample string 1",
      "Bed": "sample string 2",
      "RoomId": "sample string 3",
      "Room": "sample string 4",
      "UnitId": "sample string 5",
      "Unit": "sample string 6",
      "HospitalId": "sample string 7",
      "Hospital": "sample string 8"
    }
  },
  "EstimatedBloodLoss": "sample string 2",
  "EstimatedBloodLossUnit": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "IsAddOn": true,
  "IsFirstCase": true,
  "NumberOfPanels": "sample string 5",
  "OperatingRoomId": "sample string 6",
  "OperatingRoomName": "sample string 7",
  "Patient": {
    "PatientId": "sample string 1",
    "DisplayName": "sample string 2",
    "LastName": "sample string 3",
    "FirstName": "sample string 4",
    "MiddleName": "sample string 5",
    "MRN": "sample string 6",
    "BirthDateTime": "2025-12-12T20:53:13.691796+00:00",
    "Gender": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "DeceasedDateTime": "2025-12-12T20:53:13.6917994+00:00"
  },
  "PendingStatus": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "PreOpAppointments": [
    {
      "AppointmentId": "sample string 1",
      "PreOpAppointmentId": "sample string 2",
      "Procedure": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "AppointmentId": "sample string 1",
      "PreOpAppointmentId": "sample string 2",
      "Procedure": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ],
  "PreOpPreperations": [
    {
      "Areas": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "Laterality": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "ScrubSolutions": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ]
    },
    {
      "Areas": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "Laterality": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "ScrubSolutions": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ]
    }
  ],
  "ProgressStatus": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "ProjectedStartDateTime": "2025-12-12T20:53:13.6953085+00:00",
  "ProjectedEndDateTime": "2025-12-12T20:53:13.6967327+00:00",
  "SchedulingStatus": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "SetUpDuration": {
    "DurationUnit": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "Time": "sample string 1"
  },
  "SurgeonCost": "sample string 8",
  "SurgeryStartDateTime": "2025-12-12T20:53:13.6969425+00:00",
  "SurgeryEndDateTime": "2025-12-12T20:53:13.6969993+00:00",
  "SurgicalCaseId": "sample string 9",
  "SurgicalCaseName": "sample string 10",
  "SurgicalDetails": [
    {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Section": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "Sequence": "sample string 1",
      "Field": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "CodedValues": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "TextValues": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "SurgicalEvents": [
    {
      "EventType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EventDateTime": "2025-12-12T20:53:13.698783+00:00"
    },
    {
      "EventType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EventDateTime": "2025-12-12T20:53:13.698783+00:00"
    }
  ],
  "SurgicalProcedures": [
    {
      "AnesthesiaType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "IncisionCloseDateTime": "2025-12-12T20:53:13.7019161+00:00",
      "IncisionStartDateTime": "2025-12-12T20:53:13.7019718+00:00",
      "OperativeRegions": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "PreferenceCards": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "ProcedureCodeId": "sample string 1",
      "ProcedureCodeName": "sample string 2",
      "ProcedureDuration": {
        "DurationUnit": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Time": "sample string 1"
      },
      "ProcedureOrdinal": "sample string 3",
      "SurgicalService": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "WoundClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "AnesthesiaType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "IncisionCloseDateTime": "2025-12-12T20:53:13.7019161+00:00",
      "IncisionStartDateTime": "2025-12-12T20:53:13.7019718+00:00",
      "OperativeRegions": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "PreferenceCards": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      ],
      "ProcedureCodeId": "sample string 1",
      "ProcedureCodeName": "sample string 2",
      "ProcedureDuration": {
        "DurationUnit": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "Time": "sample string 1"
      },
      "ProcedureOrdinal": "sample string 3",
      "SurgicalService": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "WoundClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ],
  "SurgicalReports": [
    {
      "ReportId": "sample string 1",
      "ReportType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DocumentPointer": "sample string 2",
      "Storage": "sample string 3",
      "Format": "sample string 4",
      "Body": "sample string 5",
      "BodyLength": "sample string 6"
    },
    {
      "ReportId": "sample string 1",
      "ReportType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DocumentPointer": "sample string 2",
      "Storage": "sample string 3",
      "Format": "sample string 4",
      "Body": "sample string 5",
      "BodyLength": "sample string 6"
    }
  ],
  "SurgicalService": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "SurgicalStaff": [
    {
      "Provider": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      "Type": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    },
    {
      "Provider": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      "Type": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    }
  ],
  "SurgicalStaffCost": "sample string 11",
  "TimeOut": {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Type": "sample string 3"
  },
  "TotalCost": "sample string 12",
  "TotalDuration": {
    "DurationUnit": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "Time": "sample string 1"
  }
}

GET api/v1/{EMRSystem}/SurgicalCases/{SurgicalCaseId}

Returns surgical case by surgical case id

Status: Beta

URI Parameters

EMRSystem

Required

SurgicalCaseId

Required

UserId

Required

IncludeBody

IncludeSurgicalDetails

Header Parameters

LoginId

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

Password

Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox

EmrInstance

ApplicationName

Required if using application keys

ApplicationKey

Data type: Password , Required if using application keys

AuthorizationToken

RequestVerboseLogging

Request: {{ method }} {{ url }}

Http Request Headers
{{header.name}} : {{header.value}} ******

Http Request Body
```
{{httpRequestBody}}
```

Http Status Code: {{httpResponseStatus}}

Http Response Headers
{{header.name}} : {{header.value}} ******

Http Response Data
```
{{httpResponseData}}
```