Home

Spouse

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

Add spouse 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.
spouse 
Spouse 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]
            SpouseID - Patient ID of Spouse
            SpouseName - Name of Spouse [*Ignored on Create/Update]
            SpouseDOB - Date of Birth of Spouse (YYYYMMDD) [*Ignored on Create/Update]
            SpouseRelationshipCode - (See /api/RelationshipToCardHolderList for valid values)  [*Ignored on Create/Update]
            AllowHeadofHouseAccess - Allow Head of Household to access Spouse profile (Y/N)
            AllowSpouseAccess - Allow spouse to access Head of Household 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",
  "AllowSpouseAccess": "sample string 5",
  "SpouseID": "sample string 6",
  "SpouseName": "sample string 7",
  "SpouseDOB": "sample string 8",
  "AllowHeadofHouseAccess": "sample string 9",
  "SpouseRelationshipCode": "sample string 10",
  "UseHeadofHouseholdMethodOfPayment": "sample string 11",
  "UseHeadofHouseholdAddress": "sample string 12"
}

text/javascript

Sample: 
{"PatientID":"sample string 1","PatientName":"sample string 2","HouseHoldID":"sample string 3","HouseHoldName":"sample string 4","AllowSpouseAccess":"sample string 5","SpouseID":"sample string 6","SpouseName":"sample string 7","SpouseDOB":"sample string 8","AllowHeadofHouseAccess":"sample string 9","SpouseRelationshipCode":"sample string 10","UseHeadofHouseholdMethodOfPayment":"sample string 11","UseHeadofHouseholdAddress":"sample string 12"}

application/xml, text/xml

Sample: 
<SpouseProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <AllowHeadofHouseAccess>sample string 9</AllowHeadofHouseAccess>
  <AllowSpouseAccess>sample string 5</AllowSpouseAccess>
  <HouseHoldID>sample string 3</HouseHoldID>
  <HouseHoldName>sample string 4</HouseHoldName>
  <PatientID>sample string 1</PatientID>
  <PatientName>sample string 2</PatientName>
  <SpouseDOB>sample string 8</SpouseDOB>
  <SpouseID>sample string 6</SpouseID>
  <SpouseName>sample string 7</SpouseName>
  <SpouseRelationshipCode>sample string 10</SpouseRelationshipCode>
  <UseHeadofHouseholdAddress>sample string 12</UseHeadofHouseholdAddress>
  <UseHeadofHouseholdMethodOfPayment>sample string 11</UseHeadofHouseholdMethodOfPayment>
</SpouseProfile>