department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
284 stars 206 forks source link

Business intake form for Office of Connected Care #28516

Closed amattsmithva closed 1 year ago

amattsmithva commented 3 years ago

Requestor Name

Matt Smith for Kevin Troutner

Business Line

Mobile Application Platform (MAP)

What is the business outcome you are trying to achieve? (required 1-2 sentences)

Reliably send email notifications with delivery confirmation and engagement metrics.

What is an overview of the notification use case? (required 3-5 sentences)

Email notifications to Veterans and Providers for upcoming video appointments to include links to connect and instructions.

What is the user journey during which this notification will take place? Is there a desired behavior change? ( required 3-5 sentences)

Upon scheduling a video visit appointment both the Veteran and provider receive an email with the calendar information and instructions to connect.

Is this notification already being sent and if so how? (Yes/No and optional 1-2 sentences)

yes

What kind of notification would this be? (required Email, Text, Not sure)

email

If you have a draft of the content you’d like to send - please upload here. Please note we collaborate with all of our users on their content to ensure it meets standards. (optional - blank)

Have you spoken to your Privacy Officer about your content / use case and has it been approved? (Yes, No, Not Sure)

yes

What system will your notification be triggered from i.e. vets-api? (required 1-2 sentences)

mobile-email-service will call the notify API

Do you have the business logic in that system to trigger an API request to us? (required 1-2 sentences)

Yes, the current logic sends via SMTP through postfix to the VA SMTP server. This will require development changes to use a REST endpoint if SMTP is not available.

Do you have the data or access to the data needed for your notification i.e. email addresses, unique identifiers (optional yes, no, not sure)

yes

Do you have a budget for this? Please see details on the cost of using our service here. (optional yes, no, not sure)

What is your estimated volume of notifications per day, week, month? (optional - open space)

~30K emails per day (M-F)

When does this notification need to be in production? (optional - open space)

6 months

bevnobev commented 3 years ago

Hi @amattsmithva. Can you upload/attached the current email content when you get a chance? Thx!

bevnobev commented 3 years ago

https://app.zenhub.com/files/133843125/11922e24-7086-442a-9059-96bb6e4ebf0f/download Attaching PII docs

amattsmithva commented 3 years ago

Hi @bevnobev ,

Please see attached email samples. They are Yaml formatted below, but should be self-explanatory. If you have any questions please reach out. Included are the "Subject" and "Body" of a few different emails used by one of our applications.

`VCL_EMAIL_SUBJECT: 'VCL OUTREACH'

VCL_EMAIL_BODY: 'VCL, please follow up. {{n}} This email is being sent as a notification that a Veteran has completed a PHQ-9 assessment answering question 9 in a manner that indicates he/she is having thoughts of being better off dead or of harming him/herself. Please contact the Veteran as soon as possible. Contact information is provided in the secure link below. {{n}} {{event-page}}'

PROVIDER_EMAIL_SUBJECT: 'MH Checkup Patient has indicated suicidality'

PROVIDER_EMAIL_BODY: 'This email is being sent as a notification that a Veteran has completed a PHQ-9 assessment answering question 9 in a manner that indicates he/she is having thoughts of being better off dead or of harming him/herself. The Veterans Crisis Line has been notified and should be contacting the patient as soon as possible. If you would like to contact the Veteran directly, contact information is provided in the secure link below. {{n}} {{event-page}} {{n}} The assessment details can be retrieved from the alerts tab in MH Checkup or directly at the link below: {{n}} {{assessment-page}}'

PROVIDER_VCL_EMAIL_SUBJECT: 'MH Checkup Patient has indicated suicidality'

PROVIDER_VCL_EMAIL_BODY: 'This email is being sent as a notification that a Veteran has completed a PHQ-9 assessment answering question 9 in a manner that indicates he/she is having thoughts of being better off dead or of harming him/herself. The Veterans Crisis Line has been notified and should be contacting the patient as soon as possible. If you would like to contact the Veteran directly, contact information is provided in the secure link below. {{n}} {{event-page}} {{n}} The assessment details can be retrieved from the alerts tab in MH Checkup or directly at the link below: {{n}} {{assessment-page}}'

PROVIDER_COMPLETED_EMAIL_SUBJECT: 'An assigned assessment was completed'

PROVIDER_COMPLETED_EMAIL_BODY: 'An assessment you have assigned was completed by the Veteran. It was due on {{due-date}}. Please log in at https://staff.apps.va.gov/mhc-provider/ to review completed assessments'

VET_FEEDBACK_EMAIL_SUBJECT: 'You provider has provided feedback on one of your assessments'

VET_FEEDBACK_EMAIL_BODY: 'Your Provider has provided feedback on one of your assessments. Please log in at https://veteran.apps.va.gov/mhc-vet/ to view the feedback on your completed assessment.' `

