PUT api/v1/{EMRSystem}/PharmacyInterventions/{InterventionId}
Updates a Pharmacy Intervention.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| InterventionId |
The Pharmacy Intervention identifier. |
string |
Required |
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmPharmacyInterventionUpdateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Gets or sets the user identifier. |
string |
Required |
| Intervention |
Gets or sets the intervention. |
PharmacyInterventionUpdate |
Required |
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 2",
"Intervention": {
"Types": {
"FieldId": "sample string 1",
"CodedValueIds": [
"sample string 1",
"sample string 2"
],
"TextValues": [
"sample string 1",
"sample string 2"
]
},
"SubTypes": {
"FieldId": "sample string 1",
"CodedValueIds": [
"sample string 1",
"sample string 2"
],
"TextValues": [
"sample string 1",
"sample string 2"
]
},
"StatusId": "sample string 1",
"Significance": {
"FieldId": "sample string 1",
"CodedValueIds": [
"sample string 1",
"sample string 2"
],
"TextValues": [
"sample string 1",
"sample string 2"
]
},
"TimeSpent": {
"FieldId": "sample string 1",
"CodedValueIds": [
"sample string 1",
"sample string 2"
],
"TextValues": [
"sample string 1",
"sample string 2"
]
},
"Value": {
"FieldId": "sample string 1",
"CodedValueIds": [
"sample string 1",
"sample string 2"
],
"TextValues": [
"sample string 1",
"sample string 2"
]
},
"Response": {
"FieldId": "sample string 1",
"CodedValueIds": [
"sample string 1",
"sample string 2"
],
"TextValues": [
"sample string 1",
"sample string 2"
]
},
"Outcomes": {
"FieldId": "sample string 1",
"CodedValueIds": [
"sample string 1",
"sample string 2"
],
"TextValues": [
"sample string 1",
"sample string 2"
]
},
"AdditionalDetails": [
{
"FieldId": "sample string 1",
"CodedValueIds": [
"sample string 1",
"sample string 2"
],
"TextValues": [
"sample string 1",
"sample string 2"
]
},
{
"FieldId": "sample string 1",
"CodedValueIds": [
"sample string 1",
"sample string 2"
],
"TextValues": [
"sample string 1",
"sample string 2"
]
}
],
"LinkedOrders": [
{
"OrderId": "sample string 1",
"LinkTypeId": "sample string 2"
},
{
"OrderId": "sample string 1",
"LinkTypeId": "sample string 2"
}
],
"AssociatedUsers": [
{
"UserId": "sample string 1",
"RoleId": "sample string 2"
},
{
"UserId": "sample string 1",
"RoleId": "sample string 2"
}
],
"Documentation": "sample string 2",
"Notes": "sample string 3"
},
"LoginId": "sample string 4",
"Password": "sample string 5",
"EmrInstance": "sample string 6",
"ApplicationName": "sample string 7",
"ApplicationKey": null,
"AuthorizationToken": "sample string 9",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
None.
Response Codes
Http Status Code 204 - Indicates that the request was processed successfully.
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
null