PUT Allergies by AllergyId

Developer Tools

PUT api/v1/{EMRSystem}/Allergies/{AllergyId}

Updates an Allergy. Many of the fields require Ids that can be found using GET References/Discovery

HTTP Method

PUT

Applicable Emissary Products

Interactive Workflow

Allscripts

Released

Athena

Released

Cerner

Released

Meditech

In Dev

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The EMR system

EMRsystem

Required

AllergyId

Id of the allergy to update

string

Required

 
Body Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

UserId

The identifier of the user updating the Allergy.

string

Required

StatusId

The identifier of the Allergy status (must be an active status).

string

None.

ReactionTypeId

The identifier of the Reaction type of the Allergy.

string

The identifier of the Reaction type of the Allergy.

SeverityId

The identifier of the Allergy severity.

string

None.

ReactionIds

The identifier of the Reaction(s).

Collection of string

None.

Comments

Additional Allergy information.

string

None.

OnsetDate

The estimated date (string) of the Allergy onset.

string

None.

 

Response Information

 
Resource Description
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.

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 404 – Indicates that the resource to get could not be found.

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
Sample Message
Download Json Schema
{
  "UserId": "sample string 2",
  "StatusId": "sample string 3",
  "ReactionTypeId": "sample string 4",
  "SeverityId": "sample string 5",
  "ReactionIds": [
    "sample string 1",
    "sample string 2"
  ],
  "Comments": "sample string 6",
  "OnsetDate": "sample string 7"
}
Sample Message
<AllergyUpdateRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey i:nil="true" />
  <ApplicationName>sample string 11</ApplicationName>
  <EMRSystem>Allscripts</EMRSystem>
  <EmrInstance>sample string 10</EmrInstance>
  <LoginId>sample string 8</LoginId>
  <Password>sample string 9</Password>
  <AllergyId>sample string 1</AllergyId>
  <Comments>sample string 6</Comments>
  <OnsetDate>sample string 7</OnsetDate>
  <ReactionIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReactionIds>
  <ReactionTypeId>sample string 4</ReactionTypeId>
  <SeverityId>sample string 5</SeverityId>
  <StatusId>sample string 3</StatusId>
  <UserId>sample string 2</UserId>
</AllergyUpdateRequestViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?