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

Resource Profile: ILCore Patient Profile

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

Israel Core Proposed constraints and extensions on the Patient Resource.

כללי

משאב הבסיס Patient מוגדר כמידע דמוגרפי ומנהלי על אדם או בעל חיים המקבל טיפול או שירותים הקשורים לבריאות. האלמנטים של משאב המטופל מתמקדים במידע הדמוגרפי הדרוש לתמיכה בתהליכים הניהוליים, הקליניים, הפיננסיים והלוגיסטיים. לפיכך, כיוון שמשאב המטופל מעורב במגוון רחב של תרחישי שימוש ופעילויות הקשורות לבריאות, זהו אחד המשאבים הבסיסיים ביותר ב-FHIR. בדומה לשאר משאבי הבסיס, הגדרת הבסיס של משאב Patient היא פתוחה ולא אוכפת מגבלות רבות. הפרופיל הישראלי ILCorePatient נגזר ממשאב הבסיס Patient ומגדיר סט אילוצים וחוקים שהוגדרו במטרה לאפשר אחידות בהעברתו בין גורמים שונים במדינת ישראל. תצורתו הנוכחית הותאמה למערכת הבריאות הישראלית תוך הסתכלות, למידה והתחשבות במגבלות של פרופילים דומים בעולם ובפרט על פרופיל Patient מ- Us-Core, וכן מהדרישות העסקיות והאילוצים של מערכת הבריאות הישראלית. [לתעוד העסקי (קישור)]

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

שדות חובה

בכל משאב התואם לפרופיל ILCorePatient חייבים להיות האלמנטים הבאים:

  • לפחות מזהה עיסקי (identifier ) אחד (ראו פסקה הבאה)
  • לפחות שם אחד שחייב לכלול :
    • לפחות שם פרטי אחד
    • שם משפחה
  • מגדר המטופל. יש לשים לב שאלמנט זה אינו מיועד לייצוג המין כפי שהוגדר בלידה (לשם כך קיימת ההרחבה birthSex), אלא לייצוג המגדר שלו כפי שמשמש לצרכים אדמיניסטרטיביים (ראו סעיף Administrative Gender בעמוד של משאבPatient).
  • תאריך לידה.

מזהים עסקיים (slices על id)

להלן המזהים העסקיים בפרופיל :

  • ת.ז ישראלית [il-id]
  • ת.ז. פלסטינאית [pna-id]
  • מס’ דרכון [ppn]
  • ת.ז. מוצפנת לפי מפתח מב”ר [enc]

Must Support

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

  • hmo
  • parentName
  • name
  • gender
  • telecom
  • birthdate
  • language

Usage:

Formal Views of Profile Content

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient ILCore Patient profile
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... hmo S 0..1 CodeableConcept Extension: Israel Core HMO (קופת חולים)
URL: http://fhir.health.gov.il/StructureDefinition/ext-il-hmo
Binding: Israeli Health Management Organization (קופת חולים) (required)
.... parentName S 0..* (Complex) Extension: Administrative Parent Name
URL: http://fhir.health.gov.il/StructureDefinition/ext-administrative-parent-name
.... birthPlace 0..1 Address Extension: Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... immigration 0..* (Complex) Extension: Patient Immigration
URL: http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration
.... birthSex 0..1 code Extension: US Core Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth

