Implement updates to the API Programmer's Guide online content + PDF (#…

…16450)

* Implement updates to the API Programmer's Guide online content + PDF
Fixes #16289

frontend-react/e2e/helpers/internal-links.ts

@@ -74,8 +74,4 @@ export const developerResourcesApiSideNav = [
         name: "Responses from ReportStream",
         path: "/developer-resources/api/documentation/responses-from-reportstream",
     },
-    {
-        name: "Sample payloads and output",
-        path: "/developer-resources/api/documentation/sample-payloads-and-output",
-    },
 ];

frontend-react/e2e/spec/all/public/developer-resources/api/documentation/sample-payloads-and-output.spec.ts

@@ -35,7 +35,8 @@ const test = baseTest.extend<SecurityPageFixtures>({
     },
 });
 
-test.describe(
+// Page currently archived
+test.describe.skip(
     "Developer Resources / API / Documentation / Sample payloads and output page",
     {
         tag: "@smoke",

frontend-react/public/sitemap.xml

@@ -63,9 +63,6 @@
     <url>
         <loc>https://reportstream.cdc.gov/developer-resources/api/documentation/responses-from-reportstream</loc>
     </url>
-    <url>
-        <loc>https://reportstream.cdc.gov/developer-resources/api/documentation/sample-payloads-and-output</loc>
-    </url>
     <url>
         <loc>https://reportstream.cdc.gov/support</loc>
     </url>

frontend-react/src/AppRouter.tsx

@@ -45,11 +45,12 @@ const ManagingYourConnectionIndex = lazy(
     lazyRouteMarkdown(() => import("./content/managing-your-connection/index.mdx")),
 );
 const SupportIndex = lazy(lazyRouteMarkdown(() => import("./content/support/index.mdx")));
-const ReportStreamApiDocumentationPayloads = lazy(
+// Page currently archived
+/*const ReportStreamApiDocumentationPayloads = lazy(
     lazyRouteMarkdown(
         () => import("./content/developer-resources/reportstream-api/documentation/SamplePayloadsAndOutput.mdx"),
     ),
-);
+);*/
 
 /* Public Pages */
 const TermsOfService = lazy(() => import("./pages/TermsOfService"));
@@ -269,13 +270,14 @@ export const appRoutes: RouteObject[] = [
                                             isContentPage: true,
                                         },
                                     },
-                                    {
+                                    // Page currently archived
+                                    /*{
                                         path: "sample-payloads-and-output",
                                         element: <ReportStreamApiDocumentationPayloads />,
                                         handle: {
                                             isContentPage: true,
                                         },
-                                    },
+                                    },*/
                                 ],
                             },
                         ],

frontend-react/src/config/index.ts

@@ -4,6 +4,7 @@ import { WidgetOptions } from "@okta/okta-signin-widget";
 import type { Feature } from "@okta/okta-signin-widget";
 import type { IIdleTimerProps } from "react-idle-timer";
 
+import site from "../content/site.json";
 import type { ConsoleLevel } from "../utils/rsConsole/rsConsole";
 
 const envVars = {
@@ -118,7 +119,7 @@ const config = {
         } satisfies Partial<Record<Feature, boolean>>,
         useClassicEngine: false,
         helpLinks: {
-            help: "https://app.smartsheetgov.com/b/form/95d2f16b772c42d8aaa0ef5db28a6838",
+            help: site.forms.contactUs.url,
         },
         i18n: {
             // Overriding English properties

frontend-react/src/content/about/index.mdx

@@ -9,6 +9,9 @@ meta:
             src: /assets/img/opengraph/reportstream-tagline.png
             altText: "ReportStream. CDC's free, single connection to streamline your data transfer and improve public health. The words are surrounded by illustration of lines and boxes connected by colorful dots."
 ---
+
+import site from "../site.json";
+
 <HeroWrapper>
     <div className="grid-container">
         <div className="grid-row grid-gap margin-y-3">
@@ -126,7 +129,7 @@ meta:
         <CardGroup>
             <Card gridLayout={{col: "fill"}}>
                 <CardHeader typeof="div">
-                    ### <A href="/assets/pdf/ReportStream_Onepager_20240605.pdf" target="_blank">ReportStream overview PDF <Icon name='FileDownload'/></A>
+                    ### <A href={site.assets.onePager.path} target="_blank">ReportStream overview PDF <Icon name='FileDownload'/></A>
                 </CardHeader>
                 <CardBody>
                     Download a quick summary of ReportStream that you can print and share.

frontend-react/src/content/about/news.mdx

@@ -41,4 +41,4 @@ While the pilot focused on flu data, the goal was to create solutions that laid
 
 As we celebrate the success of the flu pilot, we'll be conducting further tests on other conditions with multiple partners. We are excited for the future of scaling these results so ReportStream can send a broad range of reportable public health data.
 
-If you are interested in sending or receiving flu data, <A href="https://app.smartsheetgov.com/b/form/48f580abb9b440549b1a9cf996ba6957">connect with us</A> and we’ll discuss when and how your organization can start.
+If you are interested in sending or receiving flu data, <A href={site.forms.connectWithRS.url}>connect with us</A> and we’ll discuss when and how your organization can start.

frontend-react/src/content/about/our-network.mdx

@@ -12,6 +12,7 @@ backToTop: true
 ---
 import Sidenav from "./sidenav.mdx"
 import usamapsvg from "../usa_w_territories.svg"; // in /content dir to get unique filename per build
+import site from "../site.json"
 
 <LayoutSidenav>
 <Sidenav />
@@ -22,7 +23,7 @@ import usamapsvg from "../usa_w_territories.svg"; // in /content dir to get uniq
 
 State, local, and territorial agencies across the United States rely on ReportStream to make accurate, timely public health responses.
 
-Don't see your state or territory? [Connect with us](https://app.smartsheetgov.com/b/form/48f580abb9b440549b1a9cf996ba6957).
+Don't see your state or territory? <A href={site.forms.connectWithRS.url}>Connect with us</A>.
 
 <figure>
     <img src={usamapsvg} alt="Map of states using ReportStream" />

frontend-react/src/content/about/release-notes.mdx

@@ -11,6 +11,7 @@ meta:
 backToTop: true
 ---
 import Sidenav from "./sidenav.mdx"
+import site from "../site.json"
 
 <LayoutSidenav>
 <Sidenav/>
@@ -508,9 +509,9 @@ You may also be interested in:
                     pandemics and gives us more flexibility for future
                     data types in public health. If your jurisdiction is
                     interested in REST/HTTP transport,{" "}
-                    <a href="https://app.smartsheetgov.com/b/form/48f580abb9b440549b1a9cf996ba6957">
+                    <A href={site.forms.connectWithRS.url}>
                         connect with our team
-                    </a>
+                    </A>
                     .
                 </p>
             ),

frontend-react/src/content/about/security.mdx

@@ -10,6 +10,7 @@ meta:
             altText: "An abstract illustration of screens and a document."
 ---
 import Sidenav from "./sidenav.mdx"
+import site from "../site.json"
 
 <LayoutSidenav>
 <Sidenav/>
@@ -103,7 +104,7 @@ ReportStream is committed to handling data securely and reliably. From federal r
         headingLevel:"h3",
         title: "How does ReportStream send data?",
         content: (<p>
-            ReportStream transports data through Secure File Transfer Protocol (SFTP) or a REST API. Public health entities can request data be sent in real time or batched according to their needs. ReportStream transports data through Secure File Transfer Protocol (SFTP) or a REST API. Public health entities can request data be sent in real time or batched according to their needs. If you are a public health entity interested in another transport method, <A href="https://app.smartsheetgov.com/b/form/48f580abb9b440549b1a9cf996ba6957">contact our team</A> to explore your options. 
+            ReportStream transports data through Secure File Transfer Protocol (SFTP) or a REST API. Public health entities can request data be sent in real time or batched according to their needs. ReportStream transports data through Secure File Transfer Protocol (SFTP) or a REST API. Public health entities can request data be sent in real time or batched according to their needs. If you are a public health entity interested in another transport method, <A href={site.forms.connectWithRS.url}>contact our team</A> to explore your options. 
         </p>)
     },
     {

frontend-react/src/content/developer-resources/reportstream-api/ReportStreamApi.mdx

@@ -27,7 +27,7 @@ import site from "../../site.json";
         </Card>
         <Card gridLayout={{col: "fill"}}>
             <CardHeader><span className="font-sans-lg">[Documentation](documentation)</span></CardHeader>
-            <CardBody>Details on our data model and sample responses, inputs and outputs to assist you in our set up and use of the ReportStream API.</CardBody>
+            <CardBody>Details on our sample responses to assist you in our set up and use of the ReportStream API.</CardBody>
         </Card>
     </CardGroup>
 

frontend-react/src/content/developer-resources/reportstream-api/Sidenav.mdx

@@ -6,9 +6,6 @@
                     <USNavLink href="/developer-resources/api/documentation/responses-from-reportstream#response-messages">Response messages</USNavLink>,
                     <USNavLink href="/developer-resources/api/documentation/responses-from-reportstream#json-error-responses">JSON error responses</USNavLink>,
             ]}>Responses from ReportStream</SideNavItem>,
-            <SideNavItem href="/developer-resources/api/documentation/sample-payloads-and-output" items={[
-                    <USNavLink href="/developer-resources/api/documentation/sample-payloads-and-output#sample-hl7-251-payload-and-output">Sample HL7 v2.5.1 payload and output</USNavLink>,
-            ]}>Sample payloads and output</SideNavItem>,
     ]}>Documentation</SideNavItem>,
 ]}>
 </SideNav>

frontend-react/src/content/developer-resources/reportstream-api/documentation/Documentation.mdx

@@ -1,7 +1,7 @@
 ---
 meta:
     title: ReportStream API documentation
-    description: Details on our data model and sample responses, inputs and outputs to assist you in your set up and use of the ReportStream API.
+    description: Details on our sample responses to assist you in your set up and use of the ReportStream API.
     openGraph:
         image:
             src: /assets/img/opengraph/reportstream-tagline.png
@@ -28,21 +28,9 @@ import Sidenav from "../Sidenav.mdx";
             ReportStream responds to each API call with a response (JSON formatted) about the disposition of your data.
 
             **On this page:**
-            * [Errors and warnings](responses-from-reportstream#errors-and-warnings)
             * [Response messages](responses-from-reportstream#response-messages)
             * [JSON error responses](responses-from-reportstream#json-error-responses)
         </CardBody>
     </Card>
-    <Card className="width-full">
-        <CardHeader typeof="div">
-            ## [Sample payloads and outputs](sample-payloads-and-output)
-        </CardHeader>
-        <CardBody>
-            Samples are provided for HL7 inputs and responses.
-
-            **On this page:**
-            * [Sample HL7 2.5.1 payload and output](sample-payloads-and-output#sample-hl7-251-payload-and-output)
-        </CardBody>
-    </Card>
 </CardGroup>
 </LayoutMain>

frontend-react/src/content/developer-resources/reportstream-api/documentation/SamplePayloadsAndOutput.mdx

@@ -1,4 +1,5 @@
 ---
+# Page currently archived
 meta:
     title: ReportStream API sample payloads and output
     description: Sample payloads and output for HL7 and CSV submissions to ReportStram's API

frontend-react/src/content/developer-resources/reportstream-api/getting-started/GettingStarted.mdx

@@ -13,6 +13,7 @@ import Step2 from "./Step2.mdx";
 import Step3 from "./Step3.mdx";
 import Step4 from "./Step4.mdx";
 import Sidenav from "../Sidenav.mdx";
+import site from "../../../site.json";
 
 <LayoutSidenav><Sidenav /></LayoutSidenav>
 
@@ -24,24 +25,26 @@ import Sidenav from "../Sidenav.mdx";
 Examples in this guide use curl commands for simplicity with the assumption you’ll be coding these calls into your sending system.
 You can also use a program like Postman to test submissions.
 
-<p className="text-base">**Last updated:** 9/9/24</p>
+<p className="text-base">**Last updated:** 11/4/24</p>
 
 ***
 
 <h2 className="rs-numbered">Format and validate a fake data file</h2>
 
 To prepare your file for testing, set up a sample file with fake data (artificially created, non-PII data).
 
-Currently, ReportStream can accept either HL7 or FHIR data. 
-We can send you a file with fake data to review that will always successfully validate against the NIST HL7v2 validator. 
-Note that because the data in those files are computer-generated, it may not feel realistic in some places.
+Currently, ReportStream can accept either HL7 or FHIR data. We can provide a sample HL7 file with fake data 
+to review <A href={site.forms.contactUs.url}>upon request</A>.
 
 <Alert type="tip">For this step, you can refer to formatting requirements for 
 [HL7v2.5.1 ORU-R01](https://www.hl7.org/implement/standards/product_brief.cfm?product_id=185) or 
 [RADxMARS](https://www.nibib.nih.gov/covid-19/radx-tech-program/mars/hl7v2-getting-started) for OTC (over the counter) test data.</Alert>
 
-When you’ve formatted your fake (non-PII) data file, test your data model using using the 
-[NIST General Validation Tool](https://hl7v2-gvt.nist.gov/gvt/#/home), and correct any errors you receive. 
+When you’ve formatted your fake (non-PII) data file, test your data model using the
+<A href={site.external.nistValidationSuite.url}>NIST Electronic Lab Reporting (ELR) Validation Suite</A>. 
+(Note: If you’re testing OTC data, use the <A href={site.external.nistGeneralValidationTool.url}>NIST HL7 General Validation Tool</A> and 
+select “RADx MARS HL7v2” from the tool scope dropdown. Navigate to the “Context-free” tab and select the “Onboarding” profile group).
+Correct any errors you receive.
 
 <h2 className="rs-numbered">Set up authentication and test your API connection</h2>
 

frontend-react/src/content/getting-started/receiving-data.mdx

@@ -12,7 +12,7 @@ backToTop: true
 ---
 
 import Sidenav from "./sidenav.mdx"
-import site from "../../content/site.json";
+import site from "../site.json";
 
 <LayoutSidenav>
     <Sidenav/>
@@ -86,7 +86,7 @@ Connecting to ReportStream is similar to setting up an Electronic Lab Reporting
 
 <h2 id="anchor-what-you-need">What you need</h2>
 
-In addition to gathering your team and setting aside time for the weekly calls, you’ll need to provide us with more information about your requirements and preferences. Our [onboarding form](https://app.smartsheetgov.com/b/form/b0935d5d1e924c57b2d293b4ed0f2cd5) collects the specific details about your needs.
+In addition to gathering your team and setting aside time for the weekly calls, you’ll need to provide us with more information about your requirements and preferences. Our <A href={site.forms.intakeElr.url}>onboarding form</A> collects the specific details about your needs.
 
 Review what you need to gather to start onboarding.
 
@@ -209,7 +209,7 @@ Once you have all the information you need, submit the onboarding form. We'll ge
 <CardGroup>
     <Card gridLayout={{ tablet: { col: 4 } }}>
         <CardHeader>
-            ### <A href="/assets/pdf/ReportStream_Onepager_20240605.pdf" target="_blank">ReportStream overview PDF <Icon name='FileDownload'/></A>
+            ### <A href={site.assets.onePager.path} target="_blank">ReportStream overview PDF <Icon name='FileDownload'/></A>
         </CardHeader>
         <CardBody>
             Download a quick summary of ReportStream that you can print and share.

frontend-react/src/content/getting-started/sending-data.mdx

@@ -11,6 +11,7 @@ meta:
 backToTop: true
 ---
 import Sidenav from "./sidenav.mdx"
+import site from "../site.json";
 
 <LayoutSidenav>
 <Sidenav/>
@@ -35,7 +36,7 @@ From the start, we work with your unique requirements and preferences to create
         headingLevel:"h3",
         title: "2. Complete interest form",
         content: (<>
-        <p>Let us know you want to get started by filling out and submitting the <A href="https://app.smartsheetgov.com/b/form/8c71931f25e64e42bf1fef32900bdecd" target="_blank">interest form</A>. You’ll answer a few questions about your needs, like how many messages you might be sending and data format.</p>
+        <p>Let us know you want to get started by filling out and submitting the <A href={site.forms.healthcareOrganizationInterest.url} target="_blank">interest form</A>. You’ll answer a few questions about your needs, like how many messages you might be sending and data format.</p>
         <p>Our terms of service is also available to review in the interest form. You’ll need to agree to our <A href="/terms-of-service">terms of service</A> before you begin sending data. You can sign this at any point during your onboarding or when you fill out the form.</p>
         <p>Our team will be in touch within 48 hours of receiving your form to schedule a kickoff call.</p>
         </>),
@@ -67,7 +68,7 @@ From the start, we work with your unique requirements and preferences to create
 ]} />
 If you're not connected with a ReportStream team member yet, get started by letting us know more about your needs.
 
-<A className="usa-button" href="https://app.smartsheetgov.com/b/form/48f580abb9b440549b1a9cf996ba6957" target="_blank">Get started</A>
+<A className="usa-button" href={site.forms.connectWithRS.url} target="_blank">Get started</A>
 
 {
 /* pending approval
@@ -109,7 +110,7 @@ Multiple jurisdictions, multiple formats and requirements. Just one connection f
 <Card gridLayout={{tablet: {col: 4}}}>
 
 <CardHeader>
-### <A href="/assets/pdf/ReportStream_Onepager_20230621.pdf" target="_blank">ReportStream overview PDF <Icon name='FileDownload'/></A>
+### <A href={site.assets.onePager.path} target="_blank">ReportStream overview PDF <Icon name='FileDownload'/></A>
 </CardHeader>
 <CardBody>
 Download a quick summary of ReportStream that you can print and share.

frontend-react/src/content/managing-your-connection/refer-healthcare-organizations.mdx

@@ -11,6 +11,7 @@ meta:
 backToTop: true
 ---
 import Sidenav from "./sidenav.mdx";
+import site from "../site.json";
 
 <LayoutSidenav>
 <Sidenav/>
@@ -68,7 +69,7 @@ You don’t have to track the varying needs of different jurisdictions.
 
 **Choose your platform and get started:**
 
-- To send ELR data through HL7 or FHIR: [Contact ReportStream](https://app.smartsheetgov.com/b/form/48f580abb9b440549b1a9cf996ba6957) and learn more at [reportstream.cdc.gov](https://reportstream.cdc.gov).  
+- To send ELR data through HL7 or FHIR: <A href={site.forms.connectWithRS.url}>Contact ReportStream</A> and learn more at [reportstream.cdc.gov](https://reportstream.cdc.gov).  
 - To report through single entry or CSV upload: [Sign up for SimpleReport](https://www.simplereport.gov/getting-started/organizations-and-testing-facilities/onboard-your-organization/) and learn more at [simplereport.gov](https://simplereport.gov). 
 
 We’ve been encouraged by our work with ReportStream and SimpleReport and how they are helping other organizations. We hope it will simplify your data transfer as well.  
@@ -95,4 +96,4 @@ And you can easily report to other jurisdictions through the same, single connec
 If you’re interested, go to [reportstream.cdc.gov](https://reportstream.cdc.gov) to learn more, or email the team at [[email protected]](mailto:[email protected]).
 </SummaryBox>
 
-[Let us know](https://app.smartsheetgov.com/b/form/48f580abb9b440549b1a9cf996ba6957) if we can provide any additional content, such as a logo or more copy.
+<A href={site.forms.connectWithRS.url}>Let us know</A> if we can provide any additional content, such as a logo or more copy.

frontend-react/src/content/site.json

@@ -41,17 +41,32 @@
     "contactUs": {
       "name": "Contact us",
       "url": "https://app.smartsheetgov.com/b/form/95d2f16b772c42d8aaa0ef5db28a6838"
+    },
+    "healthcareOrganizationInterest": {
+      "name": "Healthcare Organization Interest Form",
+      "url": "https://app.smartsheetgov.com/b/form/8c71931f25e64e42bf1fef32900bdecd"
     }
   },
   "assets": {
     "standardCsv": {
       "path": "/assets/csv/ReportStream-StandardCSV-ExampleData-20220509.csv"
     },
     "programmersGuidePdf": {
-      "path": "/assets/pdf/ReportStream-Programmers-Guide-v4.6.pdf"
+      "path": "/assets/pdf/ReportStream-Programmers-Guide-v4.7.pdf"
     },
     "exampleHl7": {
       "path": "/assets/hl7/Example-hl7-file.hl7"
+    },
+    "onePager": {
+      "path": "/assets/pdf/ReportStream_Onepager_20240605.pdf"
+    }
+  },
+  "external": {
+    "nistValidationSuite": {
+      "url": "https://hl7v2-elr-testing.nist.gov/mu-elr/"
+    },
+    "nistGeneralValidationTool": {
+      "url": "https://hl7v2-gvt.nist.gov/gvt/#/home"
     }
   }
 }