POST Forms/FormEntry/InitializeNote
Get empty form entry note
Request Information
URI Parameters
None.
Body Parameters
Initialize criteria
FormEntryDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Context | FormContext |
None. |
|
| FormEntryID | integer |
None. |
|
| PreviousFormEntryID | integer |
None. |
|
| FormID | integer |
None. |
|
| IsDraft | boolean |
None. |
|
| Status | FormEntryStatus |
None. |
|
| StatusReason | string |
None. |
|
| StatusLastUpdatedByUserID | integer |
None. |
|
| ReviewStatus | FormEntryReviewStatus |
None. |
|
| ReviewStatusReason | string |
None. |
|
| ReviewStatusLastUpdatedByUserID | integer |
None. |
|
| StartDateUtc | date |
None. |
|
| StopDateUtc | date |
None. |
|
| DateSummary | string |
None. |
|
| LockDateUtc | date |
None. |
|
| CustomStatus | string |
None. |
|
| CustomStatusReason | string |
None. |
|
| ParentFormEntryID | integer |
None. |
|
| ParentFieldID | integer |
None. |
|
| RecordState | ClinicalFormRecordState |
None. |
|
| CreatedByUserID | integer |
None. |
|
| LastUpdatedByUserID | integer |
None. |
|
| StatusLastUpdated | FormAuditDataOptionalDto |
None. |
|
| ReviewStatusLastUpdated | FormAuditDataOptionalDto |
None. |
|
| Entities | Collection of EntityFormDto |
None. |
|
| Notes | Collection of FormEntryNoteDto |
None. |
|
| ValidationResults | Collection of FormEntryValidationResultDto |
None. |
|
| EventRecurrences | Collection of FormEntryEventRecurrenceDto |
None. |
|
| Events | Collection of FormEntryEventDto |
None. |
|
| Form | FormDto |
None. |
|
| Parameters | Collection of FormFieldParameterDto |
None. |
|
| Created | FormAuditDataDto |
None. |
|
| LastUpdated | FormAuditDataDto |
None. |
|
| RecalculateIndex | integer |
None. |
|
| Permissions | FormEntryPermissionsDto |
None. |
|
| FormEntryType | FormEntryType |
None. |
Response Information
Resource Description
NoteDTO
NoteDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| NoteID |
Note ID |
integer |
None. |
| NoteDateUtc |
Note Date Utc |
date |
None. |
| Subject |
Subject |
string |
None. |
| Contents |
Contents |
string |
None. |
| IsDraft |
Is Draft |
boolean |
None. |
| CustomStatus |
Custom Status |
string |
None. |
| RecordState |
Record State |
ClinicalRecordState |
None. |
| RecordStateReason |
Record State Reason |
string |
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. |
| Entities |
Entities |
Collection of EntityNoteDTO |
None. |
| Extensions |
Extensions |
Collection of FormDataExtensionDto |
None. |
| NoteTypes |
Note Types |
Collection of NoteNoteTypeDTO |
None. |
| FollowUpRequired |
Follow Up Required |
boolean |
None. |