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.

Sign up for GitHub

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

Jump to bottom

Mistake in the ComprehendMedical Documentation #4122

Closed
elcho opened this issue May 10, 2024 · 2 comments
Closed

Mistake in the ComprehendMedical Documentation #4122

elcho opened this issue May 10, 2024 · 2 comments
Assignees
@tim-finnigan
Labels
documentation This is a problem with documentation. service-api This issue is caused by the service API, not the SDK implementation.

Comments

@elcho
Copy link

elcho commented May 10, 2024

Describe the issue

In the ComprehendMedical/Client/infer_rx_norm/Response Structure/Entities section, the definition for Category and Type are switched. The actual response returned sets the Type to MEDICATION and the Category to one of GENERIC_NAME or BRAND_NAME. The Response Syntax section is correct.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/comprehendmedical/client/infer_rx_norm.html
@elcho elcho added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels May 10, 2024
@tim-finnigan tim-finnigan self-assigned this May 10, 2024
@tim-finnigan tim-finnigan mentioned this issue May 10, 2024
Open
@tim-finnigan tim-finnigan added the investigating This issue is being investigated and/or work is in progress to resolve the issue. label May 10, 2024
@tim-finnigan
Copy link
Contributor

Thanks for reporting this issue, I will escalate this to the Comprehend Medical team to address this since they own the upstream InferRxNorm API / documentation. I also created an issue (aws/aws-sdk#741) to track this in our cross-SDK repository since service APIs like this are used across SDKs.

Please refer to that issue for updates going forward, and I would expect this to get fixed very soon. Thanks again for bringing this to our attention.

@tim-finnigan tim-finnigan added service-api This issue is caused by the service API, not the SDK implementation. and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. needs-triage This issue or PR still needs to be triaged. labels May 10, 2024
@github-actions GitHub Actions
Copy link

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tim-finnigan tim-finnigan

Labels
documentation This is a problem with documentation. service-api This issue is caused by the service API, not the SDK implementation.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@elcho @tim-finnigan