TN-WITS

Web Information Technology System

TN-WITS Version:24.6.0 2015 Edition API Documentation

User Authentication Request

Resource Description

This resource may be used to authenticate an existing user, taking in a username and password. Once the user is authenticated an authentication (JWT) token will be returned.

URL

https://{SECURITY_SERVER_URL}/issue/simple?realm={wits:CUSTOMER_INSTANCE:ENVIRONMENT_LEVEL}&tokenType=jwt

Headers

Key Description
Authorization

Template:

<scheme>{BASIC}<scheme> <credentials>{BASE64 ENCODED USERNAME AND PASSWORD}<credentials>


Sample:

Basic YWxhZGRpbjpvcGVuc2VzYW1l
Content-Type

Template:

<content-type>


Sample:

application/json

URI Parameters

Name Description Type Additional information
SECURITY_SERVER_URL

The customer secruity server web address.

 --

Required
wits:CUSTOMER_INSTANCE:ENVIRONMENT_LEVEL

Includes the name of the customer's instance in addition to the environment level.

 --

Required


Valid Environment Levels: PROD, UAT, TRAIN, QA


Example: wits:Maryland:QA

Response Information

application/json

Sample: 
                {
                    "token_type": "urn:ietf:params:oauth:token-type:jwt",
                    "expires_in": 3599,
                    "refresh_token": null,
                    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6InJROEthTk1NQnJEVHJMR2ozdFFmVEdnNXg0USJ9.eJpc3MiOiJodHRwOi8vbGRhcC5pZGVudGl0eXNlcnZlci52MS5jb20vc3RhbmRhcmQiLCJhdWQiOiJ3aXRzOnN0YW5kYXJkOnFhIiwibmJmIjoxNTYxNzUyNjE0LCJleHAiOjE1NjE3NTYyMTQsInVuaXF1ZV9uYW1lIjoiYmtpbWJhbGwiLCJhdXRobWV0aG9kIjoiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2F1dGhlbnRpY2F0aW9ubWV0aG9kL3Bhc3N3b3JkIiwiYXV0aF90aW1lIjoiMjAxOS0wNi0yOFQyMDoxMDoxNC43MDVaIn0.S-142lvGmvUbghDMoQJEmHnVoUB9I1M9hejFs29oxa2y7dxs9toWwrTCpZEZogbOJpJcQnjQnYbG0J2HFwlH6_4-3JWEmLE1pjoe0RA2UNjiT4U9CgwgHDdztShvVSo1Em4oOe9AWETrBv2YmrntmyuJZ1TPD70GaoE-pZVUMMFnFsCEfZM0oe4M1eR1eegomC7sZ3UqC7YloAbcQhbaw-KJaSNkLQMLaqxAmmP3VuzGGKoYjBwPZplSPEjlkuDfK7sFlufIBi2UxPr3fxKCO6MR_B_SLvmsvIi9v30AGKp0wikQJ4GTWvqAIM1hqAFXuUy877PsCkED7USpbN1lDw"
                }

General Response Codes

Code Description
HTTP 200 - OK Example: User credentials authenticate successfully.
HTTP 401 - Unauthorized Example: User credentials not found or are invalid.
HTTP 500 - Internal Server Error Example: An exception raised on server.

Patient Selection Request

Resource Description

