GET api/v2/{practiceId}/clinical/allergens

Get list of available allergens possible to select on UI for a patient

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

doctor id

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfCom.Healthbridge.Hhas.Clinical.Interface.ValueObjects.AllergenVo[]
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.AllergenVo

None.
Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample: 
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": [
    {
      "Category": "sample string 1",
      "Code": "sample string 2",
      "Description": "sample string 3",
      "CodingSource": "sample string 4"
    },
    {
      "Category": "sample string 1",
      "Code": "sample string 2",
      "Description": "sample string 3",
      "CodingSource": "sample string 4"
    }
  ],
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfArrayOfAllergenVoDJyeeiOY xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
    <d2p1:AllergenVo>
      <d2p1:Code>sample string 2</d2p1:Code>
      <d2p1:CodingSource>sample string 4</d2p1:CodingSource>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Category>sample string 1</d2p1:Category>
    </d2p1:AllergenVo>
    <d2p1:AllergenVo>
      <d2p1:Code>sample string 2</d2p1:Code>
      <d2p1:CodingSource>sample string 4</d2p1:CodingSource>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Category>sample string 1</d2p1:Category>
    </d2p1:AllergenVo>
  </Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfArrayOfAllergenVoDJyeeiOY>