Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Engagment/13845 testing plan documentation #15827

Merged
merged 16 commits into from
Dec 23, 2024
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,14 @@ After updating the receiver to route messages to the UP it should look like this
At the time this documentation was written the only sender onboarded to the UP is SimpleReport.
Therefore, to test sending reports to STLTs we can only use reports generated from SimpleReport.
The most up to date messages can be found here:
* [UP SR FHIR bundle](./samples/SimpleReport/SR_UP_02262024.fhir)
* [CP SR CSV message](./samples/SimpleReport/SR_CP_02262024.csv)
* [UP SR FHIR bundle](../onboarding-users/samples/SimpleReport/SR_UP_02262024.fhir)
* [CP SR CSV message](../onboarding-users/samples/SimpleReport/SR_CP_02262024.csv)
However, they continue making updates to their messages so a more up-to-date message can be retrieved by following these instructions: [Simple Report Test data](#simple-report-test-data)
Make sure to update the patient state or facility state to match the jurisdictional filter of the state being migrated.

After deciding what message to use the following postman collections can be used to send reports using ReportStream's API as a Simple Report Covid and UP sender.
* [SimpleReport covid postman collection](./samples/SimpleReport/Simple%20Report%20Covid.postman_collection.json)
* [SimpleReport UP postman collection](./samples/SimpleReport/Simple%20Report%20UP.postman_collection.json)
* [SimpleReport covid postman collection](../onboarding-users/samples/SimpleReport/Simple%20Report%20Covid.postman_collection.json)
* [SimpleReport UP postman collection](../onboarding-users/samples/SimpleReport/Simple%20Report%20UP.postman_collection.json)
Make sure to replace the Body request with a most up-to-date message if needed.

The API will return a Submission Id and report Id that can be used to find the status of the submission by calling this API:
Expand Down Expand Up @@ -170,6 +170,8 @@ If the receiver has any of the following settings enabled they will need a recei
- useOrderingFacilityName not STANDARD
- receivingOrganization
- stripInvalidCharsRegex
- deidentify
- deidentifiedValue

Examples on how to create and set-up a receiver schema can be found under `src/main/resources/hl7_mapping/receivers/STLTs`
More information on how transforms in the UP work can be found in the [transform design doc](../design/design/transformations.md)
Expand Down Expand Up @@ -217,7 +219,7 @@ Once we have data we can notify the STLT to start reviewing the messages.
A quick and easy way to get test data to send to a STLT is by going into SimpleReport's test environment https://test.simplereport.gov.
* Access can be requested on the [shared-simple-report-universal-pipeline](https://nava.slack.com/archives/C0411VC78DN) thread.
* Instructions on how to send a test message can be found on this youtube playlist https://www.youtube.com/playlist?list=PL3U3nqqPGhab0sys3ombZmwOplRYlBOBF.
* The file [SR upload](./samples/SimpleReport/SR-UPLOAD.csv) can be used test sending reports through SimpleReport's CSV upload.
* The file [SR upload](../onboarding-users/samples/SimpleReport/SR-UPLOAD.csv) can be used test sending reports through SimpleReport's CSV upload.
* To route the report to a specific STLT either the patient or facility state needs to updated to the STLT's jurisdiction. Keep in mind that if they are not updated the message might get routed to the incorrect STLT.
* The report sent by SimpleReport can be found in the Azure BlobStorage. The UP message will be stored in the `receive/simple_report.fullelr` and the covid pipeline message will be stored in `receive/simple_report.default`. This message can be used locally to test any new sender or receiver transforms.
* To access the blob storage. Microsoft Storage Explorer needs to be installed and login with your CDC SU credentials.
Expand All @@ -232,12 +234,12 @@ Sometimes STLTs use the same SFTP server or REST endpoint for test and productio
* A spreadsheet that keeps track of where to find a receiver's transport and their status can be found here: https://cdc.sharepoint.com/:x:/r/teams/ReportStream/_layouts/15/doc2.aspx?sourcedoc=%7B28EDE785-0FC9-4921-BCD0-B423F3C5E92A%7D&file=Receiver%20Staging%20Connection%20Test%20-%20Jan%202024.xlsx&action=default&mobileredirect=true
* If the transport can't be found we'll need to get that information from the STLT during the kick-off call and request new credentials if necessary.

Once the STLT's transport has been found. It can be tested by following these instructions [How to Check Transport](./transport/how-to-check-transport.md)
Once the STLT's transport has been found. It can be tested by following these instructions [How to Check Transport](../onboarding-users/transport/how-to-check-transport.md)
* Status returns "Network error": This probably means their SFTP server needs to be whitelisted.
* Status returns anything related to credentials: This probably means the credentials were not created correctly or are not present.
* Instructions on how to create credentials can be found here:
* [REST](./transport/rest.md)
* [SFTP](./transport/sftp.md)
* [REST](../onboarding-users/transport/rest.md)
* [SFTP](../onboarding-users/transport/sftp.md)


## How to check if STLT needs to be whitelisted
Expand Down
6 changes: 3 additions & 3 deletions prime-router/docs/onboarding-users/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This section is a step by step walkthrough for an Engagement Engineer (not an ex
Walkthrough for setting up a new sender/receiver with an Okta account
The first step to onboarding a new organization to ReportStream is to set up their Okta Account.

- [Okta account creation](./okta-account-creation.md)
- [Okta account creation](okta/okta-account-creation.md)


## How to Onboard to ReportStream
Expand All @@ -14,5 +14,5 @@ After setting up an Okta account for the receiver/sender the next step is to co
sending or receiving data:

- [Configuring a new sender](sender-onboarding/senders.md)
- [Configuring a new receiver](./receivers.md)
- [Migrating from the legacy pipeline](./migration.md)
- [Configuring a new receiver](receiver-onboarding/receivers.md)
- [Migrating from the legacy pipeline](../migrating-users/migration.md)
Binary file not shown.
Loading
Loading