Skip to content

fix: RetrievePdsDemographic API to return PdsDemographic objects instead of ParticipantDemographic #1462

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
SamAinsworth-NHS merged 7 commits into from
Aug 12, 2025
Merged

fix: RetrievePdsDemographic API to return PdsDemographic objects instead of ParticipantDemographic #1462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7d052a7
fix: Update response serialisation for demographic record in Retrieve…
SamAinsworth-NHS Aug 11, 2025
b1ef90a
fix: reverted change to RetrievePDSDemographic - updated ProcessNemsU…
SamAinsworth-NHS Aug 12, 2025
39da77f
fix: make RetrievePdsDemographic return PdsDemographic instead of Par…
SamAinsworth-NHS Aug 12, 2025
6f37293
Merge branch 'main' into Fix/retrieve-pds-demo-to-demographic-response
SamAinsworth-NHS Aug 12, 2025
e24ebcf
fix: Update ParticipantDemographic.cs - revert whitespace change
SamAinsworth-NHS Aug 12, 2025
49b42bc
Merge branch 'main' into Fix/retrieve-pds-demo-to-demographic-response
SamAinsworth-NHS Aug 12, 2025
30b23f3
Merge branch 'main' into Fix/retrieve-pds-demo-to-demographic-response
SamAinsworth-NHS Aug 12, 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 ...anager/src/Functions/DemographicServices/RetrievePDSDemographic/RetrievePDSDemographic.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public async Task<HttpResponseData> Run([HttpTrigger(AuthorizationLevel.Anonymou
var upsertResult = await _pdsProcessor.UpsertDemographicRecordFromPDS(participantDemographic);

return upsertResult ?
_createResponse.CreateHttpResponse(HttpStatusCode.OK, req, JsonSerializer.Serialize(participantDemographic)) :
_createResponse.CreateHttpResponse(HttpStatusCode.OK, req, JsonSerializer.Serialize(pdsDemographic)) :
_createResponse.CreateHttpResponse(HttpStatusCode.InternalServerError, req);
}
catch (Exception ex)
Expand Down
40 changes: 20 additions & 20 deletions ...pantManagementServices/ManageServiceNowParticipant/ManageServiceNowParticipantFunction.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ public async Task Run([ServiceBusTrigger(topicName: "%ServiceNowParticipantManag
{
try
{
var participantDemographic = await ValidateAndRetrieveParticipantFromPds(serviceNowParticipant);
if (participantDemographic is null)
var pdsDemographic = await ValidateAndRetrieveParticipantFromPds(serviceNowParticipant);
if (pdsDemographic is null)
{
return;
}
Expand All @@ -58,7 +58,7 @@ public async Task Run([ServiceBusTrigger(topicName: "%ServiceNowParticipantManag

// TODO: Add call to subscribe to NEMS (DTOSS-3881)

var participantForDistribution = new BasicParticipantCsvRecord(serviceNowParticipant, participantDemographic, participantManagement);
var participantForDistribution = new BasicParticipantCsvRecord(serviceNowParticipant, pdsDemographic, participantManagement);

var sendToQueueSuccess = await _queueClient.AddAsync(participantForDistribution, _config.CohortDistributionTopic);

Expand All @@ -73,7 +73,7 @@ public async Task Run([ServiceBusTrigger(topicName: "%ServiceNowParticipantManag
}
}

private async Task<ParticipantDemographic?> ValidateAndRetrieveParticipantFromPds(ServiceNowParticipant serviceNowParticipant)
private async Task<PdsDemographic?> ValidateAndRetrieveParticipantFromPds(ServiceNowParticipant serviceNowParticipant)
{
var pdsResponse = await _httpClientFunction.SendGetResponse($"{_config.RetrievePdsDemographicURL}?nhsNumber={serviceNowParticipant.NhsNumber}");
string responseMessage = await _httpClientFunction.GetResponseText(pdsResponse);
Expand All @@ -90,37 +90,37 @@ public async Task Run([ServiceBusTrigger(topicName: "%ServiceNowParticipantManag
return null;
}

var participantDemographic = await DeserializeParticipantDemographic(pdsResponse, serviceNowParticipant);
if (participantDemographic is null) return null;
var pdsDemographic = await DeserializePdsDemographic(pdsResponse, serviceNowParticipant);
if (pdsDemographic is null) return null;

return await ValidateParticipantData(serviceNowParticipant, participantDemographic)
? participantDemographic
return await ValidateParticipantData(serviceNowParticipant, pdsDemographic)
? pdsDemographic
: null;
}

private async Task<ParticipantDemographic?> DeserializeParticipantDemographic(HttpResponseMessage pdsResponse, ServiceNowParticipant serviceNowParticipant)
private async Task<PdsDemographic?> DeserializePdsDemographic(HttpResponseMessage pdsResponse, ServiceNowParticipant serviceNowParticipant)
{
var jsonString = await pdsResponse.Content.ReadAsStringAsync();
var participantDemographic = JsonSerializer.Deserialize<ParticipantDemographic>(jsonString);
var pdsDemographic = JsonSerializer.Deserialize<PdsDemographic>(jsonString);

if (participantDemographic is null)
if (pdsDemographic is null)
{
await HandleException(new Exception($"Deserialisation of PDS for ServiceNow Participant response to {typeof(ParticipantDemographic)} returned null"), serviceNowParticipant, ServiceNowMessageType.AddRequestInProgress);
await HandleException(new Exception($"Deserialisation of PDS for ServiceNow Participant response to {typeof(PdsDemographic)} returned null"), serviceNowParticipant, ServiceNowMessageType.AddRequestInProgress);
return null;
}

return participantDemographic;
return pdsDemographic;
}

private async Task<bool> ValidateParticipantData(ServiceNowParticipant serviceNowParticipant, ParticipantDemographic participantDemographic)
private async Task<bool> ValidateParticipantData(ServiceNowParticipant serviceNowParticipant, PdsDemographic pdsDemographic)
{
if (participantDemographic.NhsNumber != serviceNowParticipant.NhsNumber)
if (pdsDemographic.NhsNumber != serviceNowParticipant.NhsNumber.ToString())
{
await HandleException(new Exception("NHS Numbers don't match for ServiceNow Participant and PDS, NHS Number must have been superseded"), serviceNowParticipant, ServiceNowMessageType.UnableToAddParticipant);
return false;
}

if (!CheckParticipantDataMatches(serviceNowParticipant, participantDemographic))
if (!CheckParticipantDataMatches(serviceNowParticipant, pdsDemographic))
{
await HandleException(new Exception("Participant data from ServiceNow does not match participant data from PDS"), serviceNowParticipant, ServiceNowMessageType.UnableToAddParticipant);
return false;
Expand Down Expand Up @@ -219,11 +219,11 @@ private async Task HandleException(Exception exception, ServiceNowParticipant se
await SendServiceNowMessage(serviceNowParticipant.ServiceNowCaseNumber, serviceNowMessageType);
}

private static bool CheckParticipantDataMatches(ServiceNowParticipant serviceNowParticipant, ParticipantDemographic participantDemographic)
private static bool CheckParticipantDataMatches(ServiceNowParticipant serviceNowParticipant, PdsDemographic pdsDemographic)
{
return serviceNowParticipant.FirstName == participantDemographic.GivenName &&
serviceNowParticipant.FamilyName == participantDemographic.FamilyName &&
serviceNowParticipant.DateOfBirth.ToString("yyyy-MM-dd") == participantDemographic.DateOfBirth;
return serviceNowParticipant.FirstName == pdsDemographic.FirstName &&
serviceNowParticipant.FamilyName == pdsDemographic.FamilyName &&
serviceNowParticipant.DateOfBirth.ToString("yyyy-MM-dd") == pdsDemographic.DateOfBirth;
}

private async Task SendServiceNowMessage(string serviceNowCaseNumber, ServiceNowMessageType servicenowMessageType)
Expand Down
25 changes: 21 additions & 4 deletions .../src/Functions/ParticipantManagementServices/UpdateBlockedFlag/BlockParticipantHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ public async Task<BlockParticipantResult> GetParticipant(BlockParticipantDto blo
var pdsRecordsMatch = ValidateRecordsMatch(pdsParticipant, blockParticipantRequest);
var pdsResponseBody = JsonSerializer.Serialize(new BlockParticipantDto
{
NhsNumber = pdsParticipant.NhsNumber,
NhsNumber = long.Parse(pdsParticipant.NhsNumber),
FamilyName = pdsParticipant.FamilyName!,
DateOfBirth = pdsParticipant.DateOfBirth!
});
Expand All @@ -161,7 +161,7 @@ private async Task<BlockParticipantResult> BlockNewParticipant(BlockParticipantD

var participantManagementRecord = new ParticipantManagement
{
NHSNumber = pdsParticipant.NhsNumber,
NHSNumber = long.Parse(pdsParticipant.NhsNumber),
BlockedFlag = 1,
EligibilityFlag = 0,
};
Expand Down Expand Up @@ -219,7 +219,7 @@ private async Task<bool> SetBlockedFlag(ParticipantManagement participant, bool
return await _participantManagementDataService.Update(participant);
}

private async Task<ParticipantDemographic> GetPDSParticipant(long nhsNumber)
private async Task<PdsDemographic> GetPDSParticipant(long nhsNumber)
{
var pdsResponse = await _httpClient.SendGet(_config.RetrievePdsDemographicURL, CreateNhsNumberQueryParams(nhsNumber));
if (string.IsNullOrEmpty(pdsResponse))
Expand All @@ -228,7 +228,7 @@ private async Task<ParticipantDemographic> GetPDSParticipant(long nhsNumber)
return null!;
}

var pdsDemographic = JsonSerializer.Deserialize<ParticipantDemographic>(pdsResponse);
var pdsDemographic = JsonSerializer.Deserialize<PdsDemographic>(pdsResponse);

return pdsDemographic!;
}
Expand All @@ -250,6 +250,23 @@ private static bool ValidateRecordsMatch(ParticipantDemographic participant, Blo
&& parsedDob == dtoDateOfBirth;
}

private static bool ValidateRecordsMatch(PdsDemographic participant, BlockParticipantDto dto)
{

if (!DateOnly.TryParseExact(dto.DateOfBirth, "yyyy-MM-dd",new CultureInfo("en-GB"),DateTimeStyles.None, out var dtoDateOfBirth ))
{
throw new FormatException("Date of Birth not in the correct format");
}

if (!DateOnly.TryParseExact(participant.DateOfBirth, "yyyyMMdd",new CultureInfo("en-GB"),DateTimeStyles.None, out var parsedDob))
{
return false;
}
return string.Equals(participant.FamilyName, dto.FamilyName, StringComparison.InvariantCultureIgnoreCase)
&& long.Parse(participant.NhsNumber) == dto.NhsNumber
&& parsedDob == dtoDateOfBirth;
}

private static Dictionary<string, string> CreateNhsNumberQueryParams(long nhsNumber) =>
new Dictionary<string, string>
{
Expand Down
4 changes: 2 additions & 2 deletions application/CohortManager/src/Functions/Shared/Model/BasicParticipantCsvRecord.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public BasicParticipantCsvRecord()

}

public BasicParticipantCsvRecord(ServiceNowParticipant serviceNowParticipant, ParticipantDemographic participantDemographic, ParticipantManagement? participantManagement)
public BasicParticipantCsvRecord(ServiceNowParticipant serviceNowParticipant, PdsDemographic pdsDemographic, ParticipantManagement? participantManagement)
{
FileName = serviceNowParticipant.ServiceNowCaseNumber;
BasicParticipantData = new BasicParticipantData
Expand All @@ -29,7 +29,7 @@ public BasicParticipantCsvRecord(ServiceNowParticipant serviceNowParticipant, Pa
Participant = new Participant
{
ReferralFlag = "1",
Postcode = participantDemographic.PostCode,
Postcode = pdsDemographic.Postcode,
ScreeningAcronym = "BSS" // TODO: Remove hardcoding when adding support for additional screening programs
};
}
Expand Down
82 changes: 69 additions & 13 deletions ...ervicesTests/ManageServiceNowParticipantTests/ManageServiceNowParticipantFunctionTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,9 @@ public async Task Run_WhenNoPdsMatch_SendsServiceNowMessageType1()
public async Task Run_WhenNhsNumberSuperseded_SendsServiceNowMessageType1()
{
// Arrange
var json = JsonSerializer.Serialize(new ParticipantDemographic
var json = JsonSerializer.Serialize(new PdsDemographic
{
NhsNumber = 123
NhsNumber = "123"
});
_httpClientFunctionMock.Setup(x => x.SendGetResponse($"{_configMock.Object.Value.RetrievePdsDemographicURL}?nhsNumber={_serviceNowParticipant.NhsNumber}"))
.ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK)
Expand Down Expand Up @@ -205,10 +205,10 @@ public async Task Run_WhenParticipantDataDoesNotMatchPdsData_SendsServiceNowMess
string firstName, string familyName, string dateOfBirth)
{
// Arrange
var json = JsonSerializer.Serialize(new ParticipantDemographic
var json = JsonSerializer.Serialize(new PdsDemographic
{
NhsNumber = _serviceNowParticipant.NhsNumber,
GivenName = firstName,
NhsNumber = _serviceNowParticipant.NhsNumber.ToString(),
FirstName = firstName,
FamilyName = familyName,
DateOfBirth = dateOfBirth
});
Expand Down Expand Up @@ -241,7 +241,14 @@ public async Task Run_WhenParticipantDataDoesNotMatchPdsData_SendsServiceNowMess
public async Task Run_WhenServiceNowParticipantIsValidAndDoesNotExistInTheDataStore_AddsTheNewParticipant()
{
// Arrange
var json = JsonSerializer.Serialize(_demographic);
var json = JsonSerializer.Serialize(new PdsDemographic
{
NhsNumber = _serviceNowParticipant.NhsNumber.ToString(),
FirstName = _serviceNowParticipant.FirstName,
FamilyName = _serviceNowParticipant.FamilyName,
DateOfBirth = _serviceNowParticipant.DateOfBirth.ToString("yyyy-MM-dd"),
Postcode = "SW1A 2AA"
});
_httpClientFunctionMock.Setup(x => x.SendGetResponse($"{_configMock.Object.Value.RetrievePdsDemographicURL}?nhsNumber={_serviceNowParticipant.NhsNumber}"))
.ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK)
{
Expand Down Expand Up @@ -292,7 +299,14 @@ public async Task Run_WhenServiceNowParticipantIsValidAndDoesNotExistInTheDataSt
public async Task Run_WhenServiceNowParticipantIsValidAndExistsInTheDataStoreButIsBlocked_DoesNotUpdateTheParticipantAndSendsMessageType1()
{
// Arrange
var json = JsonSerializer.Serialize(_demographic);
var json = JsonSerializer.Serialize(new PdsDemographic
{
NhsNumber = _serviceNowParticipant.NhsNumber.ToString(),
FirstName = _serviceNowParticipant.FirstName,
FamilyName = _serviceNowParticipant.FamilyName,
DateOfBirth = _serviceNowParticipant.DateOfBirth.ToString("yyyy-MM-dd"),
Postcode = "SW1A 2AA"
});
_httpClientFunctionMock.Setup(x => x.SendGetResponse($"{_configMock.Object.Value.RetrievePdsDemographicURL}?nhsNumber={_serviceNowParticipant.NhsNumber}"))
.ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK)
{
Expand Down Expand Up @@ -341,7 +355,14 @@ public async Task Run_WhenServiceNowParticipantIsValidAndExistsInTheDataStoreBut
public async Task Run_WhenServiceNowParticipantIsValidAndExistsInTheDataStoreAndIsNotBlocked_UpdatesTheParticipant()
{
// Arrange
var json = JsonSerializer.Serialize(_demographic);
var json = JsonSerializer.Serialize(new PdsDemographic
{
NhsNumber = _serviceNowParticipant.NhsNumber.ToString(),
FirstName = _serviceNowParticipant.FirstName,
FamilyName = _serviceNowParticipant.FamilyName,
DateOfBirth = _serviceNowParticipant.DateOfBirth.ToString("yyyy-MM-dd"),
Postcode = "SW1A 2AA"
});
_httpClientFunctionMock.Setup(x => x.SendGetResponse($"{_configMock.Object.Value.RetrievePdsDemographicURL}?nhsNumber={_serviceNowParticipant.NhsNumber}"))
.ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK)
{
Expand Down Expand Up @@ -405,7 +426,14 @@ public async Task Run_WhenServiceNowParticipantIsVhrAndDoesNotExistInDataStore_A
ReasonForAdding = ServiceNowReasonsForAdding.VeryHighRisk
};

var json = JsonSerializer.Serialize(_demographic);
var json = JsonSerializer.Serialize(new PdsDemographic
{
NhsNumber = _serviceNowParticipant.NhsNumber.ToString(),
FirstName = _serviceNowParticipant.FirstName,
FamilyName = _serviceNowParticipant.FamilyName,
DateOfBirth = _serviceNowParticipant.DateOfBirth.ToString("yyyy-MM-dd"),
Postcode = "SW1A 2AA"
});

_httpClientFunctionMock.Setup(x => x.SendGetResponse($"{_configMock.Object.Value.RetrievePdsDemographicURL}?nhsNumber={vhrParticipant.NhsNumber}"))
.ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK)
Expand Down Expand Up @@ -461,7 +489,14 @@ public async Task Run_WhenServiceNowParticipantIsVhrAndDoesNotExistInDataStore_A
public async Task Run_WhenServiceNowParticipantIsNotVhrAndDoesNotExistInDataStore_AddsNewParticipantWithoutVhrFlag()
{
// Arrange
var json = JsonSerializer.Serialize(_demographic);
var json = JsonSerializer.Serialize(new PdsDemographic
{
NhsNumber = _serviceNowParticipant.NhsNumber.ToString(),
FirstName = _serviceNowParticipant.FirstName,
FamilyName = _serviceNowParticipant.FamilyName,
DateOfBirth = _serviceNowParticipant.DateOfBirth.ToString("yyyy-MM-dd"),
Postcode = "SW1A 2AA"
});

_httpClientFunctionMock.Setup(x => x.SendGetResponse($"{_configMock.Object.Value.RetrievePdsDemographicURL}?nhsNumber={_serviceNowParticipant.NhsNumber}"))
.ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK)
Expand Down Expand Up @@ -528,7 +563,14 @@ public async Task Run_WhenVhrParticipantExistsWithNullVhrFlag_SetsVhrFlagToTrue(
ReasonForAdding = ServiceNowReasonsForAdding.VeryHighRisk
};

var json = JsonSerializer.Serialize(_demographic);
var json = JsonSerializer.Serialize(new PdsDemographic
{
NhsNumber = _serviceNowParticipant.NhsNumber.ToString(),
FirstName = _serviceNowParticipant.FirstName,
FamilyName = _serviceNowParticipant.FamilyName,
DateOfBirth = _serviceNowParticipant.DateOfBirth.ToString("yyyy-MM-dd"),
Postcode = "SW1A 2AA"
});

var existingParticipant = new ParticipantManagement
{
Expand Down Expand Up @@ -594,7 +636,14 @@ public async Task Run_WhenVhrParticipantExistsWithNullVhrFlag_SetsVhrFlagToTrue(
public async Task Run_WhenParticipantExistsWithVhrFlagAlreadySet_MaintainsVhrFlag()
{
// Arrange
var json = JsonSerializer.Serialize(_demographic);
var json = JsonSerializer.Serialize(new PdsDemographic
{
NhsNumber = _serviceNowParticipant.NhsNumber.ToString(),
FirstName = _serviceNowParticipant.FirstName,
FamilyName = _serviceNowParticipant.FamilyName,
DateOfBirth = _serviceNowParticipant.DateOfBirth.ToString("yyyy-MM-dd"),
Postcode = "SW1A 2AA"
});

var existingParticipant = new ParticipantManagement
{
Expand Down Expand Up @@ -659,7 +708,14 @@ public async Task Run_WhenParticipantExistsWithVhrFlagAlreadySet_MaintainsVhrFla
public async Task Run_WhenNonVhrParticipantExistsWithNullVhrFlag_LeavesVhrFlagAsNull()
{
// Arrange
var json = JsonSerializer.Serialize(_demographic);
var json = JsonSerializer.Serialize(new PdsDemographic
{
NhsNumber = _serviceNowParticipant.NhsNumber.ToString(),
FirstName = _serviceNowParticipant.FirstName,
FamilyName = _serviceNowParticipant.FamilyName,
DateOfBirth = _serviceNowParticipant.DateOfBirth.ToString("yyyy-MM-dd"),
Postcode = "SW1A 2AA"
});

var existingParticipant = new ParticipantManagement
{
Expand Down
Loading
Loading