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

NPA-3543: add initial /Consent endpoint and associated schema refactoring #105

Merged
merged 12 commits into from
Oct 22, 2024

Conversation

miiisterjim
Copy link
Contributor

@miiisterjim miiisterjim commented Sep 2, 2024

Ticket Link

https://nhsd-jira.digital.nhs.uk/browse/NPA-3543

Description/Change Summary

These changes to the OAS cover the new /Consent API endpoint required for requesting proxy relationships from VRS. For each proxy relationship, there should be three resources:

  • Consent (filtering possible based on status)
  • RelatedPerson (optional _include in the bundle)
  • Patient (optional _include in the bundle)

Draft requirements can be found in confluence here (along with details of how to map NAM payloads to FHIR resources): https://nhsd-confluence.digital.nhs.uk/display/NPA/Consent+endpoint+requirements

A summary of expected behaviour of the endpoint:

  • Take IM1 connection params in HTTP header in order for VRS to use these against the new NAM endpoint outlined here. Design decision: I've decided to pass these params in a single delimited string that match the regex in order to be explicit about the expectation that these two values should be passed atomically
  • If the IM1 connection params header is not present then VRS should only check it's local cache
  • In case of a cache miss then we should hit the NAM for linked profiles and map these to FHIR resources before caching them and returning the resources requested (in accordance with status and _include query string parameter filters)
  • The performer:identifier parameter should be used for querying the local cache
  • The status parameter should be used for filtering the relationships (based on the consent.status property
  • The _include parameter should be used for including referenced resources

How to test?

No behaviour has been implemented as part of this change. Changes best reviewed in a swagger editor in addition to the raw changes

Of special note, ensure the previous two commits have been correctly incorporated into the spec due to these being merged manually.

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.

@miiisterjim miiisterjim force-pushed the NPA-3543_add_consent_endpoint_to_OAS branch 2 times, most recently from 5e03ea6 to 1069970 Compare September 2, 2024 14:30
@miiisterjim miiisterjim force-pushed the NPA-3543_add_consent_endpoint_to_OAS branch from 1069970 to 6ea611f Compare September 2, 2024 14:39
Copy link

github-actions bot commented Sep 2, 2024

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-3543

Stoods-hd
Stoods-hd previously approved these changes Sep 4, 2024
Copy link
Contributor

@Stoods-hd Stoods-hd left a comment

Choose a reason for hiding this comment

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

Reviewed all changes and made sure that the OAS incorporates all previous changes as well. Approved

Copy link

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-3543

@miiisterjim miiisterjim force-pushed the NPA-3543_add_consent_endpoint_to_OAS branch from 9034f42 to 8e6fcbe Compare September 19, 2024 16:20
Copy link

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-3543

Copy link

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-3543

Copy link
Contributor

@Stoods-hd Stoods-hd left a comment

Choose a reason for hiding this comment

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

Approved with comments made and removal of outcome

@miiisterjim miiisterjim merged commit 55e7524 into master Oct 22, 2024
9 checks passed
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