POST api/v1/{practiceId}/clinical/patientallergies/{patientId}/revise

Revise allergies

Request Information

URI Parameters

Name	Description	Type	Additional information
practiceId		globally unique identifier	Required
patientId		globally unique identifier	Required

Body Parameters

Com.Healthbridge.Hhas.Clinical.Interface.Commands.RevisePatientAllergies

Name	Type	Additional information
PracticeId	globally unique identifier	None.
PatientAllergies	Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientAllergiesVo	None.
CorrelationIds	Collection of string	None.
OriginatedSystem	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PracticeId": "6bd95b31-22a8-4ad3-aaca-6bc82d9fca2f",
  "PatientAllergies": {
    "PatientAllergiesId": "3f74deb9-d650-44f3-9d6b-c83dea3223ac",
    "Patient": {
      "PatientId": "d89e2167-95d6-4f06-b4e0-6d1cde91bdd8",
      "PatientXRef": "sample string 2",
      "PracticeId": "352b8bf4-8593-454d-98c1-1a0fef78a1d6",
      "FileNo": "sample string 4",
      "KnownAs": "sample string 5",
      "Occupation": "sample string 6",
      "Employer": "sample string 7",
      "PreferredLanguage": "sample string 8",
      "MaritalStatus": "sample string 9",
      "PatientDetails": {
        "Title": "sample string 1",
        "FirstName": "sample string 2",
        "Surname": "sample string 3",
        "DateOfBirth": "2025-04-10T23:26:16Z",
        "IdentityNo": "sample string 5",
        "Gender": "sample string 6",
        "ContactNo": "sample string 7",
        "EmailAddress": "sample string 8"
      },
      "PatientAccountDetails": {
        "AccountId": "6b220e96-4f12-4012-8179-d90c74c21bfd",
        "AccountNo": "sample string 2",
        "IsCashAccount": true,
        "MedicalAidName": "sample string 4",
        "MedicalAidPlan": "sample string 5",
        "MedicalAidPlanOption": "sample string 6",
        "MedicalAidMembershipNumber": "sample string 7",
        "MedicalAidDependentCode": "sample string 8",
        "MedicalAidMainMemberDetails": {
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "Surname": "sample string 3",
          "DateOfBirth": "2025-04-10T23:26:16Z",
          "IdentityNo": "sample string 5",
          "Gender": "sample string 6",
          "ContactNo": "sample string 7",
          "EmailAddress": "sample string 8"
        },
        "MedicalAidRoutingCode": "sample string 9",
        "MedicalAidOptionCode": "sample string 10",
        "MedicalAidSchemeCode": "sample string 11",
        "MedicalAidPlanCode": "sample string 12"
      },
      "PhysicalAddress": {
        "Line1": "sample string 1",
        "Line2": "sample string 2",
        "Line3": "sample string 3",
        "Code": "sample string 4"
      },
      "PostalAddress": {
        "Line1": "sample string 1",
        "Line2": "sample string 2",
        "Line3": "sample string 3",
        "Code": "sample string 4"
      },
      "Deceased": true
    },
    "Provider": {
      "PracticeType": "sample string 1",
      "PracticeName": "sample string 2",
      "SpecialityCode": "sample string 3",
      "SubSpecialityCode": "sample string 4",
      "PracticeNumber": "sample string 5",
      "TreatingDoctorName": "sample string 6",
      "TreatingDoctorPracticeNumber": "sample string 7",
      "DispensingDoctor": "sample string 8",
      "DispensingLicenseNumber": "sample string 9",
      "HPCSANumber": "sample string 10",
      "ContactNumber": "sample string 11",
      "Qualification": "sample string 12",
      "SpecialityDescription": "sample string 13",
      "TelephoneNumber": "sample string 14",
      "FaxNumber": "sample string 15",
      "CellphoneNumber": "sample string 16",
      "EmailAddress": "sample string 17",
      "PhysicalAddress": "sample string 18",
      "PostalAddress": "sample string 19",
      "IsLocumProvider": true
    },
    "PatientAllergies": [
      {
        "CapturedDate": "2025-04-10T23:26:16Z",
        "Allergen": {
          "Category": "sample string 1",
          "Code": "sample string 2",
          "Description": "sample string 3",
          "CodingSource": "sample string 4"
        },
        "Criticality": "sample string 2",
        "ClinicalStatus": "sample string 3",
        "VerificationStatus": "sample string 4"
      },
      {
        "CapturedDate": "2025-04-10T23:26:16Z",
        "Allergen": {
          "Category": "sample string 1",
          "Code": "sample string 2",
          "Description": "sample string 3",
          "CodingSource": "sample string 4"
        },
        "Criticality": "sample string 2",
        "ClinicalStatus": "sample string 3",
        "VerificationStatus": "sample string 4"
      }
    ],
    "Other": "sample string 2",
    "NoAllergies": true
  },
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 2"
}