... Slices for identifier 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique within the system.
.... identifier:il-id S 0..1 Identifier Israeli National Identifier
..... system 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-national-id
..... value C 0..1 string An Israeli ID number
il-id-chk: Israeli ID must be 9-digits with a correct check-digit at the end.
Example Valid Example: 000000018
..... assigner 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:pna-id 0..1 Identifier Palestinian National Identifier
..... system 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/pna-national-id
..... value 0..1 string A Palestininan ID number
Example Valid Example: 000000018
.... identifier:ppn 0..* Identifier Passport Number
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
..... system 0..1 uri The namespace for the identifier value
Binding: Passport URIs (required)
..... value 0..1 string Passport Number
.... identifier:prisoner-id S 0..1 Identifier Prisoner Number
..... system 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-prisoner-number
..... value C 0..1 string Prisoner Number
il-prison-num: up to 8 digits prisoner number, allowing for hebrew characters
Example Valid Example: 123456
..... assigner 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:enc 0..* Identifier Person's Identifier - MoH encrypted
..... system 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/encrypted-id-primary-moh
..... value 0..1 string An encrypted identifier
Example Valid Example: 000000018
..... assigner 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:visa-num S 0..* Identifier Israeli Temporary Visa number
..... system 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-visa-num
..... value 0..1 string An Israeli Visa Number
Example Valid Example: 000000018
..... assigner 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
... Slices for name SC 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:extension('http://hl7.org/fhir/StructureDefinition/language').value.ofType(code)
il-patient-name: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
.... name:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... family S 0..1 string Family name (often called 'Surname')
..... given S 0..* string Given names (not always 'first'). Includes middle names
.... name:Hebrew 0..* HumanName A name associated with the patient
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... value[x] 1..1 code Value of extension
Fixed Value: he
.... name:English 0..* HumanName A name associated with the patient
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... value[x] 1..1 code Value of extension
Fixed Value: en
.... name:Arabic 0..* HumanName A name associated with the patient
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... value[x] 1..1 code Value of extension
Fixed Value: ar
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
.... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
... gender S 1..1 code male | female | other | unknown
... birthDate S 1..1 date The date of birth for the individual
... address 0..* ILCoreAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for contact 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by pattern:relationship
.... contact:All Slices Content/Rules for all slices
..... organization 0..1 Reference(ILCore Organization Profile) Organization that is associated with the contact
.... contact:Parent 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
..... relationship
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PAR
... communication
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
... generalPractitioner 0..* Reference(ILCore Organization Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile) Patient's nominated primary care provider
... managingOrganization 0..1 Reference(ILCore Organization Profile) Organization that is the custodian of the patient record
... link
.... other 1..1 Reference(ILCore Patient Profile | ILCore RelatedPerson Profile) The other patient or related person resource that the link refers to

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.identifier:ppn.systemrequiredPassportUri
http://fhir.health.gov.il/ValueSet/passport-uri
from this IG

Constraints

