Skip to content

VED-367: Identifier Search Parameter#744

Merged
Akol125 merged 14 commits intomasterfrom
VED-367-Idenitifer-Search-Parameter
Aug 20, 2025
Merged

VED-367: Identifier Search Parameter#744
Akol125 merged 14 commits intomasterfrom
VED-367-Idenitifer-Search-Parameter

Conversation

@Akol125
Copy link
Contributor

@Akol125 Akol125 commented Aug 15, 2025

Summary

  • Routine Change
    So basically there are several ways of searching the API, for this ticket we are specifically looking at searching via - Identifier and _element (not on the onboarding page) but we use that search internally. Formally it was immunisation.identifier and _element (now not fhir compliant),
    first part of the ticket was to switch it to - identifier and _elements
    second part of the ticket was to now allow a search only by the identifier, making _elements (the new name) optional. This also changes the search payload from a truncated version to returning the full resource when a search call is made just by an identifier, the payload is exactly what would be returned in a get call.

_elements while optional, if used can only be (id,meta). The unittest also uses encoded strings, which when decoded which matches the url of the search request, just in case anyone is wondering why those strings are there.

Add any other relevant notes or explanations here. Remove this line if you have nothing to add.

Reviews Required

  • Dev
  • Test
  • Tech Author
  • Product Owner

Review Checklist

ℹ️ This section is to be filled in by the reviewer.

  • I have reviewed the changes in this PR and they fill all or part of the acceptance criteria of the ticket, and the code is in a mergeable state.
  • If there were infrastructure, operational, or build changes, I have made sure there is sufficient evidence that the changes will work.
  • I have ensured the changelog has been updated by the submitter, if necessary.

@github-actions
Copy link
Contributor

This branch is working on a ticket in the NHS England VED JIRA Project. Here's a handy link to the ticket:

VED-367

@NHSDigital NHSDigital deleted a comment from sonarqubecloud bot Aug 19, 2025
@dlzhry2nhs dlzhry2nhs self-requested a review August 19, 2025 14:21
Copy link
Collaborator

@dlzhry2nhs dlzhry2nhs left a comment

Choose a reason for hiding this comment

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

Very good - nice intricate work for the feature.

Couple of reasonably minor comments added. Also have some broader questions on this feature:

  • what testing was done/will be done. Do we need to do e2e tests for this as part of this ticket or create a new ticket for them?
  • Do we need to make any changes to the API schema? I notice we don't document anything about using the local identifier or elements in the search request.

@sonarqubecloud
Copy link

return None

requested_elements = {e.strip().lower() for e in _elements.split(",") if e.strip()}
requested_elements_valid = requested_elements.issubset({"id", "meta"})
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice, didn't know this set method. :)

@dlzhry2nhs dlzhry2nhs self-requested a review August 20, 2025 07:39
@dlzhry2nhs
Copy link
Collaborator

Very good - nice intricate work for the feature.

Couple of reasonably minor comments added. Also have some broader questions on this feature:

  • what testing was done/will be done. Do we need to do e2e tests for this as part of this ticket or create a new ticket for them?
  • Do we need to make any changes to the API schema? I notice we don't document anything about using the local identifier or elements in the search request.

Clarified with team. Will be tested through standard path with a view to adding to the e2e suite in future. Similarly, this will be discussed with BA as to whether OAS docs are needed and a future ticket will be created if required.

@Akol125 Akol125 merged commit cc6a7ef into master Aug 20, 2025
7 checks passed
@Akol125 Akol125 deleted the VED-367-Idenitifer-Search-Parameter branch August 20, 2025 09:45
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.

3 participants