GET api/v1/{practiceId}/clinical/addressbook/{lookupfilter}

Get AddressBook with additional lookup logic, OData filtering can be applied ($top, $skip, etc)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

globally unique identifier

Required
lookupfilter

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.AddressBookEntryVo
NameDescriptionTypeAdditional information
AddressBookEntryId

globally unique identifier

None.
IsFavourite

boolean

None.
TenantId

globally unique identifier

None.
Category

string

None.
OrganizationName

string

None.
PracticeNumber

string

None.
Name

string

None.
Surname

string

None.
Speciality

string

None.
EmailAddress

string

None.
OfficeNumber

string

None.
MobileNumber

string

None.
ContactNumber

string

None.
PhysicalAddress

Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.AddressVo

None.
PostalAddress

Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.AddressVo

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "AddressBookEntryId": "5bc71697-f23a-48ef-8a14-6eaf9d7b697d",
    "IsFavourite": true,
    "TenantId": "1a2565ed-3095-491f-b497-3608b588dbd3",
    "Category": "sample string 4",
    "OrganizationName": "sample string 5",
    "PracticeNumber": "sample string 6",
    "Name": "sample string 7",
    "Surname": "sample string 8",
    "Speciality": "sample string 9",
    "EmailAddress": "sample string 10",
    "OfficeNumber": "sample string 11",
    "MobileNumber": "sample string 12",
    "ContactNumber": "sample string 13",
    "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"
    }
  },
  {
    "AddressBookEntryId": "5bc71697-f23a-48ef-8a14-6eaf9d7b697d",
    "IsFavourite": true,
    "TenantId": "1a2565ed-3095-491f-b497-3608b588dbd3",
    "Category": "sample string 4",
    "OrganizationName": "sample string 5",
    "PracticeNumber": "sample string 6",
    "Name": "sample string 7",
    "Surname": "sample string 8",
    "Speciality": "sample string 9",
    "EmailAddress": "sample string 10",
    "OfficeNumber": "sample string 11",
    "MobileNumber": "sample string 12",
    "ContactNumber": "sample string 13",
    "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"
    }
  }
]

application/xml, text/xml

Sample: 
<ArrayOfAddressBookEntryVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
  <AddressBookEntryVo>
    <AddressBookEntryId>5bc71697-f23a-48ef-8a14-6eaf9d7b697d</AddressBookEntryId>
    <Category>sample string 4</Category>
    <ContactNumber>sample string 13</ContactNumber>
    <EmailAddress>sample string 10</EmailAddress>
    <IsFavourite>true</IsFavourite>
    <MobileNumber>sample string 12</MobileNumber>
    <Name>sample string 7</Name>
    <OfficeNumber>sample string 11</OfficeNumber>
    <OrganizationName>sample string 5</OrganizationName>
    <PhysicalAddress xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
      <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>
    </PhysicalAddress>
    <PostalAddress xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
      <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>
    </PostalAddress>
    <PracticeNumber>sample string 6</PracticeNumber>
    <Speciality>sample string 9</Speciality>
    <Surname>sample string 8</Surname>
    <TenantId>1a2565ed-3095-491f-b497-3608b588dbd3</TenantId>
  </AddressBookEntryVo>
  <AddressBookEntryVo>
    <AddressBookEntryId>5bc71697-f23a-48ef-8a14-6eaf9d7b697d</AddressBookEntryId>
    <Category>sample string 4</Category>
    <ContactNumber>sample string 13</ContactNumber>
    <EmailAddress>sample string 10</EmailAddress>
    <IsFavourite>true</IsFavourite>
    <MobileNumber>sample string 12</MobileNumber>
    <Name>sample string 7</Name>
    <OfficeNumber>sample string 11</OfficeNumber>
    <OrganizationName>sample string 5</OrganizationName>
    <PhysicalAddress xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
      <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>
    </PhysicalAddress>
    <PostalAddress xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
      <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>
    </PostalAddress>
    <PracticeNumber>sample string 6</PracticeNumber>
    <Speciality>sample string 9</Speciality>
    <Surname>sample string 8</Surname>
    <TenantId>1a2565ed-3095-491f-b497-3608b588dbd3</TenantId>
  </AddressBookEntryVo>
</ArrayOfAddressBookEntryVo>