bevnobev commented 3 years ago

@amattsmithva Thanks. What's the volume on these kinds of notifications? Hoping it's lower than 30K/day (due to the nature of the emails)

miabecker commented 3 years ago

Hi @amattsmithva thanks for the content! In addition to Bev's question above two more questions – "PROVIDER_EMAIL" and "PROVIDER_VCL_EMAIL" it looks like the subject and content of those emails are the same. Is it possible for this to be one template instead of two or is there a reason you'd like to keep these separate? Second question – just to clarify you would be providing us the email addresses for the recipients in your API call and or will you provide a VA identifier such as ICN? Can speak about this more IRL if needed.

amattsmithva commented 3 years ago

Hi @miabecker and @bevnobev ,

I'm not sure why both of those are configured the same. I would need to check with Ryan and /or the application team to know whether or not those are both used. For now I would consider them separate as they are both in our Consul configuration for the application. I'll check with Ryan Lemire to see if he knows for sure though.

Again I'll need to check with Ryan on the volume of those emails. Since we pivoted to a different application to start with I would think the volume of this application would be less than the other, but Ryan would know for sure. I'll ask him and get back to y'all with more definitive answers. Thanks, Matt

amattsmithva commented 3 years ago

@miabecker and @bevnobev Both emails are required. After checking with Ryan, the volume is about 200/hr during business hours.

miabecker commented 3 years ago

And @amattsmithva just to clarify you would be providing us the email addresses for the recipients in your API call and or will you provide a VA identifier such as ICN? Can speak about this more IRL if needed.

amattsmithva commented 3 years ago

@miabecker we have the email addresses now since we are sending them through SMTP, so we will provide them when sending. If that changes I will let you know.

miabecker commented 3 years ago

@amattsmithva can you share more about the context for the below messages to the Veterans, i.e. when are they triggered and what the Veteran will see when they login to the link?

VET_FEEDBACK_EMAIL_SUBJECT: 'You provider has provided feedback on one of your assessments'

VET_FEEDBACK_EMAIL_BODY: 'Your Provider has provided feedback on one of your assessments. Please log in at https://veteran.apps.va.gov/mhc-vet/ to view the feedback on your completed assessment.'

miabecker commented 3 years ago

@amattsmithva below are templates IDs for the notifications in staging. Question - who/what email would you like the internal provider notifications to come from? Also please still take note of my question above on the Veteran-facing notification.

ffafara-tw commented 3 years ago

VCL Outreach template

id: "5011690e-6687-4234-b386-3f413e767079"
name: "VCL Outreach"
subject: "VCL Outreach"

required personalisations: event-page
example request: ``` curl --location --request POST 'https://staging-api.va.gov/vanotify/v2/notifications/email' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer \ --data-raw '{ "template_id": "5011690e-6687-4234-b386-3f413e767079", "email_address": "user@domain.com", "personalisation": { "event-page": "https://some.url" } }' ```

VCL MH Checkup Patient suicidality template

