Health Data Service Interface (HDSI)

Deprecated

Time

get

Responses

200

Operation was completed successfully

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)

get/time

GET /hdsi/time HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Accept: */*

No content

GetSchema

get

Responses

200

Operation was completed successfully

includeobject[]Optional

simpleTypeobject[]Optional

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/xsd

GET /hdsi/xsd HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Accept: */*

{
  "include": [
    {}
  ],
  "simpleType": [
    {}
  ]
}

Options

options

Responses

200

Operation was completed successfully

Service options

versionstringOptional

Gets or sets the version of the service interface

serverstringOptional

Gets the server informational version

modifiedOnstring · dateOptional

Gets or sets the modified on date time of the service options.

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/

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

{
  "version": "text",
  "server": "text",
  "resource": [
    {
      "resource": "text",
      "cap": [
        {
          "cap": "none",
          "demand": [
            "text"
          ]
        }
      ],
      "children": [
        {
          "scope": "instance",
          "classification": "resource",
          "resource": "text",
          "cap": [
            {
              "cap": "none",
              "demand": [
                "text"
              ]
            }
          ],
          "children": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ],
  "endpoint": [
    {
      "type": "hdsi",
      "cap": "none",
      "security": "None",
      "url": [
        "text"
      ],
      "contract": [
        {
          "type": "text"
        }
      ],
      "behavior": null
    }
  ],
  "settings": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "modifiedOn": "2026-07-19",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Performs a patch on all resources in the

patch

Body

Represents a collection of patch instructions

modifiedOnstring · dateOptional

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

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

409

One or more of the patch instructions provided does not match the current version of the object being patched

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)

patch/

PATCH /hdsi/ HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 456

{
  "patch": [
    {
      "version": "text",
      "appliesTo": null,
      "change": [
        {
          "op": "add",
          "path": "text",
          "value": null
        }
      ],
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-07-19",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "modifiedOn": "2026-07-19",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

No content

PreviousUser Entity NextModels

Last updated 7 days ago

Was this helpful?