Ubrite Web Services API Specification

Ubrite Web Services API Specification 1.0.0

This is an example output for a service running at http://ubritedvapp1.hs.uab.edu:8080/UbriteServices:

I2B2 Services

Get All I2B2 Demographics

A `GET` request is used to Get All I2B2 Demographics Information

GET /getalli2b2demographics?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=json&limit=1%2C2 HTTP/1.1
Accept: application/json
Host: ubritedvapp1.hs.uab.edu:8080

Table 1. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id"
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 678
Content-Type: application/json;charset=UTF-8

{
  "webServiceStatus" : {
    "status" : "SUCCESS",
    "message" : "Data Limited to:1,2"
  },
  "i2b2Demographics" : [ {
    "i2b2PatientId" : "76223",
    "vitalStatusCd" : "Deceased",
    "birthDate" : "06/01/1976",
    "deathDate" : "12/31/2300",
    "ageInYearsNum" : "-1",
    "raceCode" : "White",
    "ethnicGroupCode" : "Non-Hispanic/Latino",
    "zipCode" : "35096"
  }, {
    "i2b2PatientId" : "96971",
    "vitalStatusCd" : "Alive",
    "birthDate" : "12/20/1962",
    "deathDate" : null,
    "ageInYearsNum" : "56",
    "raceCode" : "Black or African American",
    "ethnicGroupCode" : "Non-Hispanic/Latino",
    "zipCode" : "36701"
  } ]
}

Table 2. response Fields
Path	Type	Description
`webServiceStatus`	`Object`	Web Service Status
`i2b2Demographics`	`Array`	I2B2 Demographics Details

Get All I2B2 Demographics XML Payload

A `GET` request is used to Get All I2B2 Demographics Information

GET /getalli2b2demographics?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=xml&limit=1%2C2 HTTP/1.1
Host: ubritedvapp1.hs.uab.edu:8080
Accept: application/xml

Table 3. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id"
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Type: application/xml;charset=UTF-8
Content-Length: 908

<I2B2DemographicResult>
  <webServiceStatus>
    <status>SUCCESS</status>
    <message>Data Limited to:1,2</message>
  </webServiceStatus>
  <i2b2Demographics>
    <i2b2PatientId>76223</i2b2PatientId>
    <vitalStatusCd>Deceased</vitalStatusCd>
    <birthDate>06/01/1976</birthDate>
    <deathDate>12/31/2300</deathDate>
    <ageInYearsNum>-1</ageInYearsNum>
    <raceCode>White</raceCode>
    <ethnicGroupCode>Non-Hispanic/Latino</ethnicGroupCode>
    <zipCode>35096</zipCode>
  </i2b2Demographics>
  <i2b2Demographics>
    <i2b2PatientId>96971</i2b2PatientId>
    <vitalStatusCd>Alive</vitalStatusCd>
    <birthDate>12/20/1962</birthDate>
    <deathDate/>
    <ageInYearsNum>56</ageInYearsNum>
    <raceCode>Black or African American</raceCode>
    <ethnicGroupCode>Non-Hispanic/Latino</ethnicGroupCode>
    <zipCode>36701</zipCode>
  </i2b2Demographics>
</I2B2DemographicResult>

Get All I2B2 Demographics CSV Payload

A `GET` request is used to Get All I2B2 Demographics Information

GET /getalli2b2demographics?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=csv&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 4. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id"
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Type: text/plain;charset=UTF-8
Content-Length: 321

webServiceStatus=SUCCESS,webServiceMessage=Data Limited to:1,2

Patient Id,Age(in years),Birth Date,Death Date,Ethnic Group Code,Race Code,Vital Status Code,Zip Code
76223,-1,06/01/1976,12/31/2300,Non-Hispanic/Latino,White,Deceased,35096
96971,56,12/20/1962,null,Non-Hispanic/Latino,Black or African American,Alive,36701

Get All I2B2 Demographics FHIR JSON Payload

A `GET` request is used to Get All I2B2 Demographics Information

GET /getalli2b2demographics?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=fhir-json&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 5. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id"
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 1030
Content-Type: text/plain;charset=UTF-8

