VED-1054: Add API documentation for search by disease type#1276
Open
Thomas-Boyle wants to merge 4 commits intomasterfrom
Open
VED-1054: Add API documentation for search by disease type#1276Thomas-Boyle wants to merge 4 commits intomasterfrom
Thomas-Boyle wants to merge 4 commits intomasterfrom
Conversation
…e search functionality - Updated the API specification to clarify the use of the new `target-disease` parameter alongside `-immunization.target` for searching vaccination records. - Improved descriptions for both parameters to ensure clear guidelines on their usage and mutual exclusivity. - Added examples and links to supported target disease codes to aid developers in implementing the search feature effectively. - Ensured consistency in error handling documentation for invalid parameter combinations.
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
edhall-nhs
requested changes
Mar 6, 2026
Contributor
edhall-nhs
left a comment
edhall-nhs
left a comment
There was a problem hiding this comment.
Nice clear & helpful information 👍 Only suggested a few formatting changes for consistency
dlzhry2nhs
previously approved these changes
Mar 6, 2026
JamesW1-NHS
previously approved these changes
Mar 6, 2026
- Updated descriptions for the `target-disease` parameter to clarify its expression format as `system|code`. - Ensured consistency in language throughout the documentation to enhance clarity for developers implementing the search functionality. - Maintained links to the supported target disease list for reference.
Thomas-Boyle
dismissed stale reviews from JamesW1-NHS and dlzhry2nhs
via
5492a80
edhall-nhs
approved these changes
Mar 6, 2026
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
|
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev-sandbox
GitHub Actions
Inactive
Thomas-Boyle
temporarily deployed
to
internal-dev
GitHub Actions
Inactive
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
4 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.
target-diseaseparameter alongside
-immunization.targetfor searching vaccination records.