XIG: CapabilityStatement/UKCoreAccessClinicalDataProvider

FHIR IG Statistics: CapabilityStatement/UKCoreAccessClinicalDataProvider

Package	uk-core-access
Resource Type	CapabilityStatement
Id	UKCoreAccessClinicalDataProvider
FHIR Version	R4
Source	https://fhir.hl7.org.uk/uk-core-access/https://build.fhir.org/ig/HL7-UK/UK-Core-Access/CapabilityStatement-UKCoreAccessClinicalDataProvider.html
URL	https://fhir.hl7.org.uk/uk-core-access/CapabilityStatement/UKCoreAccessClinicalDataProvider
Version	0.1.0
Status	active
Date	2023-02-01
Title	UKCore Access Clinical Data Provider
Realm	uk
Authority	hl7
Description	Provider supports read-only access to clinical data for the purposes of direct care and subject of care access.
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

StructureDefinition
UKCore-Patient	UK Core Patient

Narrative

Note: links and images are rebased to the (stated) source

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 Type	Profile	S	Searches
Patient	https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient	y	_id, identifier
AllergyIntolerance	https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance	y	_id, patient, clinical-status, date, last-date, patient+clinical-status, patient+date, patient+last-date
Immunization	https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization	y	_id, patient, date, status, patient+status, patient+date
MedicationAdministration	https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration	y	_id, patient, effective-time, status, patient+status, patient+effective-time
MedicationDispense	https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationDispense	y	_id, patient, whenprepared, status, patient+status, patient+whenprepared
MedicationRequest	https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest	y	_id, patient, authoredon, status, patient+status, patient+authoredon
MedicationStatement	https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement	y	_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

Conformance	Parameter	Type	Documentation
SHALL	identifier	`token`
SHOULD	_id	`token`

Resource Conformance: SHOULD AllergyIntolerance

Base System Profile
UK Core AllergyIntolerance

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	patient	`token`
SHALL	clinical-status	`token`
SHOULD	_id	`token`
SHOULD	date	`date`
SHOULD	last-date	`date`

Combined Search Parameters

Conformance	Parameters	Types
SHOULD	patient+clinical-status	`token`+`token`
SHOULD	patient+date	`token`+`date`
SHOULD	patient+last-date	`token`+`date`

Resource Conformance: SHOULD Immunization

Base System Profile
UK Core Immunization

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	patient	`token`
SHALL	status	`token`
SHOULD	_id	`token`
SHOULD	date	`date`

Combined Search Parameters

Conformance	Parameters	Types
SHOULD	patient+status	`token`+`token`
SHOULD	patient+date	`token`+`date`

Resource Conformance: SHOULD MedicationAdministration

Base System Profile
UK Core MedicationAdministration

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	patient	`token`
SHALL	effective-time	`date`
SHALL	status	`token`
SHOULD	_id	`token`

Combined Search Parameters

Conformance	Parameters	Types
SHOULD	patient+status	`token`+`token`
SHOULD	patient+effective-time	`token`+`date`

Resource Conformance: SHOULD MedicationDispense

Base System Profile
UK Core MedicationDispense

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	patient	`token`
SHALL	status	`token`
SHOULD	_id	`token`
SHOULD	whenprepared	`date`

Combined Search Parameters

Conformance	Parameters	Types
SHOULD	patient+status	`token`+`token`
SHOULD	patient+whenprepared	`token`+`date`

Resource Conformance: SHOULD MedicationRequest

Base System Profile
UK Core MedicationRequest

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	patient	`token`
SHALL	status	`token`
SHOULD	_id	`token`
SHOULD	authoredon	`date`

Combined Search Parameters

Conformance	Parameters	Types
SHOULD	patient+status	`token`+`token`
SHOULD	patient+authoredon	`token`+`date`

Resource Conformance: SHOULD MedicationStatement

Base System Profile
UK Core MedicationStatement

Profile Conformance
SHALL

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	patient	`token`
SHALL	status	`token`
SHOULD	_id	`token`
SHOULD	effective	`date`

Combined Search Parameters

Conformance	Parameters	Types
SHOULD	patient+status	`token`+`token`
SHOULD	patient+effective	`token`+`date`

Source

{
  "resourceType": "CapabilityStatement",
  "id": "UKCoreAccessClinicalDataProvider",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://fhir.hl7.org.uk/uk-core-access/CapabilityStatement/UKCoreAccessClinicalDataProvider",
  "version": "0.1.0",
  "title": "UKCore Access Clinical Data Provider",
  "status": "active",
  "date": "2023-02-01",
  "publisher": "HL7 UK",
  "contact": [
    {
      "name": "HL7 UK",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.hl7.org.uk/"
        }
      ]
    }
  ],
  "description": "Provider supports read-only access to clinical data for the purposes of direct care and subject of care access.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "GB",
          "display": "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Patient",
          "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "_id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "clinical-status"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "last-date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "AllergyIntolerance",
          "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-AllergyIntolerance",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "_id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "clinical-status",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "date",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "last-date",
              "type": "date"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "status"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "date"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "Immunization",
          "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "_id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "date",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "status"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "effective-time"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "MedicationAdministration",
          "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "_id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "effective-time",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "status"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "whenprepared"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "MedicationDispense",
          "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationDispense",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "_id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "whenprepared",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "status"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "authoredon"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "MedicationRequest",
          "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "_id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "authoredon",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "status"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "effective"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "MedicationStatement",
          "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationStatement",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "_id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "effective",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "type": "token"
            }
          ]
        }
      ]
    }
  ]
}

FHIR IG Statistics: CapabilityStatement/UKCoreAccessClinicalDataProvider

Resources that use this resource

Resources that this resource uses

Narrative

UKCore Access Clinical Data Provider

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL Patient

Resource Conformance: SHOULD AllergyIntolerance

Resource Conformance: SHOULD Immunization

Resource Conformance: SHOULD MedicationAdministration

Resource Conformance: SHOULD MedicationDispense

Resource Conformance: SHOULD MedicationRequest

Resource Conformance: SHOULD MedicationStatement

Source

Mode: `server`