Patient

Represents an entity which is a patient

Get the dataset for the specified object

get

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Read Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Body

anyOptional

Responses

200

Operation was completed successfully

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "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
• : Read Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

Query parameters

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "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
• : Read Clinical Data

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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Creates the resource. If the resource already exists, then a 409 is thrown

post

This operation is a CREATE ONLY operation, and will throw an error if the operation results in a duplicate. If you are looking for a CREATE OR UPDATE method use the POST with identifier operation

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

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

Body

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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)

post/Patient

POST /hdsi/Patient HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 5110

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "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 an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

HEAD /hdsi/Patient 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
• : Read Clinical Data

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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Creates or updates a resource. That is, creates the resource if it does not exist, or updates it if it does

post

This method will attempt to update the resource if it exists (a-la PUT style) however, if a PUT fails the operation will create (a-la POST)

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The identifier of the resource to be created or updated

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

Body

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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)

post/Patient/{id}

POST /hdsi/Patient/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 5110

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Updates the specified resource. If the resource does not exist than a 404 is thrown, if there is a conflict (such a mismatch of data) a 409 is thrown

put

This operation will update an existing resource on the server such that the data in the database exactly matches the data passed via the API.

         Note: If you post an incomplete object (such as one missing identifiers, or addresses) then the current resource will have those attributes removed. For partial updates, use the PATCH operation instead.

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The identifier of the resource to be updated

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

Body

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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)

put/Patient/{id}

PUT /hdsi/Patient/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 5110

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "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

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

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

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

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

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

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

No content

Updates the specified resource according to the instructions in the PATCH file

patch

The PATCH operation allows for partial updating of a resource.

         This method must be used in conjunction with an If-Match header indicating the version that you would like apply the patch against.
        
         The server will load the most recent version and compre the version code with If-Match, if the match is successful the instructions in the PATCH are applied to the loaded version.

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The identifier of the resource to be patched

Body

Represents a series of patch instructions

versionstringOptional

Gets or sets the version of the patch file

appliesToanyOptional

Application version

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

The patch submitted 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/Patient/{id}

PATCH /hdsi/Patient/{id} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 340

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

No content

Gets a complete history of all changes made to the specified resource

get

The result of the history operation is a

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Read Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The identifier of the resource to retrieve

Query parameters

_sincestringOptional

The last version of the object that should be returned

_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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The ID of the object which scopes the operation

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/{id}/$diff

POST /hdsi/Patient/{id}/$diff HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The ID of the object which scopes the operation

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/{id}/$carepath-recompute

POST /hdsi/Patient/{id}/$carepath-recompute HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The ID of the object which scopes the operation

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/{id}/$tag

POST /hdsi/Patient/{id}/$tag HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The ID of the object which scopes the operation

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/{id}/$analyze

POST /hdsi/Patient/{id}/$analyze HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The ID of the object which scopes the operation

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/{id}/$carepath-unenroll

POST /hdsi/Patient/{id}/$carepath-unenroll HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The ID of the object which scopes the operation

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/{id}/$match

POST /hdsi/Patient/{id}/$match HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The ID of the object which scopes the operation

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/{id}/$generate-careplan

POST /hdsi/Patient/{id}/$generate-careplan HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The ID of the object which scopes the operation

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/{id}/$validate

POST /hdsi/Patient/{id}/$validate HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The ID of the object which scopes the operation

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/{id}/$carepath-eligibilty

POST /hdsi/Patient/{id}/$carepath-eligibilty HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The ID of the object which scopes the operation

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/{id}/$carepath-enroll

POST /hdsi/Patient/{id}/$carepath-enroll HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The ID of the object which scopes the operation

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/{id}/$match-reset

POST /hdsi/Patient/{id}/$match-reset HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Retrieves a specific version of the specified resource

get

This method allows the caller to retrieve a specific version of the identified object, which is useful for loading a previous copy of a resource for reference.

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Read Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The identifier of the resource for which history sould be retrieved

versionIdstringOptional

The version of the resource to retrieve

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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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/Patient/{id}/_history/{versionId}

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

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

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
• : Read Clinical Data

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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "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
• : Read Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

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

Query parameters

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents an entity which is a patient

multipleBirthOrdernumber · int32Optional

Gets or sets the multiple birth order of the patient

livingArrangementstring · uuidOptional

Gets or sets the living arrangement

religionstring · uuidOptional

Gets or sets the religious affiliation

ethnicitystring · uuidOptional

