A list of GP Connect API interaction IDs
GP Connect interaction ID naming policy
All interaction IDs are expected to follow the following format urn:nhs:names:services:[program]:[standard]:[mechanism]:[operation]:[subject]
- Program =
gpconnect - Standard =
fhir - Mechanism = [
rest,operation]restfor RESTful API interactionsoperationfor custom Operation API interactions
- Operation
- RESTful style = [
create,read,update,delete,search] + any more specific actions (for example,cancel) - Extended operation = [
gpc.getcarerecord]
- RESTful style = [
- Subject = [
resourceType,operationName]- Resource Type is the name of a FHIR resource, such as
Patient,Appointment,Organization - Operation Name is the name of an extended operation, such as
gpc.getcarerecord
- Resource Type is the name of a FHIR resource, such as
List of interaction IDs
Foundations interactions
| Operation | InteractionID |
|---|---|
| Read metadata | urn:nhs:names:services:gpconnect:fhir:rest:read:metadata |
Access Record HTML interactions
| Operation | InteractionID |
|---|---|
| Get Care Record | urn:nhs:names:services:gpconnect:fhir:operation:gpc.getcarerecord |
Access Record Structured and Appointment Management interactions
Access Record Structured and Appointment Management interactions are not available at this specification version. Please refer to the GP Connect specifications page for more information.
