Search loading...


Explore and Make use of Nationally Defined Messaging APIs


Interaction IDs

A list of GP Connect API interaction IDs

GP Connect Interaction ID naming policy

All new interaction IDs follow the following format:

  • urn:nhs:names:services:[programme]:[capability]:[standard]:[mechanism]:[operation]:[subject]

Many of the existing interaction IDs follow the older format, which omits the [capability] delimeter:

  • urn:nhs:names:services:[programme]:[standard]:[mechanism]:[operation]:[subject]

Where the fields above are defined as:

  • Programme = gpconnect
  • Capability = [ structured, documents ]
  • Standard = fhir
  • Mechanism = [ rest, operation ]
    • rest for RESTful API interactions
    • operation for custom Operation API interactions
  • Operation
    • RESTful style = [ create, read, update, delete, search ] + any more specific actions (for example, cancel)
    • Extended operation = [ gpc.getcarerecord, gpc.registerpatient ]
  • Subject = [ resourceType, operationName ]
    • Resource Type is the name of a FHIR resource, such as Patient, Appointment, Organization
    • Operation Name is the name of a extended operation, such as gpc.getcarerecord

List of Interaction IDs

Foundations interactions

Operation Interaction ID
Read metadata urn:nhs:names:services:gpconnect:fhir:rest:read:metadata-1
Read patient urn:nhs:names:services:gpconnect:fhir:rest:read:patient-1
Patient search urn:nhs:names:services:gpconnect:fhir:rest:search:patient-1
Read practitioner urn:nhs:names:services:gpconnect:fhir:rest:read:practitioner-1
Practitioner search urn:nhs:names:services:gpconnect:fhir:rest:search:practitioner-1
Read organisation urn:nhs:names:services:gpconnect:fhir:rest:read:organization-1
Organisation search urn:nhs:names:services:gpconnect:fhir:rest:search:organization-1
Read location urn:nhs:names:services:gpconnect:fhir:rest:read:location-1
Register patient urn:nhs:names:services:gpconnect:fhir:operation:gpc.registerpatient-1

Appointments capability interactions

Operation Interaction ID
Search for free slots urn:nhs:names:services:gpconnect:fhir:rest:search:slot-1
Read appointment urn:nhs:names:services:gpconnect:fhir:rest:read:appointment-1
Create appointment urn:nhs:names:services:gpconnect:fhir:rest:create:appointment-1
Amend appointment urn:nhs:names:services:gpconnect:fhir:rest:update:appointment-1
Cancel appointment urn:nhs:names:services:gpconnect:fhir:rest:cancel:appointment-1
Get patient appointments urn:nhs:names:services:gpconnect:fhir:rest:search:patient_appointments-1

Access Record Structured interactions

Operation Interaction ID
Get Structured Record urn:nhs:names:services:gpconnect:fhir:operation:gpc.getstructuredrecord-1
Read metadata (Access Record Structured) urn:nhs:names:services:gpconnect:structured:fhir:rest:read:metadata-1

Access Record HTML interactions

Access Record HTML interactions are not available at this specification version. Please refer to the GP Connect specifications page for more information.

All content is available under the Open Government Licence v3.0, except where otherwise stated