The TreatmentPlans API from Alleva — 10 operation(s) for treatmentplans.
openapi: 3.2.0
info:
title: Alleva Rest Treatment Plans API
version: '1.0'
security:
- Bearer: []
tags:
- name: TreatmentPlans
paths:
/treatment-plans/{id}/signature:
post:
tags:
- TreatmentPlans
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:
$ref: '#/components/schemas/Signature'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
responses:
'200':
description: Success
/v{version}/treatment-plans/{id}/signature:
post:
tags:
- TreatmentPlans
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:
$ref: '#/components/schemas/Signature'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
responses:
'200':
description: Success
/treatment-plans/{id}/review-signature:
post:
tags:
- TreatmentPlans
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:
$ref: '#/components/schemas/Signature'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
responses:
'200':
description: Success
/v{version}/treatment-plans/{id}/review-signature:
post:
tags:
- TreatmentPlans
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:
$ref: '#/components/schemas/Signature'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/Signature'
responses:
'200':
description: Success
/treatment-plans/{id}/diagnosis:
get:
tags:
- TreatmentPlans
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:
type: array
items:
$ref: '#/components/schemas/ClientDiagnosis'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ClientDiagnosis'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ClientDiagnosis'
/v{version}/treatment-plans/{id}/diagnosis:
get:
tags:
- TreatmentPlans
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:
type: array
items:
$ref: '#/components/schemas/ClientDiagnosis'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ClientDiagnosis'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ClientDiagnosis'
/treatment-plans:
get:
tags:
- TreatmentPlans
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/TreatmentPlan'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/TreatmentPlan'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/TreatmentPlan'
/v{version}/treatment-plans:
get:
tags:
- TreatmentPlans
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/TreatmentPlan'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/TreatmentPlan'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/TreatmentPlan'
/treatment-plans/{id}:
get:
tags:
- TreatmentPlans
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/TreatmentPlan'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/TreatmentPlan'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/TreatmentPlan'
/v{version}/treatment-plans/{id}:
get:
tags:
- TreatmentPlans
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/TreatmentPlan'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/TreatmentPlan'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/TreatmentPlan'
components:
schemas:
Objective:
type: object
properties:
description:
type:
- string
- 'null'
isWiley:
type: boolean
isEvidenceBased:
type: boolean
interventions:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Intervention'
additionalProperties: false
UserImageUrl:
type: object
properties:
fileName:
type:
- string
- 'null'
host:
type:
- string
- 'null'
readOnly: true
path:
type:
- string
- 'null'
readOnly: true
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
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
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
Signature:
type: object
properties:
entityId:
type: integer
format: int32
signerName:
type:
- string
- 'null'
data:
type:
- string
- 'null'
type:
type:
- string
- 'null'
signatureDateTime:
type:
- string
- 'null'
format: date-time
additionalProperties: false
ResourceLink:
type: object
properties:
id:
type: integer
format: int32
route:
type:
- string
- 'null'
additionalProperties: false
TreatmentPlan:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
client:
$ref: '#/components/schemas/ResourceLink'
description:
type:
- string
- 'null'
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
reasonForAdmission:
type:
- string
- 'null'
initialClientNeeds:
type:
- string
- 'null'
familyEducationNeeds:
type:
- string
- 'null'
isInitialTP:
type: boolean
isWiley:
type: boolean
isActive:
type: boolean
problems:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Problem'
createdDate:
type: string
format: date-time
isComplete:
type: boolean
lastModified:
type: string
format: date-time
clientSignature:
$ref: '#/components/schemas/Signature'
guardianSignature:
$ref: '#/components/schemas/Signature'
additionalProperties: false
Goal:
type: object
properties:
description:
type:
- string
- 'null'
isWiley:
type: boolean
objectives:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Objective'
additionalProperties: false
Intervention:
type: object
properties:
description:
type:
- string
- 'null'
isWiley:
type: boolean
isEvidenceBased:
type: boolean
additionalProperties: false
BehavioralDefinition:
type: object
properties:
description:
type:
- string
- 'null'
isWiley:
type: boolean
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
DiagnosisPriority:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
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
ClientDiagnosis:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
clientId:
type: integer
format: int32
leadId:
type: integer
format: int32
groupId:
type: integer
format: int32
group:
type:
- string
- 'null'
diagnosisNumber:
type:
- integer
- 'null'
format: int32
problemId:
type: integer
format: int32
problem:
type:
- string
- 'null'
problemNumber:
type: integer
format: int32
diagnosisId:
type: integer
format: int32
description:
type:
- string
- 'null'
icD10Code:
type:
- string
- 'null'
deprecated: true
code:
type:
- string
- 'null'
createdBy:
$ref: '#/components/schemas/User'
priority:
$ref: '#/components/schemas/DiagnosisPriority'
resolvedDate:
type:
- string
- 'null'
format: date-time
createdDate:
type: string
format: date-time
isRuleOut:
type: boolean
isPrimary:
type: boolean
isActive:
type: boolean
additionalProperties: false
Problem:
type: object
properties:
description:
type:
- string
- 'null'
isWiley:
type: boolean
diagnoses:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ClientDiagnosis'
behavioralDefinitions:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/BehavioralDefinition'
goals:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Goal'
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
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