Filtering health services in the API

Health services can be filtered by adding (case-insensitive) terms to the query string.

Query parameters (filters) include the following:

name

Add a text value for a partial match on the service name

type

Add a text value from a list of recognised types, to filter to services of the required type.

Specific recognised types can be found by referring to a representative service page on the web site. For example, to filter to general practices:

Find a representative such as https://www.careopinion.ie/services/f84096

The page indicates a service type of "general practice". Add this to the request as follows: https://www.careopinion.ie/api/v2/healthservices?type=general%20practice

addedAfter

Add a date value in ISO 8601 format, to filter to services added to Care Opinion after a specific time.

For example: https://www.careopinion.ie/api/v2/healthservices?type=general%20practice&addedAfter=2018-12-01

skip and take

This endpoint also accepts skip and take parameters.

Service ordering

Services will be returned in order of nacs code (the unique alphanumeric identifier of each service).