Vital Metrix API documentation version 0.1
Introduction
The Vital Metrix API (VM API) conforms to the Representational State Transfer (RESTful) architecture and provides data access to build robust user interfaces that incorporate the Vital Metrix algorithmic output. It has been written to support both web-based, desktop and mobile application development. The API is based on JSON formatted queries and responses to define the key value pairs for data transactions up to and down from the server, respectively. Each API call must have an attached token by which an authorized user is authenticated.
/users
post
get
put
patch
get /users/{user}
URI Parameters
- user: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
- UID: required(string)
- NPI: required(number)
- people: (array of Names)
Items: Names
- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
put /users/{user}
URI Parameters
- user: required(string)
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
- UID: required(string)
- NPI: required(number)
- people: (array of Names)
Items: Names
- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
- UID: required(string)
- NPI: required(number)
- people: (array of Names)
Items: Names
- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
HTTP status code 400
HTTP status code 401
HTTP status code 403
patch /users/{user}
URI Parameters
- user: required(string)
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
- UID: required(string)
- NPI: required(number)
- people: (array of Names)
Items: Names
- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
- UID: required(string)
- NPI: required(number)
- people: (array of Names)
Items: Names
- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
HTTP status code 400
HTTP status code 401
HTTP status code 403
get
post
get /users/{user}/people
URI Parameters
- user: required(string)
HTTP status code 200
Body
Media type: application/json
Type: array of Names
Items: Person
- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
post /users/{user}/people
URI Parameters
- user: required(string)
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
get
put
patch
post
get
post /users/{user}/queries
URI Parameters
- user: required(string)
Body
Media type: application/json
Type: object
Properties- People: (object)
- first_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- middle_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- last_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- first_name: (object)
- Dataset: (object)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- collection_start: (object)
- from: (datetime-only)
- to: (datetime-only)
- earliest: (boolean)
- latest: (boolean)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- systolic: (object)
- greater_than: (number)
- less_than: (number)
- diastolic: (object)
- greater_than: (number)
- less_than: (number)
- spo2: (object)
- greater_than: (number)
- less_than: (number)
- pulse_rate: (object)
- greater_than: (number)
- less_than: (number)
- cardiac_output: (object)
- greater_than: (number)
- less_than: (number)
- sort: (object)
- by: required(one of Patient Name, Capture Date, Systolic Pressure, Diastolic Pressure, SpO2, Pulse Rate, Cardiac Output)
- method: required(one of Ascending, Descending)
- Notification: (object)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- date: (object)
- from: (datetime-only)
- to: (datetime-only)
- type: (one of Data, System, User)
- level: (one of Information, Alert, Warning, Error)
- query: (number)
- past: (object)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- People: (object)
- first_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- middle_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- last_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- first_name: (object)
- Dataset: (object)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- collection_start: (object)
- from: (datetime-only)
- to: (datetime-only)
- earliest: (boolean)
- latest: (boolean)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- systolic: (object)
- greater_than: (number)
- less_than: (number)
- diastolic: (object)
- greater_than: (number)
- less_than: (number)
- spo2: (object)
- greater_than: (number)
- less_than: (number)
- pulse_rate: (object)
- greater_than: (number)
- less_than: (number)
- cardiac_output: (object)
- greater_than: (number)
- less_than: (number)
- sort: (object)
- by: required(one of Patient Name, Capture Date, Systolic Pressure, Diastolic Pressure, SpO2, Pulse Rate, Cardiac Output)
- method: required(one of Ascending, Descending)
- Notification: (object)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- date: (object)
- from: (datetime-only)
- to: (datetime-only)
- type: (one of Data, System, User)
- level: (one of Information, Alert, Warning, Error)
- query: (number)
- past: (object)
HTTP status code 400
HTTP status code 401
HTTP status code 403
get /users/{user}/queries
URI Parameters
- user: required(string)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: Query
- People: (object)
- first_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- middle_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- last_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- first_name: (object)
- Dataset: (object)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- collection_start: (object)
- from: (datetime-only)
- to: (datetime-only)
- earliest: (boolean)
- latest: (boolean)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- systolic: (object)
- greater_than: (number)
- less_than: (number)
- diastolic: (object)
- greater_than: (number)
- less_than: (number)
- spo2: (object)
- greater_than: (number)
- less_than: (number)
- pulse_rate: (object)
- greater_than: (number)
- less_than: (number)
- cardiac_output: (object)
- greater_than: (number)
- less_than: (number)
- sort: (object)
- by: required(one of Patient Name, Capture Date, Systolic Pressure, Diastolic Pressure, SpO2, Pulse Rate, Cardiac Output)
- method: required(one of Ascending, Descending)
- Notification: (object)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- date: (object)
- from: (datetime-only)
- to: (datetime-only)
- type: (one of Data, System, User)
- level: (one of Information, Alert, Warning, Error)
- query: (number)
- past: (object)
HTTP status code 401
HTTP status code 403
delete
put
patch
delete /users/{user}/queries/{query}
URI Parameters
- user: required(string)
- query: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- People: (object)
- first_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- middle_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- last_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- first_name: (object)
- Dataset: (object)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- collection_start: (object)
- from: (datetime-only)
- to: (datetime-only)
- earliest: (boolean)
- latest: (boolean)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- systolic: (object)
- greater_than: (number)
- less_than: (number)
- diastolic: (object)
- greater_than: (number)
- less_than: (number)
- spo2: (object)
- greater_than: (number)
- less_than: (number)
- pulse_rate: (object)
- greater_than: (number)
- less_than: (number)
- cardiac_output: (object)
- greater_than: (number)
- less_than: (number)
- sort: (object)
- by: required(one of Patient Name, Capture Date, Systolic Pressure, Diastolic Pressure, SpO2, Pulse Rate, Cardiac Output)
- method: required(one of Ascending, Descending)
- Notification: (object)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- date: (object)
- from: (datetime-only)
- to: (datetime-only)
- type: (one of Data, System, User)
- level: (one of Information, Alert, Warning, Error)
- query: (number)
- past: (object)
HTTP status code 401
HTTP status code 403
put /users/{user}/queries/{query}
URI Parameters
- user: required(string)
- query: required(string)
Body
Media type: application/json
Type: object
Properties- People: (object)
- first_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- middle_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- last_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- first_name: (object)
- Dataset: (object)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- collection_start: (object)
- from: (datetime-only)
- to: (datetime-only)
- earliest: (boolean)
- latest: (boolean)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- systolic: (object)
- greater_than: (number)
- less_than: (number)
- diastolic: (object)
- greater_than: (number)
- less_than: (number)
- spo2: (object)
- greater_than: (number)
- less_than: (number)
- pulse_rate: (object)
- greater_than: (number)
- less_than: (number)
- cardiac_output: (object)
- greater_than: (number)
- less_than: (number)
- sort: (object)
- by: required(one of Patient Name, Capture Date, Systolic Pressure, Diastolic Pressure, SpO2, Pulse Rate, Cardiac Output)
- method: required(one of Ascending, Descending)
- Notification: (object)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- date: (object)
- from: (datetime-only)
- to: (datetime-only)
- type: (one of Data, System, User)
- level: (one of Information, Alert, Warning, Error)
- query: (number)
- past: (object)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- People: (object)
- first_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- middle_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- last_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- first_name: (object)
- Dataset: (object)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- collection_start: (object)
- from: (datetime-only)
- to: (datetime-only)
- earliest: (boolean)
- latest: (boolean)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- systolic: (object)
- greater_than: (number)
- less_than: (number)
- diastolic: (object)
- greater_than: (number)
- less_than: (number)
- spo2: (object)
- greater_than: (number)
- less_than: (number)
- pulse_rate: (object)
- greater_than: (number)
- less_than: (number)
- cardiac_output: (object)
- greater_than: (number)
- less_than: (number)
- sort: (object)
- by: required(one of Patient Name, Capture Date, Systolic Pressure, Diastolic Pressure, SpO2, Pulse Rate, Cardiac Output)
- method: required(one of Ascending, Descending)
- Notification: (object)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- date: (object)
- from: (datetime-only)
- to: (datetime-only)
- type: (one of Data, System, User)
- level: (one of Information, Alert, Warning, Error)
- query: (number)
- past: (object)
HTTP status code 400
HTTP status code 401
HTTP status code 403
patch /users/{user}/queries/{query}
URI Parameters
- user: required(string)
- query: required(string)
Body
Media type: application/json
Type: object
Properties- People: (object)
- first_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- middle_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- last_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- first_name: (object)
- Dataset: (object)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- collection_start: (object)
- from: (datetime-only)
- to: (datetime-only)
- earliest: (boolean)
- latest: (boolean)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- systolic: (object)
- greater_than: (number)
- less_than: (number)
- diastolic: (object)
- greater_than: (number)
- less_than: (number)
- spo2: (object)
- greater_than: (number)
- less_than: (number)
- pulse_rate: (object)
- greater_than: (number)
- less_than: (number)
- cardiac_output: (object)
- greater_than: (number)
- less_than: (number)
- sort: (object)
- by: required(one of Patient Name, Capture Date, Systolic Pressure, Diastolic Pressure, SpO2, Pulse Rate, Cardiac Output)
- method: required(one of Ascending, Descending)
- Notification: (object)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- date: (object)
- from: (datetime-only)
- to: (datetime-only)
- type: (one of Data, System, User)
- level: (one of Information, Alert, Warning, Error)
- query: (number)
- past: (object)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- People: (object)
- first_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- middle_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- last_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- first_name: (object)
- Dataset: (object)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- collection_start: (object)
- from: (datetime-only)
- to: (datetime-only)
- earliest: (boolean)
- latest: (boolean)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- systolic: (object)
- greater_than: (number)
- less_than: (number)
- diastolic: (object)
- greater_than: (number)
- less_than: (number)
- spo2: (object)
- greater_than: (number)
- less_than: (number)
- pulse_rate: (object)
- greater_than: (number)
- less_than: (number)
- cardiac_output: (object)
- greater_than: (number)
- less_than: (number)
- sort: (object)
- by: required(one of Patient Name, Capture Date, Systolic Pressure, Diastolic Pressure, SpO2, Pulse Rate, Cardiac Output)
- method: required(one of Ascending, Descending)
- Notification: (object)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- date: (object)
- from: (datetime-only)
- to: (datetime-only)
- type: (one of Data, System, User)
- level: (one of Information, Alert, Warning, Error)
- query: (number)
- past: (object)
HTTP status code 400
HTTP status code 401
HTTP status code 403
post
post /users/{user}/notifications
URI Parameters
- user: required(string)
Body
Media type: application/json
Type: object
Properties- id: required(number)
- title: required(string)
- type: required(one of Data, System, User)
- level: required(one of Information, Alert, Warning, Error)
- date: required(datetime-only)
- text: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(number)
- title: required(string)
- type: required(one of Data, System, User)
- level: required(one of Information, Alert, Warning, Error)
- date: required(datetime-only)
- text: required(string)
HTTP status code 400
HTTP status code 401
HTTP status code 403
get
get /users/{user}/notifications/search
URI Parameters
- user: required(string)
Body
Media type: application/json
Type: object
Properties- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- date: (object)
- from: (datetime-only)
- to: (datetime-only)
- type: (one of Data, System, User)
- level: (one of Information, Alert, Warning, Error)
- query: (number)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: Notification
- id: required(number)
- title: required(string)
- type: required(one of Data, System, User)
- level: required(one of Information, Alert, Warning, Error)
- date: required(datetime-only)
- text: required(string)
HTTP status code 400
HTTP status code 401
HTTP status code 403
put
patch
put /users/{user}/notifications/{notification}
URI Parameters
- user: required(string)
- notification: required(string)
Body
Media type: application/json
Type: object
Properties- id: required(number)
- title: required(string)
- type: required(one of Data, System, User)
- level: required(one of Information, Alert, Warning, Error)
- date: required(datetime-only)
- text: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(number)
- title: required(string)
- type: required(one of Data, System, User)
- level: required(one of Information, Alert, Warning, Error)
- date: required(datetime-only)
- text: required(string)
HTTP status code 400
HTTP status code 401
HTTP status code 403
patch /users/{user}/notifications/{notification}
URI Parameters
- user: required(string)
- notification: required(string)
Body
Media type: application/json
Type: object
Properties- id: required(number)
- title: required(string)
- type: required(one of Data, System, User)
- level: required(one of Information, Alert, Warning, Error)
- date: required(datetime-only)
- text: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(number)
- title: required(string)
- type: required(one of Data, System, User)
- level: required(one of Information, Alert, Warning, Error)
- date: required(datetime-only)
- text: required(string)
HTTP status code 400
HTTP status code 401
HTTP status code 403
get
get /users/search
Body
Media type: application/json
Type: object
Properties- groups: required(array of number)
HTTP status code 200
Body
Media type: application/json
Type: array of Person
Items: User
- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
- UID: required(string)
- NPI: required(number)
- people: (array of Names)
Items: Names
- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
HTTP status code 400
HTTP status code 401
HTTP status code 403
/people
post
post /people
Headers
- key: required(string)
The cognito access key for the user making the request.
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
HTTP status code 400
HTTP status code 401
HTTP status code 403
get
get /people/search
Body
Media type: application/json
Type: object
Properties- first_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- middle_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- last_name: (object)
- begins_with: (string)
- ends_with: (string)
- contain: (string)
- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
HTTP status code 200
Body
Media type: application/json
Type: array of Names
Items: Person
- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
HTTP status code 400
HTTP status code 401
HTTP status code 403
get
put
patch
get /people/{person}
URI Parameters
- person: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
HTTP status code 401
HTTP status code 403
put /people/{person}
URI Parameters
- person: required(string)
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
HTTP status code 400
HTTP status code 401
HTTP status code 403
patch /people/{person}
URI Parameters
- person: required(string)
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: (number)
- prefix: (string)
- first_name: required(string)
- middle_name: (string)
- last_name: required(string)
- suffix: (string)
- addresses: (array of Address – minItems: 1)
Items: Address
- type: required(one of Home, Work, Other)
- street: required(string)
- city: required(string)
- state: required(string)
- zip: required(string)
- phone_numbers: (array of PhoneNumber – minItems: 1)
Items: PhoneNumber
- number: required(string – pattern: [0-9|-]+)
- type: required(one of Mobile, Home, Work, Other)
- email: (string – pattern: ^.+@.+\..+$)
- height: (number)
- weight: (number)
- gender: (one of Female, Male, Other)
- ethnicity: (one of American Indian, Asian, Black or African American, Hispanic or Latino, Pacific Islander, White, Other)
- date_of_birth: (date-only)
Example:
1970-01-20 - datasets: (array of number)
- groups: (array of number)
HTTP status code 400
HTTP status code 401
HTTP status code 403
get
post
get /people/{person}/notes
URI Parameters
- person: required(string)
post /people/{person}/notes
URI Parameters
- person: required(string)
Body
Media type: application/json
Type: object
Properties- id: required(number)
- type: required(one of Medication, Mood, Observation, Physical Activity)
- date: required(datetime-only)
- text: required(string)
get
get /people/{person}/datasets
URI Parameters
- person: required(string)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: Dataset
- id: required(number)
- collection_start: required(datetime-only)
- collection_end: required(datetime-only)
- person_dob: required(date-only)
- height_m: required(number)
- weight_kg: required(number)
- body_mass_index: (number)
- body_surface_area_m2: (number)
- body_volume_m3: required(number)
- is_collection_finished: required(boolean)
- has_been_processed: required(boolean)
- systolic_mmhg: required(array of number)
- diastolic_mmhg: required(array of number)
- mean_spo2: required(number)
- mean_pulse_rate_bpm: required(number)
- spo2_series_id: required(number)
- pulse_rate_series_id: required(number)
- pleth_series_id: required(number)
- cardiac_output_lpm: (number)
- note_count: required(number)
HTTP status code 401
HTTP status code 403
/datasets
get
get /datasets/search
Body
Media type: application/json
Type: object
Properties- gender: (one of Female, Male, Other)
- age: (object)
- greater_than: (number)
- less_than: (number)
- ethnicity: (array of Ethnicity)
- query: (number)
- collection_start: (object)
- from: (datetime-only)
- to: (datetime-only)
- earliest: (boolean)
- latest: (boolean)
- past: (object)
- units: required(one of Hours, Days, Weeks, Months, Years)
- time: required(number)
- systolic: (object)
- greater_than: (number)
- less_than: (number)
- diastolic: (object)
- greater_than: (number)
- less_than: (number)
- spo2: (object)
- greater_than: (number)
- less_than: (number)
- pulse_rate: (object)
- greater_than: (number)
- less_than: (number)
- cardiac_output: (object)
- greater_than: (number)
- less_than: (number)
- sort: (object)
- by: required(one of Patient Name, Capture Date, Systolic Pressure, Diastolic Pressure, SpO2, Pulse Rate, Cardiac Output)
- method: required(one of Ascending, Descending)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: Dataset
- id: required(number)
- collection_start: required(datetime-only)
- collection_end: required(datetime-only)
- person_dob: required(date-only)
- height_m: required(number)
- weight_kg: required(number)
- body_mass_index: (number)
- body_surface_area_m2: (number)
- body_volume_m3: required(number)
- is_collection_finished: required(boolean)
- has_been_processed: required(boolean)
- systolic_mmhg: required(array of number)
- diastolic_mmhg: required(array of number)
- mean_spo2: required(number)
- mean_pulse_rate_bpm: required(number)
- spo2_series_id: required(number)
- pulse_rate_series_id: required(number)
- pleth_series_id: required(number)
- cardiac_output_lpm: (number)
- note_count: required(number)
HTTP status code 400
HTTP status code 401
HTTP status code 403
get
get /datasets/{dataset}
URI Parameters
- dataset: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required(number)
- collection_start: required(datetime-only)
- collection_end: required(datetime-only)
- person_dob: required(date-only)
- height_m: required(number)
- weight_kg: required(number)
- body_mass_index: (number)
- body_surface_area_m2: (number)
- body_volume_m3: required(number)
- is_collection_finished: required(boolean)
- has_been_processed: required(boolean)
- systolic_mmhg: required(array of number)
- diastolic_mmhg: required(array of number)
- mean_spo2: required(number)
- mean_pulse_rate_bpm: required(number)
- spo2_series_id: required(number)
- pulse_rate_series_id: required(number)
- pleth_series_id: required(number)
- cardiac_output_lpm: (number)
- note_count: required(number)
HTTP status code 401
HTTP status code 403
get
get /datasets/{dataset}/timeseries
URI Parameters
- dataset: required(string)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: TimeSeries
- id: required(number)
- type: required(one of SpO2, Pule Rate, Pleth Wave, Cardiac Output, Systolic Blood Pressure, Diastolic Blood Pressure, Pulse Amplitude)
- unit: required(string)
- times: required(array of datetime-only)
- values: required(array of number)
HTTP status code 401
HTTP status code 403
get
post
get /datasets/{dataset}/notes
URI Parameters
- dataset: required(string)
post /datasets/{dataset}/notes
URI Parameters
- dataset: required(string)
Body
Media type: application/json
Type: object
Properties- id: required(number)
- type: required(one of Medication, Mood, Observation, Physical Activity)
- date: required(datetime-only)
- text: required(string)
/timeseries/search
get
get /timeseries/search
Headers
- key: required(string)
The cognito access key for the user making the request.
Body
Media type: application/json
Type: object
Properties- id: required(number)
- from: (datetime-only)
- to: (datetime-only)
HTTP status code 200
Body
Media type: application/json
Type: array of object
Items: TimeSeries
- id: required(number)
- type: required(one of SpO2, Pule Rate, Pleth Wave, Cardiac Output, Systolic Blood Pressure, Diastolic Blood Pressure, Pulse Amplitude)
- unit: required(string)
- times: required(array of datetime-only)
- values: required(array of number)
HTTP status code 400
HTTP status code 401
HTTP status code 403
/notes
post
post /notes
Headers
- key: required(string)
The cognito access key for the user making the request.
Body
Media type: application/json
Type: object
Properties- id: required(number)
- type: required(one of Medication, Mood, Observation, Physical Activity)
- date: required(datetime-only)
- text: required(string)
get
put
patch
get /notes/{note}
URI Parameters
- note: required(string)
put /notes/{note}
URI Parameters
- note: required(string)
Body
Media type: application/json
Type: object
Properties- id: required(number)
- type: required(one of Medication, Mood, Observation, Physical Activity)
- date: required(datetime-only)
- text: required(string)
patch /notes/{note}
URI Parameters
- note: required(string)
Body
Media type: application/json
Type: object
Properties- id: required(number)
- type: required(one of Medication, Mood, Observation, Physical Activity)
- date: required(datetime-only)
- text: required(string)
/output/{id}
get