Gets or sets the ethnicity codes

educationLevelstring · uuidOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstring · uuidOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

occupationstring · uuidOptional

Gets or sets the religious affiliation

maritalStatusstring · uuidOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstring · uuidOptional

Gets or sets the VIP code

nationalitystring · uuidOptional

Gets or sets the religious affiliation

classConceptstring · uuidOptional

Class concept

creationActstring · uuidOptional

Creation act reference

determinerConceptstring · uuidOptional

Determiner concept

statusConceptstring · uuidOptional

Status concept id

templatestring · uuidOptional

Gets the template key

typeConceptstring · uuidOptional

Type concept identifier

geoanyOptional

Gets or sets the geo tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

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

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

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

{
  "multipleBirthOrder": 1,
  "livingArrangement": "123e4567-e89b-12d3-a456-426614174000",
  "religion": "123e4567-e89b-12d3-a456-426614174000",
  "ethnicity": "123e4567-e89b-12d3-a456-426614174000",
  "educationLevel": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirthPrecision": "F",
  "genderConcept": "123e4567-e89b-12d3-a456-426614174000",
  "dateOfBirth": "text",
  "language": [
    {
      "externId": "text",
      "isPreferred": true,
      "languageCode": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "occupation": "123e4567-e89b-12d3-a456-426614174000",
  "maritalStatus": "123e4567-e89b-12d3-a456-426614174000",
  "deceasedDate": "text",
  "deceasedDatePrecision": "F",
  "vipStatus": "123e4567-e89b-12d3-a456-426614174000",
  "nationality": "123e4567-e89b-12d3-a456-426614174000",
  "address": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "classConcept": "123e4567-e89b-12d3-a456-426614174000",
  "creationAct": "123e4567-e89b-12d3-a456-426614174000",
  "determinerConcept": "123e4567-e89b-12d3-a456-426614174000",
  "extension": [
    {
      "value": [
        1
      ],
      "externId": "text",
      "extensionType": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "identifier": [
    {
      "value": "text",
      "externId": "text",
      "issued": "text",
      "expires": "text",
      "checkDigit": "text",
      "domain": "123e4567-e89b-12d3-a456-426614174000",
      "authority": null,
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "reliability": "u",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "name": [
    {
      "externId": "text",
      "component": [
        {
          "type": "123e4567-e89b-12d3-a456-426614174000",
          "sequence": 1,
          "value": "text",
          "modifiedOn": "2026-01-01",
          "source": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "operation": "Auto",
          "$type": "text"
        }
      ],
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "note": [
    {
      "text": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "participation": [
    {
      "externId": "text",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "player": "123e4567-e89b-12d3-a456-426614174000",
      "participationRole": "123e4567-e89b-12d3-a456-426614174000",
      "act": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "relationship": [
    {
      "externId": "text",
      "holder": "123e4567-e89b-12d3-a456-426614174000",
      "negationInd": true,
      "strength": 1,
      "quantity": 1,
      "relationshipType": "123e4567-e89b-12d3-a456-426614174000",
      "relationshipRole": "123e4567-e89b-12d3-a456-426614174000",
      "classification": "123e4567-e89b-12d3-a456-426614174000",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "statusConcept": "123e4567-e89b-12d3-a456-426614174000",
  "tag": [
    {
      "key": "text",
      "value": "text",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "text",
      "obsoletionTime": "text",
      "modifiedOn": "2026-01-01",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "telecom": [
    {
      "externId": "text",
      "use": "123e4567-e89b-12d3-a456-426614174000",
      "type": "123e4567-e89b-12d3-a456-426614174000",
      "value": "text",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "template": "123e4567-e89b-12d3-a456-426614174000",
  "typeConcept": "123e4567-e89b-12d3-a456-426614174000",
  "policy": [
    {
      "policy": "123e4567-e89b-12d3-a456-426614174000",
      "grant": "Deny",
      "modifiedOn": "2026-01-01",
      "source": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text"
    }
  ],
  "geo": null,
  "previousVersion": "123e4567-e89b-12d3-a456-426614174000",
  "version": "123e4567-e89b-12d3-a456-426614174000",
  "sequence": 1,
  "creationTime": "text",
  "obsoletionTime": "text",
  "modifiedOn": "2026-01-01",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "obsoletedBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Performs a linked or chained search on a sub-property

get

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Read Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The key of the hosting (container object)

childResourceKeystringOptional

The key of the sub-item to fetch

Query parameters

_bundlebooleanOptional

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

_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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents a single care pathway

mnemonicstringOptional

Gets or sets the mnemonic for the care pathway

namestringOptional

Gets or sets the name of the care pathway

descriptionstringOptional

Gets or sets the description of the care pathway

eligibilitystringOptional

Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)

enrollmentstring · enumOptional

Gets or sets the enrolment mode

Possible values:

encounterTemplatestring · uuidOptional

Gets or sets the type of encounter

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/Patient/{id}/carepaths/{childResourceKey}

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

{
  "mnemonic": "text",
  "name": "text",
  "description": "text",
  "eligibility": "text",
  "enrollment": "manual",
  "encounterTemplate": "123e4567-e89b-12d3-a456-426614174000",
  "updatedTime": "text",
  "modifiedOn": "2026-01-01",
  "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"
}

Removes a child resource instance from the parent container

delete

This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The key of the container

childResourceKeystringOptional

The actual value of the sub-key

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

Represents a single care pathway

mnemonicstringOptional

Gets or sets the mnemonic for the care pathway

namestringOptional

Gets or sets the name of the care pathway

descriptionstringOptional

Gets or sets the description of the care pathway

eligibilitystringOptional

Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)

enrollmentstring · enumOptional

Gets or sets the enrolment mode

Possible values:

encounterTemplatestring · uuidOptional

Gets or sets the type of encounter

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)

delete/Patient/{id}/carepaths/{childResourceKey}

DELETE /hdsi/Patient/{id}/carepaths/{childResourceKey} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "mnemonic": "text",
  "name": "text",
  "description": "text",
  "eligibility": "text",
  "enrollment": "manual",
  "encounterTemplate": "123e4567-e89b-12d3-a456-426614174000",
  "updatedTime": "text",
  "modifiedOn": "2026-01-01",
  "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"
}

Removes a child resource instance from the parent container

delete

This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The key of the container

childResourceKeystringOptional

The actual value of the sub-key

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

A bundle represents a batch of objects which are included within the bundle

modifiedOnstring · dateOptional

Gets the time the bundle was modified

correlationSeqnumber · int64Optional

Gets or sets the sequence control for this bundle

correlationIdstring · uuidOptional

A unique identifier which correlates this bundle with other bundles that are about the same "subject"

focalstring · uuid[]Optional

Entry into the bundle

offsetnumber · int32Optional

Gets or sets the count in this bundle

countnumber · int32Optional

Gets or sets the count in this bundle

totalResultsnumber · int32Optional

Gets or sets the total results

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)

delete/Patient/{id}/match-ignore/{childResourceKey}

DELETE /hdsi/Patient/{id}/match-ignore/{childResourceKey} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "modifiedOn": "2026-01-01",
  "correlationSeq": 1,
  "correlationId": "123e4567-e89b-12d3-a456-426614174000",
  "resource": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text",
      "modifiedOn": "2026-01-01"
    }
  ],
  "focal": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "offset": 1,
  "count": 1,
  "totalResults": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Performs a linked or chained search on a sub-property

get

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Read Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The key of the hosting (container object)

childResourceKeystringOptional

The key of the sub-item to fetch

Query parameters

_bundlebooleanOptional

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

_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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

A bundle represents a batch of objects which are included within the bundle

modifiedOnstring · dateOptional

Gets the time the bundle was modified

correlationSeqnumber · int64Optional

Gets or sets the sequence control for this bundle

correlationIdstring · uuidOptional

A unique identifier which correlates this bundle with other bundles that are about the same "subject"

focalstring · uuid[]Optional

Entry into the bundle

offsetnumber · int32Optional

Gets or sets the count in this bundle

countnumber · int32Optional

Gets or sets the count in this bundle

totalResultsnumber · int32Optional

Gets or sets the total results

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/Patient/{id}/match-candidate/{childResourceKey}

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

{
  "modifiedOn": "2026-01-01",
  "correlationSeq": 1,
  "correlationId": "123e4567-e89b-12d3-a456-426614174000",
  "resource": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text",
      "modifiedOn": "2026-01-01"
    }
  ],
  "focal": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "offset": 1,
  "count": 1,
  "totalResults": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Removes a child resource instance from the parent container

delete

This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The key of the container

childResourceKeystringOptional

The actual value of the sub-key

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

A bundle represents a batch of objects which are included within the bundle

modifiedOnstring · dateOptional

Gets the time the bundle was modified

correlationSeqnumber · int64Optional

Gets or sets the sequence control for this bundle

correlationIdstring · uuidOptional

A unique identifier which correlates this bundle with other bundles that are about the same "subject"

focalstring · uuid[]Optional

Entry into the bundle

offsetnumber · int32Optional

Gets or sets the count in this bundle

countnumber · int32Optional

Gets or sets the count in this bundle

totalResultsnumber · int32Optional

Gets or sets the total results

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)

delete/Patient/{id}/match-candidate/{childResourceKey}

DELETE /hdsi/Patient/{id}/match-candidate/{childResourceKey} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "modifiedOn": "2026-01-01",
  "correlationSeq": 1,
  "correlationId": "123e4567-e89b-12d3-a456-426614174000",
  "resource": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text",
      "modifiedOn": "2026-01-01"
    }
  ],
  "focal": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "offset": 1,
  "count": 1,
  "totalResults": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Performs a linked or chained search on a sub-property

get

This method performs a general search on the child resource type, however scoped to the container of the parent (so users within role container)

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Read Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The key of the hosting (container object)

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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

Represents a single care pathway

mnemonicstringOptional

Gets or sets the mnemonic for the care pathway

namestringOptional

Gets or sets the name of the care pathway

descriptionstringOptional

Gets or sets the description of the care pathway

eligibilitystringOptional

Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)

enrollmentstring · enumOptional

Gets or sets the enrolment mode

Possible values:

encounterTemplatestring · uuidOptional

Gets or sets the type of encounter

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

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

{
  "mnemonic": "text",
  "name": "text",
  "description": "text",
  "eligibility": "text",
  "enrollment": "manual",
  "encounterTemplate": "123e4567-e89b-12d3-a456-426614174000",
  "updatedTime": "text",
  "modifiedOn": "2026-01-01",
  "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"
}

Assigns the child object as a child (or link) of the parent

post

This method adds a new child resource instance to the container and performs the necessary linking

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The identiifer of the container

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

Body

Represents a single care pathway

mnemonicstringOptional

Gets or sets the mnemonic for the care pathway

namestringOptional

Gets or sets the name of the care pathway

descriptionstringOptional

Gets or sets the description of the care pathway

eligibilitystringOptional

Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)

enrollmentstring · enumOptional

Gets or sets the enrolment mode

Possible values:

encounterTemplatestring · uuidOptional

Gets or sets the type of encounter

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

Responses

200

Operation was completed successfully

Represents a single care pathway

mnemonicstringOptional

Gets or sets the mnemonic for the care pathway

namestringOptional

Gets or sets the name of the care pathway

descriptionstringOptional

Gets or sets the description of the care pathway

eligibilitystringOptional

Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)

enrollmentstring · enumOptional

Gets or sets the enrolment mode

Possible values:

encounterTemplatestring · uuidOptional

Gets or sets the type of encounter

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)

post/Patient/{id}/carepaths

POST /hdsi/Patient/{id}/carepaths HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 482

{
  "mnemonic": "text",
  "name": "text",
  "description": "text",
  "eligibility": "text",
  "enrollment": "manual",
  "encounterTemplate": "123e4567-e89b-12d3-a456-426614174000",
  "updatedTime": "text",
  "modifiedOn": "2026-01-01",
  "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"
}

{
  "mnemonic": "text",
  "name": "text",
  "description": "text",
  "eligibility": "text",
  "enrollment": "manual",
  "encounterTemplate": "123e4567-e89b-12d3-a456-426614174000",
  "updatedTime": "text",
  "modifiedOn": "2026-01-01",
  "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"
}

Performs a linked or chained search on a sub-property

get

This method performs a general search on the child resource type, however scoped to the container of the parent (so users within role container)

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Read Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The key of the hosting (container object)

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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

A bundle represents a batch of objects which are included within the bundle

modifiedOnstring · dateOptional

Gets the time the bundle was modified

correlationSeqnumber · int64Optional

Gets or sets the sequence control for this bundle

correlationIdstring · uuidOptional

A unique identifier which correlates this bundle with other bundles that are about the same "subject"

focalstring · uuid[]Optional

Entry into the bundle

offsetnumber · int32Optional

Gets or sets the count in this bundle

countnumber · int32Optional

Gets or sets the count in this bundle

totalResultsnumber · int32Optional

Gets or sets the total results

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/Patient/{id}/match-candidate

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

{
  "modifiedOn": "2026-01-01",
  "correlationSeq": 1,
  "correlationId": "123e4567-e89b-12d3-a456-426614174000",
  "resource": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text",
      "modifiedOn": "2026-01-01"
    }
  ],
  "focal": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "offset": 1,
  "count": 1,
  "totalResults": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Assigns the child object as a child (or link) of the parent

post

This method adds a new child resource instance to the container and performs the necessary linking

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstringOptional

The identiifer of the container

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

Body

A bundle represents a batch of objects which are included within the bundle

modifiedOnstring · dateOptional

Gets the time the bundle was modified

correlationSeqnumber · int64Optional

Gets or sets the sequence control for this bundle

correlationIdstring · uuidOptional

A unique identifier which correlates this bundle with other bundles that are about the same "subject"

focalstring · uuid[]Optional

Entry into the bundle

offsetnumber · int32Optional

Gets or sets the count in this bundle

countnumber · int32Optional

Gets or sets the count in this bundle

totalResultsnumber · int32Optional

Gets or sets the total results

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

200

Operation was completed successfully

A bundle represents a batch of objects which are included within the bundle

modifiedOnstring · dateOptional

Gets the time the bundle was modified

correlationSeqnumber · int64Optional

Gets or sets the sequence control for this bundle

correlationIdstring · uuidOptional

A unique identifier which correlates this bundle with other bundles that are about the same "subject"

focalstring · uuid[]Optional

Entry into the bundle

offsetnumber · int32Optional

Gets or sets the count in this bundle

countnumber · int32Optional

Gets or sets the count in this bundle

totalResultsnumber · int32Optional

Gets or sets the total results

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)

post/Patient/{id}/match-candidate

POST /hdsi/Patient/{id}/match-candidate HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 385

{
  "modifiedOn": "2026-01-01",
  "correlationSeq": 1,
  "correlationId": "123e4567-e89b-12d3-a456-426614174000",
  "resource": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text",
      "modifiedOn": "2026-01-01"
    }
  ],
  "focal": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "offset": 1,
  "count": 1,
  "totalResults": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

{
  "modifiedOn": "2026-01-01",
  "correlationSeq": 1,
  "correlationId": "123e4567-e89b-12d3-a456-426614174000",
  "resource": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text",
      "modifiedOn": "2026-01-01"
    }
  ],
  "focal": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "offset": 1,
  "count": 1,
  "totalResults": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Invokes the specified operation

