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:[programme]:[capability]:[standard]:[mechanism]:[operation]:[subject]
- Programme =
gpconnect - Capability = [
documents] - 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,gpc.registerpatient]
- 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 a extended operation, such as
gpc.getcarerecord
- Resource Type is the name of a FHIR resource, such as
List of Interaction IDs
| Operation | InteractionID |
|---|---|
| Read metadata | urn:nhs:names:services:gpconnect:documents:fhir:rest:read:metadata-1 |
| Patient search | urn:nhs:names:services:gpconnect:documents:fhir:rest:search:patient-1 |
| Search for documents | urn:nhs:names:services:gpconnect:documents:fhir:rest:search:documentreference-1 |
| Retrieve documents | urn:nhs:names:services:gpconnect:documents:fhir:rest:read:binary-1 |
