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.stu3.currentbuild
derivation: constraint
name: UKCorePatient
type: Patient
elements:
  address:
    mustSupport: true
    index: 30
    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: 31}
    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: 31
        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: 31}
  managingOrganization: {mustSupport: true, index: 45}
  name: {short: A name associated with the patient., mustSupport: true, index: 22}
  birthDate:
    short: The date of birth for the individual.
    mustSupport: true
    index: 26
    extensions:
      birthTime:
        url: http://hl7.org/fhir/StructureDefinition/patient-birthTime
        type: Extension
        short: The time of day that the patient was born. This SHOULD be included when the birth time is relevant.
        index: 27
        elements:
          value:
            short: Time of day of birth.
            choices: []
            index: 29
    elements:
      extension:
        type: Extension
        short: The time of day that the patient was born. This SHOULD be included when the birth time is relevant.
        url: http://hl7.org/fhir/StructureDefinition/patient-birthTime
        index: 27
        slicing:
          slices:
            birthTime:
              match: {}
              schema:
                type: Extension
                short: The time of day that the patient was born. This SHOULD be included when the birth time is relevant.
                url: http://hl7.org/fhir/StructureDefinition/patient-birthTime
                index: 27
                elements:
                  value:
                    short: Time of day of birth.
                    choices: []
                    index: 29
  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
            short: Indicator showing whether the patient needs an interpreter.
            url: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
            index: 12
            elements:
              value:
                short: Indicator showing whether the patient needs an interpreter
                choices: []
                index: 14
        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: 11}
        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: 15}
        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}
        fetalStatus:
          match: {}
          schema: {type: Extension, isModifier: false, url: 'http://hl7.org/fhir/6.0/StructureDefinition/extension-Patient.fetalStatus', index: 10}
  active: {short: Whether this patient's record is in active use., mustSupport: true, index: 21}
  communication:
    extensions:
      proficiency:
        url: http://hl7.org/fhir/StructureDefinition/patient-proficiency
        type: Extension
        short: The patient's proficiency level of the communication method.
        index: 37
        extensions:
          level:
            url: null
            index: 38
            elements:
              value:
                short: The proficiency level for the communication
                choices: []
                index: 40
          type:
            url: null
            index: 41
            elements:
              value:
                short: The proficiency type for the communication
                choices: []
                index: 43
        elements:
          extension:
            index: 38
            slicing:
              slices:
                level:
                  match: {}
                  schema:
                    index: 38
                    elements:
                      value:
                        short: The proficiency level for the communication
                        choices: []
                        index: 40
                type:
                  match: {}
                  schema:
                    index: 41
                    elements:
                      value:
                        short: The proficiency type for the communication
                        choices: []
                        index: 43
    elements:
      extension:
        type: Extension
        short: The patient's proficiency level of the communication method.
        url: http://hl7.org/fhir/StructureDefinition/patient-proficiency
        index: 37
        slicing:
          slices:
            proficiency:
              match: {}
              schema:
                type: Extension
                short: The patient's proficiency level of the communication method.
                url: http://hl7.org/fhir/StructureDefinition/patient-proficiency
                index: 37
                extensions:
                  level:
                    url: null
                    index: 38
                    elements:
                      value:
                        short: The proficiency level for the communication
                        choices: []
                        index: 40
                  type:
                    url: null
                    index: 41
                    elements:
                      value:
                        short: The proficiency type for the communication
                        choices: []
                        index: 43
                elements:
                  extension:
                    index: 38
                    slicing:
                      slices:
                        level:
                          match: {}
                          schema:
                            index: 38
                            elements:
                              value:
                                short: The proficiency level for the communication
                                choices: []
                                index: 40
                        type:
                          match: {}
                          schema:
                            index: 41
                            elements:
                              value:
                                short: The proficiency type for the communication
                                choices: []
                                index: 43
      language:
        short: A ValueSet that identifies the language used by a person.
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/all-languages'}
        index: 44
  identifier:
    short: An identifier for this patient.
    mustSupport: true
    index: 16
    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: 17
            extensions:
              nhsNumberVerificationStatus: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus', max: 1, type: Extension, mustSupport: false, index: 18}
            elements:
              extension:
                type: Extension
                mustSupport: false
                url: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus
                index: 18
                slicing:
                  slices:
                    nhsNumberVerificationStatus:
                      match: {}
                      schema: {type: Extension, mustSupport: false, url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus', index: 18}
                      max: 1
              system:
                pattern: {type: uri, value: 'https://fhir.nhs.uk/Id/nhs-number'}
                type: uri
                index: 19
              value: {index: 20}
            required: [system, value]
  telecom:
    short: A contact detail for the individual.
    mustSupport: true
    index: 23
    elements:
      system:
        extensions:
          otherContactSystem: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem', type: Extension, short: Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`., index: 24}
        elements:
          extension:
            type: Extension
            short: Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
            url: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
            index: 24
            slicing:
              slices:
                otherContactSystem:
                  match: {}
                  schema: {type: Extension, short: Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`., url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem', index: 24}
  gender: {short: The gender that the patient is considered to have for administration and record keeping purposes., mustSupport: true, index: 25}
  maritalStatus:
    binding: {strength: extensible, valueSet: 'https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode'}
    index: 32
  contact:
    extensions:
      contactRank: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank', type: Extension, short: The preferred ranking or order of contact applied to a contact on a Patient's contact list., index: 33}
      copyCorrespondenceIndicator: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator', type: Extension, short: Indicates that a must be copied in to all related correspondence., index: 34}
    elements:
      extension:
        type: Extension
        short: The preferred ranking or order of contact applied to a contact on a Patient's contact list.
        url: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank
        index: 33
        slicing:
          slices:
            contactRank:
              match: {}
              schema: {type: Extension, short: The preferred ranking or order of contact applied to a contact on a Patient's contact list., url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank', index: 33}
            copyCorrespondenceIndicator:
              match: {}
              schema: {type: Extension, short: Indicates that a must be copied in to all related correspondence., url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator', index: 34}
      relationship:
        binding: {strength: extensible, valueSet: 'https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType'}
        index: 35
      telecom:
        elements:
          system:
            extensions:
              otherContactSystem: {url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem', type: Extension, short: Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`., index: 36}
            elements:
              extension:
                type: Extension
                short: Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
                url: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
                index: 36
                slicing:
                  slices:
                    otherContactSystem:
                      match: {}
                      schema: {type: Extension, short: Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`., url: 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem', index: 36}
package_version: 0.0.17-pre-release
extensions:
  patientInterpreterRequired:
    url: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
    type: Extension
    short: Indicator showing whether the patient needs an interpreter.
    index: 12
    elements:
      value:
        short: Indicator showing whether the patient needs an interpreter
        choices: []
        index: 14
  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: 11}
  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: 15}
  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}
  fetalStatus: {url: 'http://hl7.org/fhir/6.0/StructureDefinition/extension-Patient.fetalStatus', type: Extension, isModifier: false, index: 10}
class: profile
kind: resource
url: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient
base: http://hl7.org/fhir/StructureDefinition/Patient
version: 2.6.1