{
  "description": "Israel Core Proposed constraints and extensions on the Patient Resource.",
  "_filename": "StructureDefinition-il-core-patient.json",
  "package_name": "il.core.fhir.r4",
  "date": "2024-04-07",
  "derivation": "constraint",
  "publisher": "Israel Core Team",
  "fhirVersion": "4.0.1",
  "name": "ILCorePatient",
  "abstract": false,
  "type": "Patient",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "ILCore Patient Profile",
  "package_version": "0.14.0",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode": "trial-use"
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger": 1
  } ],
  "status": "draft",
  "id": "9a146e22-9af5-4913-9c50-e1154c623e9f",
  "kind": "resource",
  "url": "http://fhir.health.gov.il/StructureDefinition/il-core-patient",
  "version": "0.14.0",
  "differential": {
    "element": [ {
      "id": "Patient",
      "path": "Patient",
      "short": "ILCore Patient profile",
      "definition": "The Patient Profile is based upon the core FHIR Patient Resource"
    }, {
      "id": "Patient.extension",
      "path": "Patient.extension",
      "slicing": {
        "rules": "open",
        "ordered": false,
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "path": "Patient.extension",
      "min": 0,
      "definition": "A code classifying the person's Israeli HMO",
      "short": "Extension: Israel Core HMO (קופת חולים)",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://fhir.health.gov.il/StructureDefinition/ext-il-hmo" ]
      } ],
      "mustSupport": true,
      "sliceName": "hmo",
      "max": "1",
      "id": "Patient.extension:hmo"
    }, {
      "path": "Patient.extension",
      "min": 0,
      "definition": "Extension: The name of a person’s parent, recorded for administrative purposes as part of the person’s demographics (e.g to help with identification). This SHOULD NOT be confused with a parent whose details are recorded for contact purposes (Patient.contact) or as a family member (RelatedPerson). Most systems will use the “father’s name” field as the source of data for this extension. NOTE: This extension replaces the old ParentName extension and is the PREFFERED extension",
      "short": "Extension: Administrative Parent Name",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://fhir.health.gov.il/StructureDefinition/ext-administrative-parent-name" ]
      } ],
      "mustSupport": true,
      "sliceName": "parentName",
      "max": "*",
      "id": "Patient.extension:parentName"
    }, {
      "id": "Patient.extension:birthPlace",
      "max": "1",
      "min": 0,
      "path": "Patient.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" ]
      } ],
      "short": "Extension: Place of Birth for patient",
      "sliceName": "birthPlace",
      "definition": "The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements"
    }, {
      "id": "Patient.extension:immigration",
      "max": "*",
      "min": 0,
      "path": "Patient.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration" ]
      } ],
      "short": "Extension: Patient Immigration",
      "sliceName": "immigration",
      "definition": "Extension: Immigration information for a patient - for the purpose of this extension - immigration is an international movement of a person to a destination country in order to settle as permanent resident"
    }, {
      "id": "Patient.extension:birthSex",
      "max": "1",
      "min": 0,
      "path": "Patient.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex" ]
      } ],
      "short": "Extension: US Core Birth Sex Extension",
      "sliceName": "birthSex",
      "definition": "A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9)."
    }, {
      "id": "Patient.identifier",
      "min": 1,
      "path": "Patient.identifier",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "system",
          "type": "value"
        } ]
      }
    }, {
      "id": "Patient.identifier.system",
      "min": 1,
      "path": "Patient.identifier.system",
      "mustSupport": true
    }, {
      "id": "Patient.identifier.value",
      "min": 1,
      "path": "Patient.identifier.value",
      "short": "The value that is unique within the system.",
      "mustSupport": true
    }, {
      "id": "Patient.identifier:il-id",
      "max": "1",
      "min": 0,
      "path": "Patient.identifier",
      "short": "Israeli National Identifier",
      "sliceName": "il-id",
      "definition": "Israeli ID number (9 digit unchangeable number, including leading zeros and includes a control digit), including temporarily identification numbers assigned by Israeli National Insurance",
      "mustSupport": true
    }, {
      "id": "Patient.identifier:il-id.system",
      "path": "Patient.identifier.system",
      "fixedUri": "http://fhir.health.gov.il/identifier/il-national-id"
    }, {
      "id": "Patient.identifier:il-id.value",
      "path": "Patient.identifier.value",
      "short": "An Israeli ID number",
      "example": [ {
        "label": "Valid Example",
        "valueString": "000000018"
      } ],
      "constraint": [ {
        "key": "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('^\\d{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"
      } ]
    }, {
      "id": "Patient.identifier:il-id.assigner",
      "path": "Patient.identifier.assigner",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://fhir.health.gov.il/StructureDefinition/il-core-organization" ]
      } ]
    }, {
      "id": "Patient.identifier:pna-id",
      "max": "1",
      "min": 0,
      "path": "Patient.identifier",
      "short": "Palestinian National Identifier",
      "sliceName": "pna-id",
      "definition": "Palestinian ID number",
      "mustSupport": false
    }, {
      "id": "Patient.identifier:pna-id.system",
      "path": "Patient.identifier.system",
      "fixedUri": "http://fhir.health.gov.il/identifier/pna-national-id"
    }, {
      "id": "Patient.identifier:pna-id.value",
      "path": "Patient.identifier.value",
      "short": "A Palestininan ID number",
      "example": [ {
        "label": "Valid Example",
        "valueString": "000000018"
      } ]
    }, {
      "id": "Patient.identifier:ppn",
      "max": "*",
      "min": 0,
      "path": "Patient.identifier",
      "short": "Passport Number",
      "sliceName": "ppn",
      "definition": "Passport number",
      "mustSupport": false
    }, {
      "id": "Patient.identifier:ppn.type",
      "path": "Patient.identifier.type",
      "patternCodeableConcept": {
        "coding": [ {
          "code": "PPN",
          "system": "http://terminology.hl7.org/CodeSystem/v2-0203"
        } ]
      }
    }, {
      "id": "Patient.identifier:ppn.system",
      "path": "Patient.identifier.system",
      "binding": {
        "strength": "required",
        "valueSet": "http://fhir.health.gov.il/ValueSet/passport-uri"
      }
    }, {
      "id": "Patient.identifier:ppn.value",
      "path": "Patient.identifier.value",
      "short": "Passport Number"
    }, {
      "id": "Patient.identifier:prisoner-id",
      "max": "1",
      "min": 0,
      "path": "Patient.identifier",
      "short": "Prisoner Number",
      "sliceName": "prisoner-id",
      "definition": "Israel Prison Service prisoner number (5-6 digits number). A unique identifier for any prisoner currently serving a prison sentence",
      "mustSupport": true
    }, {
      "id": "Patient.identifier:prisoner-id.system",
      "path": "Patient.identifier.system",
      "fixedUri": "http://fhir.health.gov.il/identifier/il-prisoner-number"
    }, {
      "id": "Patient.identifier:prisoner-id.value",
      "path": "Patient.identifier.value",
      "short": "Prisoner Number",
      "example": [ {
        "label": "Valid Example",
        "valueString": "123456"
      } ],
      "constraint": [ {
        "key": "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}$')"
      } ]
    }, {
      "id": "Patient.identifier:prisoner-id.assigner",
      "path": "Patient.identifier.assigner",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://fhir.health.gov.il/StructureDefinition/il-core-organization" ]
      } ]
    }, {
      "id": "Patient.identifier:enc",
      "max": "*",
      "min": 0,
      "path": "Patient.identifier",
      "short": "Person's Identifier - MoH encrypted",
      "sliceName": "enc",
      "definition": "The person’s identifier after applying MoH’s standard primary encryption algorithm",
      "mustSupport": false
    }, {
      "id": "Patient.identifier:enc.system",
      "path": "Patient.identifier.system",
      "fixedUri": "http://fhir.health.gov.il/identifier/encrypted-id-primary-moh"
    }, {
      "id": "Patient.identifier:enc.value",
      "path": "Patient.identifier.value",
      "short": "An encrypted identifier",
      "example": [ {
        "label": "Valid Example",
        "valueString": "000000018"
      } ]
    }, {
      "id": "Patient.identifier:enc.assigner",
      "path": "Patient.identifier.assigner",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://fhir.health.gov.il/StructureDefinition/il-core-organization" ]
      } ]
    }, {
      "id": "Patient.name",
      "min": 1,
      "path": "Patient.name",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "extension('http://hl7.org/fhir/StructureDefinition/language').value.ofType(code)",
          "type": "value"
        } ]
      },
      "constraint": [ {
        "key": "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.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()"
      } ],
      "mustSupport": true
    }, {
      "id": "Patient.name.extension:dataAbsentReason",
      "max": "1",
      "min": 0,
      "path": "Patient.name.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ]
      } ],
      "sliceName": "dataAbsentReason"
    }, {
      "id": "Patient.name.family",
      "path": "Patient.name.family",
      "mustSupport": true
    }, {
      "id": "Patient.name.given",
      "path": "Patient.name.given",
      "mustSupport": true
    }, {
      "id": "Patient.name:Hebrew",
      "max": "*",
      "min": 0,
      "path": "Patient.name",
      "sliceName": "Hebrew"
    }, {
      "id": "Patient.name:Hebrew.extension",
      "min": 1,
      "path": "Patient.name.extension"
    }, {
      "id": "Patient.name:Hebrew.extension:dataAbsentReason",
      "max": "1",
      "min": 0,
      "path": "Patient.name.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ]
      } ],
      "sliceName": "dataAbsentReason"
    }, {
      "id": "Patient.name:Hebrew.extension:language",
      "max": "1",
      "min": 1,
      "path": "Patient.name.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/language" ]
      } ],
      "sliceName": "language"
    }, {
      "id": "Patient.name:Hebrew.extension:language.value[x]",
      "path": "Patient.name.extension.value[x]",
      "fixedCode": "he"
    }, {
      "id": "Patient.name:English",
      "max": "*",
      "min": 0,
      "path": "Patient.name",
      "sliceName": "English"
    }, {
      "id": "Patient.name:English.extension",
      "min": 1,
      "path": "Patient.name.extension"
    }, {
      "id": "Patient.name:English.extension:dataAbsentReason",
      "max": "1",
      "min": 0,
      "path": "Patient.name.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ]
      } ],
      "sliceName": "dataAbsentReason"
    }, {
      "id": "Patient.name:English.extension:language",
      "max": "1",
      "min": 1,
      "path": "Patient.name.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/language" ]
      } ],
      "sliceName": "language"
    }, {
      "id": "Patient.name:English.extension:language.value[x]",
      "path": "Patient.name.extension.value[x]",
      "fixedCode": "en"
    }, {
      "id": "Patient.name:Arabic",
      "max": "*",
      "min": 0,
      "path": "Patient.name",
      "sliceName": "Arabic"
    }, {
      "id": "Patient.name:Arabic.extension",
      "min": 1,
      "path": "Patient.name.extension"
    }, {
      "id": "Patient.name:Arabic.extension:dataAbsentReason",
      "max": "1",
      "min": 0,
      "path": "Patient.name.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ]
      } ],
      "sliceName": "dataAbsentReason"
    }, {
      "id": "Patient.name:Arabic.extension:language",
      "max": "1",
      "min": 1,
      "path": "Patient.name.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "http://hl7.org/fhir/StructureDefinition/language" ]
      } ],
      "sliceName": "language"
    }, {
      "id": "Patient.name:Arabic.extension:language.value[x]",
      "path": "Patient.name.extension.value[x]",
      "fixedCode": "ar"
    }, {
      "id": "Patient.telecom.system",
      "min": 1,
      "path": "Patient.telecom.system",
      "mustSupport": true
    }, {
      "id": "Patient.telecom.value",
      "min": 1,
      "path": "Patient.telecom.value",
      "mustSupport": true
    }, {
      "id": "Patient.telecom.use",
      "path": "Patient.telecom.use",
      "mustSupport": true
    }, {
      "id": "Patient.gender",
      "min": 1,
      "path": "Patient.gender",
      "mustSupport": true
    }, {
      "id": "Patient.birthDate",
      "min": 1,
      "path": "Patient.birthDate",
      "mustSupport": true
    }, {
      "id": "Patient.address",
      "path": "Patient.address",
      "type": [ {
        "code": "Address",
        "profile": [ "http://fhir.health.gov.il/StructureDefinition/il-core-address" ]
      } ]
    }, {
      "id": "Patient.contact",
      "path": "Patient.contact",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "relationship",
          "type": "pattern"
        } ]
      }
    }, {
      "id": "Patient.contact.organization",
      "path": "Patient.contact.organization",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://fhir.health.gov.il/StructureDefinition/il-core-organization" ]
      } ]
    }, {
      "id": "Patient.contact:Parent",
      "max": "*",
      "min": 0,
      "path": "Patient.contact",
      "sliceName": "Parent"
    }, {
      "id": "Patient.contact:Parent.relationship.coding",
      "path": "Patient.contact.relationship.coding",
      "patternCoding": {
        "code": "PAR",
        "system": "http://terminology.hl7.org/CodeSystem/v2-0131"
      }
    }, {
      "id": "Patient.communication.language",
      "path": "Patient.communication.language",
      "mustSupport": true
    }, {
      "id": "Patient.generalPractitioner",
      "path": "Patient.generalPractitioner",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "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" ]
      } ]
    }, {
      "id": "Patient.managingOrganization",
      "path": "Patient.managingOrganization",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "http://fhir.health.gov.il/StructureDefinition/il-core-organization" ]
      } ]
    }, {
      "id": "Patient.link.other",
      "path": "Patient.link.other",
      "type": [ {
        "code": "Reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
          "valueBoolean": false
        } ],
        "targetProfile": [ "http://fhir.health.gov.il/StructureDefinition/il-core-patient", "http://fhir.health.gov.il/StructureDefinition/il-core-related-person" ]
      } ]
    } ]
  },
  "contact": [ {
    "telecom": [ {
      "value": "tal.primak@moh.gov.il",
      "system": "email"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient"
}