Download PDF

OfficeEMR 2019

API Testing Sites

SandBox: http://dev.isalushealthcare.com/officemobile/screens/webservices.htm


Production: https://www.officemd.net/officemobile/screens/webservices.htm


Data Not on File

In the event that the any API is executed, it is possible that data may not be on file. This could be an entire category of data (i.e. patient has no immunizations) or an element within a category (i.e. Demographics were requested, but patient did not have a value saved for ‘Race’). If an entire category of data is not present, the API will return the date range that was originally entered on the initial call, but no subsequent details. This is essentially an empty response. If an element in a category of data is not present, the API will not return the given node. In some rare cases, it is also possible to receive the node back, but no data within it.


ONC.FindPatient

The FindPatient endpoint is used to retrieve a unique api key for the given patient that can be passed to subsequent methods. In order to execute this method, you must supply a token (provided by the patient) as well as the patient’s date of birth, first name, and last name.

Example Request

      
      <request>
        <security>
            <key>UserID~Password~onc_api</key>
            <version>1.0</version>
            <userid />
            <account>39985F47-62E0-4533-918F-317695A6BFEB</account>
        </security>
        <token>123</token>
        <birth_date>01/01/1965</birth_date>
        <first_name>Test</first_name>
        <last_name>Patient</last_name>
      </request>

      
      
Parent Tag Type Max Length Description
request security tag Contains security information for accessing the API’s
security key string(required) Security information used to access the API. Key is made up of a user identifier, password and connection point separated by a tilde character.
The user identifier and password were assigned to you when you signed up to use the API’s. The connection point will always be cw_api.
security version string Used for backwards compatibility. For now always use 1.0.
security userid string UserId for the user of your application. Currently not used.
request account string Account identifier. This will always be 39985F47-62E0-4533-918F-317695A6BFEB
request token string(required) 39 char Token that has been given to the patient to connect with external API’s.
request birth_date string(required) 10 char Birth date of the patient in the form of mm/dd/yyyy
request first_name string(required) 25 char First name of the patient
request last_name string(required) 95 char Last name of the patient

Example Response

Patient was found and an API key was returned

      
      <response xmlns="http://www.isalushealthcare.webservices/">
        <api_key>D6000A1268434C7F4EBC758CB42463657535FA4410A1C2DF9F</api_key>
      </response>

      
      

Patient was not found

      
      <response xmlns="http://www.isalushealthcare.webservices/">
          <api_key / >
      </response>

      
      

Security key information was not valid

      
      <response xmlns="http://www.isalushealthcare.webservices/">
          <error>
              <code>1</code>
              <description>The login credentials are not valid.</description>
              <log_id>486795</log_id>
          </error>
      </response>


      
      
Parent Tag Type Max Length Description
response error tag Used to store error information from the request
error code numeric Code identifying the error
error description string Description of the error
error log_id numeric Value which can be used internally to help further identify the error
response api_key string 50 char Value used gain access to subsequent API methods. This key is only good for a limited time (Generally less than 30 minutes).
The API key expiration gets extended each time the API key is used.

ONC.GetPatient

This method takes the following information: API key, time period in months and section information and returns specific patient information for each section requested. If no sections are requested all sections will be returned.This method takes the following information: API key, time period in months and section information and returns specific patient information for each section requested. If no sections are requested all sections will be returned.

Example Request


        <request>
          <security>
              <key>UserID~Password~cw_API</key>
              <version>1.0</version>
              <userid />
              <account>39985F47-62E0-4533-918F-317695A6BFEB</account>
          </security>
          <api_key>123</api_key>
          <start_date>01/01/2019</start_date>
          <end_date>03/01/2019</end_date>
          <time_period_months>36</time_period_months>
          <section_list>
              <section_name>Demographics</section_name>
              <section_name>Social History</section_name>
              <section_name>Problems</section_name>
              <section_name>Medications</section_name>
              <section_name>Allergies</section_name>
              <section_name>Diagnostic Results</section_name>
              <section_name>Vital Signs</section_name>
              <section_name>Procedures</section_name>
              <section_name>Care Team Members</section_name>
              <section_name>Immunizations</section_name>
              <section_name>Unique Device Identifiers</section_name>
              <section_name>Assessment and Plan of Treatment</section_name>
              <section_name>Goals</section_name>
              <section_name>Health Concerns</section_name>
          </section_list>
      </request>

      
