NHS API · Example Payload

Patient Demographics Response

HealthcareFHIRNHSUKHL7Electronic PrescriptionsPatient DemographicsGP ConnectNHS LoginInteroperability

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

Top-level fields

resourceTypeidmetaidentifiernamegenderbirthDateaddressgeneralPractitionerextension

Example Payload

{
  "resourceType": "Patient",
  "id": "9000000009",
  "meta": {
    "versionId": "2",
    "security": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
        "code": "U",
        "display": "unrestricted"
      }
    ]
  },
  "identifier": [
    {
      "system": "https://fhir.nhs.uk/Id/nhs-number",
      "value": "9000000009",
      "extension": [
        {
          "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland",
                "version": "1.0.0",
                "code": "01",
                "display": "Number present and verified"
              }
            ]
          }
        }
      ]
    }
  ],
  "name": [
    {
      "use": "usual",
      "family": "SMITH",
      "given": [
        "Jane"
      ],
      "prefix": [
        "Mrs"
      ],
      "period": {
        "start": "2020-01-01"
      }
    }
  ],
  "gender": "female",
  "birthDate": "1970-06-15",
  "address": [
    {
      "id": "456",
      "use": "home",
      "line": [
        "1 Trevelyan Square",
        "Boar Lane"
      ],
      "city": "Leeds",
      "district": "West Yorkshire",
      "postalCode": "LS1 6AE",
      "period": {
        "start": "2020-01-01"
      }
    }
  ],
  "generalPractitioner": [
    {
      "id": "254406A3-0F0F-4EB0-9F8E-EB5E8BB19C71",
      "type": "Organization",
      "identifier": {
        "system": "https://fhir.nhs.uk/Id/ods-organization-code",
        "value": "Y12345"
      }
    }
  ],
  "extension": [
    {
      "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NominatedPharmacy",
      "valueReference": {
        "identifier": {
          "system": "https://fhir.nhs.uk/Id/ods-organization-code",
          "value": "Y23456"
        }
      }
    }
  ]
}