{
  "description": "API definition for COVID Vaccination",
  "_filename": "CapabilityStatement-apim-covid-vaccination.json",
  "package_name": "uk.nhsdigital.r4",
  "format": [ "application/fhir+json" ],
  "date": "2021-04-28T00:00:00+00:00",
  "publisher": "digital.nhs.uk",
  "fhirVersion": "4.0.1",
  "name": "APIMCOVIDVaccination",
  "type": null,
  "experimental": null,
  "resourceType": "CapabilityStatement",
  "title": null,
  "package_version": "2.5.1",
  "extension": [ {
    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Package",
    "extension": [ {
      "url": "FHIRPackage",
      "extension": [ {
        "url": "name",
        "valueString": "ukcore.release1.test"
      } ]
    }, {
      "url": "FHIRPackage",
      "extension": [ {
        "url": "name",
        "valueString": "uk.nhsdigital.r4.test"
      } ]
    } ]
  } ],
  "status": "active",
  "id": "9ceffcf4-5a0b-424d-b791-14c1d33f1998",
  "kind": "requirements",
  "url": "https://fhir.nhs.uk/CapabilityStatement/apim-covid-vaccinationhistory",
  "version": "3.0.0",
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "type": "Immunization",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Immunization",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "required",
          "valueString": "patient.identifier"
        }, {
          "url": "required",
          "valueString": "procedure-code:below"
        }, {
          "url": "required",
          "valueString": "_include"
        } ]
      } ],
      "interaction": [ {
        "code": "search-type",
        "extension": [ {
          "url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
          "extension": [ {
            "url": "example",
            "extension": [ {
              "url": "request",
              "valueBoolean": false
            }, {
              "url": "value",
              "valueReference": {
                "reference": "Bundle/dd4c3e37-555d-47fc-9309-37539893e074"
              }
            }, {
              "url": "summary",
              "valueMarkdown": "Immunisation history found"
            }, {
              "url": "description",
              "valueMarkdown": "Request **GET [baseUrl]/Immunization?patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9000000009**"
            } ]
          } ]
        } ]
      } ],
      "searchParam": [ {
        "name": "patient.identifier",
        "type": "token",
        "documentation": "NHS Number"
      }, {
        "name": "procedure-code:below",
        "type": "token",
        "definition": "https://fhir.nhs.uk/SearchParameter/immunization-procedure-code",
        "documentation": "Search in UKCore procedure code extension"
      }, {
        "name": "_include",
        "type": "special",
        "documentation": "Include referenced resources"
      } ]
    } ],
    "security": {
      "service": [ {
        "coding": [ {
          "code": "OAuth",
          "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
          "display": "OAuth2 Token"
        } ]
      } ]
    }
  } ]
}