Pharmacy Contraception Claims - REST API
Submit or update payment claims to the NHS Business Services Authority (BSA) for contraception services provided by a community pharmacy.
This specification is a work in progress
We'll add the missing details over time.
Overview
Submit or update payment claims to the NHS Business Services Authority (BSA) for contraception services provided by a community pharmacy.
You can:
- create a contraception services payment claim
- update it
- delete it
- get details of a previously submitted claim
Who can use this API
This API can only be used where there is a legal basis to do so.
You must do this before you can go live (see ‘Onboarding’ below).
API status
This API is in production.
Service level
<To be supplied. Bronze, Silver, Gold or Platinum support SLA as defined in service levels.>
Technology
This API is RESTful.
Network access
This API is available on the internet and, indirectly, on the Health and Social Care Network (HSCN).
For more details, see Network access for APIs.
Environments and testing
There are test environments for each endpoint, as follows:
Action | Endpoint | URL |
---|---|---|
Create a claim | POST | https://stg.api.contraception.pharmacy.mys.nhsbsa.nhs.uk/v1/claim |
Update a claim | PUT | https://stg.api.contraception.pharmacy.mys.nhsbsa.nhs.uk/v1/claim/{{ID}} |
Delete a claim | DELETE | https://stg.api.contraception.pharmacy.mys.nhsbsa.nhs.uk/v1/claim/{{ID}} |
Get details of a previous claim | GET | https://stg.api.contraception.pharmacy.mys.nhsbsa.nhs.uk/v1/claim/{{ID}} |
Onboarding
<To be supplied - details of assurance required before calling application being IP whitelisted.>
For help and support, contact <to be supplied>.
Interactions
For details of interactions, see downloads below.
Last edited: 14 September 2023 5:49 pm