id: "c5fdc047-9a21-41bd-b62f-f6ef3a07f811"
name: "VCL MH Checkup Patient suicidality"
subject: "MH Checkup Patient has indicated suicidality"

required personalisations: event-page, assessment-page
example request: ``` curl --location --request POST 'https://staging-api.va.gov/vanotify/v2/notifications/email' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer \ --data-raw '{ "template_id": "c5fdc047-9a21-41bd-b62f-f6ef3a07f811", "email_address": "user@domain.com", "personalisation": { "event-page": "https://some.url", "assessment-page": "https://some.url } }' ```

Provider MH Checkup Patient suicidality template

id: "568fb2df-6859-43cb-9f9b-9179acdb7c17"
name: "Provider MH Checkup Patient suicidality"
subject: "MH Checkup Patient has indicated suicidality"

required personalisations: event-page, assessment-page
example request: ``` curl --location --request POST 'https://staging-api.va.gov/vanotify/v2/notifications/email' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer \ --data-raw '{ "template_id": "568fb2df-6859-43cb-9f9b-9179acdb7c17", "email_address": "user@domain.com", "personalisation": { "event-page": "https://some.url", "assessment-page": "https://some.url } }' ```

Provider assessment completed template

id: "1fbec063-c092-47a1-8d5b-8bdc3ea89e9f"
name: "Provider assessment completed"
subject: "An assigned assessment was completed"

required personalisations: due-date
example request: ``` curl --location --request POST 'https://staging-api.va.gov/vanotify/v2/notifications/email' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer \ --data-raw '{ "template_id": "1fbec063-c092-47a1-8d5b-8bdc3ea89e9f", "email_address": "user@domain.com", "personalisation": { "due-date": "09/30/2021 } }' ```

VET Feedback Email template

id: "1bfff777-ea36-483c-91ce-11bc4e259927"
name: "VET Feedback Email"
subject: "Your provider has provided feedback on one of your assessments"
example request: ``` curl --location --request POST 'https://staging-api.va.gov/vanotify/v2/notifications/email' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer \ --data-raw '{ "template_id": "1bfff777-ea36-483c-91ce-11bc4e259927", "email_address": "user@domain.com" }' ```
ffafara-tw commented 3 years ago

Here is your service information:

"id": "9f0cad58-0499-4715-8348-37e3eb84fd77",
"name": "Office of Connected Care",
"message_limit": 300,
"rate_limit": 300,
"permissions": [ "email" ]

message_limit is number of allowed messages a day. rate_limit is number of API requests per minute.

These values will be adjusted in production environment.

ffafara-tw commented 3 years ago

If you want to smoke test integration you can send notifications to following email addresses:

'simulate-delivered@notifications.va.gov',
'simulate-delivered-2@notifications.va.gov',
'simulate-delivered-3@notifications.va.gov',

The smoke test email addresses will validate the request and simulate a successful response, but will not send a real message, produce a delivery receipt or persist the notification to the database.

ffafara-tw commented 3 years ago

API key shared with Matthew Smith.

amattsmithva commented 3 years ago

Hi Filip,

Please share API key with @Lemire, Ryan @.***> I wasn't able to forward the information.

Thanks,

Matt

