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

Returns all Beds 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 filter the beds by	string	None.
UnitList	The list of hospital units to filter the beds by	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 UdmBedResponse

Name	Description	Type	Additional information
Identities	The list of alternative identifiers for the bed	Collection of Identity	None.
Room	The room the bed is in	RoomCompact	None.
Unit	The hospital unit the bed is in	BaseDepartment	None.
Hospital	The hospital the bed is in	LocationCompact	None.
Status	The status of the bed	CodedObject	None.
BlockedReason	The reason the bed is blocked (if the status is Blocked)	CodedObject	None.
BlockedComment	A comment related to the reason the bed is blocked (if the status is Blocked)	string	None.
Attributes	Any special attributes of the bed	Collection of CodedObject	None.
AccommodationCode	The accomodation code of the bed	CodedObject	None.
CreatedUpdatedDateTime	The date/time the bed was last updated	datetime	None.
BedId	Identifier of the Bed	string	None.
BedName	Name of the Bed	string	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

[
  {
    "Identities": [
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      },
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      }
    ],
    "Room": {
      "RoomId": "sample string 1",
      "RoomName": "sample string 2"
    },
    "Unit": {
      "DepartmentId": "sample string 1",
      "DepartmentName": "sample string 2"
    },
    "Hospital": {
      "LocationId": "sample string 1",
      "LocationName": "sample string 2"
    },
    "Status": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "BlockedReason": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "BlockedComment": "sample string 1",
    "Attributes": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "AccommodationCode": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "CreatedUpdatedDateTime": "2025-12-12T20:55:16.3013127+00:00",
    "BedId": "sample string 2",
    "BedName": "sample string 3"
  },
  {
    "Identities": [
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      },
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      }
    ],
    "Room": {
      "RoomId": "sample string 1",
      "RoomName": "sample string 2"
    },
    "Unit": {
      "DepartmentId": "sample string 1",
      "DepartmentName": "sample string 2"
    },
    "Hospital": {
      "LocationId": "sample string 1",
      "LocationName": "sample string 2"
    },
    "Status": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "BlockedReason": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "BlockedComment": "sample string 1",
    "Attributes": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "AccommodationCode": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "CreatedUpdatedDateTime": "2025-12-12T20:55:16.3013127+00:00",
    "BedId": "sample string 2",
    "BedName": "sample string 3"
  }
]

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

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

Status: Beta

URI Parameters

EMRSystem

Required

LocationList

UnitList

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