Parent Tag Type Max Length Description
request security tag Contains security information for accessing the API’s
security key string Security information used to access the API. Key is made up of a user identifier, password and connection point separated by a tilde character.
The user identifier and password were assigned to you when you signed up to use the API’s. The connection point will always be cw_api.
security version string Used for backwards compatibility. For now always use 1.0.
security userid string UserId for the user of your application. Currently not used.
security account string(required) Account identifier. This will always be 39985F47-62E0-4533-918F-317695A6BFEB
request api_key string(required) 50 char api_key that is returned from the ONC.FindPatient method.
request start_date string Starting date to return data for (default=01/01/1901). Setting has no effect on Demographics, Allergies, Medications, Problems, Unique Device Identifiers and Social History
request end_date string Ending date to return data for (default=01/01/3001). Setting has no effect on Demographics, Allergies, Medications, Problems, Unique Device Identifiers and Social History
request time_period_months numeric(required) Number of months in the past to return patient related information.
Setting has no effect on Demographics, Allergies, Medications, Problems, Immunizations, Unique Device Identifiers and Social History
request section_list tag Contains section information to return.
section_list section_name tag 100 char Section to return. Valid values are: Demographics Social History Problems Medications Allergies Diagnostic Results Vital Signs Procedures Care Team Members Immunizations Unique Device Identifiers Assessment and Plan of Treatment Goals Health Concerns

Response

Reference

This is returned with all responses unless there is an error.

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
              <range>
                  <start>04/24/2016</start>
                  <end>04/24/2019</end>
              </range>
          </reference>
      </response>

      
Parent Tag Type Description
response reference tag Used to return reference information about tde request
reference range tag Used to return tde range of dates tdat was used for tde subsequent patient information tdat is returned.
range start string Starting date for data to be returned. Format mm/dd/yyyy.
range end string Ending date for data to be returned. Format mm/dd/yyyy.

Demographics

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
              <range>
                  <start>04/24/2016</start>
                  <end>04/24/2019</end>
              </range>
          </reference>
          <demographics>
              <name>
                  <first>The</first>
                  <middle>X</middle>
                  <nick>Bruce</nick>
                  <last>Batman</last>
                  <suffix>Sr</suffix>
              </name>
              <address>
                  <address1>123 Main Street</address1>
                  <address2>The Bat Cave</address2>
                  <city>Indianapolis</city>
                  <state>IN</state>
                  <zip>46202</zip>
                  <country>USA</country>
              </address>
              <birth_date>01/01/1965</birth_date>
              <languge>
                <code>en</code>
                <description>English</description>
              </languge>
              <gender>
                  <code>M</code>
                  <description>Male</description>
              </gender>
              <marital_status>
                  <code>S</code>
                  <description>Single</description>
              </marital_status>
              <race>
                  <list_item>
                      <code>2106-3</code>
                      <description>White</description>
                  </list_item>
              </race>
              <ethnicity>
                  <code>2106-3</code>
                  <description>Not Hispanic or Latino</description>
              </ethnicity>
              <primary_id>
                  <type>SSN</type>
                  <value>000-00-1111</value>
              </primary_id>
              <contact>
                  <phone_home>(317) 111-5555</phone_home>
                  <phone_work>(317) 222-3333</phone_work>
                  <phone_other>(317) 333-4444</phone_other>
                  <email>brucewayne@gothamcity.com</email>
              </contact>
          </demographics>
      </response>

      
Parent Tag Type Max Length Description
response demographics tag Used to return demographic information for the patient
demographics name tag Used to return name information
name first string 25 char First name of the patient
name nick string 25 char Nick name of the patient
name last string 95 char Last name of the patient
name suffix string 10 char Suffix name of the patient
demographics address tag 10 char Used to return address information for the patient
address address1 string 55 char
address address2 string 55 char
address city string 30 char
address state string 2 char
address zip string 15 char
address country string 3 char Valid values: USA CAN
demographics birth_date string Birth date for the patient. Format: mm/dd/yyyy
demographics language tag Used to return preferred language information for the patient
language code string Code for preferred language
language description string Description for preferred language
demographics gender string Internal code used to identifier gender. Valid values: M - Male F - Female U - Unkown
gender description string Gender description
demographics marital_status string Used to return marital status information for the patient
marital_status code string Internal code used to identifier marital status Valid values: D - Divorced M - Married S - Single U - Unknown W - Widowed X – Legally Separated
marital_status description string Marital status description
demographics race string Used to return race information for the patient
race list_item string Used to return 1 to many race(s) for the patient
list_item code string Internal code used to identify race Code used to identify race
Valid values:
1002-5 – American Indian or Alaska Native
2028-9 – Asian
2054-5 – Black or African American
2076-8 – Native Hawaiian or Other Pacific Islander
2106-3 – White
2131-1 – Other
– Declined to Specify
list_item description string Race description
demographics race_specific string Used to return specific race information for the patient
race_specific list_item string Used to return 1 to many specific race(s) for the patient
list_item code string Code used to identify specific race. Valid values can be found from the CDC Race and Ethnicity code system (2.16.840.1.113883.6.238)
list_item description string Specific race description
ethnicity code string Internal code used to identifier ethnicity
Valid values:
2135-2 – Hispanic or Latino
2186-5 – Not Hispanic or Latino
– Declined to specify
ethnicity description string Ethnicity description

Social History

Example


          <response xmlns="http://www.isalushealthcare.webservices/">
            <reference>
                <range>
                    <start>04/24/2016</start>
                    <end>04/24/2019</end>
                </range>
            </reference>
            <social_history>
                <smoking>
                    <snomed_conceptid>77176002</snomed_conceptid>
                    <description>Smoker, current status unknown</description>
                    <date>02/20/2019</date>
                </smoking>
                <birth_sex>
                    <code>1</code>
                    <description>Male</description>
                    <date>02/20/2019</date>
                </birth_sex>
            </social_history>
          </response>

      
Parent Tag Type Max Length Description
response social_history tag Used to return social history information for the patient
social_history smoking tag Used to return smoking information for the patient
smoking snomed_conceptid string Snomed ConceptID associated with the smoking status. Valid values:
449868002 – Current every day smoker
428041000124106 – Current some day smoker
8517006 – Former smoker
266919005 – Never smoker
77176002 – Smoker, current status unknown
428071000124103 – Heavy tobacco smoker
428061000124105 – Light tabacco smoker
266927001 – Unknown if ever smoked
smoking description string Description of the smoking status
smoking date string Date the smoking status was recorded
social_history birth_sex tag Used to return birth sex information for the patient
birth_sex code integer Type: integer Sex assigned at birth Values values:
1 – Male
2 – Female
3 – Unknown
birth_sex description string Birth sex description
birth_sex date string Date the birth sex was recorded

Problems

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
            <range>
              <start>04/24/2016</start>
              <end>04/24/2019</end>
            </range>
          </reference>
          <problems>
            <problem>
              <description>Abnormal posture</description>
              <onset_date>10/18/2018</onset_date>
              <status>
                <code>1</code>
                <description>Active</description>
              </status>
              <icd>
                <code>R29.3</code>
                <description>Abnormal posture</description>
              </icd>
              <chronic_ind>Y</chronic_ind>
            </problem>
            <problem>
              <description>ALCOHOL ABUSE-CONTINUOUS</description>
              <onset_date>02/19/2019</onset_date>
              <status>
                <code>1</code>
                <description>Active</description>
              </status>
              <icd>
                <code>305.01</code>
                <description>NONDEP ALCOHOL ABUSE CONT DRINKING</description>
              </icd>
              <chronic_ind>Y</chronic_ind>
            </problem>
          </problems>
        </response>

      
Parent Tag Type Max Length Description
response problems tag Used to return demographic information for the patient
problems problem tag Used to return 1 to many problems for the patient
problem description string Description of the problem
problem onset_date string Onset date for the problem in the form mm/dd/yyyy
problem resolution_date string Resolution date for the problem in the form mm/dd/yyyy
problem status tag Used to return status information for the problem
status code numeric Internal identifier for the status of the problem
Valid values:
1 – Active
2 – Inactive
3 - Resolved
status description string Problem status description
problem icd tag Used to return diagnosis information for the problem
icd code string Diagnosis code tied to the problem
icd description string Diagnosis description tied to the problem
problem snomed_conceptid string Snomed Concept ID tied to the problem
problem chronic_ind string Indicates if the problem is chronic
Valid Values:
Y – Yes
N - No

Medications

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
            <range>
              <start>04/24/2016</start>
              <end>04/24/2019</end>
            </range>
          </reference>
          <medications>
            <medication>
              <description>Lipitor 20 mg tablet tablet oral</description>
              <med_date>08/14/2018</med_date>
              <stop_date>08/15/2018</stop_date>
              <status>
                <code>5</code>
                <description>New</description>
              </status>
              <route>
                <code>C38288</code>
                <description>oral</description>
              </route>
              <rxnorm>
                <code>617318</code>
              </rxnorm>
            </medication>
            <medication>
              <description>Aspirin And Caffeine 400 mg-32 mg tablet tablet oral</description>
              <med_date>08/15/2018</med_date>
              <stop_date>12/03/2018</stop_date>
              <status>
                <code>4</code>
                <description>Stopped</description>
              </status>
              <route>
                <code>C38288</code>
                <description>oral</description>
              </route>
            </medication>
          </medications>
        </response>

      
Parent Tag Type Max Length Description
response medications tag Used to return medication information for the patient
medications medication tag Used to return 1 to many medications for the patient
medication description string Description for the medication
medication sig_quantity string Signature quantity for the medication
medication frequency string Frequency of the medication
medication med_date string Date the medication was started in the form mm/dd/yyyy
medication stop_date string Date the medication was stopped in the form mm/dd/yyyy
medication status tag Used to return the status of the medication
status code string Internal code used for the medication status
Valid values:
0 - Ineffective
1 - Allergic Reaction
2 - Current
3 - Expired
4 - Stopped
5 - New
6 - Overdosed
7 - Drug Interaction
8 - Other
9 - Needs Dr. Approval
10 - Change
11 - Discontinue
12 - Renew
13 - Hold
14 - Error
15 - Completed
16 - Side Effects
17 - Discontinue Financial
status description string Medication status description
medication route tag Used to return the route of the medication
route code string Internal code used for the medication route
route description string Medication route description

Allergies

Example


          <response xmlns="http://www.isalushealthcare.webservices/">
            <reference>
              <range>
                <start>04/24/2016</start>
                <end>04/24/2019</end>
              </range>
            </reference>
            <allergies>
              <allergy>
                <description>Acetaminophen</description>
                <status>Active</status>
                <rxnorm>
                  <code>161</code>
                  <description>Acetaminophen</description>
                </rxnorm>
                <posted>01/08/2019 10:40AM</posted>
                <severity>
                  <description>Mild</description>
                  <snomed_conceptid>18647004</snomed_conceptid>
                </severity>
                <symptoms>
                  <symptom>
                    <description>Hives</description>
                    <snomed_conceptid>247472004</snomed_conceptid>
                  </symptom>
                  <symptom>
                    <description>redness</description>
                  </symptom>
                </symptoms>
              </allergy>
              <allergy>
                <description>cefpodoxime</description>
                <rxnorm>
                  <code>20489</code>
                  <description>cefpodoxime</description>
                </rxnorm>
                <posted>10/19/2018 7:37AM</posted>
                <severity>
                  <description>Severe</description>
                  <snomed_conceptid>24484000</snomed_conceptid>
                </severity>
              </allergy>
            </allergies>
          </response>

      
Parent Tag Type Max Length Description
response allergies tag Used to return allergy information for the patient
allergies allergy tag Used to return 1 to many allergies for the patient
allergy description string Description of the allergy
allergy status string Status of the allergy
allergy rxnorm tag Used to return rxnorm information for the allergy
rxnorm code string rxnorm code
rxnorm description string rxnorm description
allergy posted string Date/time the allergy was posted to the system
allergy severity tag Used to return severity information for the allergy
severity description string Severity description
severity snomed_conceptid string Snomed ConceptID that represents the severity
Valid values:
1. 18647004 – Mild
2. 6736007 – Moderate
3. 24484000 - Severe
allergy symptoms tag Used to return symptom information for the allergy
symptoms symptom tag Used to return 1 to may symptoms for the allergy
symptom description tag Symptom description
symptom snomed_conceptid string Snomed ConceptID that represents the symptom

Diagnostic Results

