-
Notifications
You must be signed in to change notification settings - Fork 16
BCDA-9415: Update v3 capabilitystatement #1210
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
Conversation
SearchParam: []*fhircapabilitystatement.CapabilityStatement_Rest_Resource_SearchParam{ | ||
restResourceSearchParam("_since", fhircodes.SearchParamTypeCode_DATE, "Return resources updated after the date provided for existing enrollees and all resources for newly attributed enrollees."), | ||
restResourceSearchParam("_type", fhircodes.SearchParamTypeCode_STRING, "Comma-delimited list of FHIR resource types to include in the export. By default, all supported resource types are returned."), | ||
restResourceSearchParam("_typeFilter", fhircodes.SearchParamTypeCode_STRING, "Use a URL-encoded FHIR subquery to further-refine group export results."), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to validate if the params are properly URL encoded?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ya, good question: we do some validation here:
bcda-app/bcda/web/middleware/validation.go
Line 131 in 606b7be
// validate _typeFilter params |
If we do update the validation, I think it'd be in a follow-up / outside the scope of this ticket, which is focused on updates to the CapabilityStatement
{ | ||
Type: &fhircapabilitystatement.CapabilityStatement_Rest_Resource_TypeCode{Value: fhircodes.ResourceTypeCode_EXPLANATION_OF_BENEFIT}, | ||
SearchParam: []*fhircapabilitystatement.CapabilityStatement_Rest_Resource_SearchParam{ | ||
restResourceSearchParam("_tag", fhircodes.SearchParamTypeCode_STRING, "Filter claims by adjudication status: either Adjudicated or PartiallyAdjudicated"), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we validate _tag
against allowed values ("Adjudicated", "PartiallyAdjudicated")?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on the discussion with BCDA and BFD, I think that is going to be the strategy: explicitly checking and validating each parameter before we pass to BFD.
So yes, we should. But it should also be in a follow-up ticket/PR
🎫 Ticket
https://jira.cms.gov/browse/BCDA-9415
🛠 Changes
Updated the V3 CapabilityStatement:
ℹ️ Context
Guidance changes in the STU3 veresion of the Bulk Data IG to correct for the operation name. This updates our capabilityStatement to have the correct value for v3.
In addition to updating the operation name, we were also lacking documentation about our supported filtering parameters. Added documentation for _type, _since, _typeFilter, and the _typeFilter subquery: ExplanationOfBenefit._tag parameter
🧪 Validation
Hit the
/metadata
and confirm the new elements are returned in the CapabilityStatement resource for only the demo/v3 endpointv1 and v2 should be unchanged.
unit tests pass