GET Clients/Allergy
Get clientAllergies from criteria
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeActive |
Include records where RecordState == ClinicalRecordState.Active |
boolean |
None. |
| IncludeInactive |
Include records where RecordState == ClinicalRecordState.Inactive |
boolean |
None. |
| IncludeDeleted |
Include records where RecordState == ClinicalRecordState.Deleted |
boolean |
None. |
| IncludeError |
Include records where RecordState == ClinicalRecordState.Error |
boolean |
None. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| ClientAllergyIDs |
Filter by ClientAllergyIDs |
Collection of integer |
None. |
| BusinessUnits |
Filter by BusinessUnit(s) |
Collection of integer |
None. |
| ClientID |
Filter by ClientID |
integer |
None. |
| AllergyID |
Filter by AllergyID |
integer |
None. |
| CustomAllergyDescription |
Filter by CustomAllergyDescription |
string |
None. |
| ReportDateUtcMin |
Filter by ReportDateUtcMin |
date |
None. |
| ReportDateUtcMax |
Filter by ReportDateUtcMax |
date |
None. |
| OnsetDateUtcMin |
Filter by OnsetDateUtcMin |
date |
None. |
| OnsetDateUtcMax |
Filter by OnsetDateUtcMax |
date |
None. |
| IsOnsetDateEstimated |
Filter by IsOnsetDateEstimated |
boolean |
None. |
| Severity |
Filter by Severity |
string |
None. |
| Reaction |
Filter by Reaction |
string |
None. |
| InterventionAfterExposure |
Filter by InterventionAfterExposure |
string |
None. |
| Comments |
Filter by Comments |
string |
None. |
| ExceptClientAllergyID |
Filter out by ClientAllergyID |
integer |
None. |
| MaxRows |
Limit number of rows |
integer |
None. |
| CreatedByUserID |
Filter by CreatedByUserID |
integer |
None. |
| LastUpdatedByUserID |
Filter by LastUpdatedByUserID |
integer |
None. |
| CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
| CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
| LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
| LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
| IncludePayload |
Include sources |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
List of ClientAllergyDTOs
Collection of ClientAllergyDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientAllergyID |
Client Allergy ID |
integer |
None. |
| ClientID |
Client ID |
integer |
None. |
| AllergyID |
Allergy ID |
integer |
None. |
| AllergyType |
Allergy Type |
AllergyType |
None. |
| AllergyCode |
Allergy Code |
string |
None. |
| AllergyDescription |
Allergy Description |
string |
None. |
| ReportDate |
Report Date |
date |
None. |
| OnsetDate |
Onset Date |
date |
None. |
| IsOnsetDateEstimated |
Is Onset Date Estimated |
boolean |
None. |
| Severity |
Severity |
string |
None. |
| Reactions |
Reactions |
Collection of string |
None. |
| InterventionAfterExposure |
Intervention After Exposure |
string |
None. |
| Comments |
Comments |
string |
None. |
| Sources |
Sources |
Collection of ClientAllergySourceDTO |
None. |
| Props |
Props |
Collection of Object |
None. |
| RecordState |
Record State |
ClinicalRecordState |
None. |
| CreatedByUserID |
Created By User ID |
integer |
None. |
| LastUpdatedByUserID |
Last Updated By User ID |
integer |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |