HL7 UK - UK Core Access
0.1.0 - ci-build United Kingdom flag

HL7 UK - UK Core Access, published by HL7 UK. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-UK/UK-Core-Access/ and changes regularly. See the Directory of published versions

CapabilityStatement: UKCore Access Patient Index Provider

Official URL: https://fhir.hl7.org.uk/uk-core-access/CapabilityStatement/UKCoreAccessPatientIndexProvider Version: 0.1.0
Active as of 2023-02-01 Computable Name:

Provider supports read-only access to a patient index for the purposes of direct care and subject of care access.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement UKCoreAccessPatientIndexProvider

UKCore Access Patient Index Provider

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats:
  • Published on: 2023-02-01
  • Published by: HL7 UK

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Patienthttps://fhir.hl7.org.uk/uk-core-access/StructureDefinition/UKCoreAccessPatientIndexPatienty_id, birthdate, family, gender, given, identifier, name, birthdate+family, birthdate+name, gender+family, gender+name

Resource Conformance: SHALL Patient

Base System Profile
UKCoreAccessPatientIndexPatient
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLgendertoken
SHALLidentifiertoken
SHALLnamestring
SHOULD_idtoken
SHOULDbirthdatedate
SHOULDfamilystring
SHOULDgivenstring
Combined Search Parameters
ConformanceParametersTypes
SHOULDbirthdate+familydate+string
SHOULDbirthdate+namedate+string
SHOULDgender+familytoken+string
SHOULDgender+nametoken+string