POST api/v1/{EMRSystem}/Forms/Powerform
Creates a new Form.
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmFormCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Gets or sets the user identifier. |
string |
Required |
| FormTemplateId |
The identifier of the form template. |
string |
Required if EMRSystem = Cerner |
| EncounterId |
The identifier of the encounter associated with the intervention |
string |
Required |
| SystemId |
The identifier of the system submitted the form |
string |
None. |
| ReferenceNumber |
The reference number of the sending system. |
string |
None. |
| EnforceFieldControlLogic |
Boolean to determine if form conditional logic should be maintained or bypassed. |
boolean |
None. |
| DocumentDateTime |
The datetime of the form. |
datetime |
None. |
| PerformedDateTime |
The datetime the form documented. |
datetime |
None. |
| IncludeSocialHistoryOnNonSubmittedSections |
Boolean to include the social history component on sections that weren't included in the field inputs list |
boolean |
None. |
| FieldInputs |
Individual fields for the form |
Collection of FormFieldsCreate |
None. |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Request Formats
application/json
{
"UserId": "sample string 1",
"FormTemplateId": "sample string 2",
"EncounterId": "sample string 3",
"SystemId": "sample string 4",
"ReferenceNumber": "sample string 5",
"EnforceFieldControlLogic": true,
"DocumentDateTime": "2025-12-12T21:03:45.2873937+00:00",
"PerformedDateTime": "2025-12-12T21:03:45.2874686+00:00",
"IncludeSocialHistoryOnNonSubmittedSections": true,
"FieldInputs": [
{
"ComponentId": "sample string 1",
"CodedValueIds": [
"sample string 1",
"sample string 2"
],
"TextValues": [
"sample string 1",
"sample string 2"
],
"NumericValues": [
{
"Value": "sample string 1",
"UnitId": "sample string 2"
},
{
"Value": "sample string 1",
"UnitId": "sample string 2"
}
]
},
{
"ComponentId": "sample string 1",
"CodedValueIds": [
"sample string 1",
"sample string 2"
],
"TextValues": [
"sample string 1",
"sample string 2"
],
"NumericValues": [
{
"Value": "sample string 1",
"UnitId": "sample string 2"
},
{
"Value": "sample string 1",
"UnitId": "sample string 2"
}
]
}
],
"LoginId": "sample string 9",
"Password": "sample string 10",
"EmrInstance": "sample string 11",
"ApplicationName": "sample string 12",
"ApplicationKey": null,
"AuthorizationToken": "sample string 14",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
UdmFormCreateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| FormId |
Gets or sets the form identifier. |
string |
None. |
Response Codes
Http Status Code 201 - Indicates that the requested record was successfully created.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
{
"FormId": "sample string 1"
}