GET api/v1/{EMRSystem}/Allergies
Returns both active and inactive Allergies and related allergic reactions for a given patient. FHIR connectors use the following resources for R4: AllergyIntolerance.Search, Patient.Read, and Practitioner.Read.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
| UserId |
Gets or sets the user identifier. |
string |
Required |
| PatientId |
Gets or sets the patient identifier. |
string |
Required |
| UserType |
Gets or sets the type of the user. |
UserType |
None. |
| ShowCancelled |
Gets or sets a value indicating whether [show cancelled]. |
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
UdmAllergiesResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientId |
Gets or sets the patient identifier. |
string |
None. |
| NoKnownAllergies |
Gets or sets a value indicating whether [no known allergies]. |
boolean |
None. |
| NoKnownDrugAllergies |
Gets or sets a value indicating whether [no known drug allergies]. |
boolean |
None. |
| NoKnownDateTime |
Gets or sets the no known date time. |
datetime |
None. |
| NoKnownDocBy |
Gets or sets the no known document by. |
string |
None. |
| ReviewedStatus |
Gets or sets the reviewed status. |
string |
None. |
| ReviewedDateTime |
Gets or sets the reviewed date time. |
datetime |
None. |
| ReviewedBy |
Gets or sets the reviewed by. |
string |
None. |
| Allergies |
Gets or sets the Allergies. |
Collection of Allergy |
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
{
"PatientId": "sample string 1",
"NoKnownAllergies": true,
"NoKnownDrugAllergies": true,
"NoKnownDateTime": "2025-12-12T21:08:48.3857668+00:00",
"NoKnownDocBy": "sample string 2",
"ReviewedStatus": "sample string 3",
"ReviewedDateTime": "2025-12-12T21:08:48.3860849+00:00",
"ReviewedBy": "sample string 4",
"Allergies": [
{
"AllergyId": "sample string 1",
"AllergenCode": "sample string 2",
"AllergenDesc": "sample string 3",
"PatientId": "sample string 4",
"Severity": "sample string 5",
"OnsetDateTime": "2025-12-12T21:08:48.3871164+00:00",
"Category": "sample string 6",
"EnteredBy": "sample string 7",
"ReviewedDateTime": "2025-12-12T21:08:48.3874294+00:00",
"ReviewedBy": "sample string 8",
"Comments": [
"sample string 1",
"sample string 2"
],
"Status": "sample string 9",
"Cancelled": true,
"CancelledDateTime": "2025-12-12T21:08:48.3878556+00:00",
"CancelledBy": "sample string 10",
"CreatedDateTime": "2025-12-12T21:08:48.3880411+00:00",
"Reactions": [
{
"ReactionId": "sample string 1",
"ReactionDesc": "sample string 2",
"Active": true
},
{
"ReactionId": "sample string 1",
"ReactionDesc": "sample string 2",
"Active": true
}
]
},
{
"AllergyId": "sample string 1",
"AllergenCode": "sample string 2",
"AllergenDesc": "sample string 3",
"PatientId": "sample string 4",
"Severity": "sample string 5",
"OnsetDateTime": "2025-12-12T21:08:48.3871164+00:00",
"Category": "sample string 6",
"EnteredBy": "sample string 7",
"ReviewedDateTime": "2025-12-12T21:08:48.3874294+00:00",
"ReviewedBy": "sample string 8",
"Comments": [
"sample string 1",
"sample string 2"
],
"Status": "sample string 9",
"Cancelled": true,
"CancelledDateTime": "2025-12-12T21:08:48.3878556+00:00",
"CancelledBy": "sample string 10",
"CreatedDateTime": "2025-12-12T21:08:48.3880411+00:00",
"Reactions": [
{
"ReactionId": "sample string 1",
"ReactionDesc": "sample string 2",
"Active": true
},
{
"ReactionId": "sample string 1",
"ReactionDesc": "sample string 2",
"Active": true
}
]
}
]
}