From: Filip Fafara @.> Sent: Wednesday, September 1, 2021 4:04 PM To: department-of-veterans-affairs/va.gov-team @.> Cc: Smith, Matthew T. (Iron Bow) @.>; Mention @.> Subject: [EXTERNAL] Re: [department-of-veterans-affairs/va.gov-team] Business intake form for Office of Connected Care Mental Health Suicide Prevention Alert System (#28516)

API key shared with Matthew Smith.

- You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fdepartment-of-veterans-affairs%2Fva.gov-team%2Fissues%2F28516%23issuecomment-910750704&data=04%7C01%7C%7C85b3b0ae5d694f33502508d96d8c0054%7Ce95f1b23abaf45ee821db7ab251ab3bf%7C0%7C0%7C637661273150201874%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=TdOBQ43EbbDpARP%2Fs2a6aptZsiFB0Ep9ufUxz3El63E%3D&reserved=0, or unsubscribehttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAVA5ITGY5IP6ML7KUD2RTALT72IKLANCNFSM5B4Z7TXQ&data=04%7C01%7C%7C85b3b0ae5d694f33502508d96d8c0054%7Ce95f1b23abaf45ee821db7ab251ab3bf%7C0%7C0%7C637661273150211829%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=MY9180IODcIbfF9t%2Fbuspqj3pBjR%2BlVcarggqhWC%2BCo%3D&reserved=0. Triage notifications on the go with GitHub Mobile for iOShttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fapps.apple.com%2Fapp%2Fapple-store%2Fid1477376905%3Fct%3Dnotification-email%26mt%3D8%26pt%3D524675&data=04%7C01%7C%7C85b3b0ae5d694f33502508d96d8c0054%7Ce95f1b23abaf45ee821db7ab251ab3bf%7C0%7C0%7C637661273150211829%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=jIyFSOai%2FHW44F1Y9%2BET4XQD6Q7%2BjFt2Se9OP7C45p4%3D&reserved=0 or Androidhttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fplay.google.com%2Fstore%2Fapps%2Fdetails%3Fid%3Dcom.github.android%26referrer%3Dutm_campaign%253Dnotification-email%2526utm_medium%253Demail%2526utm_source%253Dgithub&data=04%7C01%7C%7C85b3b0ae5d694f33502508d96d8c0054%7Ce95f1b23abaf45ee821db7ab251ab3bf%7C0%7C0%7C637661273150221788%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=25zaecp42Cd5Umr7lprY0zVenQGU%2BcsaRiswXobB8i0%3D&reserved=0.

ffafara-tw commented 3 years ago

Sent email to @lemire

miabecker commented 3 years ago

Waiting to hear back from business when they want to begin testing. Veteran facing content is being reviewed.

miabecker commented 3 years ago

@amattsmithva just wanted to check in and see if you need anything else from us?

miabecker commented 3 years ago

Looks like these are notifications come from MH Check-Up vs. My HealtheVet - and it looks like the workflow has changed. The VCL is no longer involved. Slightly different notifications system with the dashboard. Send these types of notifications to Mobile Email Service, we send Subject and Body (due email, completed assessments, feedback, reminders, missed assessments, provider assessment assigned email) don't send anything to VCL anymore. Potentially the Veteran has an appointment, the Provider logs in, creates an assessment for the Veteran, the Veteran gets a due date, the Veteran gets reminders, then gets Missed Assessment, Completed Assessment email top Provider, If answer indicates positively on suicidality question on the assessment then Provider gets notified.

miabecker commented 3 years ago

Working on getting Ryan Lemire and his team access to Github and the UI.

miabecker commented 3 years ago

@lemirerr checking in here. How are things going on your side? Have access to everything you need? Our team has just finished the analysis on attachments and are beginning work next week.

lemirerr commented 3 years ago

@miabecker I believe we have everything we need for now, thanks

miabecker commented 2 years ago

@Lemirrerr just checking here - any updates on a go live date?

lemirerr commented 2 years ago

We are in a holding pattern currently.

On Tue, Dec 21, 2021 at 11:44 AM Maria @.***> wrote:

@Lemirrerr just checking here - any updates on a go live date?

— Reply to this email directly, view it on GitHub https://github.com/department-of-veterans-affairs/va.gov-team/issues/28516#issuecomment-998932350, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJCH7GBV33OBXQEFCAHYKLUSCVHFANCNFSM5B4Z7TXQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

You are receiving this because you were mentioned.Message ID: @.*** com>

bevnobev commented 2 years ago

tagging @mjones-oddball and @megansiddle. MHV PHI doc is linked above in a comment from me dated 8/11/2021

mjones-oddball commented 1 year ago

Inactive - moving to closed