GET api/v1/{EMRSystem}/PatientRegistries/Discovery
Returns the active Patient Registries configured in the EMR.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
The identifier of the user requesting the registries |
string |
Required |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Response Information
Collection of UdmPatientRegistriesDiscoveryResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| RegistryId |
The registry identifier |
string |
None. |
| RegistryName |
The registry name |
string |
None. |
| RegistryType |
The type of registry |
CodedObject |
None. |
| RegistryCategory |
The category of the registry |
CodedObject |
None. |
| ValidFromDate |
The date the registry became valid |
datetime |
None. |
| ValidToDate |
The date the registy stopped/will stop being valid |
datetime |
None. |
Response Codes
Http Status Code 200 - Indicates that the request was processed successfully.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
[
{
"RegistryId": "sample string 1",
"RegistryName": "sample string 2",
"RegistryType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"RegistryCategory": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ValidFromDate": "2025-12-12T20:55:02.4352332+00:00",
"ValidToDate": "2025-12-12T20:55:02.4352901+00:00"
},
{
"RegistryId": "sample string 1",
"RegistryName": "sample string 2",
"RegistryType": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"RegistryCategory": {
"Id": "sample string 1",
"Name": "sample string 2"
},
"ValidFromDate": "2025-12-12T20:55:02.4352332+00:00",
"ValidToDate": "2025-12-12T20:55:02.4352901+00:00"
}
]