GET Allergies

GET api/v1/{EMRSystem}/Allergies

Returns both active and inactive allergies and related allergic reactions for a given patient.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Analytics
Interactive

Allscripts

Released

Athena

Released

Cerner

Released

Epic

Released

Meditech

Released

Sandbox

Released

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

UserId

Gets or sets the user identifier.

string

Required

PatientId

Gets or sets the patient identifier.

string

Required

UserType

Gets or sets the type of the user.

UserType

None

ShowCancelled

Gets or sets a value indicating whether [show cancelled].

boolean

None

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing Allergies Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

PatientId

Gets or sets the patient identifier.

string

None.

NoKnownAllergies

Gets or sets a value indicating whether [no known allergies].

boolean

None.

NoKnownDateTime

Gets or sets the no known date time.

date

None.

NoKnownDocBy

Gets or sets the no known document by.

string

None.

ReviewedStatus

Gets or sets the reviewed status.

string

None.

ReviewedDateTime

Gets or sets the reviewed date time.

date

None.

ReviewedBy

Gets or sets the reviewed by.

string

None.

Allergies

Gets or sets the Allergies.

Collection of AllergyViewModel

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.AllergiesResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

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
{
  "PatientId": "sample string 1",
  "NoKnownAllergies": true,
  "NoKnownDateTime": "2018-01-27T18:45:35.3551463Z",
  "NoKnownDocBy": "sample string 2",
  "ReviewedStatus": "sample string 3",
  "ReviewedDateTime": "2018-01-27T18:45:35.3551463Z",
  "ReviewedBy": "sample string 4",
  "Allergies": [
    {
      "AllergyId": "sample string 1",
      "AllergenCode": "sample string 2",
      "AllergenDesc": "sample string 3",
      "PatientId": "sample string 4",
      "Severity": "sample string 5",
      "OnsetDateTime": "2018-01-27T18:45:35.3551463Z",
      "Category": "sample string 6",
      "EnteredBy": "sample string 7",
      "ReviewedDateTime": "2018-01-27T18:45:35.3551463Z",
      "ReviewedBy": "sample string 8",
      "Comments": [
        "sample string 1",
        "sample string 2"
      ],
      "Status": "sample string 9",
      "Cancelled": true,
      "CancelledDateTime": "2018-01-27T18:45:35.3551463Z",
      "CancelledBy": "sample string 10",
      "CreatedDateTime": "2018-01-27T18:45:35.3551463Z",
      "Reactions": [
        {
          "ReactionId": "sample string 1",
          "ReactionDesc": "sample string 2",
          "Active": true
        },
        {
          "ReactionId": "sample string 1",
          "ReactionDesc": "sample string 2",
          "Active": true
        }
      ]
    },
    {
      "AllergyId": "sample string 1",
      "AllergenCode": "sample string 2",
      "AllergenDesc": "sample string 3",
      "PatientId": "sample string 4",
      "Severity": "sample string 5",
      "OnsetDateTime": "2018-01-27T18:45:35.3551463Z",
      "Category": "sample string 6",
      "EnteredBy": "sample string 7",
      "ReviewedDateTime": "2018-01-27T18:45:35.3551463Z",
      "ReviewedBy": "sample string 8",
      "Comments": [
        "sample string 1",
        "sample string 2"
      ],
      "Status": "sample string 9",
      "Cancelled": true,
      "CancelledDateTime": "2018-01-27T18:45:35.3551463Z",
      "CancelledBy": "sample string 10",
      "CreatedDateTime": "2018-01-27T18:45:35.3551463Z",
      "Reactions": [
        {
          "ReactionId": "sample string 1",
          "ReactionDesc": "sample string 2",
          "Active": true
        },
        {
          "ReactionId": "sample string 1",
          "ReactionDesc": "sample string 2",
          "Active": true
        }
      ]
    }
  ]
}
Sample Message
<AllergiesResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <Allergies xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:AllergyViewModel>
      <d2p1:AllergenCode>sample string 2</d2p1:AllergenCode>
      <d2p1:AllergenDesc>sample string 3</d2p1:AllergenDesc>
      <d2p1:AllergyId>sample string 1</d2p1:AllergyId>
      <d2p1:Cancelled>true</d2p1:Cancelled>
      <d2p1:CancelledBy>sample string 10</d2p1:CancelledBy>
      <d2p1:CancelledDateTime>2018-02-13T13:26:28.3173577-06:00</d2p1:CancelledDateTime>
      <d2p1:Category>sample string 6</d2p1:Category>
      <d2p1:Comments xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Comments>
      <d2p1:CreatedDateTime>2018-02-13T13:26:28.3329834-06:00</d2p1:CreatedDateTime>
      <d2p1:EnteredBy>sample string 7</d2p1:EnteredBy>
      <d2p1:OnsetDateTime>2018-02-13T13:26:28.3173577-06:00</d2p1:OnsetDateTime>
      <d2p1:PatientId>sample string 4</d2p1:PatientId>
      <d2p1:Reactions>
        <d2p1:ReactionViewModel>
          <d2p1:Active>true</d2p1:Active>
          <d2p1:ReactionDesc>sample string 2</d2p1:ReactionDesc>
          <d2p1:ReactionId>sample string 1</d2p1:ReactionId>
        </d2p1:ReactionViewModel>
        <d2p1:ReactionViewModel>
          <d2p1:Active>true</d2p1:Active>
          <d2p1:ReactionDesc>sample string 2</d2p1:ReactionDesc>
          <d2p1:ReactionId>sample string 1</d2p1:ReactionId>
        </d2p1:ReactionViewModel>
      </d2p1:Reactions>
      <d2p1:ReviewedBy>sample string 8</d2p1:ReviewedBy>
      <d2p1:ReviewedDateTime>2018-02-13T13:26:28.3173577-06:00</d2p1:ReviewedDateTime>
      <d2p1:Severity>sample string 5</d2p1:Severity>
      <d2p1:Status>sample string 9</d2p1:Status>
    </d2p1:AllergyViewModel>
    <d2p1:AllergyViewModel>
      <d2p1:AllergenCode>sample string 2</d2p1:AllergenCode>
      <d2p1:AllergenDesc>sample string 3</d2p1:AllergenDesc>
      <d2p1:AllergyId>sample string 1</d2p1:AllergyId>
      <d2p1:Cancelled>true</d2p1:Cancelled>
      <d2p1:CancelledBy>sample string 10</d2p1:CancelledBy>
      <d2p1:CancelledDateTime>2018-02-13T13:26:28.3173577-06:00</d2p1:CancelledDateTime>
      <d2p1:Category>sample string 6</d2p1:Category>
      <d2p1:Comments xmlns:d4p1="https://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Comments>
      <d2p1:CreatedDateTime>2018-02-13T13:26:28.3329834-06:00</d2p1:CreatedDateTime>
      <d2p1:EnteredBy>sample string 7</d2p1:EnteredBy>
      <d2p1:OnsetDateTime>2018-02-13T13:26:28.3173577-06:00</d2p1:OnsetDateTime>
      <d2p1:PatientId>sample string 4</d2p1:PatientId>
      <d2p1:Reactions>
        <d2p1:ReactionViewModel>
          <d2p1:Active>true</d2p1:Active>
          <d2p1:ReactionDesc>sample string 2</d2p1:ReactionDesc>
          <d2p1:ReactionId>sample string 1</d2p1:ReactionId>
        </d2p1:ReactionViewModel>
        <d2p1:ReactionViewModel>
          <d2p1:Active>true</d2p1:Active>
          <d2p1:ReactionDesc>sample string 2</d2p1:ReactionDesc>
          <d2p1:ReactionId>sample string 1</d2p1:ReactionId>
        </d2p1:ReactionViewModel>
      </d2p1:Reactions>
      <d2p1:ReviewedBy>sample string 8</d2p1:ReviewedBy>
      <d2p1:ReviewedDateTime>2018-02-13T13:26:28.3173577-06:00</d2p1:ReviewedDateTime>
      <d2p1:Severity>sample string 5</d2p1:Severity>
      <d2p1:Status>sample string 9</d2p1:Status>
    </d2p1:AllergyViewModel>
  </Allergies>
  <NoKnownAllergies>true</NoKnownAllergies>
  <NoKnownDateTime>2018-02-13T13:26:28.3173577-06:00</NoKnownDateTime>
  <NoKnownDocBy>sample string 2</NoKnownDocBy>
  <PatientId>sample string 1</PatientId>
  <ReviewedBy>sample string 4</ReviewedBy>
  <ReviewedDateTime>2018-02-13T13:26:28.3173577-06:00</ReviewedDateTime>
  <ReviewedStatus>sample string 3</ReviewedStatus>
</AllergiesResponseViewModel>

Submit a Comment

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

 

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