Home

Addresses

POST api/Patient/{systemID}/Addresses

Creates a delivery address for a specific patient

Special Remarks

Response Codes:
            
            AddressTypes:
            [A] - Alternate, [C] - Company, [H] - Home, [O] - Office, [S] - School, [W] - Work

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
deliveryAddress 
PatientAddress object
            PatientID - Unique Identifier for Patient,
            AddressID - Backend Identifier [*Ignored on Create], 
            AddressType - Type of Address [A] - Alternate, [C] - Company, [H] - Home, [O] - Office, [S] - School, [W] - Work
            Name - Patient/Organization Name, 
            InCareOf - Attention To,
            Address - Address Line 1,
            Address2 - Address Line 2,
            City - City,
            State - Two-Letter State Abbreviation,
            ZipCode - 5-digit Zip,
            PhoneNumber - Phone of patient (no dashes),
            POBox - PO Box (Y/N),
            Refrigerated Items - Can Recieve (Y/N),
            SpecialityItems - Can Receive (Y/N),
            OrderNo - Priority level (0,1,2,3,4, etc)
            TotalAddresses - [*Ignored on Create],
            BeginDate - Start date to use address - YYYYMMDD,
            EndDate - End date to use address - YYYYMMDD,
            InActive - Address Inactive (Y/N),
            Notes - Comments for deliverer

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",
  "Name": "sample string 2",
  "InCareOf": "sample string 3",
  "Address": "sample string 4",
  "Address2": "sample string 5",
  "City": "sample string 6",
  "State": "sample string 7",
  "Zip": "sample string 8",
  "PhoneNumber": "sample string 9",
  "POBox": "sample string 10",
  "RefrigeratedItems": "sample string 11",
  "SpecialtyItem": "sample string 12",
  "AddressID": "sample string 13",
  "OrderNo": 1,
  "TotalAddresses": 1,
  "AddressType": "sample string 14",
  "BeginDate": "sample string 15",
  "EndDate": "sample string 16",
  "InActive": "sample string 17",
  "Notes": "sample string 18"
}

text/javascript

Sample: 
{"PatientID":"sample string 1","Name":"sample string 2","InCareOf":"sample string 3","Address":"sample string 4","Address2":"sample string 5","City":"sample string 6","State":"sample string 7","Zip":"sample string 8","PhoneNumber":"sample string 9","POBox":"sample string 10","RefrigeratedItems":"sample string 11","SpecialtyItem":"sample string 12","AddressID":"sample string 13","OrderNo":1,"TotalAddresses":1,"AddressType":"sample string 14","BeginDate":"sample string 15","EndDate":"sample string 16","InActive":"sample string 17","Notes":"sample string 18"}

application/xml, text/xml

Sample: 
<PatientAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <Address>sample string 4</Address>
  <Address2>sample string 5</Address2>
  <AddressID>sample string 13</AddressID>
  <AddressType>sample string 14</AddressType>
  <BeginDate>sample string 15</BeginDate>
  <City>sample string 6</City>
  <EndDate>sample string 16</EndDate>
  <InActive>sample string 17</InActive>
  <InCareOf>sample string 3</InCareOf>
  <Name>sample string 2</Name>
  <Notes>sample string 18</Notes>
  <OrderNo>1</OrderNo>
  <POBox>sample string 10</POBox>
  <PatientID>sample string 1</PatientID>
  <PhoneNumber>sample string 9</PhoneNumber>
  <RefrigeratedItems>sample string 11</RefrigeratedItems>
  <SpecialtyItem>sample string 12</SpecialtyItem>
  <State>sample string 7</State>
  <TotalAddresses>1</TotalAddresses>
  <Zip>sample string 8</Zip>
</PatientAddress>

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "PatientID": "sample string 1",
  "Name": "sample string 2",
  "InCareOf": "sample string 3",
  "Address": "sample string 4",
  "Address2": "sample string 5",
  "City": "sample string 6",
  "State": "sample string 7",
  "Zip": "sample string 8",
  "PhoneNumber": "sample string 9",
  "POBox": "sample string 10",
  "RefrigeratedItems": "sample string 11",
  "SpecialtyItem": "sample string 12",
  "AddressID": "sample string 13",
  "OrderNo": 1,
  "TotalAddresses": 1,
  "AddressType": "sample string 14",
  "BeginDate": "sample string 15",
  "EndDate": "sample string 16",
  "InActive": "sample string 17",
  "Notes": "sample string 18"
}

text/javascript

Sample: 
{"PatientID":"sample string 1","Name":"sample string 2","InCareOf":"sample string 3","Address":"sample string 4","Address2":"sample string 5","City":"sample string 6","State":"sample string 7","Zip":"sample string 8","PhoneNumber":"sample string 9","POBox":"sample string 10","RefrigeratedItems":"sample string 11","SpecialtyItem":"sample string 12","AddressID":"sample string 13","OrderNo":1,"TotalAddresses":1,"AddressType":"sample string 14","BeginDate":"sample string 15","EndDate":"sample string 16","InActive":"sample string 17","Notes":"sample string 18"}

application/xml, text/xml

Sample: 
<PatientAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <Address>sample string 4</Address>
  <Address2>sample string 5</Address2>
  <AddressID>sample string 13</AddressID>
  <AddressType>sample string 14</AddressType>
  <BeginDate>sample string 15</BeginDate>
  <City>sample string 6</City>
  <EndDate>sample string 16</EndDate>
  <InActive>sample string 17</InActive>
  <InCareOf>sample string 3</InCareOf>
  <Name>sample string 2</Name>
  <Notes>sample string 18</Notes>
  <OrderNo>1</OrderNo>
  <POBox>sample string 10</POBox>
  <PatientID>sample string 1</PatientID>
  <PhoneNumber>sample string 9</PhoneNumber>
  <RefrigeratedItems>sample string 11</RefrigeratedItems>
  <SpecialtyItem>sample string 12</SpecialtyItem>
  <State>sample string 7</State>
  <TotalAddresses>1</TotalAddresses>
  <Zip>sample string 8</Zip>
</PatientAddress>