Profile

PUT api/Patient/{systemID}/Profile?patientID={patientID}

Update an existing patient profile

Request Information

Parameters

Name	Description	Additional 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.
patient	PatientProfile object PatientID - Unique Identifier of patient in pharmacy system, SSN - Social Security Number, LastName - Last name of patient, FirstName - First name of patient, MiddleInitial Middle initial of patient, DateOfBirth - YYYYMMDD, Gender - M/F, Address - Address Line 1, Address2 - Address Line 2, City - City, State - Two-Letter State Abbreviation, Zip - Five-digit zip code, HomePhone - Home Phone (no dashes), WorkPhone - Work Phone (no dashes), CellPhone - Cell Phone (no dashes), AlternatePhone - Alternate Phone (no dashes), IVRCallBackPhone - Call Back Number (no dashes), MedicalRecordNumber = Third Party Identifier for Patient (e.g. Employee ID), Height - Formatted as Fii where F is feet and ii is inches, Weight - Weight of patient in pounds, AdmitDate - YYYYMMDD, EmailAddress - Email address of patient, UseSafetyCaps - Request Safety Caps - Y/N, DoctorName - Name of patient's doctor, DoctorCode - Unique Identifier of doctor in pharmacy system ContactUndecided - No contact method provided - Y/N, DoNotContact - Patient does not wish to be contacted - Y/N, ContactViaEmail - Contact patient via provided email address - Y/N, ContactViaPhone - Contact patient via provided home phone - Y/N, ContactViaText - Contact patient via SMS on provided cell phone - Y/N EligibleForPayrollDeduction - Patient is elgible to use Payroll Deduction - Y/N, ThirdPartyPayrollID - Customer identifier for Payroll deductions - BL to blank out field, UsePayrollDeduction - Enable Payroll Deduction for patient - Y/N, PayrollAmountPerPeriod - Maximum amount to deduct per pay period, PayrollAmountPerOrder - Maximum amount to use per order, FacilityCode - (Patient Group Code) [Ignored on Create], FacilityName - Name of Facility or Group - [Ignored on Create/Update], Room - Patient Room/Wing, Title - Patient Title, InCareOf - Person response for patient, ChargeAccountCode - [Ignored on Create], ChargeAccountName - [Ignored on Create/Update], ChargeAccountLastPdDate - Charge Account Last Paid Date - [Ignored on Create/Update], ChargeAccountPrevBalAmt - Charge Account's Previous Balance Amount - [Ignored on Create/Update], ChargeAccountCurrBalAmt - Charge Account's Current Balance Amount - [Ignored on Create/Update], ChargeAccountLimit - Charge Account's Limit - [Ignored on Create/Update], ChargeAccountFrozen - Charge Account Frozen? - Y/N - [Ignored on Create/Update], ChargeAccountAutoPost - Charge Account Auto Post Flag - Y/N - [Ignored on Create/Update], ThirdPartyPatientID1 - Third party identifier for patient, ThirdPartyPatientID2 - Third party identifier for patient, ThirdPartyPatientID3 - Third party identifier for patient, ThirdPartyPatientID4 - Third party identifier for patient, YTDRxAmount - Year to date RX amount - [*Ignored on Create/Update] HICId - HIC Id InterfacePriority - Interface Priority HealthMinderPatient - Turn HealthMinder for this patient On or Off - Y/N RefillReminder - Patient Preference regarding Refill Reminders - [Y] Yes, [N] No, [R] Refused	Define this parameter in the request body.

Name

Description

Additional 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.

patient