Example


      <response xmlns="http://www.isalushealthcare.webservices/">
        <reference>
          <range>
            <start>04/24/2016</start>
            <end>04/24/2019</end>
          </range>
        </reference>
        <diagnostic_results>
          <lab>
            <information>
              <name>Value Labs</name>
              <address1>2474 Rocky Place</address1>
              <city>Beaverton</city>
              <state>OR</state>
              <zip>97006</zip>
            </information>
            <result_list>
              <result>
                <description>Glucose</description>
                <value>50</value>
                <unit_of_measure>mg/dL</unit_of_measure>
                <range>Neg.</range>
                <result_date>06/22/2015</result_date>
                <interpret>
                  <code>N</code>
                  <description>Normal</description>
                </interpret>
                <loinc>
                  <code>5792-7</code>
                  <description>Glucose [Mass/volume] in Urine by Test strip</description>
                </loinc>
              </result>
              <result>
                <description>Ketones</description>
                <value>Negative</value>
                <range>Negative</range>
                <result_date>06/22/2015</result_date>
                <interpret>
                  <code>N</code>
                  <description>Normal</description>
                </interpret>
                <loinc>
                  <code>5797-6</code>
                  <description>Ketones [Mass/volume] in Urine by Test strip</description>
                </loinc>
              </result>
            </result_list>
          </lab>
        </diagnostic_results>
      </response>
    
Parent Tag Type Max Length Description
response diagnostic_results tag Used to return demographic information for the patient
diagnostic_results lab tag Used to return 1 to many lab location, contact and result information for the patient
lab information tag Used to store lab information
information name string Lab name
information address1 string 55 char Address line for the lab
information city string 30 char City for the lab
information state string 2 char State for the lab
information zip string 15 char Zip for the lab
information phone string Phone number for the lab
lab result_list tag Used to return result information for the lab for the patient
result_list result tag Used to return 1 to many lab results for the lab for the patient
result description string Description for the result
result result_value string Value for the result
result unit_of_measure string Unit of measure for the result
result result_date string Date for the result in the from mm/dd/yyyy
result interpret tag Used to return interpretation information for the result
interpret code string Interpretation code for the result.
Values values:
** - No range defined
*G - Above absolute high-off instrument scale
*L - Below absolute low-off instrument scale
A - Alpha abnormal
AA - Very abnormal
B - No comment
D - Significant change down
H - Above high normal
HH - Above upper panic limits
HU - High Urgent
I - Intermediate - microbiology
L - Below low normal
LL - Below lower panic limits
LU - Low Urgent
MS - Moderately susceptible - microbiology
N - Normal
R - Resistant - microbiology
S - Susceptible - microbiology
U - Significant change up
VS - Very susceptible - microbiology
W - Worse
interpret description string Description for the interpretation code
result loinc string Used to store loinc information for the result
loinc code string Loinc code for the result
loinc description string Description for the loinc code

Vital Signs

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
            <range>
              <start>04/24/2016</start>
              <end>04/24/2019</end>
            </range>
          </reference>
          <vitals>
            <vital>
              <vital_date>04/18/2019 3:04PM</vital_date>
              <height>
                <value>62.00</value>
                <units>in</units>
                <loinc>8302-2</loinc>
              </height>
              <weight>
                <value>175.00</value>
                <units>lbs</units>
                <loinc>29463-7-2</loinc>
              </weight>
              <bmi>
                <value>32.00</value>
                <loinc>39156-5></loinc>
              </bmi>               
              <temperature>
                <value>98.60</value>
                <units>Fahrenheit</units>
                <loinc>8310-5</loinc>
              </temperature>
              <bp>
                <systolic>
                  <value>120</value>
                  <units>mmHg</units>
                  <loinc>8480-6</loinc>
                </systolic>
                <diastolic>
                  <value>100</value>
                  <units>mmHg</units>
                  <loinc>8462-4</loinc>
                </diastolic>
              </bp>
            </vital>
            <vital>
              <vital_date>10/18/2018 11:54AM</vital_date>
              <height>
                <value>63.00</value>
                <units>in</units>
                <loinc>8302-2</loinc>
              </height>
              <weight>
                <value>175.00</value>
                <units>lbs</units>
                <loinc>29463-7</loinc>
              </weight>
              <bmi>
                <value>31.00</value>
                <loinc>39156-5></loinc>
              </bmi>
            </vital>
          </vitals>
        </response>

      
