| Name | Description | Type | Additional information |
|---|---|---|---|
| VisionModelItemId |
The internal id of the VisionModelItem |
integer |
Required |
| VisionModelName |
The name of the VisionModel |
string |
- |
| Description |
The description/content of the client report. The text format must match the specified Format (WordML/RTF/PlainText) |
string |
- |
| Subjective |
The Subjective. This is part of the SOEP model |
string |
- |
| Objective |
The Objective. This is part of the SOEP model |
string |
- |
| Evaluation |
The Evaluation. This is part of the SOEP model |
string |
- |
| Plan |
The Plan. This is part of the SOEP model |
string |
- |
| IsSubjectiveVisibleForAllowedDisciplines |
Determines if the Subjective is visible for the specified disciplines |
boolean |
- |
| IsObjectiveVisibleForAllowedDisciplines |
Determines if the Objective is visible for the specified disciplines |
boolean |
- |
| IsEvaluationVisibleForAllowedDisciplines |
Determines if the Evaluation is visible for the specified disciplines |
boolean |
- |
| IsPlanVisibleForAllowedDisciplines |
Determines if the Plan is visible for the specified disciplines |
boolean |
- |
| LayoutType |
The layout of the report. Available options are PlainText and SOEP. |
ClientReportingLayout |
Required |
| Format |
Describes the format that is used for the Description property |
ApiTextFormat |
- |
| OriginalFreeTextFormat |
Describes the original format of the Description property. For reading purposes only. If the original format of the clientreport is WordMl, changes cannot be made in PlainText. |
OriginalFreeTextFormat |
- |
| Id |
The internal id of the report |
integer |
Required |
| AggregateId |
AggregateId of the report. For reading purposes only. |
globally unique identifier |
- |
| ClientId |
The internal id of the client |
integer |
Required |
| ClientName |
The name of the client |
string |
- |
| CreationDate |
The creation date of the client report |
date |
- |
| ModifiedDate |
The modified date of the client report |
date |
- |
| AvailableFor |
Determines the read permission for the report. When the value is 'Disciplines', only the specified disciplines can read the report. When the value is 'Everyone', everyone can read the report. The default value is Everyone |
AvailableFor |
Required |
| AvailableForDisciplineIds |
The list of disciplines ids that are allowed to read the report. |
Collection of integer |
- |
| AvailableForDisciplineNames |
The list of disciplines that are allowed to read the report. This property is for reading purposes only. |
Collection of string |
- |
| AvailableForDisciplineGroupIds |
The list of disciplinegroups ids that are allowed to read the report. |
Collection of integer |
- |
| AvailableForDisciplineGroupNames |
The list of disciplinegroups that are allowed to read the report. This property is for reading purposes only. |
Collection of string |
- |
| Subject |
The subject of the client report. |
string |
Conditional Required: Only required for 'General' client report type |
| Date |
The date of the client report. |
date |
Required |
| Priority |
The priority of the report. |
boolean |
Required |
| PriorityText |
The priority of the client report. This property is for reading purposes only. |
string |
- |
| EmployeeId |
The internal id of employee. This property is for reading purposes only. EmployeeId of the provided token will be used when creating a new ClientReport. |
integer |
Required |
| EmployeeName |
The original creator of the client report. This property is for reading purposes only. |
string |
- |
| ShiftId |
The internal id of the shift. |
integer |
Required |
| Shift |
The shift of the client report. This property is for reading purposes only. |
string |
- |
| DisciplineId |
The internal id of the discipline. |
integer |
Required |
| Discipline |
The discipline of the client report. This property is for reading purposes only. |
string |
- |
| TypeDescription |
The type of the client report. This property is for reading purposes only. |
string |
- |
| ReportTags |
The tags of the client report. |
Collection of ReportTag |
- |
| ReportTagsText |
The tags of the client report formatted in a string. This property is for reading purposes only. |
string |
- |
| AttributeIds |
The list of selected attribute id's. |
Collection of integer |
Deprecated (unavailable from 21.01.1P): Please use 'ReportTags' instead. |
| Attributes |
The attributes of the client report. This property is for reading purposes only. |
string |
Deprecated (unavailable from 21.01.1P): Please use 'ReportTagsText' instead. |
| ParentId |
The internal id of the parent client report on which this client report is based. |
integer |
Nullable |
| ChildReports |
The child reports of the client report. |
Collection of ClientReport |
- |
| ContactTypeId |
References to a Choice of ChoiceType 'CONTACTTYPE'. |
integer |
Nullable |