PDS API Patient search by postcode

PDS API allows a Patient search by postcode using the parameter address-postcode.

FHIR R4 has an existing search parameter address-postalcode.

Why does PDS API use a different parameter to search on this property?

1 Like

Hi Dunmail!

Thanks for your query!
We’re looking into this and will get back to you as soon as we have something.

Thank you for your patience while we investigate.

As far as I’ve been able to ascertain, an oversight.

I’ve raised a ticket to add support for address-postalcode and update the documentation



Is there a way to track the ticket so that we know if/when it has been resolved?

I don’t believe there’s a way to track our internal tickets, but I’ll add a note to it to send an update here when it’s been resolved, however that may be.

1 Like

NHS API Management team let me know that this fault has been added to the backlog as ticket SPINEDEM-1014 but it’s not expected to be resolved in the immediate future.

This issue has now been resolved.

PDS API will now accept address-postalcode and address-postcode, however if both are provided then an error will be returned.

address-postcode will be deprecated some time in the future.

The official documentation can be found here


Thanks for resolving this - we’ve tested and this parameter is now as we would expect.