IL Core Implementation Guide
0.18.0 - draft Israel flag

This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

ILCore ActivityDefinition Profile

Adds several Israel-specific extensions and constraints, plus geocode extension to the ActivityDefinition datatype

ILCore AllergyIntolerance Profile

Israel Core proposed constraints and extensions on the AllergyIntolerance Resource

ILCore Blood Pressure Profile

Israel Core proposed constraints and extensions on the Observation Resource for use in Blood Pressure measurments.

ILCore CarePlan Profile

Israel Core proposed constraints and extensions on the CarePlan Resource

ILCore CareTeam Profile

Israel Core proposed constraints and extensions on the CareTeam Resource

ILCore Claim Profile

Israel Core proposed constraints and extensions on the Claim Resource

ILCore ClaimResponse Profile

Israel Core proposed constraints and extensions on the ClaimResponse Resource

ILCore Communication Profile

Israel Core proposed constraints and extensions on the Communication Resource

ILCore CommunicationRequest Profile

Israel Core proposed constraints and extensions on the CommunicationRequest Resource

ILCore Condition Profile

Israel Core proposed constraints and extensions on the Condition Resource

ILCore Consent Profile

Israel Core proposed constraints and extensions on the Consent Resource

ILCore Coverage Profile

Israel Core proposed constraints and extensions on the Coverage Resource

ILCore CoverageEligibilityRequest Profile

Israel Core proposed constraints and extensions on the CoverageEligibilityRequest Resource

ILCore CoverageEligibilityResponse Profile

Israel Core proposed constraints and extensions on the CoverageEligibilityResponse Resource

ILCore Device Profile

Israel Core proposed constraints and extensions on the Device Resource

ILCore DeviceDefinition Profile

Israel Core proposed constraints and extensions on the DeviceDefinition Resource

ILCore DeviceRequest Profile

Israel Core proposed constraints and extensions on the DeviceRequest Resource

ILCore DiagnosticReport Profile

Israel Core proposed constraints and extensions on the DiagnosticReport Resource

ILCore DocumentReference Profile

Israel Core proposed constraints and extensions on the DocumentReference Resource

ILCore Encounter Profile

Israel Core proposed constraints and extensions on the Encounter Resource

ILCore EpisodeOfCare Profile

Israel Core proposed constraints and extensions on the EpisodeOfCare Resource

ILCore FamilyMemberHistory Profile

Israel Core proposed constraints and extensions on theILCoreFamilyMemberHistory Resource

ILCore Flag Profile

Adds Isareli constraints to the Flag datatype

ILCore Goal Profile

Israel Core proposed constraints and extensions on the Goal Resource

ILCore Group Profile

Israel Core proposed constraints and extensions on the Group Resource

ILCore HealthcareService Profile

Israel Core proposed constraints and extensions on the HealthcareService Resource

ILCore ImagingStudy Profile

Israel Core proposed constraints and extensions on the ImagingStudy Resource

ILCore Immunization Profile

Israel Core proposed constraints and extensions on the Immunization Resource

ILCore ImmunizationReactionObservation Profile

Israel Core proposed constraints and extensions on the ImmunizationReactionObservation Resource

ILCore ImmunizationRecommendation Profile

Israel Core proposed constraints and extensions on the ImmunizationRecommendation Resource

ILCore Library Profile

Israel Core proposed constraints and extensions on the Library Resource

ILCore Location Profile

Israel Core proposed constraints and extensions on the Location Resource

ILCore Measure Profile

Israel Core proposed constraints and extensions on the Measure Resource

ILCore MeasureReport Profile

Israel Core proposed constraints and extensions on the MeasureReport Resource

ILCore Media Profile

Israel Core proposed constraints and extensions on the Media Resource

ILCore Medication Profile

Israel Core proposed constraints and extensions on the Medication Resource

ILCore MedicationAdministration Profile

Israel Core proposed constraints and extensions on the MedicationAdministration Resource

ILCore MedicationDispense Profile

Israel Core proposed constraints and extensions on the MedicationDispense Resource

ILCore MedicationRequest Profile

Israel Core proposed constraints and extensions on the MedicationRequest Resource

ILCore MedicationStatement Profile

Israel Core proposed constraints and extensions on the MedicationStatement Resource

ILCore Molecular Sequence

Israel Core proposed constraints and extensions on the MolecularSequence Resource

ILCore Molecular Sequence

Israel Core proposed constraints and extensions on the NutritionOrder Resource

ILCore Observation Lab Profile

Israel Core proposed constraints and extensions on the ILCoreObservation Resource for laboratory observations

ILCore Observation Profile

Israel Core proposed constraints and extensions on the Observation Resource

ILCore Organization Profile

Israel Core proposed constraints and extensions on the Organization Resource

ILCore Patient Profile

Israel Core Proposed constraints and extensions on the Patient Resource.

ILCore PlanDefinition Profile

Israel Core proposed constraints and extensions on the PlanDefinition Resource

ILCore Practitioner Profile

Israel Core proposed constraints and extensions on the Practitioner Resource

ILCore PractitionerRole Profile

Israel Core proposed constraints and extensions on the PractitionerRole Resource

ILCore Procedure Profile

Israel Core proposed constraints and extensions on the Procedure Resource

ILCore Questionnaire Profile

Israel Core proposed constraints and extensions on the Questionnaire Resource

ILCore QuestionnaireResponse Profile

Israel Core proposed constraints and extensions on the QuestionnaireResponse Resource

ILCore RelatedPerson Profile

Israel Core proposed constraints and extensions on the RelatedPerson Resource

ILCore ResearchStudy Profile

Israel Core proposed constraints and extensions on the ResearchStudy Resource

ILCore ResearchSubject Profile

Israel Core proposed constraints and extensions on the ResearchSubject Resource

ILCore RiskAssessment Profile

Israel Core proposed constraints and extensions on the RiskAssessment Resource

ILCore ServiceRequest Profile

Israel Core proposed constraints and extensions on the ServiceRequest Resource

ILCore Specimen Profile

Israel Core proposed constraints and extensions on the Specimen Resource

ILCore Substance Profile

Israel Core proposed constraints and extensions on the Substance Resource

ILCore Task Profile

Israel Core proposed constraints and extensions on the SuTaskstance Resource

ILCore Vital Signs Profile

Israel Core proposed constraints and extensions on the Observation Resource for use in querying and retrieving Vital Signs information.

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide.

ILCore Address Profile

Adds several Israel-specific extensions and constraints, plus geocode extension to the Address datatype

ILCore Dosage Profile

Adds several Israel-specific extensions and constraints to the Dosage datatype

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Ext: Administrative Parent Name

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. Note: there SHOULD be only one parent marked as ‘official’

Ext: Allergy Intolerance End

Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid.

Ext: City Code

A coded representation of the city, town or settlement

Ext: DiagnosticReport Note

Extension: DiagnosticReport Note annotation, to mimic v5 DiagnosticReport.note element

Ext: Encounter Paying Entity

Paying Entity for the Encounter

Ext: Encounter Visitor Type

Classification of the visitor type (סוג מבקר/סוג כניסה) for the Encounter

Ext: Event Occurrence Location

Extension: Location in which an event occurred

Ext: Hebrew Date

Extension: Allows the use of Hebrew dates

Ext: IL Core Processing Location

Extension: IL Core Processing Location

Ext: IL Core Processing Practitioner

Extension: IL Core Processing Practitioner

Ext: ILCore Documented Event Date

Extension: The date of the event this DocumentReference describes

Ext: ILCore Narcotic Medication

Extension: Noting if a medication is narcotic or not

Ext: ILCore Procedure Reference

Extension: Procedure Reference

Ext: ILCore Recorded Time

Extension: The time in which the medication order / administration / dispense was recorded

Ext: ILCore Specimen Collector Reference

Extension: Specimen Collector Reference

Ext: Israel Health Management Organization (קופת חולים)

Extension: Israel Health Management Organizations (קופות חולים)

Ext: Medication Course-Of-Therapy Type

