Home

FamilyMember

POST api/Patient/{systemID}/Household/FamilyMember

Add a single family member profile to Head of Household record

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
member 
FamilyMember object
            PatientID - Unique Identifier for Patient
            PatientName - Name of Patient [*Ignored on Create/Update]
            HouseHoldID - Identifier for Head of Household [*Same as PatientID]
            HouseHoldName - Name of Head of Household individual [*Ignored on Create/Update]
            FamilyMemberID - Patient ID of Family Member
            FamilyMemberName - Name of Family Member [*Ignored on Create/Update]
            FamilyMemberDOB - Date of Birth of Family Member (YYYYMMDD) [*Ignored on Create/Update]
            MemberRelationshipCode - (See /api/RelationshipToCardHolderList for valid values)  [*Ignored on Create/Update]
            AllowFamilyMemberAccess - Allow Family Members to access this profile (Y/N)
            UseHeadofHouseholdMethodofPayment - Use methods of payments linked to Head of Household (Y/N)
            UseHeadofHouseholdAddress - Use addresses linked to Head of Household (Y/N)

Define this parameter in the request body.
    

Response Codes

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

Request body formats

application/json, text/json

Sample: 
{
  "PatientID": "sample string 1",
  "PatientName": "sample string 2",
  "HouseHoldID": "sample string 3",
  "HouseHoldName": "sample string 4",
  "FamilyMemberID": "sample string 5",
  "FamilyMemberName": "sample string 6",
  "FamilyMemberDOB": "sample string 7",
  "AllowFamilyMemberAccess": "sample string 8",
  "MemberRelationshipCode": "sample string 9",
  "UseHeadofHouseholdMethodOfPayment": "sample string 10",
  "UseHeadofHouseholdAddress": "sample string 11"
}

text/javascript

Sample: 
{"PatientID":"sample string 1","PatientName":"sample string 2","HouseHoldID":"sample string 3","HouseHoldName":"sample string 4","FamilyMemberID":"sample string 5","FamilyMemberName":"sample string 6","FamilyMemberDOB":"sample string 7","AllowFamilyMemberAccess":"sample string 8","MemberRelationshipCode":"sample string 9","UseHeadofHouseholdMethodOfPayment":"sample string 10","UseHeadofHouseholdAddress":"sample string 11"}

application/xml, text/xml

Sample: 
<FamilyMemberProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <AllowFamilyMemberAccess>sample string 8</AllowFamilyMemberAccess>
  <FamilyMemberDOB>sample string 7</FamilyMemberDOB>
  <FamilyMemberID>sample string 5</FamilyMemberID>
  <FamilyMemberName>sample string 6</FamilyMemberName>
  <HouseHoldID>sample string 3</HouseHoldID>
  <HouseHoldName>sample string 4</HouseHoldName>
  <MemberRelationshipCode>sample string 9</MemberRelationshipCode>
  <PatientID>sample string 1</PatientID>
  <PatientName>sample string 2</PatientName>
  <UseHeadofHouseholdAddress>sample string 11</UseHeadofHouseholdAddress>
  <UseHeadofHouseholdMethodOfPayment>sample string 10</UseHeadofHouseholdMethodOfPayment>
</FamilyMemberProfile>