PatientProfile object
            PatientID - Unique Identifier of patient in pharmacy system, 
            SSN - Social Security Number, 
            LastName - Last name of patient,
            FirstName - First name of patient,
            MiddleInitial Middle initial of patient,
            DateOfBirth - YYYYMMDD,
            Gender - M/F,
            Address - Address Line 1,
            Address2 - Address Line 2,
            City - City,
            State - Two-Letter State Abbreviation,
            Zip - Five-digit zip code,
            HomePhone - Home Phone (no dashes),
            WorkPhone - Work Phone (no dashes),
            CellPhone - Cell Phone (no dashes),
            AlternatePhone - Alternate Phone (no dashes),
            IVRCallBackPhone - Call Back Number (no dashes),
            MedicalRecordNumber = Third Party Identifier for Patient (e.g. Employee ID),
            Height - Formatted as Fii where F is feet and ii is inches,
            Weight - Weight of patient in pounds,
            AdmitDate - YYYYMMDD,
            EmailAddress - Email address of patient,
            UseSafetyCaps - Request Safety Caps - Y/N,
            DoctorName - Name of patient's doctor,
            DoctorCode - Unique Identifier of doctor in pharmacy system
            ContactUndecided - No contact method provided - Y/N,
            DoNotContact - Patient does not wish to be contacted - Y/N,
            ContactViaEmail - Contact patient via provided email address - Y/N,
            ContactViaPhone - Contact patient via provided home phone - Y/N,
            ContactViaText - Contact patient via SMS on provided cell phone - Y/N
            EligibleForPayrollDeduction - Patient is elgible to use Payroll Deduction - Y/N,
            ThirdPartyPayrollID - Customer identifier for Payroll deductions - BL to blank out field,
            UsePayrollDeduction - Enable Payroll Deduction for patient - Y/N,
            PayrollAmountPerPeriod - Maximum amount to deduct per pay period,
            PayrollAmountPerOrder - Maximum amount to use per order,
            FacilityCode - (Patient Group Code) [*Ignored on Create],
            FacilityName - Name of Facility or Group - [*Ignored on Create/Update],
            Room - Patient Room/Wing,
            Title - Patient Title,
            InCareOf - Person response for patient,
            ChargeAccountCode - [*Ignored on Create],
            ChargeAccountName - [*Ignored on Create/Update],
            ChargeAccountLastPdDate - Charge Account Last Paid Date -  [*Ignored on Create/Update],
            ChargeAccountPrevBalAmt - Charge Account's Previous Balance Amount - [*Ignored on Create/Update],
            ChargeAccountCurrBalAmt - Charge Account's Current Balance Amount - [*Ignored on Create/Update],
            ChargeAccountLimit - Charge Account's Limit - [*Ignored on Create/Update],
            ChargeAccountFrozen - Charge Account Frozen? - Y/N - [*Ignored on Create/Update],
            ChargeAccountAutoPost - Charge Account Auto Post Flag - Y/N - [*Ignored on Create/Update],
            ThirdPartyPatientID1 - Third party identifier for patient,
            ThirdPartyPatientID2 - Third party identifier for patient,
            ThirdPartyPatientID3 - Third party identifier for patient,
            ThirdPartyPatientID4 - Third party identifier for patient,
            YTDRxAmount - Year to date RX amount - [*Ignored on Create/Update]
            HICId - HIC Id 
            InterfacePriority - Interface Priority
            HealthMinderPatient - Turn HealthMinder for this patient On or Off - Y/N
            RefillReminder - Patient Preference regarding Refill Reminders - [Y] Yes, [N] No, [R] Refused

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",
  "LastName": "sample string 2",
  "FirstName": "sample string 3",
  "MiddleInitial": "sample string 4",
  "DateOfBirth": "sample string 5",
  "Gender": "sample string 6",
  "Address": "sample string 7",
  "Address2": "sample string 8",
  "City": "sample string 9",
  "State": "sample string 10",
  "Zip": "sample string 11",
  "HomePhone": "sample string 12",
  "WorkPhone": "sample string 13",
  "CellPhone": "sample string 14",
  "IVRCallBackPhone": "sample string 15",
  "MedicalRecordNumber": "sample string 16",
  "AlternatePhone": "sample string 17",
  "Height": "sample string 18",
  "Weight": "sample string 19",
  "AdmitDate": "sample string 20",
  "DoctorName": "sample string 21",
  "DoctorCode": "sample string 22",
  "UseSafetyCaps": "sample string 23",
  "EmailAddress": "sample string 24",
  "SSN": "sample string 25",
  "ContactUndecided": "sample string 26",
  "DoNotContact": "sample string 27",
  "ContactViaEmail": "sample string 28",
  "ContactViaPhone": "sample string 29",
  "ContactViaText": "sample string 30",
  "EligibleForPayrollDeduction": "sample string 31",
  "UsePayrollDeduction": "sample string 32",
  "PayrollAmountPerPeriod": 1.0,
  "PayrollAmountPerOrder": 1.0,
  "FacilityCode": "sample string 33",
  "FacilityName": "sample string 34",
  "Room": "sample string 35",
  "Title": "sample string 36",
  "InCareOf": "sample string 37",
  "ChargeAccountCode": "sample string 38",
  "ChargeAccountName": "sample string 39",
  "ChargeAccountLastPdDate": "sample string 40",
  "ChargeAccountPrevBalAmt": "sample string 41",
  "ChargeAccountCurrBalAmt": "sample string 42",
  "ChargeAccountLimit": "sample string 43",
  "ChargeAccountFrozen": "sample string 44",
  "ChargeAccountAutoPost": "sample string 45",
  "ThirdPartyPayrollID": "sample string 46",
  "ThirdPartyPatientID1": "sample string 47",
  "ThirdPartyPatientID2": "sample string 48",
  "ThirdPartyPatientID3": "sample string 49",
  "ThirdPartyPatientID4": "sample string 50",
  "YTDRxAmount": "sample string 51",
  "InterfacePriority": "sample string 52",
  "HICId": "sample string 53",
  "AccountNumber": "sample string 54",
  "HealthMinderPatient": "sample string 55",
  "RefillReminder": "sample string 56"
}

