Usage Instructions For "content-validator-api" Github

83 views
Skip to first unread message

Mat Davis

unread,
Aug 4, 2024, 1:18:15 AM8/4/24
to Edge Test Tool (ETT)
Hi all.

As there is a  big push to have end users utilize local instances of services that were once publicly available, can detailed instructions be added to the following Github project?

https://github.com/onc-healthit/content-validator-api

This will allow those who are not familiar with Java centric projects to have a solid starting point.

Thanks - Mat

Mat Davis

unread,
Aug 4, 2024, 10:23:05 AM8/4/24
to Edge Test Tool (ETT)
Follow Up
1. Looks like the main target I needed to start with was actually the reference-ccda-validator-api repo
    > https://github.com/onc-healthit/reference-ccda-validator

    > This ReadMe.md has pretty reliable documentation but the overall tasks from end to end still can feel daunting
    > In the end, it was less complicated than I thought but only in hindsight 

    > A minor documentation improvement can also be made so newbies aren't trying to hit the http://localhost:8080/referenceccdaservice/ endpoint as mentioned in the documentation
    > Focusing on the UI Page and the Swagger Page can improve the feeling of accomplishment, especially if you aren't familiar with Java, Tomcat, .war files, etc

       2024-08-04_09h06_05.png
2. The content-validator-api works in conjunction with the reference-ccda-validator-api
    > This has the least helpful README.md
    > I just happened to start on this repo 1st because I was browsing the ONC Github and it was the 1st API that I came across

3. Then there's also the code-validator-api that works in conjuction with the reference-ccda-validator-api for codesystems and valuesets
    https://github.com/onc-healthit/code-validator-api/tree/master/codevalidator-api/docs
    > The README.md here is also helpful and has more than just a line or two in direction/instruction

4. The most helpful resource was really the Google Group history over the years from so many trying to do and achieve the same thing
    > I hope the screenshots and info I'm providing can help the next person who isn't quite sure - search for "API", "Validator", "reference"
    >  https://groups.google.com/g/edge-test-tool/c/N0pZQ_Bgtw8
    >  https://groups.google.com/g/edge-test-tool/c/pPOlIlgTEuc   

Progress
  1. I was able to successfully launch Tomcat Manager and then navigate to the 3 pages that indicated success
  2. I was also able to confirm the MDHT Conformance validation matched the EdgeTestingTool validation results as well
  3. If you're looking for additional guidance on your 1st POST request to get results, make sure to scroll to 5. API Usage - https://github.com/onc-healthit/reference-ccda-validator

  4. Working on the Vocabulary Validation may be more work than its worth at this time
  5. My ultimate goal is as much automation as possible to provide Continuous Integration and Regression Testing
  6. All in all, just glad to be able to have the usefulness of this API back available via a local instance

  7.            2024-08-04_09h10_03.png

                2024-08-04_09h07_01.png

                        2024-08-04_09h07_30.png

Thanks - Mat

Kim Poletti

unread,
Aug 7, 2024, 10:01:33 AM8/7/24
to Edge Test Tool (ETT)
Hi Mat,

Thank you for this suggestion. The team will review and keep you posted on the outcome.

Best,
Kim

Mat Davis

unread,
Aug 7, 2024, 5:27:49 PM8/7/24
to Kim Poletti, Edge Test Tool (ETT)
Thank you Kim. 

I'll add some additional feedback after installing from scratch for the 3rd time. 

My 1st 2x have been successful and the process gets more and more comfortable.

Mat

--
You received this message because you are subscribed to the Google Groups "Edge Test Tool (ETT)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to edge-test-too...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/edge-test-tool/703b0096-7726-4c6a-b228-fe95a856f3adn%40googlegroups.com.
Reply all
Reply to author
Forward
0 new messages