[{
  "webServiceStatus" : {
    "status" : "SUCCESS",
    "message" : ""
  }
},{
  "resourceType": "Bundle",
  "type": "transaction",
  "entry": [
    {
      "fullUrl": "76223",
      "resource": {
        "resourceType": "Patient",
        "id": "76223",
        "birthDate": "1976-06-01",
        "deceasedDateTime": "2300-12-31T00:00:00-06:00",
        "address": [
          {
            "postalCode": "35096"
          }
        ]
      },
      "request": {
        "method": "PUT",
        "url": "Patient",
        "ifNoneExist": "identifier=http://acme.org/mrns|76223"
      }
    },
    {
      "fullUrl": "96971",
      "resource": {
        "resourceType": "Patient",
        "id": "96971",
        "birthDate": "1962-12-20",
        "deceasedBoolean": false,
        "address": [
          {
            "postalCode": "36701"
          }
        ]
      },
      "request": {
        "method": "PUT",
        "url": "Patient",
        "ifNoneExist": "identifier=http://acme.org/mrns|96971"
      }
    }
  ]
}]

Get All I2B2 Demographics FHIR XML Payload

A `GET` request is used to Get All I2B2 Demographics Information

GET /getalli2b2demographics?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=fhir-xml&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 6. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id"
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 1301
Content-Type: text/plain;charset=UTF-8

<WebServiceResult>
  <webServiceStatus>
    <status>SUCCESS</status>
    <message></message>
  </webServiceStatus>
</WebServiceResult>
<Bundle xmlns="http://hl7.org/fhir">
   <type value="transaction"/>
   <entry>
      <fullUrl value="76223"/>
      <resource>
         <Patient xmlns="http://hl7.org/fhir">
            <id value="76223"/>
            <birthDate value="1976-06-01"/>
            <deceasedDateTime value="2300-12-31T00:00:00-06:00"/>
            <address>
               <postalCode value="35096"/>
            </address>
         </Patient>
      </resource>
      <request>
         <method value="PUT"/>
         <url value="Patient"/>
         <ifNoneExist value="identifier=http://acme.org/mrns|76223"/>
      </request>
   </entry>
   <entry>
      <fullUrl value="96971"/>
      <resource>
         <Patient xmlns="http://hl7.org/fhir">
            <id value="96971"/>
            <birthDate value="1962-12-20"/>
            <deceasedBoolean value="false"/>
            <address>
               <postalCode value="36701"/>
            </address>
         </Patient>
      </resource>
      <request>
         <method value="PUT"/>
         <url value="Patient"/>
         <ifNoneExist value="identifier=http://acme.org/mrns|96971"/>
      </request>
   </entry>
</Bundle>

Get All I2B2 Patient Ids

A `GET` request is used to Get All I2B2 Patient Ids

GET /getalli2b2patientidentifiers?ownerid=rdalej&instance=i2b2core&patientsetinstanceid=121&format=json&limit=1%2C2 HTTP/1.1
Accept: application/json
Host: ubritedvapp1.hs.uab.edu:8080

Table 7. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 386

{
  "webServiceStatus" : {
    "status" : "SUCCESS",
    "message" : "Data Limited to:1,2"
  },
  "i2b2PatientIds" : [ {
    "mrn" : "000001612041",
    "i2b2PatientId" : "1610",
    "personKey" : "7374791403",
    "personSk" : "1000334"
  }, {
    "mrn" : "000002873258",
    "i2b2PatientId" : "1987",
    "personKey" : "3499907770",
    "personSk" : "10005158"
  } ]
}

Table 8. response Fields
Path	Type	Description
`webServiceStatus`	`Object`	Web Service Status
`i2b2PatientIds`	`Array`	I2B2 Patient Id Details

Get All I2B2 Patient Ids XML Payload

A `GET` request is used to Get All I2B2 Patient Ids

GET /getalli2b2patientidentifiers?ownerid=rdalej&instance=i2b2core&patientsetinstanceid=121&format=xml&limit=1%2C2 HTTP/1.1
Host: ubritedvapp1.hs.uab.edu:8080
Accept: application/xml

Table 9. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Type: application/xml;charset=UTF-8
Content-Length: 535

<I2B2PatientIdResult>
  <webServiceStatus>
    <status>SUCCESS</status>
    <message>Data Limited to:1,2</message>
  </webServiceStatus>
  <i2b2PatientIds>
    <mrn>000001612041</mrn>
    <i2b2PatientId>1610</i2b2PatientId>
    <personKey>7374791403</personKey>
    <personSk>1000334</personSk>
  </i2b2PatientIds>
  <i2b2PatientIds>
    <mrn>000002873258</mrn>
    <i2b2PatientId>1987</i2b2PatientId>
    <personKey>3499907770</personKey>
    <personSk>10005158</personSk>
  </i2b2PatientIds>
</I2B2PatientIdResult>

Get All I2B2 Patient Ids CSV Payload

A `GET` request is used to Get All I2B2 Patient Ids

