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

BCDA-8154: Update capabilitystatement operation names #945

Merged
merged 2 commits into from
May 30, 2024

Conversation

alex-dzeda
Copy link
Contributor

@alex-dzeda alex-dzeda commented May 24, 2024

🎫 Ticket

https://jira.cms.gov/browse/BCDA-8154

🛠 Changes

Updated Operation names to meet FHIR spec

ℹ️ Context for reviewers

Names of operations in a CapabilityStatement should refer to, conceptually, an OperationDefinition code. In the case of an operation such as Patient/$export for the bulk FHIR IG, the parameter used to instantiate the operation is export, so patient-export should be changed to export.
There is also some odd auto-linting with this, which appears to go away after this is merged?

✅ Acceptance Validation

Updated + passed unit tests.

🔒 Security Implications

  • This PR adds a new software dependency or dependencies.
  • This PR modifies or invalidates one or more of our security controls.
  • This PR stores or transmits data that was not stored or transmitted before.
  • This PR requires additional review of its security implications for other reasons.

If any security implications apply, add Jason Ashbaugh (GitHub username: StewGoin) as a reviewer and do not merge this PR without his approval.

@alex-dzeda alex-dzeda marked this pull request as ready for review May 24, 2024 18:27
@@ -256,15 +256,15 @@ func CreateCapabilityStatement(reldate time.Time, relversion, baseurl string) *f
},
Operation: []*fhirmodels.CapabilityStatement_Rest_Operation{
{
Name: &fhirdatatypes.String{Value: "patient-export"},
Name: &fhirdatatypes.String{Value: "export"},
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actual change 1

Definition: &fhirdatatypes.Reference{
Reference: &fhirdatatypes.Reference_Uri{
Uri: &fhirdatatypes.String{Value: "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/patient-export"},
},
},
},
{
Name: &fhirdatatypes.String{Value: "group-export"},
Name: &fhirdatatypes.String{Value: "export"},
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actual change 2

@@ -252,13 +252,13 @@ func CreateCapabilityStatement(reldate time.Time, relversion, baseurl string) *f
},
Operation: []*fhirmodelCS.CapabilityStatement_Rest_Resource_Operation{
{
Name: &fhirdatatypes.String{Value: "patient-export"},
Name: &fhirdatatypes.String{Value: "export"},
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actual change 1

Definition: &fhirdatatypes.Canonical{
Value: "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/patient-export",
},
},
{
Name: &fhirdatatypes.String{Value: "group-export"},
Name: &fhirdatatypes.String{Value: "export"},
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actual change 2

Copy link
Contributor

@laurenkrugen-navapbc laurenkrugen-navapbc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this! Do we have docs on how to test for conformance within the BCDA-api? Might be useful in the readme, thoughts?

@alex-dzeda
Copy link
Contributor Author

Thanks for catching this! Do we have docs on how to test for conformance within the BCDA-api? Might be useful in the readme, thoughts?

I think this might be a larger initiative, and partially dependent upon what the DASG direction is for conformance; do all APIs need to pass Inferno testing? If so, then building it into regression may be an answer, for example. I can make some local instructions for us to test using inferno locally (to satisfy curiosity), but it may not be ready yet to put into a readme for the repo, until there's more direction

@alex-dzeda alex-dzeda merged commit 7ee0535 into main May 30, 2024
3 checks passed
@alex-dzeda alex-dzeda deleted the alex/bcda-8154 branch May 30, 2024 11:33
alex-dzeda added a commit that referenced this pull request Jun 10, 2024
alex-dzeda added a commit that referenced this pull request Jun 10, 2024
Reverts #945

After further inspection, the warning we were getting with inferno
appears to be a red herring. I've checked the V2 bulk api specification,
and it clearly states that patient-export and group-export are the
expected names.
https://hl7.org/fhir/uv/bulkdata/CapabilityStatement-bulk-data.json.html
(My bad)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants