POST api/PatientAllergyUpdates

Updates a patient allergy.

Request Information

URI Parameters

None.

Body Parameters

Model used to add/update patient allergies.

PatientAllergyRequestModel
NameDescriptionTypeAdditional information
PatientAllergyUpdateRequestId

Unique ID of allergy update request.

integer

None.

PatientAllergyId

Unique ID of patient allergy.

integer

None.

AllergyId

Allergy ID.

integer

None.

AllergyExternalId

ID of the allergy in the integrating system.

string

None.

AllergyName

Allergy name.

string

None.

AllergySeverityId

Unique ID of allergy severity.

integer

None.

AllergySeverityExternalId

ID of the allergy severity in the integrating system.

string

None.

AllergySeverityName

Name of allergy severity.

string

None.

AllergyReactionId

Unique ID of allergy reaction.

integer

None.

AllergyReactionExternalId

ID of the allergy reaction in the integrating system.

string

None.

AllergyReactionName

Name of allergy reaction.

string

None.

StartDate

Start date of allergy.

date

None.

Notes

Notes about the allergy.

string

None.

Operation

Status of patient allergy. Possible values: Unchanged, Added, Updated, Deleted.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PatientAllergyUpdateRequestId": 1,
  "PatientAllergyId": 1,
  "AllergyId": 1,
  "AllergyExternalId": "sample string 1",
  "AllergyName": "sample string 2",
  "AllergySeverityId": 1,
  "AllergySeverityExternalId": "sample string 3",
  "AllergySeverityName": "sample string 4",
  "AllergyReactionId": 1,
  "AllergyReactionExternalId": "sample string 5",
  "AllergyReactionName": "sample string 6",
  "StartDate": "2024-03-29T06:57:51.2466949-04:00",
  "Notes": "sample string 7",
  "Operation": "sample string 8"
}

application/xml, text/xml

Sample:
<PatientAllergyRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientAllergies">
  <AllergyExternalId>sample string 1</AllergyExternalId>
  <AllergyId>1</AllergyId>
  <AllergyName>sample string 2</AllergyName>
  <AllergyReactionExternalId>sample string 5</AllergyReactionExternalId>
  <AllergyReactionId>1</AllergyReactionId>
  <AllergyReactionName>sample string 6</AllergyReactionName>
  <AllergySeverityExternalId>sample string 3</AllergySeverityExternalId>
  <AllergySeverityId>1</AllergySeverityId>
  <AllergySeverityName>sample string 4</AllergySeverityName>
  <Notes>sample string 7</Notes>
  <Operation>sample string 8</Operation>
  <PatientAllergyId>1</PatientAllergyId>
  <PatientAllergyUpdateRequestId>1</PatientAllergyUpdateRequestId>
  <StartDate>2024-03-29T06:57:51.2466949-04:00</StartDate>
</PatientAllergyRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientAllergyRequestModel
NameDescriptionTypeAdditional information
PatientAllergyUpdateRequestId

Unique ID of allergy update request.

integer

None.

PatientAllergyId

Unique ID of patient allergy.

integer

None.

AllergyId

Allergy ID.

integer

None.

AllergyExternalId

ID of the allergy in the integrating system.

string

None.

AllergyName

Allergy name.

string

None.

AllergySeverityId

Unique ID of allergy severity.

integer

None.

AllergySeverityExternalId

ID of the allergy severity in the integrating system.

string

None.

AllergySeverityName

Name of allergy severity.

string

None.

AllergyReactionId

Unique ID of allergy reaction.

integer

None.

AllergyReactionExternalId

ID of the allergy reaction in the integrating system.

string

None.

AllergyReactionName

Name of allergy reaction.

string

None.

StartDate

Start date of allergy.

date

None.

Notes

Notes about the allergy.

string

None.

Operation

Status of patient allergy. Possible values: Unchanged, Added, Updated, Deleted.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "PatientAllergyUpdateRequestId": 1,
  "PatientAllergyId": 1,
  "AllergyId": 1,
  "AllergyExternalId": "sample string 1",
  "AllergyName": "sample string 2",
  "AllergySeverityId": 1,
  "AllergySeverityExternalId": "sample string 3",
  "AllergySeverityName": "sample string 4",
  "AllergyReactionId": 1,
  "AllergyReactionExternalId": "sample string 5",
  "AllergyReactionName": "sample string 6",
  "StartDate": "2024-03-29T06:57:51.2623146-04:00",
  "Notes": "sample string 7",
  "Operation": "sample string 8"
}

application/xml, text/xml

Sample:
<PatientAllergyRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientAllergies">
  <AllergyExternalId>sample string 1</AllergyExternalId>
  <AllergyId>1</AllergyId>
  <AllergyName>sample string 2</AllergyName>
  <AllergyReactionExternalId>sample string 5</AllergyReactionExternalId>
  <AllergyReactionId>1</AllergyReactionId>
  <AllergyReactionName>sample string 6</AllergyReactionName>
  <AllergySeverityExternalId>sample string 3</AllergySeverityExternalId>
  <AllergySeverityId>1</AllergySeverityId>
  <AllergySeverityName>sample string 4</AllergySeverityName>
  <Notes>sample string 7</Notes>
  <Operation>sample string 8</Operation>
  <PatientAllergyId>1</PatientAllergyId>
  <PatientAllergyUpdateRequestId>1</PatientAllergyUpdateRequestId>
  <StartDate>2024-03-29T06:57:51.2623146-04:00</StartDate>
</PatientAllergyRequestModel>