API use case

This specification describes a single use cases. For complete details and background please see the Foundations Capability Bundle.

Security

• GP Connect utilises TLS Mutual Authentication for system level authorization.
• GP Connect utilises a JSON Web Tokens (JWT) to transmit clinical audit & provenance details.

API usage

Request operation

FHIR relative request

GET /Practitioner/[id]

FHIR absolute request

GET https://[proxy_server]/https://[provider_server]/[fhir_base]/Practitioner/[id]

Request headers

Consumers SHALL include the following additional HTTP request headers:

Payload request body

N/A

Error handling

Provider systems SHALL return an GPConnect-OperationOutcome-1 resource that provides additional detail when one or more data fields are corrupt or a specific business rule/constraint is breached.

For example, the:

• Logical identifier of the resource is not valid/can’t be found on the server.

Refer to Development - FHIR API Guidance - Error Handling for details of error codes.

Request response

Response headers

Provider systems are not expected to add any specific headers beyond that described in the HTTP and FHIR® standards.

Payload response body

Provider systems:

• SHALL return a 200 OK HTTP status code on successful execution of the operation.
• SHALL return Practitioner resources that conform to the CareConnect-GPC-Practitioner-1 profile.
• SHALL include the URI of the CareConnect-GPC-Practitioner-1 profile StructureDefinition in the Practitioner.meta.profile element of the returned Practitioner resource.
• SHALL include the versionId of the current version of the Practitioner resource.
• SHALL include all relevant business identifier details (i.e. SDS User ID) for the Practitioner resource.

{
  "resourceType": "Practitioner",
  "id": "15",
  "meta": {
    "versionId": "636064088099800115",
    "profile": [
      "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1"
    ]
  },
  "identifier": [
    {
      "system": "https://fhir.nhs.uk/Id/sds-user-id",
      "value": "S001"
    }
  ],
  "name": {
    "family": [
      "Black"
    ],
    "given": [
      "Sarah"
    ],
    "prefix": [
      "Mrs"
    ]
  },
  "gender": "female"
}

Examples

C#

var client = new FhirClient("http://gpconnect.aprovider.nhs.net/GP001/STU3/1/");
client.PreferredFormat = ResourceFormat.Json;
var resource = client.Read<Practitioner>("Practitioner/15");
FhirSerializer.SerializeResourceToXml(resource).Dump();

Java

FhirContext ctx = new FhirContext().forStu3();
IGenericClient client = ctx.newRestfulGenericClient("http://gpconnect.aprovider.nhs.net/GP001/STU3/1/");
Practitioner practitioner = client.read().resource(Practitioner.class).withId("15").execute();