text/javascript

Sample:

{"PatientID":"sample string 1","LastName":"sample string 2","FirstName":"sample string 3","MiddleInitial":"sample string 4","DateOfBirth":"sample string 5","Gender":"sample string 6","Address":"sample string 7","Address2":"sample string 8","City":"sample string 9","State":"sample string 10","Zip":"sample string 11","HomePhone":"sample string 12","WorkPhone":"sample string 13","CellPhone":"sample string 14","IVRCallBackPhone":"sample string 15","MedicalRecordNumber":"sample string 16","AlternatePhone":"sample string 17","Height":"sample string 18","Weight":"sample string 19","AdmitDate":"sample string 20","DoctorName":"sample string 21","DoctorCode":"sample string 22","UseSafetyCaps":"sample string 23","EmailAddress":"sample string 24","SSN":"sample string 25","ContactUndecided":"sample string 26","DoNotContact":"sample string 27","ContactViaEmail":"sample string 28","ContactViaPhone":"sample string 29","ContactViaText":"sample string 30","EligibleForPayrollDeduction":"sample string 31","UsePayrollDeduction":"sample string 32","PayrollAmountPerPeriod":1.0,"PayrollAmountPerOrder":1.0,"FacilityCode":"sample string 33","FacilityName":"sample string 34","Room":"sample string 35","Title":"sample string 36","InCareOf":"sample string 37","ChargeAccountCode":"sample string 38","ChargeAccountName":"sample string 39","ChargeAccountLastPdDate":"sample string 40","ChargeAccountPrevBalAmt":"sample string 41","ChargeAccountCurrBalAmt":"sample string 42","ChargeAccountLimit":"sample string 43","ChargeAccountFrozen":"sample string 44","ChargeAccountAutoPost":"sample string 45","ThirdPartyPayrollID":"sample string 46","ThirdPartyPatientID1":"sample string 47","ThirdPartyPatientID2":"sample string 48","ThirdPartyPatientID3":"sample string 49","ThirdPartyPatientID4":"sample string 50","YTDRxAmount":"sample string 51","InterfacePriority":"sample string 52","HICId":"sample string 53","AccountNumber":"sample string 54","HealthMinderPatient":"sample string 55","RefillReminder":"sample string 56"}

application/xml, text/xml

