{
  "description": "Requirements for NHS England ODS FHIR API Implementation Guide",
  "_filename": "CapabilityStatement-England-ODS-Requirements.json",
  "package_name": "fhir.r4.nhsengland.programme",
  "format": [ "application/fhir+json", "application/fhir+xml" ],
  "date": "2024-02-14",
  "publisher": "NHS England",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "GB-ENG",
      "system": "urn:iso:std:iso:3166:-2",
      "display": "England"
    } ]
  } ],
  "purpose": "Requirements for NHS England ODS FHIR API Implementation Guide, to specify the RESTFul interactions, supported profiles, and expected minimum SearchParamneters.",
  "name": "EnglandODSRequirements",
  "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
  "type": null,
  "experimental": null,
  "resourceType": "CapabilityStatement",
  "title": "England ODS Requirements",
  "package_version": "0.0.1",
  "status": "draft",
  "id": "79656f07-cbde-4d47-9497-47325644cd9e",
  "kind": "requirements",
  "implementationGuide": [ "https://simplifier.net/guide/organisational-data-services" ],
  "url": "https://fhir.nhs.uk/England/CapabilityStatement/England-ODS-Requirements",
  "version": "0.0.2",
  "contact": [ {
    "name": "NHS England",
    "telecom": [ {
      "use": "work",
      "rank": 1,
      "value": "interoperabilityteam@nhs.net",
      "system": "email"
    } ]
  } ],
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "type": "Organization",
      "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
      "interaction": [ {
        "code": "read"
      }, {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "identifier",
        "type": "token",
        "definition": "http://hl7.org/fhir/SearchParameter/identifier"
      }, {
        "name": "active",
        "type": "token",
        "definition": "http://hl7.org/fhir/SearchParameter/active"
      }, {
        "name": "type",
        "type": "token",
        "definition": "http://hl7.org/fhir/SearchParameter/type"
      }, {
        "name": "name",
        "type": "string",
        "definition": "http://hl7.org/fhir/SearchParameter/name"
      }, {
        "name": "address-country",
        "type": "string",
        "definition": "http://hl7.org/fhir/SearchParameter/address-country"
      }, {
        "name": "roleCode",
        "type": "token",
        "definition": "https://fhir.nhs.uk/England/SearchParameter/England-Extension-OrganisationRole-RoleCode"
      }, {
        "name": "lastChangeDate",
        "type": "date",
        "definition": "https://fhir.nhs.uk/England/SearchParameter/England-Extension-TypedDateTime-LastChangeDate"
      }, {
        "name": "activeRoleCode",
        "type": "token",
        "definition": "https://fhir.nhs.uk/England/SearchParameter/England-Extension-OrganisationRole-ActiveRoleCode"
      } ]
    }, {
      "type": "OrganizationAffiliation",
      "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-OrganizationAffiliation",
      "interaction": [ {
        "code": "read"
      }, {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "identifier",
        "type": "token",
        "definition": "http://hl7.org/fhir/SearchParameter/identifier"
      }, {
        "name": "active",
        "type": "token",
        "definition": "http://hl7.org/fhir/SearchParameter/active"
      }, {
        "name": "primary-organization",
        "type": "reference",
        "definition": "http://hl7.org/fhir/SearchParameter/primary-organization"
      }, {
        "name": "participating-organization",
        "type": "reference",
        "definition": "http://hl7.org/fhir/SearchParameter/participating-organization"
      } ]
    } ],
    "security": {
      "cors": false,
      "service": [ {
        "coding": [ {
          "code": "OAuth",
          "system": "http://terminology.hl7.org/CodeSystem/restful-security-service"
        } ]
      } ],
      "description": "This API is application-restricted, meaning we authenticate the calling application but not the end user.  We are using OAuth 2.0. To use this access mode, you will be provided with a client id and client secret.  These are currently set to expire after 24 hours, after which time you will need to request a new token.  A client credentials token is necessary to obtain to authenticate with the Terminology Server. A free tool like Postman can be used to obtain tokens and issue requests, or any other RESTful client"
    }
  } ]
}