POST Allergies

Developer Tools

POST api/v1/{EMRSystem}/Allergies

Creates an Allergy for a given patient.

HTTP Method

POST

Applicable Emissary Products

Interactive Workflow

Allscripts

In Dev

Athena

In Dev

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

 
Body Parameters
The allergy create request view model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

UserId

The identifier of the user creating the Allergy order.

string

Required

PatientId

The identifier of the patient.

string

Required

AllergenId

The identifier of the Allergy.

string

Required

ReactionIds

The identifier of the Reaction(s).

Collection of string

None.

SeverityId

The identifier of the Severity.

string

None.

Comments

Additional Allergy information.

string

None.

OnsetDate

The estimated date (string) of the Allergy onset.

string

None.

 

Response Information

 
Resource Description
Http response containing newly created Allergy Id.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.

 
Response Codes

Http Status Code 201 – 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 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 1",
  "PatientId": "sample string 2",
  "AllergenId": "sample string 3",
  "ReactionIds": [
    "sample string 1",
    "sample string 2"
  ],
  "SeverityId": "sample string 4",
  "Comments": "sample string 5",
  "OnsetDate": "sample string 6",
  "Domain": "sample string 7",
  "LoginId": "sample string 8",
  "Password": "sample string 9",
  "EmrInstance": "sample string 10",
  "ApplicationName": "sample string 11",
  "ApplicationKey": "sample string 12"
}
Sample Message
<AllergyCreateRequestViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey>sample string 12</ApplicationKey>
  <ApplicationName>sample string 11</ApplicationName>
  <Domain>sample string 7</Domain>
  <EmrInstance>sample string 10</EmrInstance>
  <LoginId>sample string 8</LoginId>
  <Password>sample string 9</Password>
  <AllergenId>sample string 3</AllergenId>
  <Comments>sample string 5</Comments>
  <OnsetDate>sample string 6</OnsetDate>
  <PatientId>sample string 2</PatientId>
  <ReactionIds xmlns:d2p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReactionIds>
  <SeverityId>sample string 4</SeverityId>
  <UserId>sample string 1</UserId>
</AllergyCreateRequestViewModel>

Submit a Comment

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

 

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