FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/UKCoreAccessPatientIndexProvider

Packageuk-core-access
TypeCapabilityStatement
IdUKCoreAccessPatientIndexProvider
FHIR VersionR4
Sourcehttps://fhir.hl7.org.uk/uk-core-access/https://build.fhir.org/ig/HL7-UK/UK-Core-Access/CapabilityStatement-UKCoreAccessPatientIndexProvider.html
URLhttps://fhir.hl7.org.uk/uk-core-access/CapabilityStatement/UKCoreAccessPatientIndexProvider
Version0.1.0
Statusactive
Date2023-02-01
TitleUKCore Access Patient Index Provider
Realmuk
Authorityhl7
DescriptionProvider supports read-only access to a patient index for the purposes of direct care and subject of care access.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
UKCoreAccessPatientIndexPatientUKCoreAccessPatientIndexPatient

Narrative

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

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

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

Source

{
  "resourceType": "CapabilityStatement",
  "id": "UKCoreAccessPatientIndexProvider",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://fhir.hl7.org.uk/uk-core-access/CapabilityStatement/UKCoreAccessPatientIndexProvider",
  "version": "0.1.0",
  "title": "UKCore Access Patient Index 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 a patient index 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"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "birthdate"
                },
                {
                  "url": "required",
                  "valueString": "family"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "birthdate"
                },
                {
                  "url": "required",
                  "valueString": "name"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "gender"
                },
                {
                  "url": "required",
                  "valueString": "family"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                },
                {
                  "url": "required",
                  "valueString": "gender"
                },
                {
                  "url": "required",
                  "valueString": "name"
                }
              ],
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type": "Patient",
          "profile": "https://fhir.hl7.org.uk/uk-core-access/StructureDefinition/UKCoreAccessPatientIndexPatient",
          "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": "SHOULD"
                }
              ],
              "name": "birthdate",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "family",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "gender",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "given",
              "type": "string"
            },
            {
              "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": "SHALL"
                }
              ],
              "name": "name",
              "type": "string"
            }
          ]
        }
      ]
    }
  ]
}