Details of which operations a FHIR server should expose to be a fully compliant GP Connect solution.
FHIR Operations
Aim(s)
- Access Record Views
Mechanism
- RESTful APIs in-line with the FHIR® standard (with limited/targeted usage of custom operations as/if required).
Interactions
All InteractionIDs 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 Interactions.operationfor custom Operation API Interactions.
- Operation
- RESTful syle API = [
create,read,update,delete,search] + any more specific actions (i.e.cancel). - RPC style API = [
gpc.getcarerecord,gpc.registerpatient]
- RESTful syle API = [
- Subject = [
resourceType,operationName]- Resource Type is the name of a FHIR resource (i.e.
Patient,Appointment,Organizationetc). - Operation Name is the name of a custom FHIR operation (i.e.
gpc.getcarerecord)
- Resource Type is the name of a FHIR resource (i.e.
Foundations capability interactions
| Operation | InteractionID | Http Verb | Example URL Pattern |
|---|---|---|---|
| Read Metadata | urn:nhs:names:services:gpconnect:fhir:rest:read:metadata |
GET |
[base]/metadata |
The remaining interactions of the Foundations capability pack are not available at this specification version.
Access Record HTML capability interactions
| Operation | InteractionID | Http Verb | Example URL Pattern |
|---|---|---|---|
| Get Care Record | urn:nhs:names:services:gpconnect:fhir:operation:gpc.getcarerecord |
POST |
[base]/Patient/$gpc.getcarerecord |
Access Record Structured capability interactions
Access Record Structured interactions are not available at this specification version.
Appointments capability interactions
Appointments interactions are not available at this specification version.
Task capability interactions
Task interactions are not available at this specification version.
