Skip to content

ELI-454: Adding all virtual cohorts to person #393

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.

Sign up for GitHub

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

Merged
shweta-nhs merged 9 commits into from
Sep 30, 2025
Merged

ELI-454: Adding all virtual cohorts to person #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9b4c868
ELI-454: Adding all virtual cohorts to person
shweta-nhs Sep 26, 2025
e351413
Merge branch 'main' into ELI-454
shweta-nhs Sep 26, 2025
e6e00ea
Small change to test E2E regression tests.
ayeshalshukri1-nhs Sep 26, 2025
fcf3ef3
ELI-454 added multiple virtual cohort tests
ayeshalshukri1-nhs Sep 29, 2025
3a932b3
Merge branch 'main' into ELI-454
ayeshalshukri1-nhs Sep 29, 2025
3739046
Merge branch 'main' into ELI-454
ayeshalshukri1-nhs Sep 30, 2025
c8a1054
ELI-454: Adds test for person with no cohort
shweta-nhs Sep 30, 2025
834e5f3
ELI-454: Merges virtual cohorts tests into one
shweta-nhs Sep 30, 2025
e9c89e0
Merge branch 'main' into ELI-454
ayeshalshukri1-nhs Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/eligibility_signposting_api/model/campaign_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ class IterationCohort(BaseModel):
model_config = {"populate_by_name": True, "extra": "ignore"}

@cached_property
def is_magic_cohort(self) -> bool:
def is_virtual_cohort(self) -> bool:
return self.virtual == Virtual.YES

@field_validator("virtual", mode="before")
Expand Down
8 changes: 7 additions & 1 deletion src/eligibility_signposting_api/services/processors/rule_processor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,14 @@ class RuleProcessor:
person_data_reader: PersonDataReader = field(default_factory=PersonDataReader)

def is_base_eligible(self, person: Person, cohort: IterationCohort) -> bool:
if cohort.is_virtual_cohort:
for row in person.data:
if row.get("ATTRIBUTE_TYPE", "") == "COHORTS":
row["COHORT_MEMBERSHIPS"].append({"COHORT_LABEL": cohort.cohort_label})

person_cohorts = self.person_data_reader.get_person_cohorts(person)
return cohort.cohort_label in person_cohorts or cohort.is_magic_cohort

return cohort.cohort_label in person_cohorts

