VIPM OAuth API (1.0.0)

Download OpenAPI specification:Download

Service to service OAuth integration

Create patient

Create a patient within your organization

Authorizations:

auth

path Parameters

orgId

required

string (orgId)

The organization id

Request Body schema: application/json
optional

Create Patient DTO

firstName	string
lastName	string
email	string
dob	string^d{2}/d{2}/d{4}$
profileEmail	string

Responses

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"email": "string",
"dob": "string",
"profileEmail": "string"
}

Response samples

201
400

Content type

application/json

{"body": {"firstName": "string",
"lastName": "string",
"email": "string",
"dob": "string",
"profileEmail": "string"
},
"statusCode": "string"
}

Create bundle

Create a bundle for a patient

Authorizations:

auth

path Parameters

orgId

required

string (orgId)

The organization id

Request Body schema: application/json
optional

Create Bundle DTO

name	object
patientId	string
emailAddress	string
assessmentTypes	string
deliveryDate	string
dueDate	string
profileEmail	string

Responses

Request samples

Payload

Content type

application/json

{"name": { },
"patientId": "string",
"emailAddress": "string",
"assessmentTypes": "string",
"deliveryDate": "string",
"dueDate": "string",
"profileEmail": "string"
}

Response samples

201
400

Content type

application/json

{"body": {"id": "string",
"name": "string",
"patientId": "string",
"userProfileId": "string",
"created": "string",
"updated": "string",
"deleted": "string"
},
"statusCode": "string"
}

Create assessment group

Create an assessment group with required fields

Authorizations:

auth

path Parameters

orgId

required

string (orgId)

The organization id

Request Body schema: application/json
optional

Create assessment group DTO

bundleId	string
patientId	string
emailAddress	string
assessmentTypes	string
deliveryDate	string
dueDate	string
profileEmail	string

Responses

Request samples

Payload

Content type

application/json

{"bundleId": "string",
"patientId": "string",
"emailAddress": "string",
"assessmentTypes": "string",
"deliveryDate": "string",
"dueDate": "string",
"profileEmail": "string"
}

Response samples

201
400

Content type

application/json

{"body": {"id": "string",
"assessments": "string",
"criticalItems": { },
"deliveryDate": "string",
"dueDate": "string",
"emailAddress": "string",
"interventionTargets": { },
"metadata": { },
"recommendations": { },
"reviewedOn": "string",
"strengths": { },
"teachingPlans": { },
"created": "string",
"updated": "string",
"deleted": "string"
},
"statusCode": "string"
}

Search assessment groups

Authorizations:

auth

path Parameters

orgId

required

string (orgId)

The organization id

Request Body schema: application/json
optional

Search assessment group dto

patientId	string
bundleId	string
profileId	string
mrn	string
profileEmail	string

Responses

Request samples

Payload

Content type

application/json

{"patientId": "string",
"bundleId": "string",
"profileId": "string",
"mrn": "string",
"profileEmail": "string"
}

Response samples

200
400

Content type

application/json

{"body": [{"id": "string",
"assessments": "string",
"criticalItems": { },
"deliveryDate": "string",
"dueDate": "string",
"emailAddress": "string",
"interventionTargets": { },
"metadata": { },
"recommendations": { },
"reviewedOn": "string",
"strengths": { },
"teachingPlans": { },
"created": "string",
"updated": "string",
"deleted": "string"
}
],
"statusCode": "string"
}

Send assessment group reminder

Trigger an assessment group reminder

Authorizations:

auth

path Parameters

orgId required	string (orgId) The organization id
id required	string (id) The assessment group id

Request Body schema: application/json
optional

Send assessment group reminder dto

emailAddress	string
profile	string

Responses

Request samples

Payload

Content type

application/json

{"emailAddress": "string",
"profile": "string"
}

Response samples

201
400

Content type

application/json

{"body": {"id": "string",
"assessments": "string",
"criticalItems": { },
"deliveryDate": "string",
"dueDate": "string",
"emailAddress": "string",
"interventionTargets": { },
"metadata": { },
"recommendations": { },
"reviewedOn": "string",
"strengths": { },
"teachingPlans": { },
"created": "string",
"updated": "string",
"deleted": "string"
},
"statusCode": "string"
}

Search assessments

Authorizations:

auth

path Parameters

orgId

required

string (orgId)

The organization id

Request Body schema: application/json
optional

Search assessments dto

patientId	string
groupId	string

Responses

Request samples

Payload

Content type

application/json

{"patientId": "string",
"groupId": "string"
}

Response samples

200
400

Content type

application/json

{"body": [{"id": "string",
"type": "string",
"patient": { },
"assessmentGroupId": "string",
"completed": "string",
"data": { },
"created": "string",
"updated": "string",
"deleted": "string"
}
],
"statusCode": "string"
}

VIPM OAuth API (1.0.0)

Create patient

Authorizations:

path Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Create bundle

Authorizations:

path Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Create assessment group

Authorizations:

path Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Search assessment groups

Authorizations:

path Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Send assessment group reminder

Authorizations:

path Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Search assessments

Authorizations:

path Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional