NHS England · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Organisation Data Service (ODS) - FHIR API

1 action 1 update update extends openapi/nhs-organisation-data-service-fhir-r4-openapi.yaml

Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-standardsx-apievangelist-authx-apievangelist-platformx-apievangelist-sandbox

Targets 1

$.info

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Organisation Data Service (ODS) - FHIR API
  version: 1.0.0
extends: openapi/nhs-organisation-data-service-fhir-r4-openapi.yaml
actions:
  - target: $.info
    update:
      x-apievangelist-provider: nhs-england
      x-apievangelist-standards: [HL7 FHIR R4, FHIR UK Core, OAuth 2.0]
      x-apievangelist-auth: OAuth 2.0 bearer (application-restricted or user-restricted via NHS login / CIS2)
      x-apievangelist-platform: NHS API platform (api.service.nhs.uk)
      x-apievangelist-sandbox: https://sandbox.api.service.nhs.uk