-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #315 from CMSgov/QPPA-9269
QPPA-9269: update design systems to v10
- Loading branch information
Showing
26 changed files
with
1,927 additions
and
352 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,41 +6,41 @@ const GettingStartedUsingQppOauth: React.FC<DocPageProps> = ({dataTestId}: DocPa | |
| return ( | ||
| <div data-testid={dataTestId}> | ||
| <p className='qpp-docs-page-updated'>Last Updated: 08/31/2023</p> {/* IMPORTANT: update this Last-Updated value if you have made any changes to this page's content. */} | ||
| <h2 className='ds-h2' style={{marginTop: 0}}>Getting Started Using QPP OAuth</h2> | ||
| <p className='ds-text'> | ||
| <h2 className='ds-text-heading--2xl' style={{marginTop: 0}}>Getting Started Using QPP OAuth</h2> | ||
| <p className='ds-text-body--md'> | ||
| Using OAuth with the Submissions API allows QPP participants to use their own QPP credentials to login through your application to submit their data to and view performance feedback from QPP. Before you can request production access, you will need to use the Developer Preview Environment to build, test and demo your OAuth application. | ||
| </p> | ||
|
|
||
| <h2 className='ds-h2' id='oauth'>Using OAuth in the Developer Preview</h2> | ||
| <p className='ds-text'> | ||
| <h2 className='ds-text-heading--2xl' id='oauth'>Using OAuth in the Developer Preview</h2> | ||
| <p className='ds-text-body--md'> | ||
| To use the QPP Submissions API with OAuth, you must create a Developer Preview account and register the application. | ||
| </p> | ||
| <p className='ds-text'> | ||
| <p className='ds-text-body--md'> | ||
| Create an account for Developer Preview at <ExternalLink href={envConfig.qppCmsPreviewUrl} />. | ||
| </p> | ||
|
|
||
| <h3 className='ds-h3'>Connect to EHR or reporting application</h3> | ||
| <p className='ds-text'> | ||
| <h3 className='ds-text-heading--xl'>Connect to EHR or reporting application</h3> | ||
| <p className='ds-text-body--md'> | ||
| Log in to Developer Preview (<ExternalLink href={envConfig.qppCmsPreviewUrl} />). | ||
| </p> | ||
| <p className='ds-text'> | ||
| <p className='ds-text-body--md'> | ||
| Locate your EHR (search by the EHR name as it appears in the <ExternalLink href={envConfig.chplHealthItUrl} text='CHPL database' />). | ||
| </p> | ||
| <p className='ds-text'> | ||
| <p className='ds-text-body--md'> | ||
| If you cannot locate your EHR or are a registry user, create one manually. | ||
| </p> | ||
| <p className='ds-text'> | ||
| <p className='ds-text-body--md'> | ||
| After requesting the role, it may take a few minutes to populate. | ||
| </p> | ||
|
|
||
| <h3 className='ds-h3'>Register an Application</h3> | ||
| <p className='ds-text'> | ||
| <h3 className='ds-text-heading--xl'>Register an Application</h3> | ||
| <p className='ds-text-body--md'> | ||
| Once you are connected, you can use the OAuth APIs directly on the <ExternalLink href={`${envConfig.qppCmsPreviewUrl}/api/auth/docs/#/OAuth`} text='Auth API' />. Also, Development Preview contains a UI (<ExternalLink href={`${envConfig.qppCmsPreviewUrl}/user/applications`} text='here' />) where you can create and manage your OAuth applications. | ||
| </p> | ||
| <p className='ds-text'> | ||
| <p className='ds-text-body--md'> | ||
| Registering and testing your application within the Developer Preview is required prior to being granted production OAuth access. | ||
| </p> | ||
| <p className='ds-text'> | ||
| <p className='ds-text-body--md'> | ||
| To register the application, you will need: | ||
| </p> | ||
| <ul> | ||
|
|
@@ -53,36 +53,36 @@ const GettingStartedUsingQppOauth: React.FC<DocPageProps> = ({dataTestId}: DocPa | |
| Terms of Service and Privacy Policy are optional for the test environment, but required for production. | ||
| </li> | ||
| </ul> | ||
| <p className='ds-text'> | ||
| <p className='ds-text-body--md'> | ||
| In the test environment, a registered application is assigned a client ID and, if applicable, a client secret. The secret should only be used if it can be kept confidential, such as for communication between your server and the Submissions API. | ||
| </p> | ||
| <p className='ds-text'> | ||
| <p className='ds-text-body--md'> | ||
| Additional support along with a sample OAuth Client, can be found in the QPP Github at: <ExternalLink href='https://github.com/CMSgov/qpp-submissions-docs/tree/master/oauth_sample' />. | ||
| </p> | ||
|
|
||
| <h2 className='ds-h2' id='create-user'>Create test users in the Developer Preview</h2> | ||
| <p className='ds-text'> | ||
| <h2 className='ds-text-heading--2xl' id='create-user'>Create test users in the Developer Preview</h2> | ||
| <p className='ds-text-body--md'> | ||
| To support Developer Preview integration and testing, we created the <ExternalLink href={`${envConfig.qppCmsPreviewUrl}/api/synthetic-data/docs/index.html`} text='Test Data Service' />. Using this API, you can reserve specific scenarios in the Test Data Service to test granting access to their QPP authorizations and try out different special scoring scenarios. Please visit the Interactive Documentation to learn more about setting up test users in Developer Preview. | ||
| </p> | ||
|
|
||
| <h2 className='ds-h2' id='production-api-access'>Production API Access</h2> | ||
| <p className='ds-text'> | ||
| <h2 className='ds-text-heading--2xl' id='production-api-access'>Production API Access</h2> | ||
| <p className='ds-text-body--md'> | ||
| To submit data via OAuth and the Submissions API during the submission window, your application must be approved for production use by QPP. To apply for production access, you must demonstrate your application to QPP and attest that your organization: | ||
| </p> | ||
| <ul> | ||
| <li>Is a US-based company</li> | ||
| <li>Agrees to CMS API Terms of Use</li> | ||
| <li>Participated in the CMS QPP Submissions API Developer Preview</li> | ||
| </ul> | ||
| <p className='ds-text'> | ||
| <p className='ds-text-body--md'> | ||
| You will also be asked to provide: | ||
| </p> | ||
| <ul> | ||
| <li>A company website</li> | ||
| <li>A point of contact</li> | ||
| <li>URL to Application Privacy or Terms of Use</li> | ||
| </ul> | ||
| <p className='ds-text'> | ||
| <p className='ds-text-body--md'> | ||
| To request production access, please email the QPP Help Desk at [email protected] to set up a demonstration with the QPP team. In order to have sufficient time to go through the approval process, requests for production access for an upcoming submission period should be made no later than November 1 prior to submissions opening. | ||
| </p> | ||
| </div> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.