Home

Household

GET api/Patient/{systemID}/Household?patientID={patientID}

Retrieve Head of Household profile for a specific patient

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
patientID 
Unique ID of patient in pharmacy system.

Define this parameter in the request URI.
    

Response Codes

    
  • OK (200)
  • NotFound (404)
  • InternalServerError (500)
    •     

Response Information

List of members and associated permissions

Response body formats

application/json, text/json

Sample: 
{
  "householdID": "sample string 1",
  "houseHoldName": "sample string 2",
  "spouse": {
    "AllowSpouseAccess": "sample string 1",
    "SpouseID": "sample string 2",
    "SpouseName": "sample string 3",
    "SpouseDOB": "sample string 4",
    "AllowHeadofHouseAccess": "sample string 5",
    "SpouseRelationshipCode": "sample string 6",
    "UseHeadofHouseholdMethodOfPayment": "sample string 7",
    "UseHeadofHouseholdAddress": "sample string 8"
  },
  "familyMember": [
    {
      "FamilyMemberID": "sample string 1",
      "FamilyMemberName": "sample string 2",
      "FamilyMemberDOB": "sample string 3",
      "AllowFamilyMemberAccess": "sample string 4",
      "MemberRelationshipCode": "sample string 5",
      "UseHeadofHouseholdMethodOfPayment": "sample string 6",
      "UseHeadofHouseholdAddress": "sample string 7"
    },
    {
      "FamilyMemberID": "sample string 1",
      "FamilyMemberName": "sample string 2",
      "FamilyMemberDOB": "sample string 3",
      "AllowFamilyMemberAccess": "sample string 4",
      "MemberRelationshipCode": "sample string 5",
      "UseHeadofHouseholdMethodOfPayment": "sample string 6",
      "UseHeadofHouseholdAddress": "sample string 7"
    },
    {
      "FamilyMemberID": "sample string 1",
      "FamilyMemberName": "sample string 2",
      "FamilyMemberDOB": "sample string 3",
      "AllowFamilyMemberAccess": "sample string 4",
      "MemberRelationshipCode": "sample string 5",
      "UseHeadofHouseholdMethodOfPayment": "sample string 6",
      "UseHeadofHouseholdAddress": "sample string 7"
    }
  ]
}

text/javascript

Sample: 
{"householdID":"sample string 1","houseHoldName":"sample string 2","spouse":{"AllowSpouseAccess":"sample string 1","SpouseID":"sample string 2","SpouseName":"sample string 3","SpouseDOB":"sample string 4","AllowHeadofHouseAccess":"sample string 5","SpouseRelationshipCode":"sample string 6","UseHeadofHouseholdMethodOfPayment":"sample string 7","UseHeadofHouseholdAddress":"sample string 8"},"familyMember":[{"FamilyMemberID":"sample string 1","FamilyMemberName":"sample string 2","FamilyMemberDOB":"sample string 3","AllowFamilyMemberAccess":"sample string 4","MemberRelationshipCode":"sample string 5","UseHeadofHouseholdMethodOfPayment":"sample string 6","UseHeadofHouseholdAddress":"sample string 7"},{"FamilyMemberID":"sample string 1","FamilyMemberName":"sample string 2","FamilyMemberDOB":"sample string 3","AllowFamilyMemberAccess":"sample string 4","MemberRelationshipCode":"sample string 5","UseHeadofHouseholdMethodOfPayment":"sample string 6","UseHeadofHouseholdAddress":"sample string 7"},{"FamilyMemberID":"sample string 1","FamilyMemberName":"sample string 2","FamilyMemberDOB":"sample string 3","AllowFamilyMemberAccess":"sample string 4","MemberRelationshipCode":"sample string 5","UseHeadofHouseholdMethodOfPayment":"sample string 6","UseHeadofHouseholdAddress":"sample string 7"}]}

application/xml, text/xml

Sample: 
<HouseHold xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <familyMember>
    <FamilyMember>
      <AllowFamilyMemberAccess>sample string 4</AllowFamilyMemberAccess>
      <FamilyMemberDOB>sample string 3</FamilyMemberDOB>
      <FamilyMemberID>sample string 1</FamilyMemberID>
      <FamilyMemberName>sample string 2</FamilyMemberName>
      <MemberRelationshipCode>sample string 5</MemberRelationshipCode>
      <UseHeadofHouseholdAddress>sample string 7</UseHeadofHouseholdAddress>
      <UseHeadofHouseholdMethodOfPayment>sample string 6</UseHeadofHouseholdMethodOfPayment>
    </FamilyMember>
    <FamilyMember>
      <AllowFamilyMemberAccess>sample string 4</AllowFamilyMemberAccess>
      <FamilyMemberDOB>sample string 3</FamilyMemberDOB>
      <FamilyMemberID>sample string 1</FamilyMemberID>
      <FamilyMemberName>sample string 2</FamilyMemberName>
      <MemberRelationshipCode>sample string 5</MemberRelationshipCode>
      <UseHeadofHouseholdAddress>sample string 7</UseHeadofHouseholdAddress>
      <UseHeadofHouseholdMethodOfPayment>sample string 6</UseHeadofHouseholdMethodOfPayment>
    </FamilyMember>
    <FamilyMember>
      <AllowFamilyMemberAccess>sample string 4</AllowFamilyMemberAccess>
      <FamilyMemberDOB>sample string 3</FamilyMemberDOB>
      <FamilyMemberID>sample string 1</FamilyMemberID>
      <FamilyMemberName>sample string 2</FamilyMemberName>
      <MemberRelationshipCode>sample string 5</MemberRelationshipCode>
      <UseHeadofHouseholdAddress>sample string 7</UseHeadofHouseholdAddress>
      <UseHeadofHouseholdMethodOfPayment>sample string 6</UseHeadofHouseholdMethodOfPayment>
    </FamilyMember>
  </familyMember>
  <houseHoldName>sample string 2</houseHoldName>
  <householdID>sample string 1</householdID>
  <spouse>
    <AllowHeadofHouseAccess>sample string 5</AllowHeadofHouseAccess>
    <AllowSpouseAccess>sample string 1</AllowSpouseAccess>
    <SpouseDOB>sample string 4</SpouseDOB>
    <SpouseID>sample string 2</SpouseID>
    <SpouseName>sample string 3</SpouseName>
    <SpouseRelationshipCode>sample string 6</SpouseRelationshipCode>
    <UseHeadofHouseholdAddress>sample string 8</UseHeadofHouseholdAddress>
    <UseHeadofHouseholdMethodOfPayment>sample string 7</UseHeadofHouseholdMethodOfPayment>
  </spouse>
</HouseHold>