POST api/v1/{EMRSystem}/SocialHistories
Creates a new Social History.
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmSocialHistoryCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Gets or sets the user identifier. |
string |
Required |
| PatientId |
The identifier of the patient. |
string |
Required |
| FacilityId |
The identifier of the facility. |
string |
Required if EMRSystem = Cerner |
| UnableToObtain |
Denotes that the user was unable to obtain social history information for the patient (not currently supported). |
boolean |
None. |
| CategoryId |
The identifier of the social history category. |
string |
None. |
| AssessmentResponseId |
Gets or sets the social history assessment response identifier (not currently supported). |
string |
None. |
| Comment |
Comment for a social history category (if filled in UnableToObtain and AssessmentResponseId must be null). |
string |
None. |
| FieldInputs |
Individual fields for a social history category (if filled in UnableToObtain and AssessmentResponseId must be null). |
Collection of SocialHistoryFieldCreate |
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",
"PatientId": "sample string 2",
"FacilityId": "sample string 3",
"UnableToObtain": true,
"CategoryId": "sample string 4",
"AssessmentResponseId": "sample string 5",
"Comment": "sample string 6",
"FieldInputs": [
{
"FieldId": "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",
"ModifierId": "sample string 3"
},
{
"Value": "sample string 1",
"UnitId": "sample string 2",
"ModifierId": "sample string 3"
}
]
},
{
"FieldId": "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",
"ModifierId": "sample string 3"
},
{
"Value": "sample string 1",
"UnitId": "sample string 2",
"ModifierId": "sample string 3"
}
]
}
],
"LoginId": "sample string 8",
"Password": "sample string 9",
"EmrInstance": "sample string 10",
"ApplicationName": "sample string 11",
"ApplicationKey": null,
"AuthorizationToken": "sample string 13",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
UdmSocialHistoryCreateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| SocialHistoryId |
Gets or sets the social history 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
{
"SocialHistoryId": "sample string 1"
}