description: Israel Core Proposed constraints and extensions on the Patient Resource.
package_name: il.core.fhir.r4
derivation: constraint
name: ILCorePatient
type: Patient
elements:
  address: {type: Address, index: 59}
  managingOrganization:
    type: Reference
    refers: ['http://fhir.health.gov.il/StructureDefinition/il-core-organization']
    index: 66
  name:
    constraint:
      il-patient-name: {human: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present., source: 'http://fhir.health.gov.il/StructureDefinition/il-core-patient', severity: error, expression: '(family.exists() or given.exists()) xor name.extension(''http://hl7.org/fhir/StructureDefinition/data-absent-reason'').exists()'}
    mustSupport: true
    index: 32
    extensions:
      dataAbsentReason: {url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', min: 0, max: 1, type: Extension, index: 33}
    elements:
      extension:
        type: Extension
        url: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        index: 33
        slicing:
          slices:
            dataAbsentReason:
              match: {}
              schema: {type: Extension, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', index: 33}
              min: 0
              max: 1
      family: {mustSupport: true, index: 34}
      given: {mustSupport: true, index: 35}
    slicing:
      rules: open
      discriminator:
      - {path: 'extension(''http://hl7.org/fhir/StructureDefinition/language'').value', type: value}
      min: 1
      slices:
        Hebrew:
          match:
            extension('http://hl7:
              org/fhir/StructureDefinition/language'): {value: null}
          schema:
            array: true
            index: 36
            extensions:
              dataAbsentReason: {url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', min: 0, max: 1, type: Extension, index: 38}
              language:
                url: http://hl7.org/fhir/StructureDefinition/language
                type: Extension
                index: 39
                elements:
                  value:
                    pattern: {type: Code, value: he}
                    choices: []
                    index: 41
            elements:
              extension:
                index: 37
                slicing:
                  slices:
                    dataAbsentReason:
                      match: {}
                      schema: {type: Extension, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', index: 38}
                      min: 0
                      max: 1
                    language:
                      match: {}
                      schema:
                        type: Extension
                        url: http://hl7.org/fhir/StructureDefinition/language
                        index: 39
                        elements:
                          value:
                            pattern: {type: Code, value: he}
                            choices: []
                            index: 41
            required: [extension]
        English:
          match:
            extension('http://hl7:
              org/fhir/StructureDefinition/language'): {value: null}
          schema:
            array: true
            index: 42
            extensions:
              dataAbsentReason: {url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', min: 0, max: 1, type: Extension, index: 44}
              language:
                url: http://hl7.org/fhir/StructureDefinition/language
                type: Extension
                index: 45
                elements:
                  value:
                    pattern: {type: Code, value: en}
                    choices: []
                    index: 47
            elements:
              extension:
                index: 43
                slicing:
                  slices:
                    dataAbsentReason:
                      match: {}
                      schema: {type: Extension, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', index: 44}
                      min: 0
                      max: 1
                    language:
                      match: {}
                      schema:
                        type: Extension
                        url: http://hl7.org/fhir/StructureDefinition/language
                        index: 45
                        elements:
                          value:
                            pattern: {type: Code, value: en}
                            choices: []
                            index: 47
            required: [extension]
        Arabic:
          match:
            extension('http://hl7:
              org/fhir/StructureDefinition/language'): {value: null}
          schema:
            array: true
            index: 48
            extensions:
              dataAbsentReason: {url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', min: 0, max: 1, type: Extension, index: 50}
              language:
                url: http://hl7.org/fhir/StructureDefinition/language
                type: Extension
                index: 51
                elements:
                  value:
                    pattern: {type: Code, value: ar}
                    choices: []
                    index: 53
            elements:
              extension:
                index: 49
                slicing:
                  slices:
                    dataAbsentReason:
                      match: {}
                      schema: {type: Extension, url: 'http://hl7.org/fhir/StructureDefinition/data-absent-reason', index: 50}
                      min: 0
                      max: 1
                    language:
                      match: {}
                      schema:
                        type: Extension
                        url: http://hl7.org/fhir/StructureDefinition/language
                        index: 51
                        elements:
                          value:
                            pattern: {type: Code, value: ar}
                            choices: []
                            index: 53
            required: [extension]
  birthDate: {mustSupport: true, index: 58}
  extension:
    index: 0
    slicing:
      rules: open
      ordered: false
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        hmo:
          match: {url: null}
          schema: {short: 'Extension: Israel Core HMO (קופת חולים)', type: Extension, mustSupport: true, url: 'http://fhir.health.gov.il/StructureDefinition/ext-il-hmo', index: 1}
          min: 0
          max: 1
        parentName:
          match: {url: null}
          schema: {short: 'Extension: Administrative Parent Name', type: Extension, mustSupport: true, url: 'http://fhir.health.gov.il/StructureDefinition/ext-administrative-parent-name', index: 2}
          min: 0
        birthPlace:
          match: {url: null}
          schema: {type: Extension, short: 'Extension: Place of Birth for patient', url: 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace', index: 3}
          min: 0
          max: 1
        immigration:
          match: {url: null}
          schema: {type: Extension, short: 'Extension: Patient Immigration', url: 'http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration', index: 4}
          min: 0
        birthSex:
          match: {url: null}
          schema: {type: Extension, short: 'Extension: US Core Birth Sex Extension', url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex', index: 5}
          min: 0
          max: 1
  link:
    elements:
      other:
        type: Reference
        refers: ['http://fhir.health.gov.il/StructureDefinition/il-core-patient', 'http://fhir.health.gov.il/StructureDefinition/il-core-related-person']
        index: 67
  communication:
    elements:
      language: {mustSupport: true, index: 64}
  identifier:
    index: 6
    elements:
      system: {mustSupport: true, index: 7}
      value: {short: The value that is unique within the system., mustSupport: true, index: 8}
    required: [value, system]
    slicing:
      rules: open
      discriminator:
      - {path: system, type: value}
      min: 1
      slices:
        il-id:
          match: {system: 'http://fhir.health.gov.il/identifier/il-national-id'}
          schema:
            short: Israeli National Identifier
            mustSupport: true
            index: 9
            elements:
              system:
                pattern: {type: Uri, value: 'http://fhir.health.gov.il/identifier/il-national-id'}
                index: 10
              value:
                short: An Israeli ID number
                constraint:
                  il-id-chk:
                    human: Israeli ID must be 9-digits with a correct check-digit at the end.
                    source: http://fhir.health.gov.il/StructureDefinition/il-core-patient
                    severity: error
                    expression: "matches('[0-9]{9}$') and\r\nsubstring(8,1).toInteger()=\r\n(10-((substring(0,1).toInteger() +\r\nsubstring(1,1).toInteger()*2 mod 10 +\r\nsubstring(1,1).toInteger()*2 div 10 +\r\nsubstring(2,1).toInteger() +\r\nsubstring(3,1).toInteger()*2 mod 10 +\r\nsubstring(3,1).toInteger()*2 div 10 +\r\nsubstring(4,1).toInteger() +\r\nsubstring(5,1).toInteger()*2 mod 10 +\r\nsubstring(5,1).toInteger()*2 div 10 +\r\nsubstring(6,1).toInteger() +\r\nsubstring(7,1).toInteger()*2 mod 10 +\r\nsubstring(7,1).toInteger()*2 div 10) mod 10)) mod 10"
                index: 11
              assigner:
                type: Reference
                refers: ['http://fhir.health.gov.il/StructureDefinition/il-core-organization']
                index: 12
        pna-id:
          match: {system: 'http://fhir.health.gov.il/identifier/pna-national-id'}
          schema:
            short: Palestinian National Identifier
            mustSupport: false
            index: 13
            elements:
              system:
                pattern: {type: Uri, value: 'http://fhir.health.gov.il/identifier/pna-national-id'}
                index: 14
              value: {short: A Palestininan ID number, index: 15}
        ppn:
          match: {system: null}
          schema:
            short: Passport Number
            mustSupport: false
            array: true
            index: 16
            elements:
              type:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: PPN, system: 'http://terminology.hl7.org/CodeSystem/v2-0203'}
                index: 17
              system:
                binding: {strength: required, valueSet: 'http://fhir.health.gov.il/ValueSet/passport-uri'}
                index: 18
              value: {short: Passport Number, index: 19}
        prisoner-id:
          match: {system: 'http://fhir.health.gov.il/identifier/il-prisoner-number'}
          schema:
            short: Prisoner Number
            mustSupport: true
            index: 20
            elements:
              system:
                pattern: {type: Uri, value: 'http://fhir.health.gov.il/identifier/il-prisoner-number'}
                index: 21
              value:
                short: Prisoner Number
                constraint:
                  il-prison-num: {human: 'up to 8 digits prisoner number, allowing for hebrew characters', source: 'http://fhir.health.gov.il/StructureDefinition/il-core-patient', severity: error, expression: 'matches(''^[a-zA-Z0-9_אבגדהוזחטי כלמנסעפצקרתשךףץ]{0,8}$'')'}
                index: 22
              assigner:
                type: Reference
                refers: ['http://fhir.health.gov.il/StructureDefinition/il-core-organization']
                index: 23
        enc:
          match: {system: 'http://fhir.health.gov.il/identifier/encrypted-id-primary-moh'}
          schema:
            short: Person's Identifier - MoH encrypted
            mustSupport: false
            array: true
            index: 24
            elements:
              system:
                pattern: {type: Uri, value: 'http://fhir.health.gov.il/identifier/encrypted-id-primary-moh'}
                index: 25
              value: {short: An encrypted identifier, index: 26}
              assigner:
                type: Reference
                refers: ['http://fhir.health.gov.il/StructureDefinition/il-core-organization']
                index: 27
        entry-permit:
          match: {system: 'http://fhir.health.gov.il/identifier/il-entry-permit'}
          schema:
            short: Israeli Temporary entry permit
            mustSupport: true
            array: true
            index: 28
            elements:
              system:
                pattern: {type: Uri, value: 'http://fhir.health.gov.il/identifier/il-entry-permit'}
                index: 29
              value: {short: An Israeli Visa Number, index: 30}
              assigner:
                type: Reference
                refers: ['http://fhir.health.gov.il/StructureDefinition/il-core-organization']
                index: 31
  telecom:
    elements:
      system: {mustSupport: true, index: 54}
      value: {mustSupport: true, index: 55}
      use: {mustSupport: true, index: 56}
    required: [value, system]
  generalPractitioner:
    type: Reference
    refers: ['http://fhir.health.gov.il/StructureDefinition/il-core-organization', 'http://fhir.health.gov.il/StructureDefinition/il-core-practitioner', 'http://fhir.health.gov.il/StructureDefinition/il-core-practitioner-role']
    index: 65
  gender: {mustSupport: true, index: 57}
  contact:
    index: 60
    elements:
      organization:
        type: Reference
        refers: ['http://fhir.health.gov.il/StructureDefinition/il-core-organization']
        index: 61
    slicing:
      rules: open
      discriminator:
      - {path: relationship, type: pattern}
      min: null
      slices:
        parent:
          match:
            relationship:
              coding:
              - {code: PRN, system: 'http://terminology.hl7.org/CodeSystem/v3-RoleCode'}
          schema:
            array: true
            index: 62
            elements:
              relationship:
                pattern:
                  type: CodeableConcept
                  value:
                    coding:
                    - {code: PRN, system: 'http://terminology.hl7.org/CodeSystem/v3-RoleCode'}
                index: 63
package_version: 0.17.2
extensions:
  hmo: {url: 'http://fhir.health.gov.il/StructureDefinition/ext-il-hmo', min: 0, max: 1, short: 'Extension: Israel Core HMO (קופת חולים)', type: Extension, mustSupport: true, index: 1}
  parentName: {url: 'http://fhir.health.gov.il/StructureDefinition/ext-administrative-parent-name', min: 0, short: 'Extension: Administrative Parent Name', type: Extension, mustSupport: true, index: 2}
  birthPlace: {url: 'http://hl7.org/fhir/StructureDefinition/patient-birthPlace', min: 0, max: 1, type: Extension, short: 'Extension: Place of Birth for patient', index: 3}
  immigration: {url: 'http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration', min: 0, type: Extension, short: 'Extension: Patient Immigration', index: 4}
  birthSex: {url: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex', min: 0, max: 1, type: Extension, short: 'Extension: US Core Birth Sex Extension', index: 5}
class: profile
kind: resource
url: http://fhir.health.gov.il/StructureDefinition/il-core-patient
base: http://hl7.org/fhir/StructureDefinition/Patient
version: 0.17.0
required: [gender, name, identifier, birthDate]