{
  "description": "API definition for PDS",
  "_filename": "CapabilityStatement-apim-pds.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": "APIMPDS",
  "type": null,
  "experimental": null,
  "resourceType": "CapabilityStatement",
  "title": null,
  "package_version": "2.5.0",
  "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"
      } ]
    }, {
      "url": "openApi",
      "extension": [ {
        "url": "documentation",
        "valueUri": "https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir"
      }, {
        "url": "description",
        "valueString": "Personal Demographics Service - FHIR API"
      } ]
    } ]
  } ],
  "status": "active",
  "id": "555de642-0eba-4b17-a350-010175a60b54",
  "kind": "requirements",
  "url": "https://fhir.nhs.uk/CapabilityStatement/apim-pds",
  "version": "3.0.0",
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "type": "Patient",
      "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient-PDS",
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
          "extension": [ {
            "url": "example",
            "extension": [ {
              "url": "request",
              "valueBoolean": false
            }, {
              "url": "value",
              "valueReference": {
                "reference": "Patient/6aa13139-201b-4a54-9608-b49331a46d90"
              }
            } ]
          } ]
        } ]
      }, {
        "code": "patch"
      }, {
        "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": "Patient/6aa13139-201b-4a54-9608-b49331a46d90"
              }
            } ]
          } ]
        } ]
      } ],
      "searchParam": [ {
        "name": "family",
        "type": "string",
        "documentation": "The patient's family name (surname)."
      }, {
        "name": "given",
        "type": "string",
        "documentation": "A portion of the given name of the patient"
      }, {
        "name": "gender",
        "type": "token",
        "documentation": "Gender of the patient"
      }, {
        "name": "birthdate",
        "type": "date",
        "documentation": "The patient's date of birth"
      }, {
        "name": "death-date",
        "type": "date",
        "documentation": "The date of death has been provided and satisfies this search value"
      }, {
        "name": "address-postcode",
        "type": "string",
        "documentation": "A postalCode specified in an address"
      }, {
        "name": "address-postalcode",
        "type": "string",
        "documentation": "Correction to actual PDS API. A postalCode specified in an address"
      }, {
        "name": "general-practitioner:identifier",
        "type": "token",
        "documentation": "Correction to PDS API. Patient's nominated general practitioner, not the organization that manages the record"
      }, {
        "name": "general-practitioner",
        "type": "reference",
        "documentation": "Correction to PDS API. Patient's nominated general practitioner, not the organization that manages the record"
      } ],
      "documentation": "Person demographics Service"
    }, {
      "type": "RelatedPerson",
      "profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
      "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": "RelatedPerson/507B7621"
              }
            } ]
          } ]
        } ]
      } ],
      "searchParam": [ {
        "name": "patient",
        "type": "reference",
        "documentation": "Patients NHS Number"
      } ],
      "documentation": "Get a Patients related people"
    } ],
    "security": {
      "service": [ {
        "coding": [ {
          "code": "OAuth",
          "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
          "display": "OAuth2 Token"
        } ]
      } ]
    }
  } ]
}