This resource may be used to retrieve a patient, taking in the patient's first name; last name; date of birth; gender code; and, last four digits of the social security number. If a patient whose credentials match those of the input data is found, the patient's unique client number (which will act as the patient's token), first name, last name, middle name, and encounter list will be returned. Note: each ecounter contained within the list of patient encounters will contain the encounter's start date, end date (if available), location name, and identifier.

URL

https://{WEBSITE_URL}/api/MedicalRecordsModule/RetrievePatient

Headers

Key Description
X-Auth-Token

Template:

<XAuthToken>{JWT_TOKEN}<XAuthToken>


Sample:

eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6InJROEthTk1NQnJEVHJMR2ozdFFmVEdnNXg0USJ9.eyJpc3MiOiJodHRwOi8vbGRhcC5pZGVudGl0eXNlcnZlc
i52MS5jb20vc3RhbmRhcmQiLCJhdWQiOiJ3aXRzOnN0YW5kYXJkOnFhIiwibmJmIjoxNTYxOTk4MjIyLCJleHAiOjE1NjIwMDE4MjIsInVuaXF1ZV9uYW1lIjoiYmtpbWJhbGwi
LCJhdXRobWV0aG9kIjoiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2F1dGhlbnRpY2F0aW9ubWV0aG9kL3Bhc3N3b3JkIiwiYXV0aF9
0aW1lIjoiMjAxOS0wNy0wMVQxNjoyMzo0Mi41NTBaIn0.VrMHAH6ob4btbUHBALMQzei39r1Gc7z88fdB7IXLR5fndKtxSxTubeJm1slrP7JJ9lit8kbWPzx-UCBSAhUmafOonq
JuxoR-ZCLKroEXCMi6JEBbCiZmd05w1nwRTGFk_6mH_fi9uuZlkk6tRkd6-RcwqQIzb_ucxRICb88nS6eT6SXKTg0iMnXorP54iV4axjM13IJVlS7L9B2TggrO--xcLgz0qx3lw
qsul1zavCEfsHevKHKSt3t5ib3zrfwMJykmF4BrT45tQGsjEA_iCPlyIzqWG2JwenJJu7k6nAU1KbQDuuwk7f4_CuRUHwFykCfOYvcvjG1ClZ8tcluwFQ

Content-Type

Template:

<content-type>


Sample:

application/json

URI Parameters

Name Description Type Additional information
WEBSITE_URL

The customer web address.

 --

Required

Request Information

application/json

Sample Request Body: 
{ 
        BirthDate : "01011960",
	FirstName : "Pebbles",
	LastName : "Flintstone",
	GenderCode : "F",
	SocialSecurityNumberSerialNumber: "4789",
        StartDate = "04152010",
        EndDate = "04172010"
}

Request Field Values

Name Description Type Additional information
BirthDate

The patient's data of birth.

 string

Required - Should be formatted using the {MMddyyyy} format
FirstName

The patient's first name.

 string

Required
LastName

The patient's last name.

 string

Required
GenderCode

The patient's gender code.

 string

Required - Accepted values are F, M, and UNK

(F - Female, M - Male, and UNK - Unknown)
SocialSecurityNumberSerialNumber

The last 4 digits of the patient's social security number.

 string

Required
StartDate

The encounter start date range.

 string

Optional - Should be formatted using the {MMddyyyy} format

EndDate

The encounter end date range.

 string

Optional - Should be formatted using the {MMddyyyy} format

Response Information

application/json

Sample: 
{
    "Encounters": [
        {
            "EndDate": "",
            "Identifier": 3422,
            "Location": "Administrative Unit",
            "StartDate": "04262019"
        },
        {
            "EndDate": "",
            "Identifier": 3424,
            "Location": "Administrative Unit",
            "StartDate": "03262019"
        },
        {
            "EndDate": "",
            "Identifier": 3428,
            "Location": "Administrative Unit",
            "StartDate": "03252019"
        },
        {
            "EndDate": "",
            "Identifier": 3438,
            "Location": "Administrative Unit",
            "StartDate": "06112019"
        }
    ],
    "FirstName": "ONC2",
    "LastName": "Client2",
    "MiddleName": "ONCMiddle",
    "UniqueClientNumber": "F199434LC436120"
}

Response Field Values

Name Description Type Additional information
UniqueClientNumber

The patient's unique client number.

 string

This will serve as the client token used retrieve data in subsequent requests.
FirstName

The patient's first name.

 string

--
LastName

The patient's last name.

 string

--
MiddleName

The patient's middle name.

 string

Will be supplied if applicable.
Encounters

The list of patient encounters.

 array

Will contain a list of encounter objects. Empty if none are found.
encounter - Identifier

The identifier of the patient encounter.

 int

--
encounter - Location

The patient encounter location.

 string

--
encounter - StartDate

The start date of the patient encounter.

 int

--
encounter - EndDate

The end date of the patient encounter.

 string

Will be supplied if applicable in {MMddyyyy} format.

General Response Codes

Code Description
HTTP 200 - OK Example: Patient information found for provided input parameters. No patient found matching input parameters. Multiple patient's found for provided input parameters.
HTTP 400 - Bad Request Example: Incorrectly formatted birthdate. Missing request information including patient first name, last name gender code, last 4 digits of social security number, and/or birthdate. Missing staff member credentials (unlikely).
HTTP 401 - Unauthorized Example: User credentials not found or are invalid.
HTTP 500 - Internal Server Error Example: An exception raised on server.

All Data Request

Resource Description

This resource may be used to retrieve all data elements from the clinical data set for a patient, taking in the patient token (unique client number) and an encounter identifier. If the clinical data set corresponding to the input information is found, then the XML payload representing the contents of the patient's CCDA data will be returned.

URL

https://{WEBSITE_URL}/api/MedicalRecordsModule/RetrieveAllPatientInformation/Patient/{UNIQUE_CLIENT_NUMBER}/Encounter/{PATIENT_ENCOUNTER_IDENTIFIER}

Headers

Key Description
X-Auth-Token

Template:

<XAuthToken>{JWT_TOKEN}<XAuthToken>


Sample:

eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6InJROEthTk1NQnJEVHJMR2ozdFFmVEdnNXg0USJ9.eyJpc3MiOiJodHRwOi8vbGRhcC5pZGVudGl0eXNlcnZlc
i52MS5jb20vc3RhbmRhcmQiLCJhdWQiOiJ3aXRzOnN0YW5kYXJkOnFhIiwibmJmIjoxNTYxOTk4MjIyLCJleHAiOjE1NjIwMDE4MjIsInVuaXF1ZV9uYW1lIjoiYmtpbWJhbGwi
LCJhdXRobWV0aG9kIjoiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2F1dGhlbnRpY2F0aW9ubWV0aG9kL3Bhc3N3b3JkIiwiYXV0aF9
0aW1lIjoiMjAxOS0wNy0wMVQxNjoyMzo0Mi41NTBaIn0.VrMHAH6ob4btbUHBALMQzei39r1Gc7z88fdB7IXLR5fndKtxSxTubeJm1slrP7JJ9lit8kbWPzx-UCBSAhUmafOonq
JuxoR-ZCLKroEXCMi6JEBbCiZmd05w1nwRTGFk_6mH_fi9uuZlkk6tRkd6-RcwqQIzb_ucxRICb88nS6eT6SXKTg0iMnXorP54iV4axjM13IJVlS7L9B2TggrO--xcLgz0qx3lw
qsul1zavCEfsHevKHKSt3t5ib3zrfwMJykmF4BrT45tQGsjEA_iCPlyIzqWG2JwenJJu7k6nAU1KbQDuuwk7f4_CuRUHwFykCfOYvcvjG1ClZ8tcluwFQ

Content-Type

Template:

<content-type>


Sample:

application/xml

URI Parameters

Name Description Type Additional information
WEBSITE_URL

The customer web address.

 --

Required
UNIQUE_CLIENT_NUMBER

The unique client number.

 string

Required
PATIENT_ENCOUNTER_IDENTIFIER

The encounter ID corresponding to the patient whose unique client number is also passed in.

 integer

Required

Response Information

application/xml

Sample: 
<?xml version="1.0" encoding="UTF-8"?>
<ClinicalDocument xmlns="urn:hl7-org:v3" xmlns:gsd="http://aurora.regenstrief.org/GenericXMLSchema" xmlns:mif="urn:hl7-org:v3/mif" xmlns:sch="http://www.ascc.net/xml/schematron" xmlns:sdtc="urn:hl7-org:sdtc" xmlns:xlink="http://www.w3.org/TR/WD-xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <realmCode code="US" />
   <typeId extension="POCD_HD000040" root="2.16.840.1.113883.1.3" />
   <templateId extension="2015-08-01" root="2.16.840.1.113883.10.20.22.1.1" />
   <templateId root="2.16.840.1.113883.10.20.22.1.1" />
   <templateId extension="2015-08-01" root="2.16.840.1.113883.10.20.22.1.2" />
   <templateId root="2.16.840.1.113883.10.20.22.1.2" />
   <id extension="bbac21c7-7f93-49c8-a568-13a621c67550" root="7B9B1EF0-4E0C-455B-BFE8-6645AE8C0957" assigningAuthorityName="WITS" />
   <code code="34133-9" displayName="Summarization of episode note" codeSystemName="LOINC" codeSystem="2.16.840.1.113883.6.1" />
   <title>Summarization of episode note</title>
   <effectiveTime value="20190604204435" />
   <confidentialityCode code="N" codeSystem="2.16.840.1.113883.5.25" />
   <languageCode code="en-US" />
   <recordTarget>
      <patientRole>
         <id extension="M369100LC997120" root="7B9B1EF0-4E0C-455B-BFE8-6645AE8C0957" assigningAuthorityName="WITS" />
         <addr use="HP">
            <streetAddressLine>vvv, bbb</streetAddressLine>
            <city>latensville</city>
            <state>DC</state>
            <postalCode>89890</postalCode>
            <country>US</country>
         </addr>
         <telecom use="HP" nullFlavor="UNK" />
         <patient>
            <name>
               <given>ONC3</given>
               <family>Client3</family>
            </name>
            <administrativeGenderCode code="M" displayName="Male" codeSystem="2.16.840.1.113883.5.1" />
            <birthTime value="19650326" />
            <raceCode code="2028-9" displayName="Asian" codeSystemName="CDC - Race and Ethnicity" codeSystem="2.16.840.1.113883.6.238" />
            <sdtc:raceCode code="2029-7" displayName="Asian Indian" codeSystemName="CDC - Race and Ethnicity" codeSystem="2.16.840.1.113883.6.238" />
            <ethnicGroupCode code="2186-5" displayName="Not Hispanic or Latino" codeSystemName="CDC - Race and Ethnicity" codeSystem="2.16.840.1.113883.6.238" />
            <languageCommunication>
               <languageCode code="en" />
            </languageCommunication>
         </patient>
         <providerOrganization>
            <id root="1.1.1.1.1.1.1.1.4" />
            <name nullFlavor="UNK" />
            <telecom nullFlavor="UNK" />
            <addr nullFlavor="UNK">
               <streetAddressLine nullFlavor="UNK" />
               <city nullFlavor="UNK" />
               <state nullFlavor="UNK" />
               <postalCode nullFlavor="UNK" />
               <country nullFlavor="UNK" />
            </addr>
         </providerOrganization>
      </patientRole>
   </recordTarget>
   <author>
      <time value="20190420010000" />
      <assignedAuthor>
         <id extension="1df395cb-3414-4932-a6f5-a4dc0104dc50" root="2.16.840.1.113883.4.6" />
         <code code="208D00000X " displayName="" codeSystemName="NUCC" codeSystem="2.16.840.1.113883.6.101" />
         <addr use="WP">
            <streetAddressLine nullFlavor="UNK" />
            <city />
            <state />
            <postalCode />
            <country />
         </addr>
         <telecom value="tel:" use="WP" />
         <assignedPerson>
            <name>
               <given>Bryan</given>
               <family>Doe</family>
            </name>
         </assignedPerson>
         <representedOrganization>
            <id extension="300011" root="2.16.840.1.113883.3.441.1.50" />
            <name />
            <telecom value="tel:" use="WP" />
            <addr use="WP">
               <streetAddressLine nullFlavor="UNK" />
               <city />
               <state />
               <postalCode />
               <country />
            </addr>
         </representedOrganization>
      </assignedAuthor>
   </author>
   <dataEnterer>
      <assignedEntity>
         <id extension="692add47-3093-4523-96ea-a4dc0104dc50" root="2.16.840.1.113883.4.6" />
         <addr use="WP">
            <streetAddressLine nullFlavor="UNK" />
            <city />
            <state />
            <postalCode />
            <country />
         </addr>
         <telecom value="tel:" use="WP" />
         <assignedPerson>
            <name>
               <given>Pramathi</given>
               <family>Katanguri</family>
            </name>
         </assignedPerson>
      </assignedEntity>
   </dataEnterer>
   <custodian>
      <assignedCustodian>
         <representedCustodianOrganization>
            <id nullFlavor="UNK" />
            <name nullFlavor="UNK" />
            <telecom nullFlavor="UNK" />
            <addr nullFlavor="UNK">
               <streetAddressLine nullFlavor="UNK" />
               <city nullFlavor="UNK" />
               <state nullFlavor="UNK" />
               <postalCode nullFlavor="UNK" />
               <country nullFlavor="UNK" />
            </addr>
         </representedCustodianOrganization>
      </assignedCustodian>
   </custodian>
   <informationRecipient>
      <intendedRecipient>
         <informationRecipient>
            <name>
               <given nullFlavor="UNK" />
               <family nullFlavor="UNK" />
            </name>
         </informationRecipient>
         <receivedOrganization>
            <name nullFlavor="UNK" />
         </receivedOrganization>
      </intendedRecipient>
   </informationRecipient>
   <documentationOf typeCode="DOC">
      <serviceEvent classCode="PCPR">
         <effectiveTime>
            <low value="19650326" />
            <high value="20190604204435" />
         </effectiveTime>
         <performer typeCode="PRF">
            <assignedEntity>
               <id root="7B9B1EF0-4E0C-455B-BFE8-6645AE8C0957" assigningAuthorityName="" nullFlavor="NA" />
               <code code="200000000X" displayName="General Physicians" codeSystemName="Provider Codes" codeSystem="2.16.840.1.113883.6.101" />
               <addr>
                  <streetAddressLine nullFlavor="UNK" />
                  <city />
                  <state />
                  <postalCode />
                  <country />
               </addr>
               <telecom value="tel:" use="WP" />
               <assignedPerson>
                  <name>
                     <suffix>MD</suffix>
                     <prefix>Dr.</prefix>
                     <given>Pramathi</given>
                     <family>Katanguri</family>
                  </name>
               </assignedPerson>
               <representedOrganization>
                  <id root="2.16.840.1.113883.19.5.9999.1393" />
                  <name />
                  <telecom value="tel:" use="WP" />
                  <addr>
                     <streetAddressLine nullFlavor="UNK" />
                     <city />
                     <state />
                     <postalCode />
                     <country />
                  </addr>
               </representedOrganization>
            </assignedEntity>
         </performer>
         <performer typeCode="PRF">
            <assignedEntity>
               <id root="7B9B1EF0-4E0C-455B-BFE8-6645AE8C0957" assigningAuthorityName="" nullFlavor="NA" />
               <code code="200000000X" displayName="General Physicians" codeSystemName="Provider Codes" codeSystem="2.16.840.1.113883.6.101" />
               <addr>
                  <streetAddressLine nullFlavor="UNK" />
                  <city />
                  <state />
                  <postalCode />
                  <country />
               </addr>
               <telecom value="tel:" use="WP" />
               <assignedPerson>
                  <name>
                     <given>Bryan</given>
                     <family>Doe</family>
                  </name>
               </assignedPerson>
               <representedOrganization>
                  <id root="2.16.840.1.113883.19.5.9999.1393" />
                  <name />
                  <telecom value="tel:" use="WP" />
                  <addr>
                     <streetAddressLine nullFlavor="UNK" />
                     <city />
                     <state />
                     <postalCode />
                     <country />
                  </addr>
               </representedOrganization>
            </assignedEntity>
         </performer>
      </serviceEvent>
   </documentationOf>
        .

        .

        .

        .

</ClinicalDocument>

General Response Codes

Code Description
HTTP 200 - OK Example: Clinical data found, or no clinical data found for provided unique client number and encounter ID.
HTTP 400 - Bad Request Example: No encounter found matching the encounter ID provided. Encounter ID provided corresponds to a record found that does not match the patient with the provided unique client number provided. Missing staff member credentials (unlikely).
HTTP 401 - Unauthorized Example: User credentials not found or are invalid.
HTTP 500 - Internal Server Error Example: An exception raised on server.

Data Category Request

Resource Description

Data Category information is returned in JSON format with each CCDS section as a JSON array of data elements for the given category. If no data is returned for a specific category then the section will be set as "No data exists for this requested data set."

URL

https://{WEBSITE_URL}/api/MedicalRecordsModule/DataCategory?uniqueClientNumber={Ucn}&commonClinicalDataSetSectionCodes={CCDSCode}&EncounterId={EncounterId}

Headers

Key Description
X-Auth-Token

Template:

<XAuthToken>{JWT_TOKEN}<XAuthToken>


Sample:

eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6InJROEthTk1NQnJEVHJMR2ozdFFmVEdnNXg0USJ9.eyJpc3MiOiJodHRwOi8vbGRhcC5pZGVudGl0eXNlcnZlc
i52MS5jb20vc3RhbmRhcmQiLCJhdWQiOiJ3aXRzOnN0YW5kYXJkOnFhIiwibmJmIjoxNTYxOTk4MjIyLCJleHAiOjE1NjIwMDE4MjIsInVuaXF1ZV9uYW1lIjoiYmtpbWJhbGwi
LCJhdXRobWV0aG9kIjoiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2F1dGhlbnRpY2F0aW9ubWV0aG9kL3Bhc3N3b3JkIiwiYXV0aF9
0aW1lIjoiMjAxOS0wNy0wMVQxNjoyMzo0Mi41NTBaIn0.VrMHAH6ob4btbUHBALMQzei39r1Gc7z88fdB7IXLR5fndKtxSxTubeJm1slrP7JJ9lit8kbWPzx-UCBSAhUmafOonq
JuxoR-ZCLKroEXCMi6JEBbCiZmd05w1nwRTGFk_6mH_fi9uuZlkk6tRkd6-RcwqQIzb_ucxRICb88nS6eT6SXKTg0iMnXorP54iV4axjM13IJVlS7L9B2TggrO--xcLgz0qx3lw
qsul1zavCEfsHevKHKSt3t5ib3zrfwMJykmF4BrT45tQGsjEA_iCPlyIzqWG2JwenJJu7k6nAU1KbQDuuwk7f4_CuRUHwFykCfOYvcvjG1ClZ8tcluwFQ

Content-Type

Template:

<content-type>


Sample:

application/json

URI Parameters

Name Description Type Additional information
uniqueClientNumber

The unique client number.

 string

Required
commonClinicalDataSetSectionCodes

The Common Clinical Data Set (CCDS) section codes.

 Collection of values indicating which Common Clinical Data Set (CCDS) Sections to include in the resulting data set.
SmokingStatus, Problems, EncounterDiagnosis, Medications, Allergies, LabTests, LabResults, VitalSigns, Procedures, CareTeamMembers, Immunizations, ImplantableDevices, Assessments, Plan,Goals, HealthConcerns, Referral, FunctionalStatus, CognitiveStatus

Required
encounterId

The encounter identifier.

 integer

Required

Response Information

application/json, text/json

Sample: 
              {
                "FirstName": "ONC2",
                "MiddleName": "ONCMiddle",
                "LastName": "Client2",
                "Demographics": [
                    {
                        "ClientGenderCode": "UNK",
                        "ClientGenderDescription": "Unknown",
                        "ClientBirthDate": "19610129",
                        "ClientRaceDescription": "Dont know",
                        "ClientSubRaceCode": "UNK",
                        "ClientEthnicityCode": "2135-2",
                        "ClientEthnicityDescription": "Hispanic or Latino",
                        "ClientLanguageCode": "en"
                    }
                ],
                "SmokingStatus": "No data exists for this requested data set.",
                "Problems": "No data exists for this requested data set.",,
                "EncounterDiagnosis": : "No data exists for this requested data set.",
                "LabTests": "No data exists for this requested data set.",
                "LabResults": "No data exists for this requested data set.",
                "VitalSigns": "No data exists for this requested data set.",
                "Procedures": : "No data exists for this requested data set.",,
                "CareTeamMembers": "No data exists for this requested data set.",
                "Immunizations": : "No data exists for this requested data set.",,
                "ImplantableDevices": : "No data exists for this requested data set.",,
                "Assessments": "No data exists for this requested data set.",
                "Plan": "No data exists for this requested data set.",
                "Goals": "No data exists for this requested data set.",
                "HealthConcerns": "No data exists for this requested data set.",
                "Referral": "No data exists for this requested data set.",
                "FunctionalStatus": "No data exists for this requested data set.",
                "CognitiveStatus": "No data exists for this requested data set."
              }

General Response Codes

Code Description
HTTP 200 - OK Example: Patient information found for provided input parameters. No patient found matching input parameters. Multiple patient's found for provided input parameters.
HTTP 400 - Bad Request Example: The patient's unique client number is missing from the request and must be provided.
HTTP 401 - Unauthorized Example: User credentials not found or are invalid.
HTTP 500 - Internal Server Error Example: An exception raised on server.

Terms of Use

  1. TERMS ACCEPTANCE AND REPRESENTATION
    1. Accepting the Terms. These Terms of Use ("Terms") govern your access to and use of the Certified TN-WITS Version:24.6.0 2015 Edition API, documentation, services, etc. By accessing or using the Certified FEI.Com APIs, you agree to be bound by these Terms. “Certified TN-WITS Version:24.6.0 API” means the API provided by FEI.Com to allow authorized access to query our Client(s) Electronic Health Record system. You represent and warrant that you are at least 18 years of age and that you possess the legal right and ability to agree to these Terms and to use the Certified FEI.Com APIs in accordance with these Terms.
    2. Entity Representation If you are using the Certified FEI.Com API on behalf of a legal entity (i.e. a Clinical software services company), you represent that you have proper authority to act on behalf of and bind the entity to these Terms, and by accepting, you accept on behalf of the entity (and all references to “you” in the Terms refer to the entity).
  2. REPRESENTATIONS AND RESPONSIBILITIES
    1. Compliance. You agree to be financially responsible for your use of the Certified TN-WITS Version:24.6.0 APIs and to comply with your responsibilities and obligations as stated in these Terms. You agree to comply at all times with all applicable laws, rules and regulations relating to the use of the Certified FEI.Com EMR APIs. You hereby grant FEI.Com the right to monitor and periodically audit in a reasonable manner your use of the Certified FEI.Com APIs, your App and other activities related to your obligations under these Terms.
    2. Virus Warranty. You warrant that your Apps will not contain any viruses or other malicious computer instructions, devices, or techniques that can or were designed to threaten, infect, damage, disable, or shut down the TN-WITS Version:24.6.0 APIs, any technology, software, solution, equipment or any computer system.
  3. GENERAL
    1. Changes. FEI.Com may, in its sole and absolute discretion, make changes, modifications or updates to the Certified TN-WITS Version:24.6.0 API (including without limitation changes to the capabilities and tech specs), without notice to you.
    2. Global Availability. FEI.Com makes no representations that the Certified TN-WITS Version:24.6.0 APIs are appropriate or available for use in locations outside of the United States, and access to them from such territories is at your own risk. Those who choose to access the Certified FEI.Com APIs from locations outside of the United States do so at their own initiative and are responsible for compliance with applicable local laws.
    3. Intellectual Property Rights. You acknowledge and agree that the Certified TN-WITS Version:24.6.0 APIs and FEI.Com ’s software, products and services are proprietary in nature, that FEI.Com claims all intellectual property rights therein as well as in all modifications, enhancements and alterations thereto, and that FEI.Com neither grants nor otherwise transfers any rights of ownership therein to you or any third party. No rights or licenses are granted by FEI.Com other than those rights expressly granted in these Terms and FEI.Com reserves all rights not expressly granted.
    4. Waiver, Release and Limitation of Liability. You acknowledge and agree that neither FEI.Com nor any of its affiliates will have any responsibility or liability with respect to your or any third party’s distribution, implementation, commercialization, use, or other form of exploitation of any app, software, solution, service or other technology created by you or another third party. As between you and FEI.Com , you are solely responsible and liable for all representations, warranties, support and other obligations made by you to any third party related to any app, software, solution, service or other technology created by you, including claims arising from product liability, breach of warranty, and intellectual property infringement.

      YOU HEREBY RELEASE AND FOREVER WAIVE ANY AND ALL CLAIMS YOU MAY HAVE AGAINST FEI.Com , ITS OFFICERS, DIRECTORS, EMPLOYEES, AGENTS, INFORMATION PROVIDERS OR SUPPLIERS FOR LOSSES OR DAMAGES YOU SUSTAIN IN CONNECTION WITH YOUR USE OF THE CERTIFIED TN-WITS Version:24.6.0 API AND ANY FEI.Com WEBSITES. FEI.Com MAKES NO REPRESENTATIONS ABOUT THE SUITABILITY, RELIABILITY, AVAILABILITY, TIMELINESS AND ACCURACY OF THE CERTIFIED FEI.Com APIs OR OTHER INFORMATION, TECHNOLOGY, SOFTWARE, PRODUCTS AND SERVICES PROVIDED BY FEI.Com FOR ANY PURPOSE. ALL SUCH TECHNOLOGY, INFORMATION, SOFTWARE, PRODUCTS AND SERVICES ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. FEI.Com HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS WITH REGARD TO THE CERTIFIED FEI.Com APIs, OTHER TECHNOLOGY, INFORMATION, SOFTWARE, SOLUTIONS, PRODUCTS AND SERVICES, INCLUDING ALL IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT.

      TO THE FULLEST EXTENT PERMITTED BY LAW, IN NO EVENT FEI.Com , ITS OFFICERS, DIRECTORS, EMPLOYEES, AGENTS, AND/OR ITS SUPPLIERS BE LIABLE FOR ANY DIRECT, INDIRECT, PUNITIVE, INCIDENTAL, SPECIAL, CONSEQUENTIAL DAMAGES OR ANY OTHER DAMAGES WHATSOEVER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF USE, DATA OR PROFITS, ARISING OUT OF OR IN ANY WAY CONNECTED WITH THE ACCESS, USE OR PERFORMANCE OF THE CERTIFIED FEI.Com APIs, WITH THE DELAY OR INABILITY TO USE THE CERTIFIED FEI.Com APIs OR RELATED TECHNOLOGY, SOFTWARE OR SERVICES, THE PROVISION OF OR FAILURE TO PROVIDE THE CERTIFIED FEI.Com APIs, SOFTWARE OR SERVICES, OR FOR ANY INFORMATION, SOFTWARE, PRODUCTS AND SERVICES OBTAINED FROM FEI.Com , OR OTHERWISE ARISING OUT OF THE USE OF THE CERTIFIED FEI.Com APIs, WHETHER BASED ON CONTRACT, TORT, NEGLIGENCE, STRICT LIABILITY OR OTHERWISE, EVEN IF FEI.Com HAS BEEN ADVISED OF THE POSSIBILITY OF DAMAGES. BECAUSE SOME STATES/JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, THE ABOVE LIMITATION MAY NOT APPLY TO YOU. IF YOU ARE DISSATISFIED WITH ANY PORTION OF THE CERTIFIED FEI.Com APIs, OR WITH THESE TERMS OF USE, YOUR SOLE AND EXCLUSIVE REMEDY IS TO DISCONTINUE USING THE CERTIFIED TN-WITS Version:24.6.0 APIs. NOTWITHSTANDING THE FOREGOING PARAGRAPH, THE TOTAL LIABILITY OF FEI.Com , ITS OFFICERS, DIRECTORS, EMPLOYEES, AGENTS, INFORMATION PROVIDERS AND SUPPLIERS, IF ANY, FOR LOSSES OR DAMAGES SHALL NOT EXCEED THE FEES PAID BY YOU FOR THE USE OF THE PARTICULAR TECHNOLOGY, SOFTWARE, PRODUCT, INFORMATION OR SERVICE PROVIDED BY FEI.Com

    5. Indemnification. YOU AGREE TO INDEMNIFY, DEFEND AND HOLD HARMLESS FEI.Com , ITS OFFICERS, DIRECTORS, EMPLOYEES, AGENTS, INFORMATION PROVIDERS AND SUPPLIERS FROM AND AGAINST ALL CLAIMS, LIABILITIES, LOSSES, EXPENSES, DAMAGES AND COSTS, INCLUDING REASONABLE ATTORNEYS’ FEES, RESULTING FROM ANY VIOLATION OF THESE TERMS OR ANY ACTIVITY RELATED TO YOUR USE OF THE CERTIFIED FEI.Com APIs OR THE FEI.Com WEB SITES.
    6. Term and Termination. Either you or FEI.Com may terminate your right to use the Certified TN-WITS Version:24.6.0 APIs at any time, with or without cause, upon notice. FEI.Com also reserves the right to disable your API access in a production environment at any time, with or without cause. FEI.Com reserves the right to disable access to the TN-WITS Version:24.6.0 APIs if your App poses any security, privacy, or patient safety risks. The provisions concerning Indemnification, Waiver, Release and Limitation of Liability, and General shall survive any termination of these Terms.
    7. Governing Law. These Terms are governed by US federal law or the laws of the State of Tennessee.