Sample:

<PatientProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <AccountNumber>sample string 54</AccountNumber>
  <Address>sample string 7</Address>
  <Address2>sample string 8</Address2>
  <AdmitDate>sample string 20</AdmitDate>
  <AlternatePhone>sample string 17</AlternatePhone>
  <CellPhone>sample string 14</CellPhone>
  <ChargeAccountAutoPost>sample string 45</ChargeAccountAutoPost>
  <ChargeAccountCode>sample string 38</ChargeAccountCode>
  <ChargeAccountCurrBalAmt>sample string 42</ChargeAccountCurrBalAmt>
  <ChargeAccountFrozen>sample string 44</ChargeAccountFrozen>
  <ChargeAccountLastPdDate>sample string 40</ChargeAccountLastPdDate>
  <ChargeAccountLimit>sample string 43</ChargeAccountLimit>
  <ChargeAccountName>sample string 39</ChargeAccountName>
  <ChargeAccountPrevBalAmt>sample string 41</ChargeAccountPrevBalAmt>
  <City>sample string 9</City>
  <ContactUndecided>sample string 26</ContactUndecided>
  <ContactViaEmail>sample string 28</ContactViaEmail>
  <ContactViaPhone>sample string 29</ContactViaPhone>
  <ContactViaText>sample string 30</ContactViaText>
  <DateOfBirth>sample string 5</DateOfBirth>
  <DoNotContact>sample string 27</DoNotContact>
  <DoctorCode>sample string 22</DoctorCode>
  <DoctorName>sample string 21</DoctorName>
  <EligibleForPayrollDeduction>sample string 31</EligibleForPayrollDeduction>
  <EmailAddress>sample string 24</EmailAddress>
  <FacilityCode>sample string 33</FacilityCode>
  <FacilityName>sample string 34</FacilityName>
  <FirstName>sample string 3</FirstName>
  <Gender>sample string 6</Gender>
  <HICId>sample string 53</HICId>
  <HealthMinderPatient>sample string 55</HealthMinderPatient>
  <Height>sample string 18</Height>
  <HomePhone>sample string 12</HomePhone>
  <IVRCallBackPhone>sample string 15</IVRCallBackPhone>
  <InCareOf>sample string 37</InCareOf>
  <InterfacePriority>sample string 52</InterfacePriority>
  <LastName>sample string 2</LastName>
  <MedicalRecordNumber>sample string 16</MedicalRecordNumber>
  <MiddleInitial>sample string 4</MiddleInitial>
  <PatientID>sample string 1</PatientID>
  <PayrollAmountPerOrder>1</PayrollAmountPerOrder>
  <PayrollAmountPerPeriod>1</PayrollAmountPerPeriod>
  <RefillReminder>sample string 56</RefillReminder>
  <Room>sample string 35</Room>
  <SSN>sample string 25</SSN>
  <State>sample string 10</State>
  <ThirdPartyPatientID1>sample string 47</ThirdPartyPatientID1>
  <ThirdPartyPatientID2>sample string 48</ThirdPartyPatientID2>
  <ThirdPartyPatientID3>sample string 49</ThirdPartyPatientID3>
  <ThirdPartyPatientID4>sample string 50</ThirdPartyPatientID4>
  <ThirdPartyPayrollID>sample string 46</ThirdPartyPayrollID>
  <Title>sample string 36</Title>
  <UsePayrollDeduction>sample string 32</UsePayrollDeduction>
  <UseSafetyCaps>sample string 23</UseSafetyCaps>
  <Weight>sample string 19</Weight>
  <WorkPhone>sample string 13</WorkPhone>
  <YTDRxAmount>sample string 51</YTDRxAmount>
  <Zip>sample string 11</Zip>
</PatientProfile>

QCF Web API Guide

Quantum Communications Framework (QCF) Web API Guide

Profile

PUT api/Patient/{systemID}/Profile?patientID={patientID}

Request Information

Parameters

Response Codes

Request body formats

application/json, text/json

text/javascript

application/xml, text/xml