def is_eligible(
self,
Expand Down
268 changes: 268 additions & 0 deletions tests/unit/services/calculators/test_eligibility_calculator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -893,6 +893,274 @@ def test_eligibility_status_replaces_tokens_with_attribute_data(faker: Faker):
assert audit_condition.actions[0].action_url_label == "Your GP practice code is ."


@pytest.mark.parametrize(
("rule_type", "cohorts", "expected_status"),
[
(RuleType.filter, ["rsv_eli_440_cohort_999"], Status.not_eligible),
(RuleType.suppression, ["rsv_eli_440_cohort_999"], Status.not_actionable),
(RuleType.redirect, ["rsv_eli_440_cohort_999"], Status.actionable),
(RuleType.filter, [], Status.not_eligible),
(RuleType.suppression, [], Status.not_actionable),
(RuleType.redirect, [], Status.actionable),
],
)
def test_virtual_cohorts(faker: Faker, rule_type: RuleType, cohorts: list[str], expected_status: Status):
# Given
nhs_number = NHSNumber(faker.nhs_number())
date_of_birth = DateOfBirth(datetime.date(2025, 5, 10))

person_rows = person_rows_builder(
nhs_number,
date_of_birth=date_of_birth,
cohorts=cohorts,
)

campaign_configs = [
rule_builder.CampaignConfigFactory.build(
target="RSV",
iterations=[
rule_builder.IterationFactory.build(
iteration_cohorts=[
rule_builder.IterationCohortFactory.build(
cohort_label="elid_virtual_cohort",
cohort_group="elid_virtual_cohort",
positive_description="In elid_virtual_cohort",
negative_description="Out elid_virtual_cohort",
priority=1,
virtual="Y",
),
rule_builder.IterationCohortFactory.build(
cohort_label="rsv_eli_440_cohort_999",
cohort_group="rsv_eli_440_cohort_999",
positive_description="In rsv_eli_440_cohort_999",
negative_description="Out rsv_eli_440_cohort_999",
priority=2,
),
],
iteration_rules=[
rule_builder.PersonAgeSuppressionRuleFactory.build(
type=rule_type,
name="Filter based on cohort membership",
description="Filter based on cohort membership.",
priority=100,
operator=RuleOperator.is_in,
attribute_level=RuleAttributeLevel.COHORT,
attribute_name="COHORT_LABEL",
comparator="elid_virtual_cohort",
),
],
)
],
)
]

calculator = EligibilityCalculator(person_rows, campaign_configs)

# When
actual = calculator.get_eligibility_status("Y", ["ALL"], "ALL")

# Then
assert_that(
actual,
is_eligibility_status().with_conditions(
has_item(is_condition().with_condition_name(ConditionName("RSV")).and_status(expected_status))
),
)


def test_virtual_cohorts_multiple_campaigns(faker: Faker):
# Given
nhs_number = NHSNumber(faker.nhs_number())
date_of_birth = DateOfBirth(datetime.date(2025, 5, 10))

person_rows = person_rows_builder(
nhs_number,
date_of_birth=date_of_birth,
cohorts=["rsv_eli_440_cohort_999"],
)
campaign_configs = [
rule_builder.CampaignConfigFactory.build(
target="RSV",
iterations=[
rule_builder.IterationFactory.build(
iteration_cohorts=[
rule_builder.IterationCohortFactory.build(
cohort_label="elid_virtual_cohort",
cohort_group="elid_virtual_cohort",
positive_description="In elid_virtual_cohort",
negative_description="Out elid_virtual_cohort",
priority=1,
virtual="Y",
),
rule_builder.IterationCohortFactory.build(
cohort_label="rsv_eli_440_cohort_999",
cohort_group="rsv_eli_440_cohort_999",
positive_description="In rsv_eli_440_cohort_999",
negative_description="Out rsv_eli_440_cohort_999",
priority=2,
),
],
iteration_rules=[
rule_builder.PersonAgeSuppressionRuleFactory.build(
type=RuleType.filter,
name="Filter based on cohort membership",
description="Filter based on cohort membership.",
priority=100,
operator=RuleOperator.is_in,
attribute_level=RuleAttributeLevel.COHORT,
attribute_name="COHORT_LABEL",
comparator="elid_virtual_cohort",
),
],
)
],
),
rule_builder.CampaignConfigFactory.build(
target="COVID",
iterations=[
rule_builder.IterationFactory.build(
iteration_cohorts=[
rule_builder.IterationCohortFactory.build(
cohort_label="elid_virtual_cohort",
cohort_group="elid_virtual_cohort",
positive_description="In elid_virtual_cohort",
negative_description="Out elid_virtual_cohort",
priority=1,
virtual="Y",
),
rule_builder.IterationCohortFactory.build(
cohort_label="rsv_eli_440_cohort_999",
cohort_group="rsv_eli_440_cohort_999",
positive_description="In rsv_eli_440_cohort_999",
negative_description="Out rsv_eli_440_cohort_999",
priority=2,
),
],
iteration_rules=[
rule_builder.PersonAgeSuppressionRuleFactory.build(
type=RuleType.suppression,
name="Filter based on cohort membership",
description="Filter based on cohort membership.",
priority=100,
operator=RuleOperator.is_in,
attribute_level=RuleAttributeLevel.COHORT,
attribute_name="COHORT_LABEL",
comparator="elid_virtual_cohort",
),
],
)
],
),
]

calculator = EligibilityCalculator(person_rows, campaign_configs)

# When
actual = calculator.get_eligibility_status("Y", ["ALL"], "ALL")

assert_that(
actual,
is_eligibility_status().with_conditions(
has_items(
is_condition().with_condition_name(ConditionName("RSV")).and_status(Status.not_eligible),
is_condition().with_condition_name(ConditionName("COVID")).and_status(Status.not_actionable),
)
),
)


def test_multiple_virtual_cohorts(faker: Faker):
# Given
nhs_number = NHSNumber(faker.nhs_number())
date_of_birth = DateOfBirth(datetime.date(2025, 5, 10))

person_rows = person_rows_builder(
nhs_number,
date_of_birth=date_of_birth,
cohorts=["rsv_eli_440_cohort_999"],
)

available_action = AvailableAction(
ActionType="ButtonAuthLink",
ExternalRoutingCode="BookNBS",
ActionDescription="## Get vaccinated.",
UrlLink=HttpUrl("https://www.nhs.uk/book-rsv"),
UrlLabel="Label",
)

campaign_configs = [
rule_builder.CampaignConfigFactory.build(
target="RSV",
iterations=[
rule_builder.IterationFactory.build(
iteration_cohorts=[
rule_builder.IterationCohortFactory.build(
cohort_label="elid_virtual_cohort",
cohort_group="elid_virtual_cohort",
positive_description="In elid_virtual_cohort",
negative_description="Out elid_virtual_cohort",
priority=1,
virtual="Y",
),
rule_builder.IterationCohortFactory.build(
cohort_label="elid_virtual_cohort_2",
cohort_group="elid_virtual_cohort_2",
positive_description="In elid_virtual_cohort_2",
negative_description="Out elid_virtual_cohort_2",
priority=2,
virtual="Y",
),
rule_builder.IterationCohortFactory.build(
cohort_label="rsv_eli_440_cohort_999",
cohort_group="rsv_eli_440_cohort_999",
positive_description="In rsv_eli_440_cohort_999",
negative_description="Out rsv_eli_440_cohort_999",
priority=3,
),
],
iteration_rules=[
rule_builder.PersonAgeSuppressionRuleFactory.build(
type=RuleType.filter,
name="Filter based on cohort membership",
description="Filter based on cohort membership.",
priority=100,
operator=RuleOperator.is_in,
attribute_level=RuleAttributeLevel.COHORT,
attribute_name="COHORT_LABEL",
comparator="elid_virtual_cohort",
),
rule_builder.PersonAgeSuppressionRuleFactory.build(
type=RuleType.suppression,
name="Filter based on cohort membership",
description="Filter based on cohort membership.",
priority=110,
operator=RuleOperator.is_in,
attribute_level=RuleAttributeLevel.COHORT,
attribute_name="COHORT_LABEL",
comparator="elid_virtual_cohort_2",
),
],
actions_mapper=rule_builder.ActionsMapperFactory.build(root={"TEST": available_action}),
)
],
)
]

calculator = EligibilityCalculator(person_rows, campaign_configs)

# When
actual = calculator.get_eligibility_status("Y", ["ALL"], "ALL")

assert_that(
actual,
is_eligibility_status().with_conditions(
has_items(
is_condition().with_condition_name(ConditionName("RSV")).and_status(Status.not_eligible),
)
),
)


def test_regardless_of_final_status_audit_all_types_of_cohort_status_rules(faker: Faker):
# Given
nhs_number = NHSNumber(faker.nhs_number())
Expand Down