Skip to main content

Visitors and Migrants - FHIR API

Identify overseas visitors and migrants liable for charging for their healthcare with the Visitors and Migrants FHIR API.

Page contents

This API is retired and not available for use.

Overview

Use this API to identify overseas visitors and migrants liable for charging for their healthcare.

You can:

  • identify a patient's simple chargeable status of Yes, No or Unset
  • identify their more detailed chargeable category as show below (if set)

Code

Chargeable category
A Ordinarily resident in the UK (according to the domestic Charging Regulations)
B Resident in UK, in possession of a valid visa AND (surcharge paid OR exempt)
C Ordinarily resident in another EEA country AND (EHIC/PRC/S2 OR exempt)
D Ordinarily resident in another EEA country AND (No EHIC/PRC/S2 OR not exempt)
E Not ordinarily resident in the UK, not paid, but exempt by personal status or treatment
F Not ordinarily resident in the UK or EEA, not paid, not exempt by personal status or treatment

Their status is based on a Home Office feed - currently a weekly update but transitioning to a Home Office API under the covers.

API status

This API is retired.

However, it was never used and was made obsolete by Brexit.

Technology

This API is a FHIR API.

Specifically, it is based on the HL7 FHIR DSTU2 Messaging Implementation.

For more details, see FHIR.

Interactions

For more information, see Introduction to Visitors and Migrants and the 'Requirements Specification - Migrants & Visitors Query Interface V0.4' in downloads below,

For details on the general structure of the interactions, see FHIR.

Downloads

This is a Microsoft Word file.  To request a different format, contact us.

Last edited: 27 October 2023 12:53 pm