GET /getalli2b2patientidentifiers?ownerid=rdalej&instance=i2b2core&patientsetinstanceid=121&format=csv&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 10. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 180
Content-Type: text/plain;charset=UTF-8

webServiceStatus=SUCCESS,webServiceMessage=Data Limited to:1,2

MRN,I2B2 Patient Id,Person Key,Person SK
000001612041,1610,7374791403,1000334
000002873258,1987,3499907770,10005158

Get All I2B2 Patient Ids FHIR JSON Payload

A `GET` request is used to Get All I2B2 Patient Ids

GET /getalli2b2patientidentifiers?ownerid=rdalej&instance=i2b2core&patientsetinstanceid=121&format=fhir-json&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 11. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 1346
Content-Type: text/plain;charset=UTF-8

[{
  "webServiceStatus" : {
    "status" : "SUCCESS",
    "message" : ""
  }
},{
  "resourceType": "Bundle",
  "type": "transaction",
  "entry": [
    {
      "fullUrl": "1610",
      "resource": {
        "resourceType": "Patient",
        "id": "1610",
        "identifier": [
          {
            "id": "1610",
            "system": "id1 : i2b2 patient id"
          },
          {
            "id": "7374791403",
            "value": "id2 : i2b2 person key"
          },
          {
            "id": "1000334",
            "value": "id3 : i2b2 person sk"
          }
        ]
      },
      "request": {
        "method": "PUT",
        "url": "Patient",
        "ifNoneExist": "identifier=http://acme.org/mrns|1610"
      }
    },
    {
      "fullUrl": "1987",
      "resource": {
        "resourceType": "Patient",
        "id": "1987",
        "identifier": [
          {
            "id": "1987",
            "system": "id1 : i2b2 patient id"
          },
          {
            "id": "3499907770",
            "value": "id2 : i2b2 person key"
          },
          {
            "id": "10005158",
            "value": "id3 : i2b2 person sk"
          }
        ]
      },
      "request": {
        "method": "PUT",
        "url": "Patient",
        "ifNoneExist": "identifier=http://acme.org/mrns|1987"
      }
    }
  ]
}]

Get All I2B2 Patient Ids FHIR XML Payload

A `GET` request is used to Get All I2B2 Patient Ids

GET /getalli2b2patientidentifiers?ownerid=rdalej&instance=i2b2core&patientsetinstanceid=121&format=fhir-xml&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 12. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 1629
Content-Type: text/plain;charset=UTF-8

<WebServiceResult>
  <webServiceStatus>
    <status>SUCCESS</status>
    <message></message>
  </webServiceStatus>
</WebServiceResult>
<Bundle xmlns="http://hl7.org/fhir">
   <type value="transaction"/>
   <entry>
      <fullUrl value="1610"/>
      <resource>
         <Patient xmlns="http://hl7.org/fhir">
            <id value="1610"/>
            <identifier id="1610">
               <system value="id1 : i2b2 patient id"/>
            </identifier>
            <identifier id="7374791403">
               <value value="id2 : i2b2 person key"/>
            </identifier>
            <identifier id="1000334">
               <value value="id3 : i2b2 person sk"/>
            </identifier>
         </Patient>
      </resource>
      <request>
         <method value="PUT"/>
         <url value="Patient"/>
         <ifNoneExist value="identifier=http://acme.org/mrns|1610"/>
      </request>
   </entry>
   <entry>
      <fullUrl value="1987"/>
      <resource>
         <Patient xmlns="http://hl7.org/fhir">
            <id value="1987"/>
            <identifier id="1987">
               <system value="id1 : i2b2 patient id"/>
            </identifier>
            <identifier id="3499907770">
               <value value="id2 : i2b2 person key"/>
            </identifier>
            <identifier id="10005158">
               <value value="id3 : i2b2 person sk"/>
            </identifier>
         </Patient>
      </resource>
      <request>
         <method value="PUT"/>
         <url value="Patient"/>
         <ifNoneExist value="identifier=http://acme.org/mrns|1987"/>
      </request>
   </entry>
</Bundle>

Get All I2B2 Encounters

A `GET` request is used to Get All I2B2 Encounters

GET /getalli2b2encounters?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=json&limit=1%2C2 HTTP/1.1
Accept: application/json
Host: ubritedvapp1.hs.uab.edu:8080

Table 13. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 244

{
  "webServiceStatus" : {
    "status" : "ERROR",
    "message" : "ORA-06502: PL/SQL: numeric or value error: number precision too large\nORA-06512: at \"I2B2CORE.GET_VISIT_DTL_I2B2_QUERY_VW\", line 73\n"
  },
  "i2b2Encounters" : null
}

