Status and progress of the VA's portfolio of APIs
|
Define
|
Prototype
|
Iterate
|
Launch
|
Live
|
|---|---|---|---|---|
|
|
|
|
|
|
|
| Legend | |
|---|---|
|
Not yet started
|
Having issues, but we're managing
|
|
Overall things are going well
|
Experiencing major blockers to success
|
Sort by name
| Sort by status
Peer Support (EX)
This project provides and API for finding peer support resources.
Live Stage
Blocked
Bugs all over the place
Bugs all over the place
| Completed | Step |
|---|---|
|
Retired any previous legacy services that need to be deprecated |
|
|
Achieving business and operational performance targets |
|
|
Developing and deploying product improvements iteratively, driven by ongoing consumer feedback and analysis of product usage |
|
Executing and making any necessary adjustments to the outreach plan in order to achieve performance targets |
|
|
Executing a process for evaluating, communicating, and supporting deprecations to the API |
|
|
Providing a regular summary of the service's general status |
Funnel metrics
| Metric | Current | Target |
|---|---|---|
| Total API Key Registrations | 75 | 100 |
| Total API Calls in Sandbox | 1075 | 2000 |
| Total API Calls in Production | 65 | 100 |
| Total Number of Verified Apps Built | 2 | 5 |
Facility Locator (EX)
This project provides an API for getting information on VA facilities, including contact information, patient satisfaction, and more.
Launch Stage
Blocked
Waiting on Group A
Waiting on Group A
| Completed | Step |
|---|---|
|
|
Passed all unit, integration, code quality, performance, and security tests |
|
|
Ensured compliance with all VA privacy and security policies |
|
|
Obtained sign-off from all key stakeholders, including consumers |
|
|
Registered with the API management platform |
|
|
Launched into production environment and usage monitored to ensure any errors are quickly remediated |
|
|
Executed launch outreach plan |
Family Support (EX)
This project provides an API for to help Veterans and their supports discover family support services.
Prototype Stage
| Completed | Step |
|---|---|
|
|
Translated API definition into a functioning, virtualized, URL-accessible API that uses synthetic, production-like data as part of the request and responses (test environment) |
|
|
Tested with real consumers in the test environment |
|
|
Provided a list of functional assertions for turning into tests |
Benefits (EX)
Example of a change. This project provides an API for managing, submitting, tracking, and receiving notifications on benefits claims.
Launch Stage
Integrating new team members slowing us down
| Completed | Step |
|---|---|
|
|
Passed all unit, integration, code quality, performance, and security tests |
|
|
Ensured compliance with all VA privacy and security policies |
|
|
Obtained sign-off from all key stakeholders, including consumers |
|
|
Registered with the API management platform |
|
|
Launched into production environment and usage monitored to ensure any errors are quickly remediated |
|
|
Executed launch outreach plan |
Health (EX)
This project enables people to build tools to help Veterans manage their health, view their medical records, schedule an appointment, find a specialty facility, and securely share their information with caregivers and providers.
Iterate Stage
Progressing nicely
| Completed | Step |
|---|---|
|
|
Built iteratively, driven by ongoing feedback from real consumers |
|
|
Tested performance against expected load and potential stress conditions |
|
|
Conducted security tests and resolved vulnerabilities |
|
|
Documentation is provided within a portal |
|
|
Developed an outreach plan for driving and measuring adoption |
|
|
Identified measurable performance metrics and documented baseline (if one exists) for future comparison |
|
|
Validated correct business and operational metrics are being collected, using automated tools wherever possible |
Veteran Verification (EX)
This project provides an API for building tools to help Veterans verify their Veteran status electronically.
Define Stage
Just started current phase
| Completed | Step |
|---|---|
|
|
Product vision is defined and aligns to a strategic imperative |
|
|
Identified and documented who the primary users are and what their needs are through primary research |
|
|
Identified and documented all service, system, data, and human dependencies, including those that can be deprecated post deployment |
|
|
Defined using OpenAPI Specification and JSON Schema |
|
|
Team behind the service is defined |
|
|
Established a base set of design practices and standards (e.g., versioning, media types, status codes) |
|
|
Defined entire lifespan of the API, including deprecation, even if generalized |
API Stages
Define
Delivery success criteria:
- Product vision is defined and aligns to a strategic imperative
- Identified and documented who the primary users are and what their needs are through primary research
- Identified and documented all service, system, data, and human dependencies, including those that can be deprecated post deployment
- Defined using OpenAPI Specification and JSON Schema
- Team behind the service is defined
- Established a base set of design practices and standards (e.g., versioning, media types, status codes)
- Defined entire lifespan of the API, including deprecation, even if generalized
Prototype
Delivery success criteria:
- Translated API definition into a functioning, virtualized, URL-accessible API that uses synthetic, production-like data as part of the request and responses (test environment)
- Tested with real consumers in the test environment
- Provided a list of functional assertions for turning into tests
Iterate
Delivery success criteria:
- Built iteratively, driven by ongoing feedback from real consumers
- Tested performance against expected load and potential stress conditions
- Conducted security tests and resolved vulnerabilities
- Documentation is provided within a portal
- Developed an outreach plan for driving and measuring adoption
- Identified measurable performance metrics and documented baseline (if one exists) for future comparison
- Validated correct business and operational metrics are being collected, using automated tools wherever possible
Launch
Delivery success criteria:
- Passed all unit, integration, code quality, performance, and security tests
- Ensured compliance with all VA privacy and security policies
- Obtained sign-off from all key stakeholders, including consumers
- Registered with the API management platform
- Launched into production environment and usage monitored to ensure any errors are quickly remediated
- Executed launch outreach plan
Live
Delivery success criteria:
- Retired any previous legacy services that need to be deprecated
- Achieving business and operational performance targets
- Developing and deploying product improvements iteratively, driven by ongoing consumer feedback and analysis of product usage
- Executing and making any necessary adjustments to the outreach plan in order to achieve performance targets
- Executing a process for evaluating, communicating, and supporting deprecations to the API
- Providing a regular summary of the service's general status