GET api/v1/{practiceId}/clinical/patientallergies/{patientId}
Get patient allergies details
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| practiceId | globally unique identifier |
Required |
|
| patientId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientAllergiesVo| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientAllergiesId | globally unique identifier |
None. |
|
| Patient |
A reference to the patient |
Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.PatientVo |
None. |
| Provider |
A reference to the provider |
Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.ProviderVo |
None. |
| PatientAllergies | Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientAllergyVo |
None. |
|
| Other |
The doctor may capture free text for any additional allergies that are not structurally added in PatientAllergies |
string |
None. |
| NoAllergies |
The doctor selected no allergies |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"PatientAllergiesId": "17da1fcd-9a53-4185-ab7d-65346ebd7ce0",
"Patient": {
"PatientId": "3c3f4f27-ab0c-4b8e-afe0-a99de1bdbb8d",
"PatientXRef": "sample string 2",
"PracticeId": "442fcf64-1b70-4e90-a452-2004d13b5ef3",
"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-18T08:28:45Z",
"IdentityNo": "sample string 5",
"Gender": "sample string 6",
"ContactNo": "sample string 7",
"EmailAddress": "sample string 8"
},
"PatientAccountDetails": {
"AccountId": "551ad27a-631a-46f4-8969-82647d70bc4d",
"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-18T08:28:45Z",
"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-18T08:28:45Z",
"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-18T08:28:45Z",
"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
}
application/xml, text/xml
Sample:
<PatientAllergiesVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
<NoAllergies>true</NoAllergies>
<Other>sample string 2</Other>
<Patient xmlns:d2p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
<d2p1:Deceased>true</d2p1:Deceased>
<d2p1:Employer>sample string 7</d2p1:Employer>
<d2p1:FileNo>sample string 4</d2p1:FileNo>
<d2p1:KnownAs>sample string 5</d2p1:KnownAs>
<d2p1:MaritalStatus>sample string 9</d2p1:MaritalStatus>
<d2p1:Occupation>sample string 6</d2p1:Occupation>
<d2p1:PatientAccountDetails>
<d2p1:AccountId>551ad27a-631a-46f4-8969-82647d70bc4d</d2p1:AccountId>
<d2p1:AccountNo>sample string 2</d2p1:AccountNo>
<d2p1:IsCashAccount>true</d2p1:IsCashAccount>
<d2p1:MedicalAidDependentCode>sample string 8</d2p1:MedicalAidDependentCode>
<d2p1:MedicalAidMainMemberDetails>
<d2p1:ContactNo>sample string 7</d2p1:ContactNo>
<d2p1:DateOfBirth>2025-04-18T08:28:45.1547917+02:00</d2p1:DateOfBirth>
<d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
<d2p1:FirstName>sample string 2</d2p1:FirstName>
<d2p1:Gender>sample string 6</d2p1:Gender>
<d2p1:IdentityNo>sample string 5</d2p1:IdentityNo>
<d2p1:Surname>sample string 3</d2p1:Surname>
<d2p1:Title>sample string 1</d2p1:Title>
</d2p1:MedicalAidMainMemberDetails>
<d2p1:MedicalAidMembershipNumber>sample string 7</d2p1:MedicalAidMembershipNumber>
<d2p1:MedicalAidName>sample string 4</d2p1:MedicalAidName>
<d2p1:MedicalAidOptionCode>sample string 10</d2p1:MedicalAidOptionCode>
<d2p1:MedicalAidPlan>sample string 5</d2p1:MedicalAidPlan>
<d2p1:MedicalAidPlanCode>sample string 12</d2p1:MedicalAidPlanCode>
<d2p1:MedicalAidPlanOption>sample string 6</d2p1:MedicalAidPlanOption>
<d2p1:MedicalAidRoutingCode>sample string 9</d2p1:MedicalAidRoutingCode>
<d2p1:MedicalAidSchemeCode>sample string 11</d2p1:MedicalAidSchemeCode>
</d2p1:PatientAccountDetails>
<d2p1:PatientDetails>
<d2p1:ContactNo>sample string 7</d2p1:ContactNo>
<d2p1:DateOfBirth>2025-04-18T08:28:45.1547917+02:00</d2p1:DateOfBirth>
<d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
<d2p1:FirstName>sample string 2</d2p1:FirstName>
<d2p1:Gender>sample string 6</d2p1:Gender>
<d2p1:IdentityNo>sample string 5</d2p1:IdentityNo>
<d2p1:Surname>sample string 3</d2p1:Surname>
<d2p1:Title>sample string 1</d2p1:Title>
</d2p1:PatientDetails>
<d2p1:PatientId>3c3f4f27-ab0c-4b8e-afe0-a99de1bdbb8d</d2p1:PatientId>
<d2p1:PatientXRef>sample string 2</d2p1:PatientXRef>
<d2p1:PhysicalAddress>
<d2p1:Code>sample string 4</d2p1:Code>
<d2p1:Line1>sample string 1</d2p1:Line1>
<d2p1:Line2>sample string 2</d2p1:Line2>
<d2p1:Line3>sample string 3</d2p1:Line3>
</d2p1:PhysicalAddress>
<d2p1:PostalAddress>
<d2p1:Code>sample string 4</d2p1:Code>
<d2p1:Line1>sample string 1</d2p1:Line1>
<d2p1:Line2>sample string 2</d2p1:Line2>
<d2p1:Line3>sample string 3</d2p1:Line3>
</d2p1:PostalAddress>
<d2p1:PracticeId>442fcf64-1b70-4e90-a452-2004d13b5ef3</d2p1:PracticeId>
<d2p1:PreferredLanguage>sample string 8</d2p1:PreferredLanguage>
</Patient>
<PatientAllergies>
<PatientAllergyVo>
<Allergen>
<Code>sample string 2</Code>
<CodingSource>sample string 4</CodingSource>
<Description>sample string 3</Description>
<Category>sample string 1</Category>
</Allergen>
<CapturedDate>2025-04-18T08:28:45.1547917+02:00</CapturedDate>
<ClinicalStatus>sample string 3</ClinicalStatus>
<Criticality>sample string 2</Criticality>
<VerificationStatus>sample string 4</VerificationStatus>
</PatientAllergyVo>
<PatientAllergyVo>
<Allergen>
<Code>sample string 2</Code>
<CodingSource>sample string 4</CodingSource>
<Description>sample string 3</Description>
<Category>sample string 1</Category>
</Allergen>
<CapturedDate>2025-04-18T08:28:45.1547917+02:00</CapturedDate>
<ClinicalStatus>sample string 3</ClinicalStatus>
<Criticality>sample string 2</Criticality>
<VerificationStatus>sample string 4</VerificationStatus>
</PatientAllergyVo>
</PatientAllergies>
<PatientAllergiesId>17da1fcd-9a53-4185-ab7d-65346ebd7ce0</PatientAllergiesId>
<Provider xmlns:d2p1="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
<d2p1:CellphoneNumber>sample string 16</d2p1:CellphoneNumber>
<d2p1:ContactNumber>sample string 11</d2p1:ContactNumber>
<d2p1:DispensingDoctor>sample string 8</d2p1:DispensingDoctor>
<d2p1:DispensingLicenseNumber>sample string 9</d2p1:DispensingLicenseNumber>
<d2p1:EmailAddress>sample string 17</d2p1:EmailAddress>
<d2p1:FaxNumber>sample string 15</d2p1:FaxNumber>
<d2p1:HPCSANumber>sample string 10</d2p1:HPCSANumber>
<d2p1:IsLocumProvider>true</d2p1:IsLocumProvider>
<d2p1:PhysicalAddress>sample string 18</d2p1:PhysicalAddress>
<d2p1:PostalAddress>sample string 19</d2p1:PostalAddress>
<d2p1:PracticeName>sample string 2</d2p1:PracticeName>
<d2p1:PracticeNumber>sample string 5</d2p1:PracticeNumber>
<d2p1:PracticeType>sample string 1</d2p1:PracticeType>
<d2p1:Qualification>sample string 12</d2p1:Qualification>
<d2p1:SpecialityCode>sample string 3</d2p1:SpecialityCode>
<d2p1:SpecialityDescription>sample string 13</d2p1:SpecialityDescription>
<d2p1:SubSpecialityCode>sample string 4</d2p1:SubSpecialityCode>
<d2p1:TelephoneNumber>sample string 14</d2p1:TelephoneNumber>
<d2p1:TreatingDoctorName>sample string 6</d2p1:TreatingDoctorName>
<d2p1:TreatingDoctorPracticeNumber>sample string 7</d2p1:TreatingDoctorPracticeNumber>
</Provider>
</PatientAllergiesVo>