Extension: A coded representation of the type of course-of-therapy

Ext: Medication Dose Form

Extension: A coded representation of the type of dose form

Ext: Movement Sequence-Number

Extension: Movement Sequence-Number

Ext: Name of parent

Extension: The name of a parent. NOTE: This extension is now DEPRECATED (ststus: retired) and has been replaced with AdminParentName

Ext: Patient Immigration

Extension: Immigration information for 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

Ext: Qualification Practice

Extension: Qualification Practice

Ext: Reaction Duration

Extension: Reaction Duration

Ext: Statistical Area

Extension: Statistical Area. A concatination of the city symbol + 4-digit statistical area code in settelment. Full CBS number conatins two parts: City symbol + statistical number. E.g.: Jerusalem (3000) 113 area produces -> 3000113

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Blood Pressure Unit code

A single unit code for blood presssure observations reporting

Blood Pressure component codes

A list of codes for components in the blood presssure observations reporting

City Symbol (סמל ישוב)

City classification according to the Israeli Postal Company city-symbol coding system

Country Codes

Codes for countries according to ISO 3166

Department Type MoH

Israel ministry of health coding system for department types

Encounter Paying Entity MoH

MoH Codes for the Paying Entity for the Encounter Note that this value-set is not yet finalized and approved and might change in the future. It’s provided only for general reference.

Hebrew Date Day

Codes for Hebrew date days

Hebrew Date Month

Codes for Hebrew date months

ICD9 IL Diagnoses

codes of diagnoses from ICD9-IL

ICD9 IL Procedures

codes of procedures from ICD9-IL

IL Core Allergy Intolerance Code

A list of codes for Allergy Intolerance for the IL Core

IL Core Condition Category Codes

A list of category codes for conditions for the IL Core

IL Core Condition Code

A list of codes for conditions for the IL Core

IL Core Condition Codes

A list of codes for intolerance manifestation for the IL Core

IL Core Condition End Reason

A list of codes for End Reasons of Allergy Intolerance for the IL Core

IL Core Coverage Class codes

Codes for Coverage classes

IL Core Coverage Premium Type codes

Codes for Types of premium payment methods

IL Core Coverage Type codes

Codes for expressing general heigh level coverage types unique to Israel health system

IL Core Doctor To Doctor Codes

Codes for Doctor To Doctor encounter for the IL Core

IL Core Encounter Class Codes

A list of class codes for Encounters for the IL Core

IL Core Medication Dose Form

A list of codes medication dose forms

IL Core Observation Codes

A list of code codes for observations for the IL Core

IL Core Observation Lab Code

A list of lab-code codes for lab observations for the IL Core

IL Core Observation Value Codes

A list of value codes for observations for the IL Core

Note: The entire LOINC code system is included in this ValueSet although it should only include LOINC Answers - LOINC codes that start with ‘LA’. Since there is no computable way to define a ValueSet according to the code’s prefix, we rely on an invariant to enforce this rule.

IL Core Patient Relationship Type codes

A set of codes that can be used to indicate the relationship between a Patient and a Related Person.

IL Core Religion Code

A list of codes for Religion for the IL Core

IL Core Route Code

A list of codes for Route for the IL Core

IL Core Service type

A list of codes for Service types for the IL Core

IL Core ServiceCategory

A list of codes for Service Category for the IL Core

IL Core Specimen type

A list of codes for Specimen types for the IL Core

IL Core Substance Codes

A list of codes for Substances for the IL Core

IL Core Units Of Measure Codes

A list of codes for Units Of Measure for the IL Core. <mark>Note:</mark> UCUM code SHALL be used, unless one cannot be found, in which case a SNOMED-CT code SHALL be used

IL Core Units Of Measure Codes

A list of codes for Units Of Measure for the IL Core. <mark>Note:</mark> UCUM code SHALL be used, unless one cannot be found, in which case a SNOMED-CT code SHALL be used

IL Core Virtual encounter Type Codes

A list of type codes for Virtual Encounters for the IL Core

IL Core procedure Codes