Parent Tag Type Max Length Description
response vitals tag Used to return vitals information for the patient
vitals vital tag Used to return 1 to many vitals for the patient
vital vital_date string Date/time the vital was given in the from mm/dd/yyyy hh:mm(AM/PM)
vital height tag Used to return height information for the patient
height value decimal Height of the patient
height units string Units for the height value
Valid Values:
cm
in
height lonic string loinc code for height
vital weight tag Used to return weight information for the patient
weight value decimal Weight of the patient
weight units string Units for the weight value
Valid Values:
Kg
lbs
weight loinc string loinc code for weight
vital bmi tag Used to return bmi information for the patient
bmi value decimal Body Mass Index for the vital record
bmi loinc string loinc code for bmi
vital temperature tag Used to return temperature information for the patient
temperature value decimal Temperature of the patient
temperature units string Units for the temperature value
Valid Values:
Celsius
Fahrenheit
temperature loinc string loinc code for temperature
vital bp tag Used to return blood pressure information for the patient
bp systolic integer Systolic pressure for the patient
systolic value integer Systolic pressure for the patient
systolic units string Units for systolic Valid Values: mmHg
systolic loinc integer oinc code for systolic blood pressure
bp diastolic tag Used to return diastolic blood pressure information for the patient
diastolic value integer diastolic pressure for the patient
diastolic units string Units for diastolic Valid Values: mmHg
diastolic loinc integer oinc code for diastolic blood pressure
vital heart tag Used to return heart rate information for the patient
heart rate tag Heart rate of the patient
heart units tag Units for the heart rate
Valid Values:
Beats/Min
vital respirations tag Used to return respiration information for the patient
respirations rate integer Number of respirations for the patient
respirations units integer Units for the respirations
Valid Values:
Breaths/Min
respirations loinc string loinc code for respirations
vital O2Saturation tag Used to return oxygen saturation information for the patient
O2Saturation value decimal Oxygen saturation for the patient
O2Saturation units string Units for the oxygen saturation
Valid Values:
%
O2Saturation loinc string loinc code for oxygen saturation
vital FiO2 tag Used to return the Fraction of Inspired Oxygen information for the patient
FiO2 value decimal Fraction Inspired Oxygen value for the patient
FiO2 units decimal Units for the Fraction Inspired Oxygen
Valid Values:
%
Fi02 loinc string loinc code for Fractured Inspired Oxygen

Procedures

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
            <range>
              <start>04/24/2016</start>
              <end>04/24/2019</end>
            </range>
          </reference>
          <procedures>
            <procedure>
              <code>97032</code>
              <description>Elec Stim</description>
              <range>
                <from>01/15/2019</from>
                <to>01/15/2019</to>
              </range>
            </procedure>
            <procedure>
              <code>95870</code>
              <description>emg limited 1extremity</description>
              <range>
                <from>01/15/2019</from>
                <to>01/15/2019</to>
              </range>
            </procedure>
          </procedures>
        </response>

      
Parent Tag Type Max Length Description
response procedures tag Used to return demographic information for the patient
procedures procedure tag Used to return 1 to many procedures for the patient
procedure code string Code for the procedure
procedure description tag Code description for the procedure
procedure range tag Used to return the range information for the procedure
range from string Starting date for the procedure in the form of mm/dd/yyyy
range to string Ending date for the procedure in the form of mm/dd/yyyy

Care Team Members

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
            <range>
              <start>04/24/2016</start>
              <end>04/24/2019</end>
            </range>
          </reference>
          <care_team_members>
            <member>
              <name>
                <first>John</first>
                <last>Smith</last>
                <suffix>
                </suffix>
              </name>
              <address>
                <address1>123 Main Street</address1>
                <city>Beaverton</city>
                <state>OR</state>
                <zip>97006</zip>
                <country>USA</country>
              </address>
            </member>
            <member>
              <name>
                <first>Jane</first>
                <last>Smith</last>
                <suffix>
                </suffix>
              </name>
              <address>
                <address1>123 Main Street</address1>
                <city>Beaverton</city>
                <state>OR</state>
                <zip>97006</zip>
                <country>USA</country>
              </address>
            </member>
          </care_team_members>
        </response>

      
Parent Tag Type Max Length Description
response care_team_members tag Used to return team members who cared for the patient
care_team_members member tag Used to return 1 to many members
member name tag Used to return name information for the member
name first string 25 char First name of the patient
name last string 95 char Last name of the patient
name suffix string 10 char Suffix name of the patient
care_team_members address string Used to return address information for the member
address address1 string 55 char
address address2 string 55 char
address city string 30 char
address state string 2 char
address zip string 15 char
address country string 3 char Valid values:
1. USA
2. CAN
care_team_members national_provider_id string National provider id for the member
care_team_members taxonomy string Used to return taxonomy information for the member
taxonomy code string Taxonomy code
taxonomy description string Taxonomy description

