GET api/v1/{EMRSystem}/Population/BedRequests

Returns all Bed Requests for a given date range and filtered, optionally, by Locations (facilities).

Status: Beta

URI Parameters

Name	Description	Type	Additional information
EMRSystem	The emr system.	EMRSystem	None.
LocationList	The list of locations to get Bed Requests from.	string	None.
UserId	Identifier of the user initiating the request.	string	Required
FromDateTime	Gets or sets from date time.	datetime	Required if EMRSystem = Cerner, or Epic, or Meditech
ToDateTime	Gets or sets to date time.	datetime	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

Collection of UdmBedRequestResponse

Name	Description	Type	Additional information
RequestId	Identifier of the Bed Request	string	None.
EventType	The patient event type that created this Bed Request	CodedObject	None.
CreatedBy	Who created this Bed Request	Person	None.
Patient	The patient this Bed Request is for	BasePatient	None.
Encounter	The patient encounter this Bed Request is for	BaseEncounter	None.
Hospital	The hospital this Bed Request is for	LocationCompact	None.
Unit	The requested or assigned unit	BaseDepartment	None.
Room	The assigned room	RoomCompact	None.
Bed	The assigned bed	BedCompact	None.
RoomType	The requested room type	CodedObject	None.
BedType	The requested bde type	CodedObject	None.
AssignedDateTime	The date/time the bed was assigned	datetime	None.
CreatedDateTime	The date/time this Bed Request was created	datetime	None.
UpdatedBy	Who last updated this Bed Request	Person	None.
Status	The status of this Bed Request	CodedObject	None.
ServiceType	The requested service type	CodedObject	None.
LevelOfCare	The requested level of care	CodedObject	None.
AccommodationCode	The requested accomodation code	CodedObject	None.
AccommodationCodeReason	The reason for the requested accomodation code	CodedObject	None.
RequestUrgency	The urgency of this Bed Request	CodedObject	None.
CanceledDateTime	The date/time this Bed Request was canceled	datetime	None.
CanceledBy	Who canceled this Bed Request	Person	None.
CanceledReason	Canceled reason	string	None.
CreatedUpdatedDateTime	The date/time this Bed Request was last updated	datetime	None.
UnitAssignedDateTime	Unit Assigned Date Time	datetime	None.
BedAssignedDateTime	Bed Assigned Date Time	datetime	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

[
  {
    "RequestId": "sample string 1",
    "EventType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "CreatedBy": {
      "Name": "sample string 1",
      "NPI": "sample string 2",
      "UserId": "sample string 3",
      "ProviderId": "sample string 4"
    },
    "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-12T21:06:26.6703282+00:00",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeceasedDateTime": "2025-12-12T21:06:26.6703328+00:00"
    },
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DischargeDateTime": "2025-12-12T21:06:26.6742624+00:00",
      "FinancialNumber": "sample string 2"
    },
    "Hospital": {
      "LocationId": "sample string 1",
      "LocationName": "sample string 2"
    },
    "Unit": {
      "DepartmentId": "sample string 1",
      "DepartmentName": "sample string 2"
    },
    "Room": {
      "RoomId": "sample string 1",
      "RoomName": "sample string 2"
    },
    "Bed": {
      "BedId": "sample string 1",
      "BedName": "sample string 2"
    },
    "RoomType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "BedType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AssignedDateTime": "2025-12-12T21:06:26.693612+00:00",
    "CreatedDateTime": "2025-12-12T21:06:26.6971442+00:00",
    "UpdatedBy": {
      "Name": "sample string 1",
      "NPI": "sample string 2",
      "UserId": "sample string 3",
      "ProviderId": "sample string 4"
    },
    "Status": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "ServiceType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "LevelOfCare": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AccommodationCode": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AccommodationCodeReason": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "RequestUrgency": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "CanceledDateTime": "2025-12-12T21:06:26.6978923+00:00",
    "CanceledBy": {
      "Name": "sample string 1",
      "NPI": "sample string 2",
      "UserId": "sample string 3",
      "ProviderId": "sample string 4"
    },
    "CanceledReason": "sample string 2",
    "CreatedUpdatedDateTime": "2025-12-12T21:06:26.7021312+00:00",
    "UnitAssignedDateTime": "2025-12-12T21:06:26.7040866+00:00",
    "BedAssignedDateTime": "2025-12-12T21:06:26.7043114+00:00"
  },
  {
    "RequestId": "sample string 1",
    "EventType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "CreatedBy": {
      "Name": "sample string 1",
      "NPI": "sample string 2",
      "UserId": "sample string 3",
      "ProviderId": "sample string 4"
    },
    "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-12T21:06:26.6703282+00:00",
      "Gender": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeceasedDateTime": "2025-12-12T21:06:26.6703328+00:00"
    },
    "Encounter": {
      "EncounterId": "sample string 1",
      "EncounterType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DischargeDateTime": "2025-12-12T21:06:26.6742624+00:00",
      "FinancialNumber": "sample string 2"
    },
    "Hospital": {
      "LocationId": "sample string 1",
      "LocationName": "sample string 2"
    },
    "Unit": {
      "DepartmentId": "sample string 1",
      "DepartmentName": "sample string 2"
    },
    "Room": {
      "RoomId": "sample string 1",
      "RoomName": "sample string 2"
    },
    "Bed": {
      "BedId": "sample string 1",
      "BedName": "sample string 2"
    },
    "RoomType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "BedType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AssignedDateTime": "2025-12-12T21:06:26.693612+00:00",
    "CreatedDateTime": "2025-12-12T21:06:26.6971442+00:00",
    "UpdatedBy": {
      "Name": "sample string 1",
      "NPI": "sample string 2",
      "UserId": "sample string 3",
      "ProviderId": "sample string 4"
    },
    "Status": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "ServiceType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "LevelOfCare": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AccommodationCode": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "AccommodationCodeReason": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "RequestUrgency": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "CanceledDateTime": "2025-12-12T21:06:26.6978923+00:00",
    "CanceledBy": {
      "Name": "sample string 1",
      "NPI": "sample string 2",
      "UserId": "sample string 3",
      "ProviderId": "sample string 4"
    },
    "CanceledReason": "sample string 2",
    "CreatedUpdatedDateTime": "2025-12-12T21:06:26.7021312+00:00",
    "UnitAssignedDateTime": "2025-12-12T21:06:26.7040866+00:00",
    "BedAssignedDateTime": "2025-12-12T21:06:26.7043114+00:00"
  }
]

GET api/v1/{EMRSystem}/Population/BedRequests

Returns all Bed Requests for a given date range and filtered, optionally, by Locations (facilities).

Status: Beta

URI Parameters

EMRSystem

Required

LocationList

UserId

Required

FromDateTime

Required if EMRSystem = Cerner, or Epic, or Meditech

ToDateTime

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}}
```