A list of codes for procedures for the IL Core

IL Core procedure Reason

A list of codes for procedure reasons for the IL Core

IL Core procedure Reason

A list of codes for procedure reasons for the IL Core

ILCore Medication Code

Codes for medications according to ILCore catalogue

ILCore Medication Course Of Therapy type

Codes for Medication Course Of Therapy

ILCore Medication Request Category

Codes for Medication Request Category

ILCore Medication administration Category

Codes for Medication administration Category

ILCore Medication dispense Category

Codes for Medication dispense Category

ILCore Medication statement Category

Codes for Medication statement Category

ILCore Medication statement Code

Codes for Medication statement Code

Icd9 Cm Procedures

All Procedure codes from ICD9-CM codesystem

Icd9 Cm diagnoses

All Diagnosis codes from ICD9-CM codesystem

Immunization Observation Body Site list

All codes from SNOMED CT describing body sites for Immunization Observation

Immunization side-effect codes

Codes from SNOMED CT detailing possible immunization-side-effects for ILCoreImmunizationReactionObservation profile

Israeli Health Management Organization (קופת חולים)

A code classifying Health Management Organizations

Israeli statistical area (אג"ס) URI

URI’s of statistical area identifiers. NOTE: When using CBS-statistical area numbers, use as directed in the statistical-area NamingSystem - i.e.,: 4-digit citiy code + 3-digit statistical area code. See here

MoH Admit Source Codes

Codes for admit source according to MoH catalogue

MoH Medication Code

Codes for medications according to MoH catalogue

Organization Type

SNOMED based value set of recommended types of organizations and organization units

Passport URIs

A country specific URI for passport numbers

Patient Admit Source MoH

Moh Codes for Patient Admit Source Note that this value-set is not yet finalized and approved and might change in the future. It’s provided only for general reference.

Patient Mode of Arrival MoH

Moh Codes for Patient Mode of Arrival Note that this value-set is not yet finalized and approved and might change in the future. It’s provided only for general reference.

Patient Realease Type MoH

Moh Codes for Patient Realease Type Note that this value-set is not yet finalized and approved and might change in the future. It’s provided only for general reference.

Patient Visit Reason MoH

Moh Codes for Patient Visit Reason Note that this value-set is not yet finalized and approved and might change in the future. It’s provided only for general reference.

Patient Visitor Type MoH

MoH Codes for visitor type (סוג מבקר/סוג כניסה) Note that this value-set is not yet finalized and approved and might change in the future. It’s provided only for general reference.

Practitioner Certificate Types

A list of codes for certificate types for all medical practitioners

Target Disease Codes

SNOMED based valueset of all Disease caused by microorganism or bacterial toxin

The role of the parent (father/mother) whose name is recorded

This set of codes is used to mark a parent name as a father or mother’s name. Should only be used by systems that explicitly differentiate between the two.

Tofes17 Error Codes

קודי שגיאה לתהליכים הקשורים לטופס 17

Tofes17 Reject Codes

קודי שגיאה לתהליכים הקשורים לטופס 17

Vaccine Codes

A list of SNOMED codes for vaccines

Vaccine Product Codes

A list of codes for vaccine products from ATC and cvx codeSystems

Yarpa Medication Code

Codes for medications according to ‘Yarpa’ catalogue

statusReason codes for Immunization profile

Codes from SNOMED CT describing reasons for Immnization not taking place, for statusCode

סוג מוסד לפי רישוי משרד הבריאות

סוג מוסד לפי רישוי משרד הבריאות - הרוב המכריע נמצא בפרסום המאגר של רישוי מוסדות של משרד הבריאות

קוד מומחיות לעוסק בבריאות

קוד מומחיות לעוסק בבריאות לפי רישוי משרד הבריאות

קוד מומחיות לעוסק בבריאות

קוד מומחיות לעוסק בבריאות לפי רישוי משרד הבריאות

קוד מוצר או שירות

קוד שירותים רפואיים , כולל שירותים באשפוז, שירותים אמבולטוריים, רפואת שיניים ובריאות הנפש

קוד מקצוע לעוסק בבריאות

קוד מקצוע לעוסק בבריאות לפי רישוי משרד הבריאות. שימו לב: מקצועות הסיעוד הוחרגו מרשימה זו ונמצאים ברשימה נפרדת

קוד מקצוע לעוסק בסיעוד

קוד מקצוע לעוסק בסיעוד לפי רישוי משרד הבריאות

קוד קורס על בסיסי לעוסק בסיעוד

קוד קורס על בסיסי לעוסק בסיעוד לפי רישוי משרד הבריאות

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

City Symbol (סמל ישוב)

Codes for cities in Israel

CodeSyestem for URNs

Codes for for URNs of different kinds, instead of using urn:ietf:rfc:3986 and urn:iso:std:iso:3166 as CodeSystem identifiers

Codes for Medication Course of therpy types

A list of codes for Medication Course of therpy types

Codes for MedicationRequest categories

A list of codes for MedicationRequest categories

Department Type MoH

Israel ministry of health coding system for department types

Hebrew Date Day

Codes for Hebrew date days

Hebrew Date Month

Codes for Hebrew date months

ICD9IL: Adendum to ICD9 according to codes by Israeli MoH

Strings for procedures and diagnoses, added to ICD9

IL Core Coverage Class codes

Codes for Coverage classes

IL Core Coverage Premium Type codes

Codes for Types of premium payment methods

IL Core Coverage Type codes

Codes for expressing general high level coverage types unique to the Israeli health system

IL Core Encounter Class codes

A list of codes for class types of encounters

IL Core Error code

A list of error codes for ILCore profiles

IL Core Not Perfomed Reasons

A list of codes for reasons an observation was not made

IL Core relirion code

Codes for religions, an addendum to the HL7 religions CodeSystem

Ministry of Health practitioner advanced courses codes

Codes for practitioner advanced courses according to Israeli MoH

Ministry of Health practitioner-education-type codes

Codes for practitioner-education-types according to Israeli MoH

MoH Certificate Types

A list of codes for certificate types according to Israeli MoH

MoLSA Certificate Types

A list of codes for certificate types according to Israeli MoLSA

Moh Form-17 Issue Code

קודי שגיאה \ סירוב לתהליכים הקשורים לטופס 17

Patient Admit Source MoH

Moh Codes for Patient Admit Source Note that this code system is not yet finalized and approved and might change in the future. It’s provided only for general reference.

Patient Mode of Arrival MoH

MoH Codes for Patient Mode of Arrival Note that this code system is not yet finalized and approved and might change in the future. It’s provided only for general reference.

Patient Realease Type MoH

Moh Codes for Patient Realease Type Note that this code system is not yet finalized and approved and might change in the future. It’s provided only for general reference.

Patient Visit Reason MoH

Moh Codes for Patient Visit Reason Note that this code system is not yet finalized and approved and might change in the future. It’s provided only for general reference.

Patient Visitor Type MoH

MoH Codes for visitor type (סוג מבקר/סוג כניסה) Note that this code system is not yet finalized and approved and might change in the future. It’s provided only for general reference.

Payer (Paying Entity / גורם משלם)

Codes for different paying entities in Israel; including HMOs, IDF, MoD, PLA, Prison system

Yarpa Medication Codes

Codes for medications according to ‘Yarpa’ catalogue

סוג מוסד לפי רישוי משרד הבריאות

סוג מוסד לפי רישוי משרד הבריאות - הרוב המכריע נמצא בפרסום המאגר של רישוי מוסדות של משרד הבריאות

קוד מומחיות לעוסק בבריאות

קוד מומחיות לעוסק בבריאות לפי רישוי משרד הבריאות

קוד מוצר או שירות על פי משרד הבריאות

קוד שירותים רפואיים , כולל שירותים באשפוז, שירותים אמבולטוריים, רפואת שיניים ובריאות הנפש Codes for medical services. Note that while this code system closely resembles CPT and includes a large number of CPT codes, there are some additional codes that are not covered by CPT and, more importantly, some cases where CPT codes are remapped and have different semantic meanings (e.g., code #28899 has two different meanings in CPT and in MoH codesytem). Therefore, despite apparent resemblance, this code system MUST NOT be treated as CPT.

קוד מקצוע לעוסק בבריאות

קוד מקצוע לעוסק בבריאות לפי רישוי משרד הבריאות

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide.

cbs-statistical-area

Identifies statistical sub-divisions of cities in Israel as defined by CBS.

idf-service-number

Israel Defence forces Sevice number. A unique identifier for any soldier currently serving or having served in the IDF

il-national-id

Israeli Identifier number issued for all citizens and permanent residents. A nine-digit number including a check-digit

il-prisoner-number

Israel Prison Service prisoner number. A unique identifier for any prisoner currently serving a prison sentence

israel-drugs

Identifies drugs according to the Israeli MoH.

legal-entity

Israeli legal entity number

nurse-advanced-course

Identifies RN advanced course according to Israeli MoH

nurse-expertise

Identifies RN expertise according to Israeli MoH

nurse-registration

Identifies Registered Nurses according to Israeli MoH

pna-national-id

Palestinian Identifier number. A nine-digit number

practitioner-expertise

Identifies practitioner expertise according to Israeli MoH

practitioner-instructor

Identifies practitioner instructor according to Israeli MoH

practitioner-license

Identifies Licensed medical proffesionals according to Israeli MoH

social-worker

Identifies Licensed social worker practitioners according to Israeli MoLSA

Terminology: Concept Maps

These define transformations to convert between codes by systems conforming with this implementation guide.

IL Core Religions

Religion code mapping from Israeli MoH to HL7 v3-ReligiousAffiliation

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

AllergyIntollerance: aspirin-intolerance

An example of ILCoreAllergyIntolerance of a aspirin intolerance

AllergyIntollerance: cat-dander-allergy

An example of ILCoreAllergyIntolerance of a cat-dander allergy

AllergyIntollerance: latex-allergy

An example of ILCoreAllergyIntolerance of a latex allergy

AllergyIntollerance: no-known-allergy

An example of ILCoreAllergyIntolerance a person with no known allergies

AllergyIntollerance: penut-allergy

An example of ILCoreAllergyIntolerance of a penut allergy

Example ILCore MedicationDispense

An example instance of the ILCore MedicationDispense profile.

Example ILCore RelatedPerson

An example instance of the ILCore RelatedPerson profile.

Immunization-with-product-code
Immunization-with-vaccine-code
MedicationAdministration-morphine-hospitalization

MedicationAdministration - morphine during hospitalization

MedicationStatement-morphine-hospitalization

MedicationStatement - morphine during hospitalization

Observation - hight measurement

Observation - hight measurement

Observation - hight measurement

Observation - hight measurement

Observation that hasn't been performed, with data absent reason

testing

anesthesiologist-with-expertise
breast-screaning
community-consultation
condition-burnt-ear
condition-type-1-diabetes
home-visit
location-general-kind-hospital-ward
location-hospital-unit
medication-paracetamol

Paracetamol

medicationRequest-metamizole-for-gangreenous-tonsolitis

MedicationRequest for Metamizole sodium, for a case of Gangrenous tonsillitis

organization-hospital-department
organization-ministry-of-health
organization-part-of-ministry-of-health
organization-school-moe
partial-parotidectomy
patient-immigrant
patient-israeli-redacted
patient-israeli-with-statistical-area
patient-israeli-with-two-identifiers

Israeli Patient with two identifiers

patient-with-hebrew-date
patient-with-israeli-id
patient-with-multiple-birth
patient-with-palestinian-id-and-parent-name
patient-with-passport-identification
patient-with-passport-identification-unknown-country
patient-with-two-addresses
practitioner-md
practitioner-nurse
practitioner-nurse-no-expertise-with-advanced-courses
practitioner-nurse-with-expertise-and-advanced-courses
practitioner-psychologist
practitionerRole-gp
procedure-bloodwork-before-partial-parotidectomy