DRAFT - WPP-11130 - Proposed changes to API specs for Invite to Book#166
Draft
simeonparris-nhs wants to merge 9 commits into
Draft
DRAFT - WPP-11130 - Proposed changes to API specs for Invite to Book#166simeonparris-nhs wants to merge 9 commits into
simeonparris-nhs wants to merge 9 commits into
Conversation
so that it is suitable for a variety of tasks rather than just questionnaire responses
so that a variety of task details, such as booking invites and questionnaire responses can be communicated
for allAppointmentBookingInvitationStates
|
This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket: APM-000 |
|
This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket: APM-000 |
|
This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket: APM-000 |
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
1 participant
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.
Summary
NOTE: This is PR has been raised as a
DRAFTbecause the changes to the Task resource are only proposed ones and are being shared to source feedback from developers and stakeholders.The changes introduced in this PR are designed to enable the "Invite to Book" feature in the NHS App.
To enable this feature, the proposed changes to the producer API spec focus on modifying the
Taskresource so that it can still be used for questionnaire response while also being suitable for Appointment Booking Invitations, and later, if needed, extended so that other types of tasks can be captured by this resource.The changes to the consumer API spec introduce a Task resource that can be used in conjunction with the existing Questionnaire resource. It closely follows the structure of the Questionnaire resource because the eventual desire is to deprecate the Questionnaire resource and have this Task resource represent questionnaires, appointment booking invites as well as other tasks which may be needed in the future.
Reviews Required
Review Checklist
ℹ️ This section is to be filled in by the reviewer.