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

Data Type Profile: ILCore Address Profile

Official URL: http://fhir.health.gov.il/StructureDefinition/il-core-address Version: 0.18.0
Standards status: Trial-use Maturity Level: 1 Computable Name: ILCoreAddress

Copyright/Legal: Israeli Ministry of Health

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

כללי

Address הוא אינו משאב (resource) אלא סוג נתונים (data-type) כללי המשמש לתיעוד כתובות ולכן משתמשים בו ב-resources רבים בהם נדרש תעוד של כתובות (למשל כתובת של מטופל, מטפל, ארגון וכו’). כתובת כוללת מס’ אלמנטים כגון: מטרת שימוש (למשל עבודה או בית), סוג (למשל כתובת לדיוור בלבד או כתובת פיזית), המדינה, העיר והמחוז, פרטי הכתובת עצמה (שורות טקסט המכילות שם רחוב, מס’ בית וכניסה, דירה וכו’), מיקוד והתקופה בה היתה הכתובת תקפה. בתצורתו הבסיסית Address מאפשר להגדיר כתובת באופן פתוח וללא אכיפת מגבלות כלשהן, כאשר הרכיבים המתארים את פרטי הכתובת עצמה (כלומר שם רחוב, מס’ בית, מס’ כניסה וכו’) מוגדרים כולם באלמנט line כמערך של שורות טקסט, דבר המקשה על הפרדת רכיבי הכתובת כפי שנהוג במערכות מידע רבות בישראל (למשל, אין דרך מוסדרת לחלץ את שם הרחוב מתוך הטקסט). כמו כן, Address בתצורתו הבסיסית אינו מאפשר לתעד קוד יישוב כפי שנהוג בישראל, אלא רק שם יישוב (באלמנט city).

הפרופיל הישראל ILCoreAddress מגדיר בעיקר הרחבות שנוספו במטרה לאפשר אחידות בהעברת כתובת בין גורמים שונים במדינת ישראל. ההרחבות בפרופיל נוספו כדי להגדיר בצורה יותר מובנית ואחידה את האלמנטים המרכיבים את הכתובת וכן ליצור אחידות בייצוג של נתונים נוספים כגון קואורדינטות וקידוד של יישובים. תצורתו הנוכחית הותאמה לישראל תוך הסתכלות, למידה והתחשבות במגבלות של פרופילים דומים בעולם, וכן מהדרישות העסקיות והאילוצים של מערכת הבריאות הישראלית.

עוד מידע על פרופיל זה ניתן למצוא באתר הקהילה

הרחבות

הרחבות על line (שורות הכתובת)

כיוון שבתוצרתו הבסיסית Address אינו מכיל אלמנטים ייעודיים לכל אחד מרכיבי הבסיס של הכתובת (רחוב, מספר בית וכו’) אלא רק מערך של שורות טקסט, הוחלט להוסיף מספר הרחבות ייעודיות לכך מ-HL7, ע”מ להבהיר כיצד ניתן לתעד את רכיבי הכתובת באלמנטים נפרדים. כך מרכיביהן של שורות במערך line, לדוגמא “רחוב פרג 7, כניסה ב, דירה 3” או “ת.ד. 1446” יכולים להיות מיוצגים באופן בדיד עם ההרחבות הבאות:

  • streetName – שם הרחוב (למשל, “פרג”)
  • houseNumber- מס’ הבית (למשל, “7”)
  • buildingNumberSuffix – כניסה (למשל, “ב”)
  • unitId – מס’ דירה ( למשל “3”)
  • postBox- מס’ תיבת דואר (למשל ,”1446”)

כיוון שאלמנט line הוא מערך של שורות טקסט, רכיבי הכתובת עשויים להתפרס על יותר משורה אחת. למשל, ניתן לראות בדוגמא 1 כתובת שהטקסט המלא שלה (אלמנט Address.text) הוא “רחוב פרג 7,כניסה ב’, דירה 3 גדרה” ובאלמנט line שלה ישנן שתי שורות, כך שבתא הראשון במערך (line[0]) תהיה השורה “פרג 7” ובתא השני (line[1]) יהיה הטקסט “כניסה ב”. כיוון שההרחבות הנ”ל מוגדרות על אלמנט אשר יכול לחזור על עצמו (מערך), כל מופע של ההרחבה חייב להיות משויך לאיבר מסוים במערך, ויש לוודא שההרחבות מוגדרות על השורה הנכונה. ניתן לראות בדוגמא 1 שההרחבות streetName ו-houseNumber מוגדרות על התא הראשון ואילו buildingNumberSuffix ו-unitId על התא השני. כיוון שהרחבות אלו הן אופציונאליות, אין צורך להגדיר את כולן עבור כל תא, אלא רק את הרלוונטיות בהתאם לתוכן התא. כמו כן יש לשים לב שהשימוש בהרחבות רק יחדד את המידע הקיים בשורה או יוסיף עליו ולא יסתור אותו או ישנה אותו, אחרת יש להגדיר את ההרחבה כ-modifierExtention. כלומר, זה יהיה לא תקין להגדיר הרחבת כניסה עם הערך “ב” על שורה המכילה את הטקסט “כניסה ד’”. על הערכים שבהרחבות להיות תואמים לתוכן שנמצא בשורה אליה הם מתייחסים (כמו הרחוב ומספר הבית בשורה 0 בדוגמא) או להכיל מידע נוסף שלא נכלל בטקסט עצמו (כמו הדירה בהרחבה על שורה 1).

