description: This profile defines the UK constraints and extensions on the International FHIR resource [Patient](https://hl7.org/fhir/R4/Patient.html).
package_name: fhir.r4.ukcore.stu2
derivation: constraint
name: UKCorePatient
type: Patient
elements:
  address:
    mustSupport: true
    index: 33
    extensions:
      addressKey: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey', type: Extension, short: A patient's address key and type, mustSupport: false, index: 34}
    elements:
      extension:
        type: Extension
        short: A patient's address key and type
        mustSupport: false
        url: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
        index: 34
        slicing:
          slices:
            addressKey:
              match: {}
              schema: {type: Extension, short: A patient's address key and type, mustSupport: false, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey', index: 34}
      line: {mustSupport: true, index: 35}
      city: {mustSupport: true, index: 36}
      postalCode: {mustSupport: true, index: 37}
  name:
    mustSupport: true
    index: 21
    elements:
      family: {mustSupport: true, index: 22}
      given: {mustSupport: true, index: 23}
  birthDate:
    mustSupport: true
    index: 29
    extensions:
      birthTime:
        url: http://hl7.org/fhir/StructureDefinition/patient-birthTime
        type: Extension
        short: Time of day of birth.
        index: 30
        elements:
          value:
            short: Time of day of birth.
            choices: []
            index: 32
    elements:
      extension:
        type: Extension
        short: Time of day of birth.
        url: http://hl7.org/fhir/StructureDefinition/patient-birthTime
        index: 30
        slicing:
          slices:
            birthTime:
              match: {}
              schema:
                type: Extension
                short: Time of day of birth.
                url: http://hl7.org/fhir/StructureDefinition/patient-birthTime
                index: 30
                elements:
                  value:
                    short: Time of day of birth.
                    choices: []
                    index: 32
  extension:
    type: Extension
    short: The registered place of birth of the patient.
    url: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    index: 0
    slicing:
      slices:
        patientInterpreterRequired:
          match: {}
          schema:
            type: Extension
            url: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
            index: 11
            elements:
              value:
                short: Indicator showing whether the patient needs an interpreter
                choices: []
                index: 13
        contactPreference:
          match: {}
          schema: {type: Extension, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference', index: 7}
        residentialStatus:
          match: {}
          schema: {type: Extension, short: The residential status of the patient., url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus', index: 10}
        cadavericDonor:
          match: {}
          schema:
            type: Extension
            short: Post-mortem donor status.
            url: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
            index: 4
            elements:
              value:
                short: Post-mortem donor status.
                choices: []
                index: 6
        ethnicCategory:
          match: {}
          schema: {type: Extension, short: The ethnicity of the subject, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory', index: 9}
          max: 1
        nhsNumberUnavailableReason:
          match: {}
          schema: {type: Extension, short: Reason why this Patient does not include an NHS Number identifier, isModifier: false, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason', index: 14}
        deathNotificationStatus:
          match: {}
          schema: {type: Extension, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus', index: 8}
        birthPlace:
          match: {}
          schema:
            type: Extension
            short: The registered place of birth of the patient.
            url: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
            index: 0
            elements:
              value:
                short: The registered place of birth of the patient.
                choices: []
                index: 2
        birthSex:
          match: {}
          schema: {type: Extension, short: The patient's phenotypic sex at birth., url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex', index: 3}
  active: {mustSupport: true, index: 20}
  communication:
    extensions:
      proficiency:
        url: http://hl7.org/fhir/StructureDefinition/patient-proficiency
        type: Extension
        index: 43
        extensions:
          level:
            url: null
            index: 44
            elements:
              value:
                short: The proficiency level for the communication
                choices: []
                index: 46
          type:
            url: null
            index: 47
            elements:
              value:
                short: The proficiency type for the communication
                choices: []
                index: 49
        elements:
          extension:
            index: 44
            slicing:
              slices:
                level:
                  match: {}
                  schema:
                    index: 44
                    elements:
                      value:
                        short: The proficiency level for the communication
                        choices: []
                        index: 46
                type:
                  match: {}
                  schema:
                    index: 47
                    elements:
                      value:
                        short: The proficiency type for the communication
                        choices: []
                        index: 49
    elements:
      extension:
        type: Extension
        url: http://hl7.org/fhir/StructureDefinition/patient-proficiency
        index: 43
        slicing:
          slices:
            proficiency:
              match: {}
              schema:
                type: Extension
                url: http://hl7.org/fhir/StructureDefinition/patient-proficiency
                index: 43
                extensions:
                  level:
                    url: null
                    index: 44
                    elements:
                      value:
                        short: The proficiency level for the communication
                        choices: []
                        index: 46
                  type:
                    url: null
                    index: 47
                    elements:
                      value:
                        short: The proficiency type for the communication
                        choices: []
                        index: 49
                elements:
                  extension:
                    index: 44
                    slicing:
                      slices:
                        level:
                          match: {}
                          schema:
                            index: 44
                            elements:
                              value:
                                short: The proficiency level for the communication
                                choices: []
                                index: 46
                        type:
                          match: {}
                          schema:
                            index: 47
                            elements:
                              value:
                                short: The proficiency type for the communication
                                choices: []
                                index: 49
      language:
        short: A ValueSet that identifies the language used by a person.
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/all-languages'}
        index: 50
  identifier:
    mustSupport: true
    index: 15
    slicing:
      rules: open
      ordered: false
      discriminator:
      - {path: system, type: value}
      min: null
      slices:
        nhsNumber:
          match: {system: 'https://fhir.nhs.uk/Id/nhs-number'}
          schema:
            short: The patient's NHS number
            mustSupport: false
            index: 16
            extensions:
              nhsNumberVerificationStatus: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus', max: 1, type: Extension, mustSupport: false, index: 17}
            elements:
              extension:
                type: Extension
                mustSupport: false
                url: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus
                index: 17
                slicing:
                  slices:
                    nhsNumberVerificationStatus:
                      match: {}
                      schema: {type: Extension, mustSupport: false, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus', index: 17}
                      max: 1
              system:
                pattern: {type: uri, value: 'https://fhir.nhs.uk/Id/nhs-number'}
                mustSupport: true
                type: uri
                index: 18
              value: {mustSupport: true, index: 19}
            required: [system, value]
  telecom:
    mustSupport: true
    index: 24
    elements:
      system:
        mustSupport: true
        index: 25
        extensions:
          otherContactSystem: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem', type: Extension, index: 26}
        elements:
          extension:
            type: Extension
            url: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
            index: 26
            slicing:
              slices:
                otherContactSystem:
                  match: {}
                  schema: {type: Extension, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem', index: 26}
      value: {mustSupport: true, index: 27}
  gender: {mustSupport: true, index: 28}
  maritalStatus:
    binding: {strength: extensible, valueSet: 'https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode'}
    index: 38
  contact:
    extensions:
      contactRank: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank', type: Extension, index: 39}
      copyCorrespondenceIndicator: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator', type: Extension, index: 40}
    elements:
      extension:
        type: Extension
        url: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank
        index: 39
        slicing:
          slices:
            contactRank:
              match: {}
              schema: {type: Extension, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank', index: 39}
            copyCorrespondenceIndicator:
              match: {}
              schema: {type: Extension, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator', index: 40}
      relationship:
        binding: {strength: extensible, valueSet: 'https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType'}
        index: 41
      telecom:
        elements:
          system:
            extensions:
              otherContactSystem: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem', type: Extension, index: 42}
            elements:
              extension:
                type: Extension
                url: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
                index: 42
                slicing:
                  slices:
                    otherContactSystem:
                      match: {}
                      schema: {type: Extension, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem', index: 42}
package_version: 2.0.0
extensions:
  patientInterpreterRequired:
    url: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
    type: Extension
    index: 11
    elements:
      value:
        short: Indicator showing whether the patient needs an interpreter
        choices: []
        index: 13
  contactPreference: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference', type: Extension, index: 7}
  residentialStatus: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus', type: Extension, short: The residential status of the patient., index: 10}
  cadavericDonor:
    url: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
    type: Extension
    short: Post-mortem donor status.
    index: 4
    elements:
      value:
        short: Post-mortem donor status.
        choices: []
        index: 6
  ethnicCategory: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory', max: 1, type: Extension, short: The ethnicity of the subject, index: 9}
  nhsNumberUnavailableReason: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason', type: Extension, short: Reason why this Patient does not include an NHS Number identifier, isModifier: false, index: 14}
  deathNotificationStatus: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus', type: Extension, index: 8}
  birthPlace:
    url: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
    type: Extension
    short: The registered place of birth of the patient.
    index: 0
    elements:
      value:
        short: The registered place of birth of the patient.
        choices: []
        index: 2
  birthSex: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex', type: Extension, short: The patient's phenotypic sex at birth., index: 3}
class: profile
kind: resource
url: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient
base: http://hl7.org/fhir/StructureDefinition/Patient
version: 2.5.0