Immunizations

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
            <range>
              <start>04/24/2016</start>
              <end>04/24/2019</end>
            </range>
          </reference>
          <immunizations>
            <immunization>
              <description>influenza, intradermal, quadrivalent, preservative</description>
              <date_given>04/18/2019</date_given>
              <cvx>
                <code>166</code>
                <description>influenza, intradermal, quadrivalent, preservative free</description>
              </cvx>
            </immunization>
            <immunization>
              <description>GARDASIL 9</description>
              <date_given>04/18/2019</date_given>
              <cvx>
                <code>165</code>
                <description>Human Papillomavirus 9-valent vaccine</description>
              </cvx>
            </immunization>
          </immunizations>
        </response>

      
Parent Tag Type Max Length Description
response immunizations tag Used to return demographic information for the patient
immunizations immunization tag Used to return 1 to many immunizations for the patient
immunization description string Description for the immunization
immunization date_given string Date the immunization was given in the form mm/dd/yyyy
immunization cvx tag Used to return cvx information for the immunization record
cvx code string CVX code tied to the immunization
cvx description string CVX description tied to the immunization
immunization refusal tag Used to return refusal information for the immunization record
refusal code string Code for why the immunization record was refused
Valid Values:
00 – Parental Decision
01 – Religious Exemption
02 – Other
03 – Parental Decision
refusal description string Description for why the immunization record was refused
immunization immunity string Used to return evidence of immunity information for the immunization record
immunity code string Code for the evidence of immunity for the immunization that was given. This code represents the Snomed ConceptID
Valid Values:
4834000 - History of typhoid infection.
6142004 - History of influenza infection.
14168008 - History of rabies infection.
14189004 - History of measles infection.
16541001 - History of yellow fever infection.
16814004 - History of pneumococcal infection.
18624000 - History of rotavirus infection.
23511006 - History of meningococcal infection.
27836007 - History of pertussis infection.
36653000 - History of rubella infection.
36989005 - History of mumps infection.
38907003 - History of Varicella infection.
40468003 - History of Hepatitis A infection.
52947006 - History of Japanese encephalitis infection.
66071002 - History of Hepatitis B infection.
76902006 - History of tetanus infection.
91428005 - History of HIB infection.
111852003 - History of vaccinia infection.
240532009 - History of HPV infection.
271511000 - Immunity to hepatitis B
397428000 - History of diphtheria infection.
398102009 - History of polio infection.
409498004 - History of anthrax infection.
immunity description string Description for the evidence of immunity for the immunization record

Unique Device Identfiers

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
            <range>
              <start>04/24/2016</start>
              <end>04/24/2019</end>
            </range>
          </reference>
          <unique_device_identifiers>
            <identifier>
              <udi>(01)00643169007222(17)160128(21)BLC200461H</udi>
              <device_name>Cardiac resynchronization therapy implantable defibrillator</device_name>
              <implant_date>10/05/2011</implant_date>
              <snomed_conceptid>704707009</snomed_conceptid>
              <assigning_authority>FDA</assigning_authority>
            </identifier>
          </unique_device_identifiers>
        </response>

      
Parent Tag Type Max Length Description
response unique_device_identifiers tag Used to return implant information for the patient
unique_device_identifiers identifier tag Used to return 1 to many implants for the patient
identifier udi string Unique device identifier for the implant
identifier device_name string Device name for the implant
identifier implant_date string Date the device was implanted
identifier snomed_conceptid string Snomed ConceptID for the implant
identifier assigning_authority string Assigning authority for device

Assessment and Plan of Treatment

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
            <range>
              <start>04/24/2016</start>
              <end>04/24/2019</end>
            </range>
          </reference>
          <asssessment_and_plan_of_treatment>
            <item>
              <type>Patient Education</type>
              <description>ABNORMAL POSTURE</description>
              <plan_date>10/18/2018</plan_date>
            </item>
            <item>
              <type>Pending Test</type>
              <description>Unknown </description>
              <plan_date>08/31/2018</plan_date>
              <test>Labs</test>
            </item>
          </asssessment_and_plan_of_treatment>
        </response>

      
