Template Definition

Represents a template definition

Get the dataset for the specified object

get

Required scopes

This endpoint requires the following scopes:

: Login as a Service

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstringOptional

Gets the time this item was modified

updatedBystringOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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

Represents a template definition

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstring · dateOptional

Gets the time this item was modified

updatedBystring · uuidOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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/TemplateDefinition/_export

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

{
  "mnemonic": "text",
  "name": "text",
  "oid": "text",
  "description": "text",
  "updatedTime": "text",
  "modifiedOn": "2026-07-19",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "text",
  "obsoletionTime": "text",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "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 as a Service

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

Query parameters

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstringOptional

Gets the time this item was modified

updatedBystringOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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

Represents a template definition

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstring · dateOptional

Gets the time this item was modified

updatedBystring · uuidOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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/TemplateDefinition/{id}/_export

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

{
  "mnemonic": "text",
  "name": "text",
  "oid": "text",
  "description": "text",
  "updatedTime": "text",
  "modifiedOn": "2026-07-19",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "text",
  "obsoletionTime": "text",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "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 as a Service

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

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstringOptional

Gets the time this item was modified

updatedBystringOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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

Represents a template definition

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstring · dateOptional

Gets the time this item was modified

updatedBystring · uuidOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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

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

{
  "mnemonic": "text",
  "name": "text",
  "oid": "text",
  "description": "text",
  "updatedTime": "text",
  "modifiedOn": "2026-07-19",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "text",
  "obsoletionTime": "text",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "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

Represents a template definition

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstring · dateOptional

Gets the time this item was modified

updatedBystring · uuidOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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

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

{
  "mnemonic": "text",
  "name": "text",
  "oid": "text",
  "description": "text",
  "updatedTime": "text",
  "modifiedOn": "2026-07-19",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "text",
  "obsoletionTime": "text",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "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

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstringOptional

Gets the time this item was modified

updatedBystringOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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

HEAD /hdsi/TemplateDefinition 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 as a Service

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

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstringOptional

Gets the time this item was modified

updatedBystringOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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

Represents a template definition

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstring · dateOptional

Gets the time this item was modified

updatedBystring · uuidOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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/TemplateDefinition/{id}

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

{
  "mnemonic": "text",
  "name": "text",
  "oid": "text",
  "description": "text",
  "updatedTime": "text",
  "modifiedOn": "2026-07-19",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "text",
  "obsoletionTime": "text",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "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

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstringOptional

Gets the time this item was modified

updatedBystringOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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/TemplateDefinition/{id}

HEAD /hdsi/TemplateDefinition/{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 as a Service

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.)

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstringOptional

Gets the time this item was modified

updatedBystringOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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

Represents a template definition

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstring · dateOptional

Gets the time this item was modified

updatedBystring · uuidOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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/TemplateDefinition/{id}/_code

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

{
  "mnemonic": "text",
  "name": "text",
  "oid": "text",
  "description": "text",
  "updatedTime": "text",
  "modifiedOn": "2026-07-19",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "text",
  "obsoletionTime": "text",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "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 as a Service

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

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

Query parameters

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstringOptional

Gets the time this item was modified

updatedBystringOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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

Represents a template definition

mnemonicstringOptional

Gets or sets the mnemonic

namestringOptional

Gets or set the name

oidstringOptional

Gets or sets the oid of the concept set

descriptionstringOptional

Gets or sets the description

updatedTimestringOptional

Gets or sets the time that this object was last modified in ISO format

modifiedOnstring · dateOptional

Gets the time this item was modified

updatedBystring · uuidOptional

Gets or sets the provenance identifier associated with the last update of this object

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

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/TemplateDefinition/{id}/_ptr

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

{
  "mnemonic": "text",
  "name": "text",
  "oid": "text",
  "description": "text",
  "updatedTime": "text",
  "modifiedOn": "2026-07-19",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "text",
  "obsoletionTime": "text",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

PreviousSubstance Administration NextText Observation

Last updated 7 days ago

Was this helpful?