GET api/CustomForm/{id}?patientId={patientId}&encounterTypeId={encounterTypeId}&moduleName={moduleName}&encounterId={encounterId}&recordId={recordId}&moduleAreaId={moduleAreaId}
Customform Get
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
|
patientId | globally unique identifier |
Required |
|
encounterTypeId | globally unique identifier |
Required |
|
moduleName | string |
Required |
|
encounterId | globally unique identifier |
Required |
|
recordId | globally unique identifier |
Required |
|
moduleAreaId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of CustomFormViewModelName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
ModuleName | string |
None. |
|
ModuleOrder | integer |
None. |
|
ModuleParentId | integer |
None. |
|
ModuleId | integer |
None. |
|
CustomFormId | globally unique identifier |
None. |
|
CustomFormName | string |
None. |
|
Description | string |
None. |
|
IsAllowMultiple | boolean |
None. |
|
ParentId | globally unique identifier |
None. |
|
CustomFormRule | string |
None. |
|
Title | string |
None. |
|
SubTitle | string |
None. |
|
IsRequired | boolean |
None. |
|
Rule | string |
None. |
|
StyleId | integer |
None. |
|
Name | string |
None. |
|
ClientTitle | string |
None. |
|
ClientSubTitle | string |
None. |
|
ProviderTitle | string |
None. |
|
ProviderSubTitle | string |
None. |
|
Option1 | string |
None. |
|
Option2 | string |
None. |
|
DefaultValue | string |
None. |
|
ErrorMessage | string |
None. |
|
ControlId | integer |
None. |
|
DataTypeId | integer |
None. |
|
Order | integer |
None. |
|
DataMask | string |
None. |
|
MinLength | string |
None. |
|
MaxLength | string |
None. |
|
Controls | string |
None. |
|
DataType | string |
None. |
|
Style | string |
None. |
|
FormType | string |
None. |
|
Value | string |
None. |
|
CustomFormInputDetailId | globally unique identifier |
None. |
|
CustomFormParentId | globally unique identifier |
None. |
|
CustomFormFieldsId | globally unique identifier |
None. |
|
CustomFormDisplayOrder | integer |
None. |
|
IsRead | boolean |
None. |
|
IsWrite | boolean |
None. |
|
ShowOnce | boolean |
None. |
|
ResultHtml | string |
None. |
|
Code | string |
None. |
|
FormClientTitle | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "1f107860-9494-463d-b133-26469500770d", "ModuleName": "sample string 1", "ModuleOrder": 2, "ModuleParentId": 1, "ModuleId": 3, "CustomFormId": "cb913272-a997-49d4-aed3-d622189ad527", "CustomFormName": "sample string 5", "Description": "sample string 6", "IsAllowMultiple": true, "ParentId": "f50cee97-deda-435d-bb50-3daf4dd1e5fe", "CustomFormRule": "sample string 8", "Title": "sample string 9", "SubTitle": "sample string 10", "IsRequired": true, "Rule": "sample string 12", "StyleId": 13, "Name": "sample string 14", "ClientTitle": "sample string 15", "ClientSubTitle": "sample string 16", "ProviderTitle": "sample string 17", "ProviderSubTitle": "sample string 18", "Option1": "sample string 19", "Option2": "sample string 20", "DefaultValue": "sample string 21", "ErrorMessage": "sample string 22", "ControlId": 23, "DataTypeId": 24, "Order": 25, "DataMask": "sample string 26", "MinLength": "sample string 27", "MaxLength": "sample string 28", "Controls": "sample string 29", "DataType": "sample string 30", "Style": "sample string 31", "FormType": "sample string 32", "Value": "sample string 33", "CustomFormInputDetailId": "9e76d70f-2f45-44f7-b8f4-c12e021fe55e", "CustomFormParentId": "baa4e87a-7884-4f1d-8a5a-d9db8816bff7", "CustomFormFieldsId": "039d4ae6-0297-4238-8444-70b761116acd", "CustomFormDisplayOrder": 34, "IsRead": true, "IsWrite": true, "ShowOnce": true, "ResultHtml": "sample string 35", "Code": "sample string 36", "FormClientTitle": "sample string 37" }, { "Id": "1f107860-9494-463d-b133-26469500770d", "ModuleName": "sample string 1", "ModuleOrder": 2, "ModuleParentId": 1, "ModuleId": 3, "CustomFormId": "cb913272-a997-49d4-aed3-d622189ad527", "CustomFormName": "sample string 5", "Description": "sample string 6", "IsAllowMultiple": true, "ParentId": "f50cee97-deda-435d-bb50-3daf4dd1e5fe", "CustomFormRule": "sample string 8", "Title": "sample string 9", "SubTitle": "sample string 10", "IsRequired": true, "Rule": "sample string 12", "StyleId": 13, "Name": "sample string 14", "ClientTitle": "sample string 15", "ClientSubTitle": "sample string 16", "ProviderTitle": "sample string 17", "ProviderSubTitle": "sample string 18", "Option1": "sample string 19", "Option2": "sample string 20", "DefaultValue": "sample string 21", "ErrorMessage": "sample string 22", "ControlId": 23, "DataTypeId": 24, "Order": 25, "DataMask": "sample string 26", "MinLength": "sample string 27", "MaxLength": "sample string 28", "Controls": "sample string 29", "DataType": "sample string 30", "Style": "sample string 31", "FormType": "sample string 32", "Value": "sample string 33", "CustomFormInputDetailId": "9e76d70f-2f45-44f7-b8f4-c12e021fe55e", "CustomFormParentId": "baa4e87a-7884-4f1d-8a5a-d9db8816bff7", "CustomFormFieldsId": "039d4ae6-0297-4238-8444-70b761116acd", "CustomFormDisplayOrder": 34, "IsRead": true, "IsWrite": true, "ShowOnce": true, "ResultHtml": "sample string 35", "Code": "sample string 36", "FormClientTitle": "sample string 37" } ]