דוגמא 1 – אלמנט line עם שני תאים לכתובת : רחוב הרצל 7 ,כניסה ב, דירה 3 גדרה,ת.ד. 1446

ערך ערך  
line [1] – “כניסה ב “ line [0] -“ הרצל 7” []line
  פרג streetName
  7 houseNumber
ב   buildingNumberSuffix
3   unitId

בנוסף, כאשר מייצגים את המידע בפורמט JSON יש לשים לב שבמקרים שבהם נרצה להעביר את הכתובת עם ההרחבות אך ללא הטקסט בשורת הכתובת, יש לשים null כערך בתא המערך כמו בדוגמא 2. יש להקפיד לשים null בכל תא שעליו מעוניינים להעביר הרחבות, מאחר ושיוך של הרחבה לשורה נקבע לפי התאמה בין האינדקס שלה במערך line לבין האינדקס במערך extension. כמו-כן, מאותה הסיבה, אם נרצה להרחיב רק את השורה השניה, יש “לתפוס” את התא הראשון במערך ה-extension עם הערך null, כדי שנוכל לשים את ההרחבות על התא הבא במערך.

דוגמא 2 – אלמנט line עם תא אחד null

הכתובת תא דואר 1111 יבנה
  line[0] - null
postBox 1111

ניתן לראות מימוש של הרחבה זו בדוגמא של מטופל עם שתי כתובות הנמצאת פה

הרחבה על אלמנט city

  • citycode – ע”מ לאפשר ייצוג מקודד של היישוב כפי שנהוג במערכות רבות בישראל, הוחלט להוסיף הרחבה חדשה ייעודית לכך. במסגרת ההגדרה של הרחבה זו בוצעה גם הגדרה של מערכת הקידוד “סמל ישוב” המהווה מערכת קידוד סטנדרטית ליישובים במדינת ישראל ונמצאת בשימוש נרחב ע”י ארגונים רבים, כולל משרד הפנים, רשות האוכלוסין וההגירה ודואר ישראל (ראה פרטים נוספים על הרחבה זו בדף שלה).

Must Support

בנוסף להרחבות שהוגדרו, הוחלט להגדיר עבור חלק מהאלמנטים את התגית MS) Must Support) המציינת שכל מערכת חייבת לתמוך גם באלמנט זה במידה והוא קיים במופע ה-ILCoreAddress שהתקבל. להלן האלמנטים שהוגדו עם MS:

  • line
  • streetname
  • housenumber
  • city
  • postalCode
  • period

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address Address
... Slices for extension Content/Rules for all slices
.... geolocation 0..1 (Complex) geolocation
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... statArea 0..* Identifier Extension: Statistical Area
URL: http://fhir.health.gov.il/StructureDefinition/ext-statistical-area
... line S 0..* string Street name, number, direction & P.O. Box etc.
Example Valid Example: הירקון 1א' דירה 4 תל אביב
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... streetName S 0..1 string Extension: street name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... houseNumber S 0..1 string Extension: house number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... buildingNumberSuffix 0..1 string Extension: building suffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
..... unitId 0..1 string unit id
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... postBox 0..1 string Extension: post box
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
... city S 0..1 string Name of city, town etc.
Example Valid Example: ירושלים
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... cityCode 0..1 CodeableConcept city code
URL: http://fhir.health.gov.il/StructureDefinition/ext-city-code
Binding: City Symbol (סמל ישוב) (required)
... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Country Codes (required)
... period S 0..1 Period Time period when address was/is in use

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Address.countryrequiredILCoreJurisdiction
http://fhir.health.gov.il/ValueSet/il-core-jurisdiction
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension Content/Rules for all slices
.... geolocation 0..1 (Complex) geolocation
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... statArea 0..* Identifier Extension: Statistical Area
URL: http://fhir.health.gov.il/StructureDefinition/ext-statistical-area
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Valid Example: הירקון 1א' דירה 4 תל אביב
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... streetName S 0..1 string Extension: street name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... houseNumber S 0..1 string Extension: house number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... buildingNumberSuffix 0..1 string Extension: building suffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
..... unitId 0..1 string unit id
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... postBox 0..1 string Extension: post box
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... cityCode 0..1 CodeableConcept city code
URL: http://fhir.health.gov.il/StructureDefinition/ext-city-code
Binding: City Symbol (סמל ישוב) (required)
... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
Example Valid Example: 6964101
... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Country Codes (required)
... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.countryrequiredILCoreJurisdiction
http://fhir.health.gov.il/ValueSet/il-core-jurisdiction
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... geolocation 0..1 (Complex) geolocation
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... statArea 0..* Identifier Extension: Statistical Area
URL: http://fhir.health.gov.il/StructureDefinition/ext-statistical-area
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Valid Example: הירקון 1א' דירה 4 תל אביב
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... streetName S 0..1 string Extension: street name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... houseNumber S 0..1 string Extension: house number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... buildingNumberSuffix 0..1 string Extension: building suffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
..... unitId 0..1 string unit id
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... postBox 0..1 string Extension: post box
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... value 0..1 string Primitive value for string
Max Length: 1048576
... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example Valid Example: ירושלים
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... cityCode 0..1 CodeableConcept city code
URL: http://fhir.health.gov.il/StructureDefinition/ext-city-code
Binding: City Symbol (סמל ישוב) (required)
.... value 0..1 string Primitive value for string
Max Length: 1048576
... district Σ 0..1 string District name (aka county)
Example General: Madison
... state Σ 0..1 string Sub-unit of country (abbreviations ok)
... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
Example Valid Example: 6964101
... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Country Codes (required)
... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Address.countryrequiredILCoreJurisdiction
http://fhir.health.gov.il/ValueSet/il-core-jurisdiction
from this IG

