POST api/patients/{patientId}/allergies

Request Information

URI Parameters

NameDescriptionTypeAdditional information
patientId

integer

Required

Body Parameters

AddAllergyRequest
NameDescriptionTypeAdditional information
Name

string

Required

String length: inclusive between 0 and 100

Code

string

Required

String length: inclusive between 0 and 50

CodeType

AllergyCodeType

Required

Range: inclusive between 1 and 3

Reaction

string

String length: inclusive between 0 and 200

ReactionType

AllergyReactionType

Required

Range: inclusive between 1 and 2

StatusType

AllergyStatusType

Required

Range: inclusive between 1 and 3

OnsetDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Code": "sample string 2",
  "CodeType": 1,
  "Reaction": "sample string 3",
  "ReactionType": 1,
  "StatusType": 1,
  "OnsetDate": "2024-05-18T21:33:03.3534849+00:00"
}

application/xml, text/xml

Sample:
<AddAllergyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <Code>sample string 2</Code>
  <CodeType>AllergyClass</CodeType>
  <Name>sample string 1</Name>
  <OnsetDate>2024-05-18T21:33:03.3534849+00:00</OnsetDate>
  <Reaction>sample string 3</Reaction>
  <ReactionType>Allergy</ReactionType>
  <StatusType>Active</StatusType>
</AddAllergyRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IdentifierResponse
NameDescriptionTypeAdditional information
Id

integer

None.

Result

Result

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Result": {
    "ResultCode": "sample string 1",
    "ResultDescription": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<IdentifierResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <Result>
    <ResultCode>sample string 1</ResultCode>
    <ResultDescription>sample string 2</ResultDescription>
  </Result>
  <Id>1</Id>
</IdentifierResponse>