description: This profile is designed around Patient Demographics Services and PDS may be used as the source of this data. \r\nUse of PDS is not mandatory for Patient resources, Patient Administration Systems (PAS) and Master Patient Index (MPI) may be used instead. Only traced NHS Number SHOULD be used with this resource unless explicitly stated. Within NHS Trusts the inclusion of MRN (Medical Record Numbers) identifiers is highly recommended.
package_name: uk.nhsdigital.r4
derivation: constraint
name: NHSDigitalPatient
type: Patient
elements:
  address:
    mustSupport: true
    index: 17
    extensions:
      addressKey:
        url: null
        mustSupport: true
        index: 18
        extensions: {}
        elements:
          extension: {array: true, min: 2, index: 19}
    elements:
      extension:
        mustSupport: true
        index: 18
        slicing:
          slices:
            addressKey:
              match: {}
              schema:
                mustSupport: true
                index: 18
                extensions: {}
                elements:
                  extension: {array: true, min: 2, index: 19}
      use: {short: 'The following values are allowed: home, work, temp, billing', index: 20}
      line: {index: 21}
  managingOrganization:
    elements:
      identifier:
        index: 33
        elements:
          system:
            pattern: {type: Uri, value: 'https://fhir.nhs.uk/Id/ods-organization-code'}
            index: 34
    required: [identifier]
  name:
    mustSupport: true
    index: 8
    elements:
      use: {short: 'The following values are allowed:  usual, temp, nickname, old, maiden', index: 9}
      family: {mustSupport: true, index: 10}
      given: {mustSupport: true, array: true, max: 5, index: 11}
  birthDate: {mustSupport: true, index: 14}
  multipleBirth:
    choices: []
    index: 23
  deceased:
    mustSupport: true
    choices: []
    index: 16
  extension:
    index: 0
    slicing:
      slices:
        deathNotificationStatus:
          match: {}
          schema:
            index: 0
            extensions: {}
            elements:
              extension: {index: 1}
            required: [extension]
        medicalApplianceSupplier:
          match: {}
          schema: {type: Extension, mustSupport: true, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicalApplianceSupplier', index: 2}
          max: 1
        nominatedPharmacy:
          match: {}
          schema: {type: Extension, mustSupport: true, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NominatedPharmacy', index: 3}
        preferredDispenserOrganization:
          match: {}
          schema: {type: Extension, mustSupport: true, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PreferredDispenserOrganization', index: 4}
          max: 1
  communication: {mustSupport: true, index: 25}
  identifier:
    short: The patient's NHS number. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a valid NHS number.
    mustSupport: true
    index: 5
    slicing:
      slices:
        nhsNumber:
          match: {}
          schema:
            mustSupport: true
            index: 6
            elements:
              system: {mustSupport: true, index: 7}
  telecom: {mustSupport: true, index: 12}
  generalPractitioner:
    type: Reference
    mustSupport: true
    refers: ['https://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization', 'https://fhir.nhs.uk/StructureDefinition/NHSDigital-Practitioner', 'https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole']
    index: 26
    elements:
      identifier:
        elements:
          system: {index: 27}
          value: {index: 28}
        required: [value, system]
    slicing:
      rules: openAtEnd
      discriminator:
      - {path: identifier.system, type: value}
      min: null
      slices:
        registeredGPPractice:
          match:
            identifier: {system: 'https://fhir.nhs.uk/Id/ods-organization-code'}
          schema:
            index: 29
            elements:
              identifier:
                elements:
                  system:
                    pattern: {type: Uri, value: 'https://fhir.nhs.uk/Id/ods-organization-code'}
                    index: 30
        registeredGeneralMedicalPractitioner:
          match:
            identifier: {system: 'https://fhir.nhs.uk/Id/gmp-number'}
          schema:
            short: Patient registered GP
            index: 31
            elements:
              identifier:
                elements:
                  system:
                    pattern: {type: Uri, value: 'https://fhir.nhs.uk/Id/gmp-number'}
                    index: 32
  gender: {mustSupport: true, index: 13}
  contact: {mustSupport: true, index: 24}
package_version: 2.10.0
extensions:
  deathNotificationStatus:
    url: null
    index: 0
    extensions: {}
    elements:
      extension: {index: 1}
    required: [extension]
  medicalApplianceSupplier: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicalApplianceSupplier', max: 1, type: Extension, mustSupport: true, index: 2}
  nominatedPharmacy: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NominatedPharmacy', type: Extension, mustSupport: true, index: 3}
  preferredDispenserOrganization: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PreferredDispenserOrganization', max: 1, type: Extension, mustSupport: true, index: 4}
class: profile
kind: resource
url: https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient
base: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient
version: null