Device Mailbox

Associates a

Get the dataset for the specified object

get

Required scopes

This endpoint requires the following scopes:

: Login

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

messagestringOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Body

anyOptional

Responses

200

Operation was completed successfully

Associates a

messagestring · uuidOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:

$typestringOptional

Gets the type registration of this object

400

The provided resource was in an incorrect format

401

The principal is unauthorized and needs to either elevate or authenticate themselves

403

The principal is not permitted (cannot elevate) to perform the operation

404

The requested object does not exist

410

The specified object did exist however is no-longer present

415

The client is submitting an invalid object

422

There was a business rule violation executing the operation

429

The server rejected the request due to a throttling constraint

500

The server encountered an error processing the result

503

The service is not available (starting up or shutting down)

get/DeviceMailbox/_export

GET /hdsi/DeviceMailbox/_export HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*

{
  "message": "123e4567-e89b-12d3-a456-426614174000",
  "flags": "u",
  "time": "text",
  "modifiedOn": "2026-07-18",
  "source": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Get the dataset for the specified object

get

Required scopes

This endpoint requires the following scopes:

: Login

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

Query parameters

messagestringOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses

200

Operation was completed successfully

Associates a

messagestring · uuidOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:

$typestringOptional

Gets the type registration of this object

400

The provided resource was in an incorrect format

401

The principal is unauthorized and needs to either elevate or authenticate themselves

403

The principal is not permitted (cannot elevate) to perform the operation

404

The requested object does not exist

410

The specified object did exist however is no-longer present

415

The client is submitting an invalid object

422

There was a business rule violation executing the operation

429

The server rejected the request due to a throttling constraint

500

The server encountered an error processing the result

503

The service is not available (starting up or shutting down)

get/DeviceMailbox/{id}/_export

GET /hdsi/DeviceMailbox/{id}/_export HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "123e4567-e89b-12d3-a456-426614174000",
  "flags": "u",
  "time": "text",
  "modifiedOn": "2026-07-18",
  "source": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Perform a search (query) for

get

The search operation calls the database and loads results either from cache or data store. Care should be taken in the number of results retrieved by this operation.

Required scopes

This endpoint requires the following scopes:

: Login

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

_offsetnumberOptional

The offet of the first result to return

_countnumberOptional

The count of items to return in this result set

_includeTotalbooleanOptional

True if the server should count the matching results. May reduce performance

_orderBystringOptional

Instructs the result set to be ordered (in format: property:(asc|desc))

_queryIdstringOptional

The query state identifier. This allows the client to get a stable result set.

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

messagestringOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses

200

Operation was completed successfully

Associates a

messagestring · uuidOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:

$typestringOptional

Gets the type registration of this object

400

The provided resource was in an incorrect format

401

The principal is unauthorized and needs to either elevate or authenticate themselves

403

The principal is not permitted (cannot elevate) to perform the operation

404

The requested object does not exist

410

The specified object did exist however is no-longer present

415

The client is submitting an invalid object

422

There was a business rule violation executing the operation

429

The server rejected the request due to a throttling constraint

500

The server encountered an error processing the result

503

The service is not available (starting up or shutting down)

get/DeviceMailbox

GET /hdsi/DeviceMailbox HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "123e4567-e89b-12d3-a456-426614174000",
  "flags": "u",
  "time": "text",
  "modifiedOn": "2026-07-18",
  "source": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Returns specific options for a single resource

options

Responses

200

Operation was completed successfully

Associates a

messagestring · uuidOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:

$typestringOptional

Gets the type registration of this object

400

The provided resource was in an incorrect format

401

The principal is unauthorized and needs to either elevate or authenticate themselves

403

The principal is not permitted (cannot elevate) to perform the operation

404

The requested object does not exist

410

The specified object did exist however is no-longer present

415

The client is submitting an invalid object

422

There was a business rule violation executing the operation

429

The server rejected the request due to a throttling constraint

500

The server encountered an error processing the result

503

The service is not available (starting up or shutting down)

options/DeviceMailbox

OPTIONS /hdsi/DeviceMailbox HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Accept: */*

{
  "message": "123e4567-e89b-12d3-a456-426614174000",
  "flags": "u",
  "time": "text",
  "modifiedOn": "2026-07-18",
  "source": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Perform a search (query) and return only the headers

head

The HEAD operation is useful if you wish to determine if the header information for a specific result set has resulted in a change

Query parameters

messagestringOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses

204

There is not response for this method

No content

400

The provided resource was in an incorrect format

401

The principal is unauthorized and needs to either elevate or authenticate themselves

403

The principal is not permitted (cannot elevate) to perform the operation

404

The requested object does not exist

410

The specified object did exist however is no-longer present

415

The client is submitting an invalid object

422

There was a business rule violation executing the operation

429

The server rejected the request due to a throttling constraint

500

The server encountered an error processing the result

503

The service is not available (starting up or shutting down)

head/DeviceMailbox

HEAD /hdsi/DeviceMailbox HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Accept: */*

No content

Retrieves the current version of the specified resource

get

This method will first use cache to locate the most recent copy before searching the database. It is recommended to use this method rather than a query to Resource?id={id}

Required scopes

This endpoint requires the following scopes:

: Login

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The identifier of the object which should be retrieved

Query parameters

_bundlebooleanOptional

True if the server should send related objects to the caller in a bundle

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

messagestringOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses

200

Operation was completed successfully

Associates a

messagestring · uuidOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:

$typestringOptional

Gets the type registration of this object

400

The provided resource was in an incorrect format

401

The principal is unauthorized and needs to either elevate or authenticate themselves

403

The principal is not permitted (cannot elevate) to perform the operation

404

The requested object does not exist

410

The specified object did exist however is no-longer present

415

The client is submitting an invalid object

422

There was a business rule violation executing the operation

429

The server rejected the request due to a throttling constraint

500

The server encountered an error processing the result

503

The service is not available (starting up or shutting down)

get/DeviceMailbox/{id}

GET /hdsi/DeviceMailbox/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "123e4567-e89b-12d3-a456-426614174000",
  "flags": "u",
  "time": "text",
  "modifiedOn": "2026-07-18",
  "source": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Deletes the specified resource from the server

delete

This operation either logically or permanently deletes the identified resource so that it no longer appears in general searches. The method of deletion is controlled by the

Path parameters

idstringOptional

The identifier of the resource to be deleted

Query parameters

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Responses

200

Operation was completed successfully

Associates a

messagestring · uuidOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:

$typestringOptional

Gets the type registration of this object

400

The provided resource was in an incorrect format

401

The principal is unauthorized and needs to either elevate or authenticate themselves

403

The principal is not permitted (cannot elevate) to perform the operation

404

The requested object does not exist

409

There is a conflict in the update request (version mismatch)

410

The specified object did exist however is no-longer present

415

The client is submitting an invalid object

422

There was a business rule violation executing the operation

429

The server rejected the request due to a throttling constraint

500

The server encountered an error processing the result

503

The service is not available (starting up or shutting down)

delete/DeviceMailbox/{id}

DELETE /hdsi/DeviceMailbox/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Accept: */*

{
  "message": "123e4567-e89b-12d3-a456-426614174000",
  "flags": "u",
  "time": "text",
  "modifiedOn": "2026-07-18",
  "source": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Retrieves only the metadata of the specified resource

head

The metadata for the most recent version of this resource includes the last modified time, the e-tag, etc.

Path parameters

idstringOptional

The identifier of the resource to be retrieved

Query parameters

messagestringOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses

204

There is not response for this method

No content

400

The provided resource was in an incorrect format

401

The principal is unauthorized and needs to either elevate or authenticate themselves

403

The principal is not permitted (cannot elevate) to perform the operation

404

The requested object does not exist

410

The specified object did exist however is no-longer present

415

The client is submitting an invalid object

422

There was a business rule violation executing the operation

429

The server rejected the request due to a throttling constraint

500

The server encountered an error processing the result

503

The service is not available (starting up or shutting down)

head/DeviceMailbox/{id}

HEAD /hdsi/DeviceMailbox/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Accept: */*

No content

Gets the specified barcode for the resource

get

This method returns a barcode which explicitly points at the specified resource in the specified authority.

         The barcode is generated using the server's configuration, and is signed by the server's signing key.
        
         For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api

Required scopes

This endpoint requires the following scopes:

: Login

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The identifier of the resource for which a VRP should be generated

Query parameters

_formatstringOptional

The format of the barcode (santedb-vrp, code39, etc.)

messagestringOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses

200

Operation was completed successfully

Associates a

messagestring · uuidOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:

$typestringOptional

Gets the type registration of this object

400

The provided resource was in an incorrect format

401

The principal is unauthorized and needs to either elevate or authenticate themselves

403

The principal is not permitted (cannot elevate) to perform the operation

404

The requested object does not exist

410

The specified object did exist however is no-longer present

415

The client is submitting an invalid object

422

There was a business rule violation executing the operation

429

The server rejected the request due to a throttling constraint

500

The server encountered an error processing the result

503

The service is not available (starting up or shutting down)

get/DeviceMailbox/{id}/_code

GET /hdsi/DeviceMailbox/{id}/_code HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "123e4567-e89b-12d3-a456-426614174000",
  "flags": "u",
  "time": "text",
  "modifiedOn": "2026-07-18",
  "source": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Gets the digitally signed pointer (in JWS format) for the resource

get

This operation (like the _code operation) generates a digitally signed pointer for an object. Rather than rendering that pointer as a visual code, the API will return the structured contents of that code so the client can best determine how to represent the data.

         For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api

Required scopes

This endpoint requires the following scopes:

: Login

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The identifier of the object for which the pointer should be created

Query parameters

messagestringOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstringOptional

Get the modification date

sourcestringOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

etagstringOptional

Gets a tag which changes whenever the object is updated

Responses

200

Operation was completed successfully

Associates a

messagestring · uuidOptional

Gets the target of the association

flagsstring · enumOptional

Gets or sets the flags

Possible values:

timestringOptional

Gets or sets the time of the alert.

modifiedOnstring · dateOptional

Get the modification date

sourcestring · uuidOptional

Gets or sets the source entity's key (where the relationship is FROM)

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:

$typestringOptional

Gets the type registration of this object

400

The provided resource was in an incorrect format

401

The principal is unauthorized and needs to either elevate or authenticate themselves

403

The principal is not permitted (cannot elevate) to perform the operation

404

The requested object does not exist

410

The specified object did exist however is no-longer present

415

The client is submitting an invalid object

422

There was a business rule violation executing the operation

429

The server rejected the request due to a throttling constraint

500

The server encountered an error processing the result

503

The service is not available (starting up or shutting down)

get/DeviceMailbox/{id}/_ptr

GET /hdsi/DeviceMailbox/{id}/_ptr HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "123e4567-e89b-12d3-a456-426614174000",
  "flags": "u",
  "time": "text",
  "modifiedOn": "2026-07-18",
  "source": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

PreviousDevice Entity NextEntity

Last updated 5 days ago

Was this helpful?