IdGradePath(s)DetailsRequirements
il-id-chkerrorPatient.identifier:il-id.valueIsraeli ID must be 9-digits with a correct check-digit at the end.
: matches('[0-9]{9}$') and substring(8,1).toInteger()= (10-((substring(0,1).toInteger() + substring(1,1).toInteger()*2 mod 10 + substring(1,1).toInteger()*2 div 10 + substring(2,1).toInteger() + substring(3,1).toInteger()*2 mod 10 + substring(3,1).toInteger()*2 div 10 + substring(4,1).toInteger() + substring(5,1).toInteger()*2 mod 10 + substring(5,1).toInteger()*2 div 10 + substring(6,1).toInteger() + substring(7,1).toInteger()*2 mod 10 + substring(7,1).toInteger()*2 div 10) mod 10)) mod 10
il-patient-nameerrorPatient.nameEither Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
: (family.exists() or given.exists()) xor name.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
il-prison-numerrorPatient.identifier:prisoner-id.valueup to 8 digits prisoner number, allowing for hebrew characters
: matches('^[a-zA-Z0-9_אבגדהוזחטי כלמנסעפצקרתשךףץ]{0,8}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient ILCore Patient profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... hmo S 0..1 CodeableConcept Extension: Israel Core HMO (קופת חולים)
URL: http://fhir.health.gov.il/StructureDefinition/ext-il-hmo
Binding: Israeli Health Management Organization (קופת חולים) (required)
.... parentName S 0..* (Complex) Extension: Administrative Parent Name
URL: http://fhir.health.gov.il/StructureDefinition/ext-administrative-parent-name
.... birthPlace 0..1 Address Extension: Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... immigration 0..* (Complex) Extension: Patient Immigration
URL: http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration
.... birthSex 0..1 code Extension: US Core Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
.... identifier:il-id SΣ 0..1 Identifier Israeli National Identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-national-id
..... value ΣC 0..1 string An Israeli ID number
il-id-chk: Israeli ID must be 9-digits with a correct check-digit at the end.
Example General: 123456
Example Valid Example: 000000018
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:pna-id Σ 0..1 Identifier Palestinian National Identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/pna-national-id
..... value Σ 0..1 string A Palestininan ID number
Example General: 123456
Example Valid Example: 000000018
.... identifier:ppn Σ 0..* Identifier Passport Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
..... system Σ 0..1 uri The namespace for the identifier value
Binding: Passport URIs (required)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string Passport Number
Example General: 123456
.... identifier:prisoner-id SΣ 0..1 Identifier Prisoner Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-prisoner-number
..... value ΣC 0..1 string Prisoner Number
il-prison-num: up to 8 digits prisoner number, allowing for hebrew characters
Example General: 123456
Example Valid Example: 123456
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:enc Σ 0..* Identifier Person's Identifier - MoH encrypted
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/encrypted-id-primary-moh
..... value Σ 0..1 string An encrypted identifier
Example General: 123456
Example Valid Example: 000000018
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:visa-num SΣ 0..* Identifier Israeli Temporary Visa number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-visa-num
..... value Σ 0..1 string An Israeli Visa Number
Example General: 123456
Example Valid Example: 000000018
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣC 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:extension('http://hl7.org/fhir/StructureDefinition/language').value.ofType(code)
il-patient-name: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
.... name:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... family SΣ 0..1 string Family name (often called 'Surname')
..... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... name:Hebrew Σ 0..* HumanName A name associated with the patient
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: he
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... name:English Σ 0..* HumanName A name associated with the patient
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: en
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... name:Arabic Σ 0..* HumanName A name associated with the patient
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: ar
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

... telecom Σ 0..* ContactPoint A contact detail for the individual
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address 0..* ILCoreAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by pattern:relationship
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... contact:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... organization C 0..1 Reference(ILCore Organization Profile) Organization that is associated with the contact
.... contact:Parent C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... generalPractitioner 0..* Reference(ILCore Organization Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(ILCore Organization Profile) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(ILCore Patient Profile | ILCore RelatedPerson Profile) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:il-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:pna-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:ppn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:ppn.typeextensiblePattern: PPN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:ppn.systemrequiredPassportUri
http://fhir.health.gov.il/ValueSet/passport-uri
from this IG
Patient.identifier:prisoner-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:enc.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:visa-num.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:Hebrew.extension:language.value[x]preferredFixed Value: he
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:Hebrew.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:English.extension:language.value[x]preferredFixed Value: en
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:English.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:Arabic.extension:language.value[x]preferredFixed Value: ar
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:Arabic.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
il-id-chkerrorPatient.identifier:il-id.valueIsraeli ID must be 9-digits with a correct check-digit at the end.
: matches('[0-9]{9}$') and substring(8,1).toInteger()= (10-((substring(0,1).toInteger() + substring(1,1).toInteger()*2 mod 10 + substring(1,1).toInteger()*2 div 10 + substring(2,1).toInteger() + substring(3,1).toInteger()*2 mod 10 + substring(3,1).toInteger()*2 div 10 + substring(4,1).toInteger() + substring(5,1).toInteger()*2 mod 10 + substring(5,1).toInteger()*2 div 10 + substring(6,1).toInteger() + substring(7,1).toInteger()*2 mod 10 + substring(7,1).toInteger()*2 div 10) mod 10)) mod 10
il-patient-nameerrorPatient.nameEither Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
: (family.exists() or given.exists()) xor name.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
il-prison-numerrorPatient.identifier:prisoner-id.valueup to 8 digits prisoner number, allowing for hebrew characters
: matches('^[a-zA-Z0-9_אבגדהוזחטי כלמנסעפצקרתשךףץ]{0,8}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient ILCore Patient profile
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... hmo S 0..1 CodeableConcept Extension: Israel Core HMO (קופת חולים)
URL: http://fhir.health.gov.il/StructureDefinition/ext-il-hmo
Binding: Israeli Health Management Organization (קופת חולים) (required)
.... parentName S 0..* (Complex) Extension: Administrative Parent Name
URL: http://fhir.health.gov.il/StructureDefinition/ext-administrative-parent-name
.... birthPlace 0..1 Address Extension: Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... immigration 0..* (Complex) Extension: Patient Immigration
URL: http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration
.... birthSex 0..1 code Extension: US Core Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:il-id SΣ 0..1 Identifier Israeli National Identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-national-id
..... value ΣC 0..1 string An Israeli ID number
il-id-chk: Israeli ID must be 9-digits with a correct check-digit at the end.
Example General: 123456
Example Valid Example: 000000018
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:pna-id Σ 0..1 Identifier Palestinian National Identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/pna-national-id
..... value Σ 0..1 string A Palestininan ID number
Example General: 123456
Example Valid Example: 000000018
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:ppn Σ 0..* Identifier Passport Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Binding: Passport URIs (required)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string Passport Number
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:prisoner-id SΣ 0..1 Identifier Prisoner Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-prisoner-number
..... value ΣC 0..1 string Prisoner Number
il-prison-num: up to 8 digits prisoner number, allowing for hebrew characters
Example General: 123456
Example Valid Example: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:enc Σ 0..* Identifier Person's Identifier - MoH encrypted
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/encrypted-id-primary-moh
..... value Σ 0..1 string An encrypted identifier
Example General: 123456
Example Valid Example: 000000018
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:visa-num SΣ 0..* Identifier Israeli Temporary Visa number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-visa-num
..... value Σ 0..1 string An Israeli Visa Number
Example General: 123456
Example Valid Example: 000000018
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣC 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:extension('http://hl7.org/fhir/StructureDefinition/language').value.ofType(code)
il-patient-name: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
.... name:All Slices Content/Rules for all slices
..... 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
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family SΣ 0..1 string Family name (often called 'Surname')
..... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:Hebrew Σ 0..* HumanName A name associated with the patient
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: he
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:English Σ 0..* HumanName A name associated with the patient
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: en
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:Arabic Σ 0..* HumanName A name associated with the patient
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: ar
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* ContactPoint A contact detail for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address 0..* ILCoreAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by pattern:relationship
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... contact:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... name 0..1 HumanName A name associated with the contact person
..... telecom 0..* ContactPoint A contact detail for the person
..... address 0..1 Address Address for the contact person
..... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C 0..1 Reference(ILCore Organization Profile) Organization that is associated with the contact
..... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:Parent C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PAR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... name 0..1 HumanName A name associated with the contact person
..... telecom 0..* ContactPoint A contact detail for the person
..... address 0..1 Address Address for the contact person
..... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C 0..1 Reference(Organization) Organization that is associated with the contact
..... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(ILCore Organization Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(ILCore Organization Profile) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(ILCore Patient Profile | ILCore RelatedPerson Profile) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:il-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:il-id.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:pna-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:pna-id.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:ppn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:ppn.typeextensiblePattern: PPN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:ppn.systemrequiredPassportUri
http://fhir.health.gov.il/ValueSet/passport-uri
from this IG
Patient.identifier:prisoner-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:prisoner-id.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:enc.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:enc.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:visa-num.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:visa-num.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:Hebrew.extension:language.value[x]preferredFixed Value: he
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:Hebrew.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:English.extension:language.value[x]preferredFixed Value: en
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:English.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:Arabic.extension:language.value[x]preferredFixed Value: ar
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:Arabic.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.contact:Parent.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:Parent.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
il-id-chkerrorPatient.identifier:il-id.valueIsraeli ID must be 9-digits with a correct check-digit at the end.
: matches('[0-9]{9}$') and substring(8,1).toInteger()= (10-((substring(0,1).toInteger() + substring(1,1).toInteger()*2 mod 10 + substring(1,1).toInteger()*2 div 10 + substring(2,1).toInteger() + substring(3,1).toInteger()*2 mod 10 + substring(3,1).toInteger()*2 div 10 + substring(4,1).toInteger() + substring(5,1).toInteger()*2 mod 10 + substring(5,1).toInteger()*2 div 10 + substring(6,1).toInteger() + substring(7,1).toInteger()*2 mod 10 + substring(7,1).toInteger()*2 div 10) mod 10)) mod 10
il-patient-nameerrorPatient.nameEither Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
: (family.exists() or given.exists()) xor name.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
il-prison-numerrorPatient.identifier:prisoner-id.valueup to 8 digits prisoner number, allowing for hebrew characters
: matches('^[a-zA-Z0-9_אבגדהוזחטי כלמנסעפצקרתשךףץ]{0,8}$')

This structure is derived from Patient

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient ILCore Patient profile
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... hmo S 0..1 CodeableConcept Extension: Israel Core HMO (קופת חולים)
URL: http://fhir.health.gov.il/StructureDefinition/ext-il-hmo
Binding: Israeli Health Management Organization (קופת חולים) (required)
.... parentName S 0..* (Complex) Extension: Administrative Parent Name
URL: http://fhir.health.gov.il/StructureDefinition/ext-administrative-parent-name
.... birthPlace 0..1 Address Extension: Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... immigration 0..* (Complex) Extension: Patient Immigration
URL: http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration
.... birthSex 0..1 code Extension: US Core Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth

... Slices for identifier 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique within the system.
.... identifier:il-id S 0..1 Identifier Israeli National Identifier
..... system 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-national-id
..... value C 0..1 string An Israeli ID number
il-id-chk: Israeli ID must be 9-digits with a correct check-digit at the end.
Example Valid Example: 000000018
..... assigner 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:pna-id 0..1 Identifier Palestinian National Identifier
..... system 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/pna-national-id
..... value 0..1 string A Palestininan ID number
Example Valid Example: 000000018
.... identifier:ppn 0..* Identifier Passport Number
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
..... system 0..1 uri The namespace for the identifier value
Binding: Passport URIs (required)
..... value 0..1 string Passport Number
.... identifier:prisoner-id S 0..1 Identifier Prisoner Number
..... system 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-prisoner-number
..... value C 0..1 string Prisoner Number
il-prison-num: up to 8 digits prisoner number, allowing for hebrew characters
Example Valid Example: 123456
..... assigner 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:enc 0..* Identifier Person's Identifier - MoH encrypted
..... system 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/encrypted-id-primary-moh
..... value 0..1 string An encrypted identifier
Example Valid Example: 000000018
..... assigner 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:visa-num S 0..* Identifier Israeli Temporary Visa number
..... system 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-visa-num
..... value 0..1 string An Israeli Visa Number
Example Valid Example: 000000018
..... assigner 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
... Slices for name SC 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:extension('http://hl7.org/fhir/StructureDefinition/language').value.ofType(code)
il-patient-name: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
.... name:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... family S 0..1 string Family name (often called 'Surname')
..... given S 0..* string Given names (not always 'first'). Includes middle names
.... name:Hebrew 0..* HumanName A name associated with the patient
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... value[x] 1..1 code Value of extension
Fixed Value: he
.... name:English 0..* HumanName A name associated with the patient
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... value[x] 1..1 code Value of extension
Fixed Value: en
.... name:Arabic 0..* HumanName A name associated with the patient
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... value[x] 1..1 code Value of extension
Fixed Value: ar
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
.... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
... gender S 1..1 code male | female | other | unknown
... birthDate S 1..1 date The date of birth for the individual
... address 0..* ILCoreAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for contact 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by pattern:relationship
.... contact:All Slices Content/Rules for all slices
..... organization 0..1 Reference(ILCore Organization Profile) Organization that is associated with the contact
.... contact:Parent 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
..... relationship
...... coding 0..* Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PAR
... communication
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
... generalPractitioner 0..* Reference(ILCore Organization Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile) Patient's nominated primary care provider
... managingOrganization 0..1 Reference(ILCore Organization Profile) Organization that is the custodian of the patient record
... link
.... other 1..1 Reference(ILCore Patient Profile | ILCore RelatedPerson Profile) The other patient or related person resource that the link refers to

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.identifier:ppn.systemrequiredPassportUri
http://fhir.health.gov.il/ValueSet/passport-uri
from this IG

Constraints

IdGradePath(s)DetailsRequirements
il-id-chkerrorPatient.identifier:il-id.valueIsraeli ID must be 9-digits with a correct check-digit at the end.
: matches('[0-9]{9}$') and substring(8,1).toInteger()= (10-((substring(0,1).toInteger() + substring(1,1).toInteger()*2 mod 10 + substring(1,1).toInteger()*2 div 10 + substring(2,1).toInteger() + substring(3,1).toInteger()*2 mod 10 + substring(3,1).toInteger()*2 div 10 + substring(4,1).toInteger() + substring(5,1).toInteger()*2 mod 10 + substring(5,1).toInteger()*2 div 10 + substring(6,1).toInteger() + substring(7,1).toInteger()*2 mod 10 + substring(7,1).toInteger()*2 div 10) mod 10)) mod 10
il-patient-nameerrorPatient.nameEither Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
: (family.exists() or given.exists()) xor name.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
il-prison-numerrorPatient.identifier:prisoner-id.valueup to 8 digits prisoner number, allowing for hebrew characters
: matches('^[a-zA-Z0-9_אבגדהוזחטי כלמנסעפצקרתשךףץ]{0,8}$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient ILCore Patient profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... hmo S 0..1 CodeableConcept Extension: Israel Core HMO (קופת חולים)
URL: http://fhir.health.gov.il/StructureDefinition/ext-il-hmo
Binding: Israeli Health Management Organization (קופת חולים) (required)
.... parentName S 0..* (Complex) Extension: Administrative Parent Name
URL: http://fhir.health.gov.il/StructureDefinition/ext-administrative-parent-name
.... birthPlace 0..1 Address Extension: Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... immigration 0..* (Complex) Extension: Patient Immigration
URL: http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration
.... birthSex 0..1 code Extension: US Core Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
.... identifier:il-id SΣ 0..1 Identifier Israeli National Identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-national-id
..... value ΣC 0..1 string An Israeli ID number
il-id-chk: Israeli ID must be 9-digits with a correct check-digit at the end.
Example General: 123456
Example Valid Example: 000000018
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:pna-id Σ 0..1 Identifier Palestinian National Identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/pna-national-id
..... value Σ 0..1 string A Palestininan ID number
Example General: 123456
Example Valid Example: 000000018
.... identifier:ppn Σ 0..* Identifier Passport Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
..... system Σ 0..1 uri The namespace for the identifier value
Binding: Passport URIs (required)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string Passport Number
Example General: 123456
.... identifier:prisoner-id SΣ 0..1 Identifier Prisoner Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-prisoner-number
..... value ΣC 0..1 string Prisoner Number
il-prison-num: up to 8 digits prisoner number, allowing for hebrew characters
Example General: 123456
Example Valid Example: 123456
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:enc Σ 0..* Identifier Person's Identifier - MoH encrypted
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/encrypted-id-primary-moh
..... value Σ 0..1 string An encrypted identifier
Example General: 123456
Example Valid Example: 000000018
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:visa-num SΣ 0..* Identifier Israeli Temporary Visa number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-visa-num
..... value Σ 0..1 string An Israeli Visa Number
Example General: 123456
Example Valid Example: 000000018
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣC 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:extension('http://hl7.org/fhir/StructureDefinition/language').value.ofType(code)
il-patient-name: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
.... name:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... family SΣ 0..1 string Family name (often called 'Surname')
..... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... name:Hebrew Σ 0..* HumanName A name associated with the patient
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: he
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... name:English Σ 0..* HumanName A name associated with the patient
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: en
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... name:Arabic Σ 0..* HumanName A name associated with the patient
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: ar
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

... telecom Σ 0..* ContactPoint A contact detail for the individual
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address 0..* ILCoreAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by pattern:relationship
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... contact:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... organization C 0..1 Reference(ILCore Organization Profile) Organization that is associated with the contact
.... contact:Parent C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... generalPractitioner 0..* Reference(ILCore Organization Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(ILCore Organization Profile) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(ILCore Patient Profile | ILCore RelatedPerson Profile) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:il-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:pna-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:ppn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:ppn.typeextensiblePattern: PPN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:ppn.systemrequiredPassportUri
http://fhir.health.gov.il/ValueSet/passport-uri
from this IG
Patient.identifier:prisoner-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:enc.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:visa-num.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:Hebrew.extension:language.value[x]preferredFixed Value: he
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:Hebrew.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:English.extension:language.value[x]preferredFixed Value: en
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:English.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:Arabic.extension:language.value[x]preferredFixed Value: ar
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:Arabic.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
il-id-chkerrorPatient.identifier:il-id.valueIsraeli ID must be 9-digits with a correct check-digit at the end.
: matches('[0-9]{9}$') and substring(8,1).toInteger()= (10-((substring(0,1).toInteger() + substring(1,1).toInteger()*2 mod 10 + substring(1,1).toInteger()*2 div 10 + substring(2,1).toInteger() + substring(3,1).toInteger()*2 mod 10 + substring(3,1).toInteger()*2 div 10 + substring(4,1).toInteger() + substring(5,1).toInteger()*2 mod 10 + substring(5,1).toInteger()*2 div 10 + substring(6,1).toInteger() + substring(7,1).toInteger()*2 mod 10 + substring(7,1).toInteger()*2 div 10) mod 10)) mod 10
il-patient-nameerrorPatient.nameEither Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
: (family.exists() or given.exists()) xor name.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
il-prison-numerrorPatient.identifier:prisoner-id.valueup to 8 digits prisoner number, allowing for hebrew characters
: matches('^[a-zA-Z0-9_אבגדהוזחטי כלמנסעפצקרתשךףץ]{0,8}$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient ILCore Patient profile
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... hmo S 0..1 CodeableConcept Extension: Israel Core HMO (קופת חולים)
URL: http://fhir.health.gov.il/StructureDefinition/ext-il-hmo
Binding: Israeli Health Management Organization (קופת חולים) (required)
.... parentName S 0..* (Complex) Extension: Administrative Parent Name
URL: http://fhir.health.gov.il/StructureDefinition/ext-administrative-parent-name
.... birthPlace 0..1 Address Extension: Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... immigration 0..* (Complex) Extension: Patient Immigration
URL: http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration
.... birthSex 0..1 code Extension: US Core Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:il-id SΣ 0..1 Identifier Israeli National Identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-national-id
..... value ΣC 0..1 string An Israeli ID number
il-id-chk: Israeli ID must be 9-digits with a correct check-digit at the end.
Example General: 123456
Example Valid Example: 000000018
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:pna-id Σ 0..1 Identifier Palestinian National Identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/pna-national-id
..... value Σ 0..1 string A Palestininan ID number
Example General: 123456
Example Valid Example: 000000018
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:ppn Σ 0..* Identifier Passport Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Binding: Passport URIs (required)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string Passport Number
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:prisoner-id SΣ 0..1 Identifier Prisoner Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-prisoner-number
..... value ΣC 0..1 string Prisoner Number
il-prison-num: up to 8 digits prisoner number, allowing for hebrew characters
Example General: 123456
Example Valid Example: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:enc Σ 0..* Identifier Person's Identifier - MoH encrypted
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/encrypted-id-primary-moh
..... value Σ 0..1 string An encrypted identifier
Example General: 123456
Example Valid Example: 000000018
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
.... identifier:visa-num SΣ 0..* Identifier Israeli Temporary Visa number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: http://fhir.health.gov.il/identifier/il-visa-num
..... value Σ 0..1 string An Israeli Visa Number
Example General: 123456
Example Valid Example: 000000018
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(ILCore Organization Profile) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣC 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:extension('http://hl7.org/fhir/StructureDefinition/language').value.ofType(code)
il-patient-name: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
.... name:All Slices Content/Rules for all slices
..... 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
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family SΣ 0..1 string Family name (often called 'Surname')
..... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:Hebrew Σ 0..* HumanName A name associated with the patient
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: he
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:English Σ 0..* HumanName A name associated with the patient
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: en
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... name:Arabic Σ 0..* HumanName A name associated with the patient
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... language 1..1 (Complex) Human Language for the item
URL: http://hl7.org/fhir/StructureDefinition/language
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/language"
....... value[x] 1..1 code Value of extension
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguages Max Binding

Fixed Value: ar
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* ContactPoint A contact detail for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 1..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address 0..* ILCoreAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... Slices for contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Slice: Unordered, Open by pattern:relationship
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... contact:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... name 0..1 HumanName A name associated with the contact person
..... telecom 0..* ContactPoint A contact detail for the person
..... address 0..1 Address Address for the contact person
..... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C 0..1 Reference(ILCore Organization Profile) Organization that is associated with the contact
..... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
.... contact:Parent C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PAR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... name 0..1 HumanName A name associated with the contact person
..... telecom 0..* ContactPoint A contact detail for the person
..... address 0..1 Address Address for the contact person
..... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

..... organization C 0..1 Reference(Organization) Organization that is associated with the contact
..... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(ILCore Organization Profile | ILCore Practitioner Profile | ILCore PractitionerRole Profile) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(ILCore Organization Profile) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(ILCore Patient Profile | ILCore RelatedPerson Profile) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:il-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:il-id.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:pna-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:pna-id.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:ppn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:ppn.typeextensiblePattern: PPN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:ppn.systemrequiredPassportUri
http://fhir.health.gov.il/ValueSet/passport-uri
from this IG
Patient.identifier:prisoner-id.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:prisoner-id.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:enc.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:enc.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:visa-num.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:visa-num.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:Hebrew.extension:language.value[x]preferredFixed Value: he
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:Hebrew.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:English.extension:language.value[x]preferredFixed Value: en
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:English.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.name:Arabic.extension:language.value[x]preferredFixed Value: ar
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.name:Arabic.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.contact:Parent.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact:Parent.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
il-id-chkerrorPatient.identifier:il-id.valueIsraeli ID must be 9-digits with a correct check-digit at the end.
: matches('[0-9]{9}$') and substring(8,1).toInteger()= (10-((substring(0,1).toInteger() + substring(1,1).toInteger()*2 mod 10 + substring(1,1).toInteger()*2 div 10 + substring(2,1).toInteger() + substring(3,1).toInteger()*2 mod 10 + substring(3,1).toInteger()*2 div 10 + substring(4,1).toInteger() + substring(5,1).toInteger()*2 mod 10 + substring(5,1).toInteger()*2 div 10 + substring(6,1).toInteger() + substring(7,1).toInteger()*2 mod 10 + substring(7,1).toInteger()*2 div 10) mod 10)) mod 10
il-patient-nameerrorPatient.nameEither Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
: (family.exists() or given.exists()) xor name.extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
il-prison-numerrorPatient.identifier:prisoner-id.valueup to 8 digits prisoner number, allowing for hebrew characters
: matches('^[a-zA-Z0-9_אבגדהוזחטי כלמנסעפצקרתשךףץ]{0,8}$')

This structure is derived from Patient

 

Other representations of profile: CSV, Excel, Schematron