XIG: CapabilityStatement/UKCoreAccessProvider-instance

FHIR IG Statistics: CapabilityStatement/UKCoreAccessProvider-instance

Package	uk-core-access
Resource Type	CapabilityStatement
Id	UKCoreAccessProvider-instance
FHIR Version	R4
Source	https://fhir.hl7.org.uk/uk-core-access/https://build.fhir.org/ig/HL7-UK/UK-Core-Access/CapabilityStatement-UKCoreAccessProvider-instance.html
URL	https://fhir.hl7.org.uk/uk-core-access/CapabilityStatement/UKCoreAccessProvider-instance
Version	0.1.0
Status	active
Date	2021-01-01
Realm	uk
Authority	hl7
Description	An example of a Provider supporting UKCore Access Patient Index Provider requirements.
Kind	instance

Resources that use this resource

No resources found

Resources that this resource uses

CapabilityStatement
UKCoreAccessPatientIndexProvider	UKCore Access Patient Index Provider

StructureDefinition
UKCore-Patient	UK Core Patient

Narrative

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

Generated Narrative: CapabilityStatement UKCoreAccessProvider-instance

Implementation Guide Version: 0.1.0
FHIR Version: 4.0.1
Supported Formats: `json`
Supported Patch Formats:
Published on: 2021-01-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.
This CapabilityStatement instantiates the CapabilityStatement UKCore Access Patient Index Provider

FHIR RESTful Capabilities

Mode: `server`

Security

Enable CORS: yes

Security services supported: Certificates

Requests to this instance are secured using mTLS with client certificates issued by provider.nhs.uk

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	R	S	U	C	Searches	`_include`	`_revinclude`	Operations
Patient	https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient		y			identifier

Resource Conformance: supported Patient

Base System Profile
UK Core Patient

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports search-type.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	identifier	`token`

Source

{
  "resourceType": "CapabilityStatement",
  "id": "UKCoreAccessProvider-instance",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://fhir.hl7.org.uk/uk-core-access/CapabilityStatement/UKCoreAccessProvider-instance",
  "version": "0.1.0",
  "status": "active",
  "date": "2021-01-01",
  "publisher": "HL7 UK",
  "contact": [
    {
      "name": "HL7 UK",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.hl7.org.uk/"
        }
      ]
    }
  ],
  "description": "An example of a Provider supporting UKCore Access Patient Index Provider requirements.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "GB",
          "display": "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "kind": "instance",
  "instantiates": [
    "https://fhir.hl7.org.uk/uk-core-access/CapabilityStatement/UKCoreAccessPatientIndexProvider"
  ],
  "implementation": {
    "description": "FHIR Server providing access to information controlled by Provider",
    "url": "https://fhir.example-provider.nhs.uk/"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "json"
  ],
  "rest": [
    {
      "mode": "server",
      "security": {
        "cors": true,
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "Certificates"
              }
            ]
          }
        ],
        "description": "Requests to this instance are secured using mTLS with client certificates issued by provider.nhs.uk"
      },
      "resource": [
        {
          "type": "Patient",
          "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
          "interaction": [
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "identifier",
              "type": "token"
            }
          ]
        }
      ]
    }
  ]
}