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 Clinical Data Provider

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

Provider supports read-only access to clinical data for the purposes of direct care and subject of care access.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement UKCoreAccessClinicalDataProvider

UKCore Access Clinical Data 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/StructureDefinition/UKCore-Patienty_id, identifier
AllergyIntolerancehttps://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerancey_id, patient, clinical-status, date, last-date, patient+clinical-status, patient+date, patient+last-date
Immunizationhttps://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunizationy_id, patient, date, status, patient+status, patient+date
MedicationAdministrationhttps://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministrationy_id, patient, effective-time, status, patient+status, patient+effective-time
MedicationDispensehttps://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationDispensey_id, patient, whenprepared, status, patient+status, patient+whenprepared
MedicationRequesthttps://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequesty_id, patient, authoredon, status, patient+status, patient+authoredon
MedicationStatementhttps://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatementy_id, patient, effective, status, patient+status, patient+effective

Resource Conformance: SHALL Patient

Base System Profile
UK Core Patient
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHOULD_idtoken
 

Resource Conformance: SHOULD AllergyIntolerance

Base System Profile
UK Core AllergyIntolerance
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatienttoken
SHALLclinical-statustoken
SHOULD_idtoken
SHOULDdatedate
SHOULDlast-datedate
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+clinical-statustoken+token
SHOULDpatient+datetoken+date
SHOULDpatient+last-datetoken+date

Resource Conformance: SHOULD Immunization

Base System Profile
UK Core Immunization
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatienttoken
SHALLstatustoken
SHOULD_idtoken
SHOULDdatedate
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+statustoken+token
SHOULDpatient+datetoken+date

Resource Conformance: SHOULD MedicationAdministration

Base System Profile
UK Core MedicationAdministration
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatienttoken
SHALLeffective-timedate
SHALLstatustoken
SHOULD_idtoken
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+statustoken+token
SHOULDpatient+effective-timetoken+date

Resource Conformance: SHOULD MedicationDispense

Base System Profile
UK Core MedicationDispense
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatienttoken
SHALLstatustoken
SHOULD_idtoken
SHOULDwhenprepareddate
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+statustoken+token
SHOULDpatient+whenpreparedtoken+date

Resource Conformance: SHOULD MedicationRequest

Base System Profile
UK Core MedicationRequest
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatienttoken
SHALLstatustoken
SHOULD_idtoken
SHOULDauthoredondate
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+statustoken+token
SHOULDpatient+authoredontoken+date

Resource Conformance: SHOULD MedicationStatement

Base System Profile
UK Core MedicationStatement
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatienttoken
SHALLstatustoken
SHOULD_idtoken
SHOULDeffectivedate
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+statustoken+token
SHOULDpatient+effectivetoken+date