This structure is derived from Address

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address Address
... Slices for extension Content/Rules for all slices
.... geolocation 0..1 (Complex) geolocation
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... statArea 0..* Identifier Extension: Statistical Area
URL: http://fhir.health.gov.il/StructureDefinition/ext-statistical-area
... line S 0..* string Street name, number, direction & P.O. Box etc.
Example Valid Example: הירקון 1א' דירה 4 תל אביב
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... streetName S 0..1 string Extension: street name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... houseNumber S 0..1 string Extension: house number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... buildingNumberSuffix 0..1 string Extension: building suffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
..... unitId 0..1 string unit id
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... postBox 0..1 string Extension: post box
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
... city S 0..1 string Name of city, town etc.
Example Valid Example: ירושלים
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... cityCode 0..1 CodeableConcept city code
URL: http://fhir.health.gov.il/StructureDefinition/ext-city-code
Binding: City Symbol (סמל ישוב) (required)
... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Country Codes (required)
... period S 0..1 Period Time period when address was/is in use

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Address.countryrequiredILCoreJurisdiction
http://fhir.health.gov.il/ValueSet/il-core-jurisdiction
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for extension Content/Rules for all slices
.... geolocation 0..1 (Complex) geolocation
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... statArea 0..* Identifier Extension: Statistical Area
URL: http://fhir.health.gov.il/StructureDefinition/ext-statistical-area
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Valid Example: הירקון 1א' דירה 4 תל אביב
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... streetName S 0..1 string Extension: street name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... houseNumber S 0..1 string Extension: house number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... buildingNumberSuffix 0..1 string Extension: building suffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
..... unitId 0..1 string unit id
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... postBox 0..1 string Extension: post box
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... cityCode 0..1 CodeableConcept city code
URL: http://fhir.health.gov.il/StructureDefinition/ext-city-code
Binding: City Symbol (סמל ישוב) (required)
... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
Example Valid Example: 6964101
... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Country Codes (required)
... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.countryrequiredILCoreJurisdiction
http://fhir.health.gov.il/ValueSet/il-core-jurisdiction
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... geolocation 0..1 (Complex) geolocation
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... statArea 0..* Identifier Extension: Statistical Area
URL: http://fhir.health.gov.il/StructureDefinition/ext-statistical-area
... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example Valid Example: הירקון 1א' דירה 4 תל אביב
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... streetName S 0..1 string Extension: street name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
..... houseNumber S 0..1 string Extension: house number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... buildingNumberSuffix 0..1 string Extension: building suffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
..... unitId 0..1 string unit id
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... postBox 0..1 string Extension: post box
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... value 0..1 string Primitive value for string
Max Length: 1048576
... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example Valid Example: ירושלים
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... cityCode 0..1 CodeableConcept city code
URL: http://fhir.health.gov.il/StructureDefinition/ext-city-code
Binding: City Symbol (סמל ישוב) (required)
.... value 0..1 string Primitive value for string
Max Length: 1048576
... district Σ 0..1 string District name (aka county)
Example General: Madison
... state Σ 0..1 string Sub-unit of country (abbreviations ok)
... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
Example Valid Example: 6964101
... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Country Codes (required)
... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Address.countryrequiredILCoreJurisdiction
http://fhir.health.gov.il/ValueSet/il-core-jurisdiction
from this IG

This structure is derived from Address

 

Other representations of profile: CSV, Excel, Schematron