GET api/v1/{EMRSystem}/References/Discovery
Returns the Reference Codes available within the installed EMR system.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
The identifier of the user making the request. |
string |
Required |
| ServiceName |
The name of the service. |
ServiceName |
Required |
| RequestOrResponse |
Is the field to be discovered from the Request parameters or the Response parameters. |
RequestOrResponse |
Required |
| FieldPathAndName |
The path and name of the field to be discovered. |
string |
Required |
| IncludeInactive |
Should the results include inactive values. |
boolean |
None. |
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
UdmReferenceDiscoveryResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Codes |
Gets or sets the codes. |
Collection of ReferenceCode |
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
{
"Codes": [
{
"Active": true,
"Id": "sample string 1",
"Description": "sample string 2",
"Display": "sample string 3",
"KeyName": "sample string 4",
"Synonyms": [
"sample string 1",
"sample string 2"
],
"CustomScreenId": "sample string 5",
"CodeValueExtensions": [
{
"FieldName": "sample string 1",
"FieldType": "sample string 2",
"FieldValue": "sample string 3"
},
{
"FieldName": "sample string 1",
"FieldType": "sample string 2",
"FieldValue": "sample string 3"
}
]
},
{
"Active": true,
"Id": "sample string 1",
"Description": "sample string 2",
"Display": "sample string 3",
"KeyName": "sample string 4",
"Synonyms": [
"sample string 1",
"sample string 2"
],
"CustomScreenId": "sample string 5",
"CodeValueExtensions": [
{
"FieldName": "sample string 1",
"FieldType": "sample string 2",
"FieldValue": "sample string 3"
},
{
"FieldName": "sample string 1",
"FieldType": "sample string 2",
"FieldValue": "sample string 3"
}
]
}
]
}