application/xml, text/xml

Sample:

<RevisePatientAllergies xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.Commands">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <OriginatedSystem xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">sample string 2</OriginatedSystem>
  <PatientAllergies xmlns:d2p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
    <d2p1:NoAllergies>true</d2p1:NoAllergies>
    <d2p1:Other>sample string 2</d2p1:Other>
    <d2p1:Patient xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
      <d3p1:Deceased>true</d3p1:Deceased>
      <d3p1:Employer>sample string 7</d3p1:Employer>
      <d3p1:FileNo>sample string 4</d3p1:FileNo>
      <d3p1:KnownAs>sample string 5</d3p1:KnownAs>
      <d3p1:MaritalStatus>sample string 9</d3p1:MaritalStatus>
      <d3p1:Occupation>sample string 6</d3p1:Occupation>
      <d3p1:PatientAccountDetails>
        <d3p1:AccountId>6b220e96-4f12-4012-8179-d90c74c21bfd</d3p1:AccountId>
        <d3p1:AccountNo>sample string 2</d3p1:AccountNo>
        <d3p1:IsCashAccount>true</d3p1:IsCashAccount>
        <d3p1:MedicalAidDependentCode>sample string 8</d3p1:MedicalAidDependentCode>
        <d3p1:MedicalAidMainMemberDetails>
          <d3p1:ContactNo>sample string 7</d3p1:ContactNo>
          <d3p1:DateOfBirth>2025-04-10T23:26:16.604011+02:00</d3p1:DateOfBirth>
          <d3p1:EmailAddress>sample string 8</d3p1:EmailAddress>
          <d3p1:FirstName>sample string 2</d3p1:FirstName>
          <d3p1:Gender>sample string 6</d3p1:Gender>
          <d3p1:IdentityNo>sample string 5</d3p1:IdentityNo>
          <d3p1:Surname>sample string 3</d3p1:Surname>
          <d3p1:Title>sample string 1</d3p1:Title>
        </d3p1:MedicalAidMainMemberDetails>
        <d3p1:MedicalAidMembershipNumber>sample string 7</d3p1:MedicalAidMembershipNumber>
        <d3p1:MedicalAidName>sample string 4</d3p1:MedicalAidName>
        <d3p1:MedicalAidOptionCode>sample string 10</d3p1:MedicalAidOptionCode>
        <d3p1:MedicalAidPlan>sample string 5</d3p1:MedicalAidPlan>
        <d3p1:MedicalAidPlanCode>sample string 12</d3p1:MedicalAidPlanCode>
        <d3p1:MedicalAidPlanOption>sample string 6</d3p1:MedicalAidPlanOption>
        <d3p1:MedicalAidRoutingCode>sample string 9</d3p1:MedicalAidRoutingCode>
        <d3p1:MedicalAidSchemeCode>sample string 11</d3p1:MedicalAidSchemeCode>
      </d3p1:PatientAccountDetails>
      <d3p1:PatientDetails>
        <d3p1:ContactNo>sample string 7</d3p1:ContactNo>
        <d3p1:DateOfBirth>2025-04-10T23:26:16.604011+02:00</d3p1:DateOfBirth>
        <d3p1:EmailAddress>sample string 8</d3p1:EmailAddress>
        <d3p1:FirstName>sample string 2</d3p1:FirstName>
        <d3p1:Gender>sample string 6</d3p1:Gender>
        <d3p1:IdentityNo>sample string 5</d3p1:IdentityNo>
        <d3p1:Surname>sample string 3</d3p1:Surname>
        <d3p1:Title>sample string 1</d3p1:Title>
      </d3p1:PatientDetails>
      <d3p1:PatientId>d89e2167-95d6-4f06-b4e0-6d1cde91bdd8</d3p1:PatientId>
      <d3p1:PatientXRef>sample string 2</d3p1:PatientXRef>
      <d3p1:PhysicalAddress>
        <d3p1:Code>sample string 4</d3p1:Code>
        <d3p1:Line1>sample string 1</d3p1:Line1>
        <d3p1:Line2>sample string 2</d3p1:Line2>
        <d3p1:Line3>sample string 3</d3p1:Line3>
      </d3p1:PhysicalAddress>
      <d3p1:PostalAddress>
        <d3p1:Code>sample string 4</d3p1:Code>
        <d3p1:Line1>sample string 1</d3p1:Line1>
        <d3p1:Line2>sample string 2</d3p1:Line2>
        <d3p1:Line3>sample string 3</d3p1:Line3>
      </d3p1:PostalAddress>
      <d3p1:PracticeId>352b8bf4-8593-454d-98c1-1a0fef78a1d6</d3p1:PracticeId>
      <d3p1:PreferredLanguage>sample string 8</d3p1:PreferredLanguage>
    </d2p1:Patient>
    <d2p1:PatientAllergies>
      <d2p1:PatientAllergyVo>
        <d2p1:Allergen>
          <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:Allergen>
        <d2p1:CapturedDate>2025-04-10T23:26:16.604011+02:00</d2p1:CapturedDate>
        <d2p1:ClinicalStatus>sample string 3</d2p1:ClinicalStatus>
        <d2p1:Criticality>sample string 2</d2p1:Criticality>
        <d2p1:VerificationStatus>sample string 4</d2p1:VerificationStatus>
      </d2p1:PatientAllergyVo>
      <d2p1:PatientAllergyVo>
        <d2p1:Allergen>
          <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:Allergen>
        <d2p1:CapturedDate>2025-04-10T23:26:16.604011+02:00</d2p1:CapturedDate>
        <d2p1:ClinicalStatus>sample string 3</d2p1:ClinicalStatus>
        <d2p1:Criticality>sample string 2</d2p1:Criticality>
        <d2p1:VerificationStatus>sample string 4</d2p1:VerificationStatus>
      </d2p1:PatientAllergyVo>
    </d2p1:PatientAllergies>
    <d2p1:PatientAllergiesId>3f74deb9-d650-44f3-9d6b-c83dea3223ac</d2p1:PatientAllergiesId>
    <d2p1:Provider xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
      <d3p1:CellphoneNumber>sample string 16</d3p1:CellphoneNumber>
      <d3p1:ContactNumber>sample string 11</d3p1:ContactNumber>
      <d3p1:DispensingDoctor>sample string 8</d3p1:DispensingDoctor>
      <d3p1:DispensingLicenseNumber>sample string 9</d3p1:DispensingLicenseNumber>
      <d3p1:EmailAddress>sample string 17</d3p1:EmailAddress>
      <d3p1:FaxNumber>sample string 15</d3p1:FaxNumber>
      <d3p1:HPCSANumber>sample string 10</d3p1:HPCSANumber>
      <d3p1:IsLocumProvider>true</d3p1:IsLocumProvider>
      <d3p1:PhysicalAddress>sample string 18</d3p1:PhysicalAddress>
      <d3p1:PostalAddress>sample string 19</d3p1:PostalAddress>
      <d3p1:PracticeName>sample string 2</d3p1:PracticeName>
      <d3p1:PracticeNumber>sample string 5</d3p1:PracticeNumber>
      <d3p1:PracticeType>sample string 1</d3p1:PracticeType>
      <d3p1:Qualification>sample string 12</d3p1:Qualification>
      <d3p1:SpecialityCode>sample string 3</d3p1:SpecialityCode>
      <d3p1:SpecialityDescription>sample string 13</d3p1:SpecialityDescription>
      <d3p1:SubSpecialityCode>sample string 4</d3p1:SubSpecialityCode>
      <d3p1:TelephoneNumber>sample string 14</d3p1:TelephoneNumber>
      <d3p1:TreatingDoctorName>sample string 6</d3p1:TreatingDoctorName>
      <d3p1:TreatingDoctorPracticeNumber>sample string 7</d3p1:TreatingDoctorPracticeNumber>
    </d2p1:Provider>
  </PatientAllergies>
  <PracticeId>6bd95b31-22a8-4ad3-aaca-6bc82d9fca2f</PracticeId>
</RevisePatientAllergies>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'RevisePatientAllergies'.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid

Name	Type	Additional information
Sucess	boolean	None.
ResponseCode	integer	None.
ResponseMessage	string	None.
Data	globally unique identifier	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": "705be6eb-0e53-4a90-a625-898562875631",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>705be6eb-0e53-4a90-a625-898562875631</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>
</RestApiResultOfguid>

URI parameters

Headers | Add header

Body

Status

Headers

Body

POST api/v1/{practiceId}/clinical/patientallergies/{patientId}/revise

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml