Need information about available rest endpoint for C-CDA R2.1 Validator for USCDI v1

[Shawon Maity]

Hi,

Do we have any rest endpoint available for C-CDA R2.1 Validator for USCDI v1?

https://ett.healthit.gov/ett/#/direct/validator/ccda/r3#ccdaValdReport

Result

[Shawon Maity]

Can we consider the below as an official one and make use of it?

https://github.com/onc-healthit/ccda-scorecard?tab=readme-ov-file#api

[Katie Crenshaw]

Hi Shawon - your ticket has been logged and someone from the technical team will be reaching out shortly. Thank you!

[Shawon Maity]

I didn't find any specific api which provides similar result as shown in the UI. 

It will be really helpful if we get such api if available.

Thanks

Shawon

[Ashwini More SITE]

Hi Shawon,

Please refer to the documentation on API here (scroll to 'Public API Usage' section): https://github.com/onc-healthit/reference-ccda-validator
Use POST request and parameters as provided in the documentation - make sure to select form-data option, that should let you simulate the option selections similar to UI for ccdaFile: file, referenceFileName: string of filename or empty & validationObjective: C-CDA_IG_Plus_Vocab. Set curesUpdate: true as you are looking to validate for USCDI v1(or other appropriate option for other validator versions).

Hope this helps.

Ashwini

[Shawon Maity]

Hi Ashwini,

Thanks for providing this information. 

I were actively using this but for last couple of days, It is providing status code 500. 

Is there any issue going on ?

[Shawon Maity]

I do see an another person has reported the same issue 

https://groups.google.com/g/edge-test-tool/c/UgUbmZOZRio/m/Eg_ZME5vAQAJ

[Kim Poletti]

Hello Shawon,

The C-CDA R2.1 Validator for USCDI v1 has been updated and no longer supports accessing the endpoint.

Please refer to the documentation on API here (scroll to 'Public API Usage' section): https://github.com/onc-healthit/reference-ccda-validator. You can still use our GUI or run directly by setting up your own from the GitHub page.

Please let me know if this answers your question.

Thank you,

Kim

[Mat Davis]

Hi Kim, this sounds like a pretty significant change.

Please provide any additional details that you can based off the following questions below:

1. There is no "Public API Usage" section that I can see when I search the link you supplied
- https://github.com/onc-healthit/reference-ccda-validator?tab=readme-ov-file 

- The README.md was changed last week according to Github

README.md
Change Public API Usage to API Usage
last week

2. There is a "5. API Usage" section and that section just points to the same link that throws the same 500 error reported in other Google Conversations

https://ccda.healthit.gov/referenceccdaservice/swagger-ui.html#/reference-ccda-validation-controller

3. True or False - the swagger documentation is no longer publicly available?

4. True or False - the API endpoints in the swagger documentation are no longer available / reachable / able to be used?

5. Are there any other publicly available solutions to support the same usage as the API endpoints and Swagger documentation besides creating a local version of the tool?

6. Can we get any further details on the C-CDA R2.1 Validator for USCDI v1 being updated?

7. Can the Swagger API documentation configuration file be provided as a download OR is it expected to be available once a local instance of the validator is installed/configured?

Thanks for your time and attention to these questions.

Mat

[James Spillman]

Hi Mat. The API and associated swagger documentation are no longer publicly available. This is a recent change. This link https://github.com/onc-healthit/reference-ccda-validator provides instructions for installing a local copy of the CCDA validator if you wish to access the API directly. Equivalent swagger documentation will be available on a local install.

Have you found an issue with the CCDA R2.1 validator for USCDI v1?

-James

[Mat Davis]

Hi James.

Thanks for your follow up. 

This is a pretty big change in my opinion and more info and more heads up of the Swagger documentation as well as the API endpoints not being available could have been provided beforehand.

Review Of Your Feedback

"Have you found an issue with the CCDA R2.1 validator for USCDI v1?"

• I have not but an "update to the CCDA R2.1 validator for USCDI v1" was mentioned as the reason why the Swagger and API endpoints are no longer available.
• It's not clear how that update caused the Swagger and API endpoints to not be available. (security reasons, not enough usage, reduction in maintenance?)

Review Of My Questions For Others To See In The Future

1. The README.MD was partially updated to remove the word "Public"

2. There is a "5. API Usage" section

• the following URL needs to be removed or at least updated to be localhost vs the previous URL https://ccda.healthit.gov/referenceccdaservice/swagger-ui.html#/reference-ccda-validation-controller
• even a custom error page could be created to simply say "This public service is no longer available. Please install the Validator locally using the following Github link {INSERT GITHUB LINK}"

3. True or False - the swagger documentation is no longer publicly available? 

TRUE

4. True or False - the API endpoints in the swagger documentation are no longer available / reachable / able to be used? 

TRUE

5. Are there any other publicly available solutions to support the same usage as the API endpoints and Swagger documentation besides creating a local version of the tool? 

Looks like NO

6. Can we get any further details on the C-CDA R2.1 Validator for USCDI v1 being updated? 

Looks like NO

7. Can the Swagger API documentation configuration file be provided as a download OR is it expected to be available once a local instance of the validator is installed/configured? 

Local instance is expected to be used to access all previous Swagger and API endpoint functionality

Thanks - Mat