[11229] Add relationship methods on Provider #571
Merged
Conversation
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
malcolmbaig
force-pushed
the
11229-provider-scoped-queries--v1--methods-on-provider
branch
from
3119145 to
bb18d9e
Compare
MatMoore
reviewed
Oct 22, 2025
| def __str__(self): | ||
| return self.name | ||
|
|
||
| @property |
Contributor
There was a problem hiding this comment.
If we go with this approach we might also want to consider customising related_name for some of our foreign keys, so that the naming is more consistent when accessing related objects https://docs.djangoproject.com/en/5.2/ref/models/fields/#django.db.models.ForeignKey.related_name
Otherwise we will have a mix of the pluralised form and "foo_set"
malcolmbaig
force-pushed
the
11229-provider-scoped-queries--v1--methods-on-provider
branch
from
bb18d9e to
3c171ff
Compare
This methods define the relationship traversals for a provider's appointments and clinics. They allow view code to retrieve these records correctly scoped to provider.
We can use strings instead of actual models when defining our foreign keys to make sure we don't trigger circular dependency issues on model import.
We want to write a linter to discourage the use of direct record retrieval from Appointment, Clinic, and Participants models. The linter will look for 'ModelName.objects'. With this in mind, it would be useful to discourage use of get_object_or_404, which simply accepts the bare ModelName as an argument. We'll also likely replace get_object_or_404 at some point with some custom behaviour. Replace use of this method with a slightly more verbose alternative.
Allows simpler querying of associated appointments in the participant show view.
Allows for: - Retrieval of appointments scoped to a clinic record - Refactoring of `Appointment.objects.for_clinic_and_filter` to `for_filter`.
This linter checks for two things: - If Model.objects is being used in views, where Model is one of Appointment, Clinic or Participant. - Use of get_object_or_404 We check for the latter because: - We're going to replace it eventually anyway, probably with some kind of flash message usage - It accepts a model as an arg, with no call to objects. Not using it makes it easier to lint for unscoped queries.
malcolmbaig
force-pushed
the
11229-provider-scoped-queries--v1--methods-on-provider
branch
from
3c171ff to
cee05b0
Compare
MatMoore
approved these changes
Oct 22, 2025
malcolmbaig
deleted the
11229-provider-scoped-queries--v1--methods-on-provider
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Description
With the goal of ensuring we have a set of conventions for scoping certain queries by provider, this is an alternative to the approach taken in #558 .
Here we:
appointments,clinicsandparticipantsmethods onProvider, each defining how to traverse the relationship.request.current_provider.appointments(for example) in views instead of direct access to the Appointment model.There are also these related changes:
appointmentsmethods to Clinic and Participants models as well.Jira link
https://nhsd-jira.digital.nhs.uk/browse/DTOSS-11229
Review notes
has_many,has_many: :through, etc). Does it make sense to do something like this in Django?