{
  "description": "Conformance requirements for NHS Digital RESTful Endpoinsts",
  "_filename": "api.json",
  "package_name": "uk.nhsdigital.r4",
  "format": [ "application/fhir+json", "application/fhir+xml" ],
  "date": "2021-04-28T00:00:00+00:00",
  "publisher": "digital.nhs.uk",
  "fhirVersion": "4.0.1",
  "name": "NHS Digital Conformance Capability Statement",
  "type": null,
  "experimental": null,
  "resourceType": "CapabilityStatement",
  "title": null,
  "package_version": "2.1.18-discovery",
  "status": "active",
  "id": "55572f8f-3edc-4c73-a74c-adb11d0f813f",
  "kind": "requirements",
  "url": "https://fhir.nhs.uk/CapabilityStatement/apim-conformance",
  "version": "3.0.0",
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "type": "Encounter",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Encounter",
      "interaction": [ {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "patient:identifier",
        "type": "token",
        "documentation": "The patient identifier (e.g. NHS Number) that the encounter is about"
      }, {
        "name": "patient",
        "type": "reference",
        "documentation": "The patient that the encounter is about"
      }, {
        "name": "class",
        "type": "token",
        "documentation": "Classification of patient encounter"
      }, {
        "name": "identifier",
        "type": "token",
        "documentation": "The identifier that the encounter is about"
      } ]
    }, {
      "type": "DocumentReference",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-DocumentReference",
      "interaction": [ {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "patient:identifier",
        "type": "token",
        "documentation": "Who/what is the subject of the document (by NHS Number)"
      }, {
        "name": "patient",
        "type": "reference",
        "documentation": "Who/what is the subject of the document"
      }, {
        "name": "type",
        "type": "token",
        "documentation": "Kind of document (SNOMED if possible)"
      }, {
        "name": "category",
        "type": "token",
        "documentation": "Categorization of document"
      }, {
        "name": "status",
        "type": "token",
        "documentation": "current | superseded | entered-in-error"
      }, {
        "name": "date",
        "type": "date",
        "documentation": "When this document reference was created"
      }, {
        "name": "period",
        "type": "date",
        "documentation": "Time of service that is being documented"
      } ]
    }, {
      "type": "Flag",
      "interaction": [ {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "patient:identifier",
        "type": "token",
        "documentation": "The patient identifier (e.g. NHS Number) that the flag is about"
      }, {
        "name": "patient",
        "type": "reference",
        "documentation": "The patient that the flag is about"
      } ]
    }, {
      "type": "HealthcareService",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-HealthcareService",
      "interaction": [ {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "identifier",
        "type": "token",
        "documentation": "A organisation identifier (e.g. ODS Code)"
      }, {
        "name": "name",
        "type": "string",
        "documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
      }, {
        "name": "address",
        "type": "string",
        "documentation": "A server defined search that may match any of the string fields in the Address, including line, city, county, country, postalCode, and/or text"
      } ]
    }, {
      "type": "Organization",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization",
      "interaction": [ {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "identifier",
        "type": "token",
        "documentation": "A organisation identifier (e.g. ODS Code)"
      }, {
        "name": "name",
        "type": "string",
        "documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
      }, {
        "name": "address",
        "type": "string",
        "documentation": "A server defined search that may match any of the string fields in the Address, including line, city, county, country, postalCode, and/or text"
      } ]
    }, {
      "type": "Patient",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient",
      "interaction": [ {
        "code": "read"
      }, {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "identifier",
        "type": "token",
        "documentation": "A patient identifier (e.g. NHS Number)"
      }, {
        "name": "name",
        "type": "string",
        "documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
      }, {
        "name": "birthdate",
        "type": "date",
        "documentation": "The patient's date of birth"
      }, {
        "name": "gender",
        "type": "token",
        "documentation": "Gender of the patient"
      }, {
        "name": "family",
        "type": "string",
        "documentation": "A portion of the family name of the patient"
      } ]
    }, {
      "type": "Practitioner",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Practitioner",
      "interaction": [ {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "identifier",
        "type": "token",
        "documentation": "A practitioner identifier (e.g. GMC Code, GMP Code, GPHC Code, etc)"
      }, {
        "name": "name",
        "type": "string",
        "documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
      } ]
    }, {
      "type": "PractitionerRole",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole",
      "interaction": [ {
        "code": "search-type"
      } ],
      "searchParam": [ {
        "name": "organization:identifier",
        "type": "token",
        "documentation": "A organisation identifier (e.g. ODS Code)"
      }, {
        "name": "practitioner:identifier",
        "type": "token",
        "documentation": "A practitioner identifier (e.g. GMC Code, GMP Code, GPHC Code, etc)"
      } ]
    }, {
      "type": "Device",
      "profile": "https://fhir.nhs.uk/StructureDefinition/SDS-Device"
    }, {
      "type": "Endpoint",
      "profile": "https://fhir.nhs.uk/StructureDefinition/SDS-Endpoint"
    } ],
    "security": {
      "service": [ {
        "coding": [ {
          "code": "OAuth",
          "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
          "display": "OAuth2 Token"
        } ]
      } ]
    }
  } ]
}