Table 14. response Fields
Path	Type	Description
`webServiceStatus`	`Object`	Web Service Status
`i2b2Encounters`	`Null`	I2B2 Encounter Details

Get All I2B2 Encounters XML Payload

A `GET` request is used to Get All I2B2 Encounters

GET /getalli2b2encounters?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=xml&limit=1%2C2 HTTP/1.1
Host: ubritedvapp1.hs.uab.edu:8080
Accept: application/xml

Table 15. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Type: application/xml;charset=UTF-8
Content-Length: 298

<I2B2EncounterResult>
  <webServiceStatus>
    <status>ERROR</status>
    <message>ORA-06502: PL/SQL: numeric or value error: number precision too large
ORA-06512: at "I2B2CORE.GET_VISIT_DTL_I2B2_QUERY_VW", line 73
</message>
  </webServiceStatus>
  <i2b2Encounters/>
</I2B2EncounterResult>

Get All I2B2 Encounters CSV Payload

A `GET` request is used to Get All I2B2 Encounters

GET /getalli2b2encounters?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=csv&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 16. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 175
Content-Type: text/plain;charset=UTF-8

webServiceStatus=ERROR,webServiceMessage=ORA-06502: PL/SQL: numeric or value error: number precision too large
ORA-06512: at "I2B2CORE.GET_VISIT_DTL_I2B2_QUERY_VW", line 73

Get All I2B2 Encounters FHIR JSON Payload

A `GET` request is used to Get All I2B2 Encounters

GET /getalli2b2encounters?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=fhir-json&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 17. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 6
Content-Type: text/plain;charset=UTF-8

