NHS API · Example Payload

Organisation Search Response

HealthcareFHIRNHSUKHL7Electronic PrescriptionsPatient DemographicsGP ConnectNHS LoginInteroperability

Organisation Search Response is an example object payload from NHS API, with 7 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

resourceTypeidmetatypetotallinkentry

Example Payload

Raw ↑ 
{
  "resourceType": "Bundle",
  "id": "7d37e8e6-24a5-4b62-b51e-51ec8dc5d65d",
  "meta": {
    "lastUpdated": "2026-06-13T10:00:00+00:00"
  },
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://api.service.nhs.uk/organisation-data-service/FHIR/R4/Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|RJ1"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://api.service.nhs.uk/organisation-data-service/FHIR/R4/Organization/RJ1",
      "resource": {
        "resourceType": "Organization",
        "id": "RJ1",
        "meta": {
          "lastUpdated": "2024-01-15T09:00:00+00:00",
          "versionId": "20240115"
        },
        "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "RJ1"
          }
        ],
        "active": true,
        "type": [
          {
            "coding": [
              {
                "system": "https://fhir.nhs.uk/CodeSystem/NHSD-OrganisationType",
                "code": "TRU",
                "display": "NHS Trust"
              }
            ]
          }
        ],
        "name": "SOUTH LONDON AND MAUDSLEY NHS FOUNDATION TRUST",
        "telecom": [
          {
            "system": "phone",
            "value": "020 3228 6000",
            "use": "work"
          }
        ],
        "address": [
          {
            "use": "work",
            "line": [
              "Maudsley Hospital",
              "Denmark Hill"
            ],
            "city": "London",
            "postalCode": "SE5 8AZ",
            "country": "ENGLAND"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}