Interactions

The CP-IS FHIR R4 API allows healthcare professionals to use healthcare applications acting as API consumers to search for, read and display CP-IS information.

The CP-IS FHIR R4 API provides 2 endpoints:

- /CareTeam
- /AuditEvent

which are searched and retrieved via http GET and a patient NHS Number searchParameter. So:

Query for CP-IS information

Http query

GET /CareTeam?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|[nhs-number];

Parameters

The patient's NHS Number. This must be a verified NHS Number.

• patient:identifier (required), type token.

Headers

• Authorization: Bearer [access token]
• TraceID: [yourRef]
• IsUnscheduledAccessEvent: [boolean]

Query for AuditEvent information

Http query

GET /AuditEvent?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|[nhs-number]&_include=AuditEvent:entity-type=http://terminology.hl7.org/CodeSystem/v3-RoleClass|ASSIGNED

Parameters

The patient's NHS Number. This must be a verified NHS Number.

• patient:identifier (required), type token.

Headers

• Authorization: Bearer [access token]
• TraceID: [yourRef]
• IsUnscheduledAccessEvent: [boolean]

Conformance

The Consumer API SHALL request Access History information using idiomatic, restful FHIR search-with-includes pattern.