Fix incorrect CDS response examples in Health Tool documentation#10207
Open
Nadeesha-D-Shalom wants to merge 5 commits intoballerina-platform:masterfrom
Open
Fix incorrect CDS response examples in Health Tool documentation#10207Nadeesha-D-Shalom wants to merge 5 commits intoballerina-platform:masterfrom
Nadeesha-D-Shalom wants to merge 5 commits intoballerina-platform:masterfrom
Conversation
Minor capitalization fixes for consistency without altering policy meaning.
This PR fixes minor capitalization inconsistencies in the privacy policy to improve grammatical consistency, without altering the policy meaning or intent.
Standardized capitalization for "Hello World" titles to improve consistency across the navigation.
Fix capitalization of “Hello World” titles in BBE navigation
Corrects the CDS template generation documentation to show proper CDS card responses instead of FHIR resource examples.
Nadeesha-D-Shalom
requested review from
anupama-pathirage,
keizer619 and
sm1990
as code owners
|
|
Author
|
The CDS template generation section of the Health Tool documentation contained incorrect response examples. Specifically, FHIR resource JSON outputs were shown where CDS card responses should be returned. This change fixes the documentation to reflect actual CDS Hooks responses generated by the tool, ensuring correctness and preventing confusion for developers. Fixes #10192 |
3 tasks
sm1990
reviewed
Dec 29, 2025
| url: learn/by-example | ||
| sublinks: | ||
| - title: Language concepts | ||
| - title: Language Concepts |
Contributor
There was a problem hiding this comment.
In ballerina.io we use the sentence case. Please revert the changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Corrects the CDS template generation documentation to display valid CDS Hooks responses.
The documentation previously showed FHIR resource examples (e.g., Practitioner) as CDS responses, which is incorrect and confusing for users. This change replaces those examples with proper CDS card-based responses that align with the CDS Hooks 2.0 specification.
This improves accuracy, clarity, and developer experience when using the Health Tool for CDS service generation.