GET Clients/Diagnosis
Get clientDiagnosiss from criteria
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientDiagnosisIDs |
Filter by ClientDiagnosisIDs |
Collection of integer |
None. |
| BusinessUnits |
Filter by BusinessUnit(s) |
Collection of integer |
None. |
| ClientID |
Filter by ClientID |
integer |
None. |
| DiagnosisID |
Filter by DiagnosisID |
integer |
None. |
| DiagnosisCode |
Filter by DiagnosisCode |
string |
None. |
| DiagnosisDescription |
Filter by DiagnosisDescription |
string |
None. |
| DiagnosisFullDescription |
Filter by DiagnosisFullDescription |
string |
None. |
| DiagnosisDateMin |
Filter by DiagnosisDateUtcMin |
date |
None. |
| DiagnosisDateMax |
Filter by DiagnosisDateUtcMax |
date |
None. |
| CustomDiagnosisDescription |
Filter by CustomDiagnosisDescription |
string |
None. |
| OnsetType |
Filter by OnsetType |
ClientDiagnosisOnsetType |
None. |
| Severity |
Filter by Severity |
string |
None. |
| ResolutionDateMin |
Filter by ResolutionDateUtcMin |
date |
None. |
| ResolutionDateMax |
Filter by ResolutionDateUtcMax |
date |
None. |
| Comments |
Filter by Comments |
string |
None. |
| ExceptClientDiagnosisID |
Filter out by ClientDiagnosisID |
integer |
None. |
| IsSignificant |
Only significant diagnoses |
boolean |
None. |
| MaxRows |
Limit number of rows |
integer |
None. |
| CreatedByUserID |
Filter by CreatedByUserID |
integer |
None. |
| LastUpdatedByUserID |
Filter by LastUpdatedByUserID |
integer |
None. |
| IncludePayload |
Include sources |
boolean |
None. |
| IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
| IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
| IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
| IncludeError |
Include records where RecordState == RecordState.CreatedInError |
boolean |
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. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
Body Parameters
None.
Response Information
Resource Description
List of ClientDiagnosisDTOs
Collection of ClientDiagnosisDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientDiagnosisID |
Client Diagnosis ID |
integer |
None. |
| ClientID |
Client ID |
integer |
None. |
| DiagnosisID |
Diagnosis ID |
integer |
None. |
| DiagnosisCode |
Diagnosis Code |
string |
None. |
| DiagnosisDescription |
Diagnosis Description |
string |
None. |
| DiagnosisFullDescription |
Diagnosis Description |
string |
None. |
| DiagnosisDate |
Diagnosis Date |
date |
None. |
| ResolutionDate |
Resolution Date |
date |
None. |
| OnsetType |
Onset Type |
ClientDiagnosisOnsetType |
None. |
| Severity |
Severity |
string |
None. |
| IsSignificant |
Is Significant |
boolean |
None. |
| Comments |
Comments |
string |
None. |
| Sources |
Sources |
Collection of ClientDiagnosisSourceDTO |
None. |
| Props |
Props |
Collection of Object |
None. |
| RecordState |
Record State |
ClinicalRecordState |
None. |
| SortOrder |
Sort Order |
integer |
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. |
| DiagnosesTableID |
DiagnosesTableID - naming it Diagnoses instead of Diagnosis to be consistent with what comes back from DiagnosisTableController Get method |
integer |
None. |
| DiagnosisTableName |
DiagnosesTableName |
string |
None. |
| DiagnosisReference |
DiagnosisReference |
string |
None. |