Parent Tag Type Max Length Description
response assessment_and_plan_of_treatment tag Used to return assessment and treatment information for the patient
assessment_and_plan_of_treatment item tag Used to return 1 to many assessment and treatment information for the patient
item type string Type of assessment or treatment plan.
Valid values:
Assessment
Future Appointment
Instruction
Patient Education
Pending Test
Future Test
item description string Description for the assessment or plan of treatment
item address string Address for the assessment or plan of treatment
item plan_date string Date for the assessment or plan of treatment
item test string If the type is a Pending Test or a Future test this fields describes the test.
Valid values:
Labs
Radiology
Pathology
Procedures
item snomed_conceptid string Snomed ConceptID associated with the assessment or treatment plan
item loinc string Loinc code associated with the assessment or treatment plan.

Goals

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
            <range>
              <start>04/24/2016</start>
              <end>04/24/2019</end>
            </range>
          </reference>
          <goals>
            <goal>
              <description>Eat Healthier</description>
              <plan_date>04/29/2019</plan_date>
            </goal>
          </goals>
        </response>

      
Parent Tag Type Max Length Description
response goals tag Used to return goal information for the patient
goals goal tag Used return 1 to many goals for the patient
goal description string Description of the goal
goal plan_date string Date the goal was planned in the form mm/dd/yyyy

Health Concerns

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <reference>
            <range>
              <start>04/24/2016</start>
              <end>04/24/2019</end>
            </range>
          </reference>
          <health_concerns>
            <concern>
              <type>Health Concern</type>
              <description>Unable to manage medication</description>
              <plan_date>04/29/2019</plan_date>
              <snomed_conceptid>285035003</snomed_conceptid>
            </concern>
            <concern>
              <type>Health Concern</type>
              <description>Hypertension</description>
              <plan_date>04/29/2019</plan_date>
              <snomed_conceptid>155301003</snomed_conceptid>
            </concern>
          </health_concerns>
        </response>

      
Parent Tag Type Max Length Description
response health_concerns tag Used to return health concern / health status information for the patient
health_concerns concern tag Used return 1 to many health concern / health status for the patient
concern type string Type of health concern.
Values values:
Health Concern
Health Status
concern description string Description for the health concern / health status
concern plan_date string Date of the health concern / health status
concern snomed_conceptid string Snomed ConceptID associated with the health concern / health status

Error

Example


        <response xmlns="http://www.isalushealthcare.webservices/">
          <error>
            <code>1</code>
            <description>API Key is not valid</description>
          </error>
        </response>

      
Parent Tag Type Max Length Description
response error tag Used to store error information from the request
error code numeric Code identifying the error
error description string Description of the error

ONC.GetCCD

This method takes the API key and the time period in months and returns a CCDA Version 2.1 clinical document for the api key requested. The following header elements are not included as part of the xml data that is returned


        <xml version="1.0" encoding="UTF-8"?>
        <xml-stylesheet type="text/xsl" href="CDA.xsl"?>
      

Example


        <request>
          <security>
            <key>UserID~Password~cw_API</key>
            <version>1.0</version>
            <userid />
            <account>39985F47-62E0-4533-918F-317695A6BFEB</account>
          </security>
          <api_key>123</api_key>
          <start_date>01/01/2019</start_date>
          <end_date>03/01/2019</end_date>
          <time_period_months>36</time_period_months>
        </request>

      
Parent Tag Type Max Length Description
request security tag Contains security information for accessing the API’s
security key string(required) Security information used to access the API. Key is made up of a user identifier, password and connection point separated by a tilde character. The user identifier and password were assigned to you when you signed up to use the API’s. The connection point will always be cw_api.
security version string Used for backwards compatibility. For now always use 1.0.
security userid string UserId for the user of your application. Currently not used.
security account string Account identifier. This will always be 39985F47-62E0-4533-918F-317695A6BFEB
requested api_key string 50 char api_key that is returned from the ONC.FindPatient method.
requested start_date string 50 char Starting date to return patient related information (default=01/01/1901). Setting has no effect on Demographics, Allergies, Medications, Problems, Unique Device Identifiers and Social History
requested end_date string 50 char Starting date to return patient related information (default=01/01/3001). Setting has no effect on Demographics, Allergies, Medications, Problems, Unique Device Identifiers and Social History

Example:


        <response xmlns="http://www.isalushealthcare.webservices/">
          <ClinicalDocument xsi:schemaLocation="urn:hl7-org:v3 http://xreg2.nist.gov:8080/hitspValidation/schema/cdar2c32/infrastructure/cda/C32_CDA.xsd" xmlns:sdtc="urn:hl7-org:sdtc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:hl7-org:v3">
              <realmCode code="US" />
               …
          </ClinicalDocument>
      </response>