The ShiftRounds API from Alleva — 6 operation(s) for shiftrounds.
openapi: 3.2.0
info:
title: Alleva Rest Shift Rounds API
version: '1.0'
security:
- Bearer: []
tags:
- name: ShiftRounds
paths:
/rounds:
post:
tags:
- ShiftRounds
parameters:
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
get:
tags:
- ShiftRounds
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRounds'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRounds'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRounds'
/v{version}/rounds:
post:
tags:
- ShiftRounds
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
get:
tags:
- ShiftRounds
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
type: string
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRounds'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRounds'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRounds'
/rounds/{id}:
patch:
tags:
- ShiftRounds
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
get:
tags:
- ShiftRounds
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
/v{version}/rounds/{id}:
patch:
tags:
- ShiftRounds
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
get:
tags:
- ShiftRounds
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ShiftRounds'
/rounds/locations:
get:
tags:
- ShiftRounds
parameters:
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRoundLocation'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRoundLocation'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRoundLocation'
/v{version}/rounds/locations:
get:
tags:
- ShiftRounds
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRoundLocation'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRoundLocation'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ShiftRoundLocation'
components:
schemas:
ClientReferralContact:
type: object
properties:
id:
type:
- string
- 'null'
firstName:
type:
- string
- 'null'
lastName:
type:
- string
- 'null'
phone:
type:
- string
- 'null'
email:
type:
- string
- 'null'
additionalProperties: false
ClientOccupation:
type: object
properties:
name:
type:
- string
- 'null'
currentEmployer:
type:
- string
- 'null'
years:
type: integer
format: int32
months:
type: integer
format: int32
additionalProperties: false
State:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
stateId:
type: integer
format: int32
countryId:
type: integer
format: int32
stateName:
type:
- string
- 'null'
stateCode:
type:
- string
- 'null'
additionalProperties: false
UserName:
type: object
properties:
first:
type:
- string
- 'null'
last:
type:
- string
- 'null'
prefix:
type:
- string
- 'null'
suffix:
type:
- string
- 'null'
additionalProperties: false
User:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
name:
$ref: '#/components/schemas/UserName'
gender:
type:
- string
- 'null'
userName:
type:
- string
- 'null'
birthDate:
type:
- string
- 'null'
format: date-time
ssn:
type:
- string
- 'null'
email:
type:
- string
- 'null'
phone:
type:
- string
- 'null'
address:
$ref: '#/components/schemas/Address'
facility:
$ref: '#/components/schemas/Facility'
tenant:
type:
- string
- 'null'
role:
type:
- string
- 'null'
profileImage:
$ref: '#/components/schemas/UserImageUrl'
isMedicalProvider:
type:
- boolean
- 'null'
hireDate:
type:
- string
- 'null'
format: date-time
startDate:
type:
- string
- 'null'
format: date-time
endDate:
type:
- string
- 'null'
format: date-time
licenses:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UserLicense'
additionalProperties: false
JToken:
type: array
items:
$ref: '#/components/schemas/JToken'
ResourceLink:
type: object
properties:
id:
type: integer
format: int32
route:
type:
- string
- 'null'
additionalProperties: false
Room:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
facilityId:
type: integer
format: int32
roomName:
type:
- string
- 'null'
isActive:
type: boolean
totalBeds:
type: integer
format: int32
additionalProperties: false
ClientContact:
type: object
properties:
firstName:
type:
- string
- 'null'
lastName:
type:
- string
- 'null'
name:
type:
- string
- 'null'
phone:
type:
- string
- 'null'
relationship:
type:
- string
- 'null'
email:
type:
- string
- 'null'
isPrimary:
type: boolean
writeOnly: true
isEmergencyContact:
type: boolean
additionalProperties: false
UserImageUrl:
type: object
properties:
fileName:
type:
- string
- 'null'
host:
type:
- string
- 'null'
readOnly: true
path:
type:
- string
- 'null'
readOnly: true
additionalProperties: false
ClientName:
type: object
properties:
clientFullName:
type:
- string
- 'null'
readOnly: true
first:
type:
- string
- 'null'
last:
type:
- string
- 'null'
middle:
type:
- string
- 'null'
isLegalName:
type:
- boolean
- 'null'
former:
type:
- string
- 'null'
prefix:
type:
- string
- 'null'
preferred:
type:
- string
- 'null'
additionalProperties: false
ShiftRounds:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
isSigned:
type: boolean
signedBy:
$ref: '#/components/schemas/User'
signature:
type:
- string
- 'null'
createdDate:
type: string
format: date-time
createdBy:
$ref: '#/components/schemas/User'
roundName:
type:
- string
- 'null'
facilityId:
type: integer
format: int32
clients:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ClientShiftRounds'
additionalProperties: false
ShiftRoundLocation:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
additionalProperties: false
Address:
type: object
properties:
line1:
type:
- string
- 'null'
line2:
type:
- string
- 'null'
city:
type:
- string
- 'null'
state:
type:
- string
- 'null'
stateAbbr:
type:
- string
- 'null'
country:
type:
- string
- 'null'
zipCode:
type:
- string
- 'null'
additionalProperties: false
ClientImageUrl:
type: object
properties:
fileName:
type:
- string
- 'null'
host:
type:
- string
- 'null'
readOnly: true
path:
type:
- string
- 'null'
readOnly: true
additionalProperties: false
Facility:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
name:
type:
- string
- 'null'
rehabName:
type:
- string
- 'null'
domainName:
type:
- string
- 'null'
email:
type:
- string
- 'null'
officePhone:
type:
- string
- 'null'
fax:
type:
- string
- 'null'
address1:
type:
- string
- 'null'
address2:
type:
- string
- 'null'
state:
type:
- string
- 'null'
city:
type:
- string
- 'null'
postalCode:
type:
- string
- 'null'
country:
type:
- string
- 'null'
additionalProperties: false
UserLicense:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
acronym:
type:
- string
- 'null'
order:
type: integer
format: int32
number:
type:
- string
- 'null'
isActive:
type: boolean
effectiveDate:
type:
- string
- 'null'
format: date-time
expiryDate:
type:
- string
- 'null'
format: date-time
type:
$ref: '#/components/schemas/UserLicenseType'
user:
$ref: '#/components/schemas/User'
state:
$ref: '#/components/schemas/State'
additionalProperties: false
UserLicenseType:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
name:
type:
- string
- 'null'
description:
type:
- string
- 'null'
isActive:
type: boolean
canModifyOrDelete:
type: boolean
inUse:
type: boolean
additionalProperties: false
ClientShiftRounds:
type: object
properties:
id:
type: integer
format: int64
client:
$ref: '#/components/schemas/Client'
location:
$ref: '#/components/schemas/ShiftRoundLocation'
notes:
type:
- string
- 'null'
additionalProperties: false
Client:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
name:
$ref: '#/components/schemas/ClientName'
gender:
type:
- string
- 'null'
pronoun:
type:
- string
- 'null'
identifiesAs:
type:
- string
- 'null'
primaryLanguage:
type:
- string
- 'null'
ssn:
type:
- string
- 'null'
dateOfBirth:
type:
- string
- 'null'
format: date-time
address:
$ref: '#/components/schemas/Address'
phone:
$ref: '#/components/schemas/Phone'
email:
type:
- string
- 'null'
isClient:
type: boolean
clientId:
type:
- integer
- 'null'
format: int64
uniqueId:
type:
- string
- 'null'
contact:
$ref: '#/components/schemas/ClientContact'
referral:
$ref: '#/components/schemas/ClientReferralContact'
facilityName:
type:
- string
- 'null'
facilityId:
type: integer
format: int64
otherNumber:
type:
- string
- 'null'
status:
type:
- string
- 'null'
mrn:
type:
- string
- 'null'
admissionDateTime:
type:
- string
- 'null'
format: date-time
firstContactDate:
type:
- string
- 'null'
format: date-time
dischargeDateTime:
type:
- string
- 'null'
ethnicity:
type:
- string
- 'null'
profileImage:
$ref: '#/components/schemas/ClientImageUrl'
occupation:
$ref: '#/components/schemas/ClientOccupation'
levelOfCare:
type:
- string
- 'null'
primaryClinician:
$ref: '#/components/schemas/ResourceLink'
hasReadmitted:
type: boolean
room:
$ref: '#/components/schemas/Room'
primaryClinicians:
type:
- string
- 'null'
medicalProviders:
type:
- string
- 'null'
additionalProperties: false
Phone:
type: object
properties:
home:
type:
- string
- 'null'
office:
type:
- string
- 'null'
other:
type:
- string
- 'null'
number:
type:
- string
- 'null'
fax:
type:
- string
- 'null'
additionalProperties: false
securitySchemes:
Bearer:
type: apiKey
description: "JWT Authorization header using the Bearer scheme. \n\n Enter Bearer [space] and then\
\ your token in the text input below.\n\nExample: Bearer 12345abcdef"
name: Authorization
in: header
servers:
- url: https://api.helloalleva.com
description: Base URL reconciled from apis.yml