post

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/$analyze

POST /hdsi/Patient/$analyze HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/$xsd-complete

POST /hdsi/Patient/$xsd-complete HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/$match

POST /hdsi/Patient/$match HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/$expand

POST /hdsi/Patient/$expand HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/$schema-complete

POST /hdsi/Patient/$schema-complete HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/$generate-careplan

POST /hdsi/Patient/$generate-careplan HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/$validate

POST /hdsi/Patient/$validate HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/$match-reset

POST /hdsi/Patient/$match-reset HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Invokes the specified operation

post

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

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

Body

Gets the operation invokation

Responses

200

Operation was completed successfully

object · ObjectOptional

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)

post/Patient/$xref-use

POST /hdsi/Patient/$xref-use HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x.santedb.rim.viewModel+json
Accept: */*
Content-Length: 42

{
  "parameter": [
    {
      "name": "text",
      "int": null
    }
  ]
}

{}

Performs a linked or chained search on a sub-property

get

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Read Clinical Data

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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

A bundle represents a batch of objects which are included within the bundle

modifiedOnstring · dateOptional

Gets the time the bundle was modified

correlationSeqnumber · int64Optional

Gets or sets the sequence control for this bundle

correlationIdstring · uuidOptional

A unique identifier which correlates this bundle with other bundles that are about the same "subject"

focalstring · uuid[]Optional

Entry into the bundle

offsetnumber · int32Optional

Gets or sets the count in this bundle

countnumber · int32Optional

Gets or sets the count in this bundle

totalResultsnumber · int32Optional

Gets or sets the total results

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/Patient/match-candidate

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

{
  "modifiedOn": "2026-01-01",
  "correlationSeq": 1,
  "correlationId": "123e4567-e89b-12d3-a456-426614174000",
  "resource": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text",
      "modifiedOn": "2026-01-01"
    }
  ],
  "focal": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "offset": 1,
  "count": 1,
  "totalResults": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Performs a linked or chained search on a sub-property

get

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Read Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

childResourceKeystringOptional

The key of the sub-item to fetch

Query parameters

_bundlebooleanOptional

True if the server should include related objects

_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

multipleBirthOrderstringOptional

Gets or sets the multiple birth order of the patient

livingArrangementstringOptional

Gets or sets the living arrangement

religionstringOptional

Gets or sets the religious affiliation

ethnicitystringOptional

Gets or sets the ethnicity codes

educationLevelstringOptional

Gets or sets the key of the education level

dateOfBirthPrecisionstring · enumOptional

Gets or sets the precision ofthe date of birth

Possible values:

genderConceptstringOptional

Gets or sets the gender concept key

dateOfBirthstringOptional

Gets the date of birth as XML

languagestringOptional

Gets the person's languages of communication

occupationstringOptional

Gets or sets the religious affiliation

maritalStatusstringOptional

Gets or sets the key of the marital status concept

deceasedDatestringOptional

Deceased date XML

deceasedDatePrecisionstring · enumOptional

Gets or sets the precision of the date of deceased

Possible values:

vipStatusstringOptional

Gets or sets the VIP code

nationalitystringOptional

Gets or sets the religious affiliation

addressstringOptional

Gets a list of all addresses associated with the entity

classConceptstringOptional

Class concept

creationActstringOptional

Creation act reference

determinerConceptstringOptional

Determiner concept

extensionstringOptional

Gets a list of all extensions associated with the entity

identifierstringOptional

Gets the identifiers associated with this entity

namestringOptional

Gets a list of all names associated with the entity

notestringOptional

Gets a list of all notes associated with the entity

participationstringOptional

Gets the acts in which this entity participates

relationshipstringOptional

Gets a list of all associated entities for this entity

statusConceptstringOptional

Status concept id

tagstringOptional

Gets a list of all tags associated with the entity

telecomstringOptional

Gets a list of all telecommunications addresses associated with the entity

templatestringOptional

Gets the template key

typeConceptstringOptional

Type concept identifier

policystringOptional

Gets or sets the security policy instances associated with the entity

geostringOptional

Gets or sets the geo tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

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

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

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

Responses

200

Operation was completed successfully

A bundle represents a batch of objects which are included within the bundle

modifiedOnstring · dateOptional

Gets the time the bundle was modified

correlationSeqnumber · int64Optional

Gets or sets the sequence control for this bundle

correlationIdstring · uuidOptional

A unique identifier which correlates this bundle with other bundles that are about the same "subject"

focalstring · uuid[]Optional

Entry into the bundle

offsetnumber · int32Optional

Gets or sets the count in this bundle

countnumber · int32Optional

Gets or sets the count in this bundle

totalResultsnumber · int32Optional

Gets or sets the total results

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/Patient/match-candidate/{childResourceKey}

GET /hdsi/Patient/match-candidate/{childResourceKey} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "modifiedOn": "2026-01-01",
  "correlationSeq": 1,
  "correlationId": "123e4567-e89b-12d3-a456-426614174000",
  "resource": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text",
      "modifiedOn": "2026-01-01"
    }
  ],
  "focal": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "offset": 1,
  "count": 1,
  "totalResults": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}

Removes a child resource instance from the parent container

delete

This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.

Required scopes

This endpoint requires the following scopes:

• : Login as a Service
• : Write Clinical Data

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

childResourceKeystringOptional

The actual value of the sub-key

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

A bundle represents a batch of objects which are included within the bundle

modifiedOnstring · dateOptional

Gets the time the bundle was modified

correlationSeqnumber · int64Optional

Gets or sets the sequence control for this bundle

correlationIdstring · uuidOptional

A unique identifier which correlates this bundle with other bundles that are about the same "subject"

focalstring · uuid[]Optional

Entry into the bundle

offsetnumber · int32Optional

Gets or sets the count in this bundle

countnumber · int32Optional

Gets or sets the count in this bundle

totalResultsnumber · int32Optional

Gets or sets the total results

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)

delete/Patient/match-candidate/{childResourceKey}

DELETE /hdsi/Patient/match-candidate/{childResourceKey} HTTP/1.1
Host: ims-ncc1701.santesuite.net:8443
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "modifiedOn": "2026-01-01",
  "correlationSeq": 1,
  "correlationId": "123e4567-e89b-12d3-a456-426614174000",
  "resource": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "Auto",
      "$type": "text",
      "modifiedOn": "2026-01-01"
    }
  ],
  "focal": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "offset": 1,
  "count": 1,
  "totalResults": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "operation": "Auto",
  "$type": "text"
}