GET api/v1/{practiceId}/clinical/patientclinicalnotes/{patientId}
Get patient clinical notes 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.PatientClinicalNotesVoName | Description | Type | Additional information |
---|---|---|---|
PatientClinicalNotesId | globally unique identifier |
None. |
|
Patient | Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.PatientVo |
None. |
|
PracticeId | globally unique identifier |
None. |
|
Note | string |
None. |
|
IsImportant | boolean |
None. |
|
Type | string |
None. |
|
Format | string |
None. |
|
CapturedDate | date |
None. |
Response Formats
application/json, text/json
Sample:
{ "PatientClinicalNotesId": "31c4affc-e301-41f5-92e3-a124c46e1014", "Patient": { "PatientId": "b6c977fb-8a2d-448b-a0e7-5b447dd1bf82", "PatientXRef": "sample string 2", "PracticeId": "ba09791c-3eb4-4045-95ba-e0032f413512", "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-16T09:46:33Z", "IdentityNo": "sample string 5", "Gender": "sample string 6", "ContactNo": "sample string 7", "EmailAddress": "sample string 8" }, "PatientAccountDetails": { "AccountId": "1bf84b53-5273-43a9-bec9-fb24a960c589", "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-16T09:46:33Z", "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 }, "PracticeId": "9ab59869-90dc-462b-9a95-7ee12557afac", "Note": "sample string 3", "IsImportant": true, "Type": "sample string 5", "Format": "sample string 6", "CapturedDate": "2025-04-16T09:46:33Z" }
application/xml, text/xml
Sample:
<PatientClinicalNotesVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects"> <CapturedDate>2025-04-16T09:46:33.3747139+02:00</CapturedDate> <Format>sample string 6</Format> <IsImportant>true</IsImportant> <Note>sample string 3</Note> <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>1bf84b53-5273-43a9-bec9-fb24a960c589</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-16T09:46:33.3747139+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-16T09:46:33.3747139+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>b6c977fb-8a2d-448b-a0e7-5b447dd1bf82</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>ba09791c-3eb4-4045-95ba-e0032f413512</d2p1:PracticeId> <d2p1:PreferredLanguage>sample string 8</d2p1:PreferredLanguage> </Patient> <PatientClinicalNotesId>31c4affc-e301-41f5-92e3-a124c46e1014</PatientClinicalNotesId> <PracticeId>9ab59869-90dc-462b-9a95-7ee12557afac</PracticeId> <Type>sample string 5</Type> </PatientClinicalNotesVo>