[null,

Get All I2B2 Encounters FHIR XML Payload

A `GET` request is used to Get All I2B2 Encounters

GET /getalli2b2encounters?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=fhir-xml&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 18. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 9
Content-Type: text/plain;charset=UTF-8


<null/>

Get All I2B2 Appointments

A `GET` request is used to Get All I2B2 Appointments

GET /getalli2b2appointments?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=json&limit=1%2C2 HTTP/1.1
Accept: application/json
Host: ubritedvapp1.hs.uab.edu:8080

Table 19. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 645
Content-Type: application/json;charset=UTF-8

{
  "webServiceStatus" : {
    "status" : "SUCCESS",
    "message" : "Data Limited to:1,2"
  },
  "i2b2Appointments" : [ {
    "i2b2PatientId" : "43883397",
    "mrn" : null,
    "appointmentDate" : "06/25/2019",
    "appointmentLocation" : "TKC Ears Nose Throat",
    "appointmentProvider" : "Physician Name unknown at this time",
    "i2b2EncounterId" : null
  }, {
    "i2b2PatientId" : "2251186",
    "mrn" : null,
    "appointmentDate" : "06/26/2019",
    "appointmentLocation" : "WHITAKER INTERNAL MEDICINE 2 WEST",
    "appointmentProvider" : "Physician Name unknown at this time",
    "i2b2EncounterId" : null
  } ]
}

Table 20. response Fields
Path	Type	Description
`webServiceStatus`	`Object`	Web Service Status
`i2b2Appointments`	`Array`	I2B2 Appointment Details

Get All I2B2 Appointments XML Payload

A `GET` request is used to Get All I2B2 Appointments

GET /getalli2b2appointments?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=xml&limit=1%2C2 HTTP/1.1
Host: ubritedvapp1.hs.uab.edu:8080
Accept: application/xml

Table 21. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Type: application/xml;charset=UTF-8
Content-Length: 842

<I2B2AppointmentResult>
  <webServiceStatus>
    <status>SUCCESS</status>
    <message>Data Limited to:1,2</message>
  </webServiceStatus>
  <i2b2Appointments>
    <i2b2PatientId>43883397</i2b2PatientId>
    <mrn/>
    <appointmentDate>06/25/2019</appointmentDate>
    <appointmentLocation>TKC Ears Nose Throat</appointmentLocation>
    <appointmentProvider>Physician Name unknown at this time</appointmentProvider>
    <i2b2EncounterId/>
  </i2b2Appointments>
  <i2b2Appointments>
    <i2b2PatientId>2251186</i2b2PatientId>
    <mrn/>
    <appointmentDate>06/26/2019</appointmentDate>
    <appointmentLocation>WHITAKER INTERNAL MEDICINE 2 WEST</appointmentLocation>
    <appointmentProvider>Physician Name unknown at this time</appointmentProvider>
    <i2b2EncounterId/>
  </i2b2Appointments>
</I2B2AppointmentResult>

Get All I2B2 Appointments CSV Payload

A `GET` request is used to Get All I2B2 Appointments

GET /getalli2b2appointments?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=csv&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 22. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 319
Content-Type: text/plain;charset=UTF-8

webServiceStatus=SUCCESS,webServiceMessage=Data Limited to:1,2

PatientId,I2B2 EncounterId,Mrn,Appt Date,Appt Location,Appt Provider
43883397,null,null,06/25/2019,TKC Ears Nose Throat,Physician Name unknown at this time
2251186,null,null,06/26/2019,WHITAKER INTERNAL MEDICINE 2 WEST,Physician Name unknown at this time

Get All I2B2 Appointments FHIR JSON Payload

A `GET` request is used to Get All I2B2 Appointments

GET /getalli2b2appointments?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=fhir-json&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 23. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 2320
Content-Type: text/plain;charset=UTF-8

[{
  "webServiceStatus" : {
    "status" : "SUCCESS",
    "message" : ""
  }
},{
  "resourceType": "Bundle",
  "type": "transaction",
  "entry": [
    {
      "fullUrl": "43883397",
      "resource": {
        "resourceType": "Appointment",
        "id": "43883397",
        "contained": [
          {
            "resourceType": "Practitioner",
            "id": "1",
            "name": [
              {
                "text": "Physician Name unknown at this time"
              }
            ]
          },
          {
            "resourceType": "Location",
            "id": "2",
            "name": "TKC Ears Nose Throat"
          }
        ],
        "identifier": [
          {
            "id": "43883397",
            "system": "id1 : i2b2 patient id"
          }
        ],
        "start": "2019-06-25T00:00:00.000-05:00",
        "participant": [
          {
            "actor": {
              "reference": "#1"
            }
          },
          {
            "actor": {
              "reference": "#2"
            }
          }
        ]
      },
      "request": {
        "method": "PUT",
        "url": "Appointment",
        "ifNoneExist": "identifier=http://acme.org/mrns|43883397"
      }
    },
    {
      "fullUrl": "2251186",
      "resource": {
        "resourceType": "Appointment",
        "id": "2251186",
        "contained": [
          {
            "resourceType": "Practitioner",
            "id": "1",
            "name": [
              {
                "text": "Physician Name unknown at this time"
              }
            ]
          },
          {
            "resourceType": "Location",
            "id": "2",
            "name": "WHITAKER INTERNAL MEDICINE 2 WEST"
          }
        ],
        "identifier": [
          {
            "id": "2251186",
            "system": "id1 : i2b2 patient id"
          }
        ],
        "start": "2019-06-26T00:00:00.000-05:00",
        "participant": [
          {
            "actor": {
              "reference": "#1"
            }
          },
          {
            "actor": {
              "reference": "#2"
            }
          }
        ]
      },
      "request": {
        "method": "PUT",
        "url": "Appointment",
        "ifNoneExist": "identifier=http://acme.org/mrns|2251186"
      }
    }
  ]
}]

Get All I2B2 Appointments FHIR XML Payload

A `GET` request is used to Get All I2B2 Appointments

GET /getalli2b2appointments?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&format=fhir-xml&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 24. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Type: text/plain;charset=UTF-8
Content-Length: 2933

<WebServiceResult>
  <webServiceStatus>
    <status>SUCCESS</status>
    <message></message>
  </webServiceStatus>
</WebServiceResult>
<Bundle xmlns="http://hl7.org/fhir">
   <type value="transaction"/>
   <entry>
      <fullUrl value="43883397"/>
      <resource>
         <Appointment xmlns="http://hl7.org/fhir">
            <id value="43883397"/>
            <contained>
               <Practitioner xmlns="http://hl7.org/fhir">
                  <id value="1"/>
                  <name>
                     <text value="Physician Name unknown at this time"/>
                  </name>
               </Practitioner>
            </contained>
            <contained>
               <Location xmlns="http://hl7.org/fhir">
                  <id value="2"/>
                  <name value="TKC Ears Nose Throat"/>
               </Location>
            </contained>
            <identifier id="43883397">
               <system value="id1 : i2b2 patient id"/>
            </identifier>
            <start value="2019-06-25T00:00:00.000-05:00"/>
            <participant>
               <actor>
                  <reference value="#1"/>
               </actor>
            </participant>
            <participant>
               <actor>
                  <reference value="#2"/>
               </actor>
            </participant>
         </Appointment>
      </resource>
      <request>
         <method value="PUT"/>
         <url value="Appointment"/>
         <ifNoneExist value="identifier=http://acme.org/mrns|43883397"/>
      </request>
   </entry>
   <entry>
      <fullUrl value="2251186"/>
      <resource>
         <Appointment xmlns="http://hl7.org/fhir">
            <id value="2251186"/>
            <contained>
               <Practitioner xmlns="http://hl7.org/fhir">
                  <id value="1"/>
                  <name>
                     <text value="Physician Name unknown at this time"/>
                  </name>
               </Practitioner>
            </contained>
            <contained>
               <Location xmlns="http://hl7.org/fhir">
                  <id value="2"/>
                  <name value="WHITAKER INTERNAL MEDICINE 2 WEST"/>
               </Location>
            </contained>
            <identifier id="2251186">
               <system value="id1 : i2b2 patient id"/>
            </identifier>
            <start value="2019-06-26T00:00:00.000-05:00"/>
            <participant>
               <actor>
                  <reference value="#1"/>
               </actor>
            </participant>
            <participant>
               <actor>
                  <reference value="#2"/>
               </actor>
            </participant>
         </Appointment>
      </resource>
      <request>
         <method value="PUT"/>
         <url value="Appointment"/>
         <ifNoneExist value="identifier=http://acme.org/mrns|2251186"/>
      </request>
   </entry>
</Bundle>

Get All I2B2 Aggregates

A `GET` request is used to Get All I2B2 Aggregates

GET /getalli2b2aggregates?ownerid=rdalej&instance=i2b2core&patientsetinstanceid=121&patientset=I2B2_PATIENT_SET&aggregatetype=DEMOGRAPHICS&format=json&limit=1%2C2 HTTP/1.1
Accept: application/json
Host: ubritedvapp1.hs.uab.edu:8080

Table 25. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`aggregatetype`	Aggregate Type
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 359
Content-Type: application/json;charset=UTF-8

{
  "webServiceStatus" : {
    "status" : "SUCCESS",
    "message" : "Data Limited to:1,2"
  },
  "i2B2Aggregates" : [ {
    "itemCount" : "45412",
    "itemCode" : "FEMALE",
    "itemGroup" : "Gender - Distinct Patient Count"
  }, {
    "itemCount" : "31814",
    "itemCode" : "MALE",
    "itemGroup" : "Gender - Distinct Patient Count"
  } ]
}

Table 26. response Fields
Path	Type	Description
`webServiceStatus`	`Object`	Web Service Status
`i2B2Aggregates`	`Array`	I2B2 Aggregate Details

Get All I2B2 Aggregates XML Payload

A `GET` request is used to Get All I2B2 Aggregates

GET /getalli2b2aggregates?ownerid=rdalej&instance=i2b2core&patientsetinstanceid=121&patientset=I2B2_PATIENT_SET&aggregatetype=DEMOGRAPHICS&format=xml&limit=1%2C2 HTTP/1.1
Host: ubritedvapp1.hs.uab.edu:8080
Accept: application/xml

Table 27. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`aggregatetype`	Aggregate Type
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Type: application/xml;charset=UTF-8
Content-Length: 500

<I2B2AggregateResult>
  <webServiceStatus>
    <status>SUCCESS</status>
    <message>Data Limited to:1,2</message>
  </webServiceStatus>
  <i2B2Aggregates>
    <itemCount>45412</itemCount>
    <itemCode>FEMALE</itemCode>
    <itemGroup>Gender - Distinct Patient Count</itemGroup>
  </i2B2Aggregates>
  <i2B2Aggregates>
    <itemCount>31814</itemCount>
    <itemCode>MALE</itemCode>
    <itemGroup>Gender - Distinct Patient Count</itemGroup>
  </i2B2Aggregates>
</I2B2AggregateResult>

Get All I2B2 Aggregates CSV Payload

A `GET` request is used to Get All I2B2 Aggregates

GET /getalli2b2aggregates?ownerid=rdalej&instance=i2b2core&patientsetinstanceid=121&patientset=I2B2_PATIENT_SET&aggregatetype=DEMOGRAPHICS&format=csv&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 28. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`aggregatetype`	Aggregate Type
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 184
Content-Type: text/plain;charset=UTF-8

webServiceStatus=SUCCESS,webServiceMessage=Data Limited to:1,2

Item Code,Item Count,Item Group
FEMALE,45412,Gender - Distinct Patient Count
MALE,31814,Gender - Distinct Patient Count

Get All I2B2 Facts

A `GET` request is used to Get All I2B2 Facts

GET /getalli2b2facts?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&factfilter=SNOMED&format=json&limit=1%2C2 HTTP/1.1
Accept: application/json
Host: ubritedvapp1.hs.uab.edu:8080

Table 29. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`factfilter`	Fact Filter Type
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 1203
Content-Type: application/json;charset=UTF-8

{
  "webServiceStatus" : {
    "status" : "SUCCESS",
    "message" : "Data Limited to:1,2"
  },
  "i2b2Facts" : [ {
    "i2b2PatientId" : "76223",
    "i2b2EncounterId" : "1194530",
    "factStartDate" : "02/10/2014",
    "factEndDate" : null,
    "conceptCd" : "SNOMED:102589003",
    "conceptDescription" : "Atypical chest pain                                                                                                                                                                                                                     04-MAR-2014 12:51:01<$>",
    "factValue" : "No fact value",
    "modifierCd" : "DXTYPE:MEDICAL"
  }, {
    "i2b2PatientId" : "76223",
    "i2b2EncounterId" : "1194530",
    "factStartDate" : "02/10/2014",
    "factEndDate" : null,
    "conceptCd" : "SNOMED:102589003",
    "conceptDescription" : "Atypical chest pain                                                                                                                                                                                                                     04-MAR-2014 12:51:01<$>",
    "factValue" : "No fact value",
    "modifierCd" : "CONFIRM:CONFIRMED"
  } ]
}

Table 30. response Fields
Path	Type	Description
`webServiceStatus`	`Object`	Web Service Status
`i2b2Facts`	`Array`	I2B2 Facts Details

Get All I2B2 Facts XML Payload

A `GET` request is used to Get All I2B2 Facts

GET /getalli2b2facts?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&factfilter=SNOMED&format=xml&limit=1%2C2 HTTP/1.1
Host: ubritedvapp1.hs.uab.edu:8080
Accept: application/xml

Table 31. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`factfilter`	Fact Filter Type
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 1409
Content-Type: application/xml;charset=UTF-8

<I2B2FactResult>
  <webServiceStatus>
    <status>SUCCESS</status>
    <message>Data Limited to:1,2</message>
  </webServiceStatus>
  <i2b2Facts>
    <i2b2PatientId>76223</i2b2PatientId>
    <i2b2EncounterId>1194530</i2b2EncounterId>
    <factStartDate>02/10/2014</factStartDate>
    <factEndDate/>
    <conceptCd>SNOMED:102589003</conceptCd>
    <conceptDescription>Atypical chest pain                                                                                                                                                                                                                     04-MAR-2014 12:51:01&lt;$></conceptDescription>
    <factValue>No fact value</factValue>
    <modifierCd>DXTYPE:MEDICAL</modifierCd>
  </i2b2Facts>
  <i2b2Facts>
    <i2b2PatientId>76223</i2b2PatientId>
    <i2b2EncounterId>1194530</i2b2EncounterId>
    <factStartDate>02/10/2014</factStartDate>
    <factEndDate/>
    <conceptCd>SNOMED:102589003</conceptCd>
    <conceptDescription>Atypical chest pain                                                                                                                                                                                                                     04-MAR-2014 12:51:01&lt;$></conceptDescription>
    <factValue>No fact value</factValue>
    <modifierCd>CONFIRM:CONFIRMED</modifierCd>
  </i2b2Facts>
</I2B2FactResult>

Get All I2B2 Facts CSV Payload

A `GET` request is used to Get All I2B2 Facts

GET /getalli2b2facts?ownerid=rdalej&instance=i2b2lds&patientsetinstanceid=29706&patientset=I2B2_PATIENT_SET&factfilter=SNOMED&format=csv&limit=1%2C2 HTTP/1.1
Accept: */*
Host: ubritedvapp1.hs.uab.edu:8080

Table 32. request Parameters
Parameter	Description
`ownerid`	Owner Id
`instance`	I2B2 Instance
`patientsetinstanceid`	Patient Set Instance id
`patientset`	Patient Set
`factfilter`	Fact Filter Type
`format`	Format of data
`limit`	Row limit of data

response

HTTP/1.1 200 OK
Content-Length: 839
Content-Type: text/plain;charset=UTF-8

webServiceStatus=SUCCESS,webServiceMessage=Data Limited to:1,2

I2B2 Patiend Id,I2B2 Encounter Id,Fact Start Date,Fact End Date,Concept Cd,Concept Desc,Fact Value,Mod Code
76223,1194530,02/10/2014,null,SNOMED:102589003,Atypical chest pain                                                                                                                                                                                                                     04-MAR-2014 12:51:01<$>,No fact value,DXTYPE:MEDICAL
76223,1194530,02/10/2014,null,SNOMED:102589003,Atypical chest pain                                                                                                                                                                                                                     04-MAR-2014 12:51:01<$>,No fact value,CONFIRM:CONFIRMED

Ubrite Web Services API Specification 1.0.0

I2B2 Services

Get All I2B2 Demographics

A GET request is used to Get All I2B2 Demographics Information

Get All I2B2 Demographics XML Payload

A GET request is used to Get All I2B2 Demographics Information

Get All I2B2 Demographics CSV Payload

A GET request is used to Get All I2B2 Demographics Information

Get All I2B2 Demographics FHIR JSON Payload

A GET request is used to Get All I2B2 Demographics Information

Get All I2B2 Demographics FHIR XML Payload

A GET request is used to Get All I2B2 Demographics Information

Get All I2B2 Patient Ids

A GET request is used to Get All I2B2 Patient Ids

Get All I2B2 Patient Ids XML Payload

A GET request is used to Get All I2B2 Patient Ids

Get All I2B2 Patient Ids CSV Payload

A GET request is used to Get All I2B2 Patient Ids

Get All I2B2 Patient Ids FHIR JSON Payload

A GET request is used to Get All I2B2 Patient Ids

Get All I2B2 Patient Ids FHIR XML Payload

A GET request is used to Get All I2B2 Patient Ids

Get All I2B2 Encounters

A GET request is used to Get All I2B2 Encounters

Get All I2B2 Encounters XML Payload

A GET request is used to Get All I2B2 Encounters

Get All I2B2 Encounters CSV Payload

A GET request is used to Get All I2B2 Encounters

Get All I2B2 Encounters FHIR JSON Payload

A GET request is used to Get All I2B2 Encounters

Get All I2B2 Encounters FHIR XML Payload

A GET request is used to Get All I2B2 Encounters

Get All I2B2 Appointments

A GET request is used to Get All I2B2 Appointments

Get All I2B2 Appointments XML Payload

A GET request is used to Get All I2B2 Appointments

Get All I2B2 Appointments CSV Payload

A GET request is used to Get All I2B2 Appointments

Get All I2B2 Appointments FHIR JSON Payload

A GET request is used to Get All I2B2 Appointments

Get All I2B2 Appointments FHIR XML Payload

A GET request is used to Get All I2B2 Appointments

Get All I2B2 Aggregates

A GET request is used to Get All I2B2 Aggregates

Get All I2B2 Aggregates XML Payload

A GET request is used to Get All I2B2 Aggregates

Get All I2B2 Aggregates CSV Payload

A GET request is used to Get All I2B2 Aggregates

Get All I2B2 Facts

A GET request is used to Get All I2B2 Facts

Get All I2B2 Facts XML Payload

A GET request is used to Get All I2B2 Facts

Get All I2B2 Facts CSV Payload

A GET request is used to Get All I2B2 Facts

A `GET` request is used to Get All I2B2 Demographics Information

A `GET` request is used to Get All I2B2 Demographics Information

A `GET` request is used to Get All I2B2 Demographics Information

A `GET` request is used to Get All I2B2 Demographics Information

A `GET` request is used to Get All I2B2 Demographics Information

A `GET` request is used to Get All I2B2 Patient Ids

A `GET` request is used to Get All I2B2 Patient Ids

A `GET` request is used to Get All I2B2 Patient Ids

A `GET` request is used to Get All I2B2 Patient Ids

A `GET` request is used to Get All I2B2 Patient Ids

A `GET` request is used to Get All I2B2 Encounters

A `GET` request is used to Get All I2B2 Encounters

A `GET` request is used to Get All I2B2 Encounters

A `GET` request is used to Get All I2B2 Encounters

A `GET` request is used to Get All I2B2 Encounters

A `GET` request is used to Get All I2B2 Appointments

A `GET` request is used to Get All I2B2 Appointments

A `GET` request is used to Get All I2B2 Appointments

A `GET` request is used to Get All I2B2 Appointments

A `GET` request is used to Get All I2B2 Appointments

A `GET` request is used to Get All I2B2 Aggregates

A `GET` request is used to Get All I2B2 Aggregates

A `GET` request is used to Get All I2B2 Aggregates

A `GET` request is used to Get All I2B2 Facts

A `GET` request is used to Get All I2B2 Facts

A `GET` request is used to Get All I2B2 Facts