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

Extension: Ext: Patient Immigration

Official URL: http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration Version: 0.18.0
Draft as of 2024-04-07 Computable Name: PatientImmigration

Extension: Immigration information for patient - for the purpose of this extension - immigration is an international movement of a person to a destination country in order to settle as permanent resident

Context of Use

This extension may be used on the following element(s):

  • Element ID Patient

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: Extension: Immigration information for patient - for the purpose of this extension - immigration is an international movement of a person to a destination country in order to settle as permanent resident

  • origin: CodeableConcept: Country code corresponding to origin country of patient.
  • destination: CodeableConcept: Country code corresponding to destination country of patient. When missing, destination country is assumed to be Israel
  • date: date: Date of immigration.
  • status: CodeableConcept: Immigration status according to LOINC answer-list LL5005-5 [http://loinc.org/LL5005-5]

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Ext: Patient Immigration
... Slices for extension Content/Rules for all slices
.... extension:origin 0..1 Extension Country code of origin
..... extension 0..0
..... url 1..1 uri "origin"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Country Codes (preferred)
Example Valid Example: {"coding":[{"system":"urn:iso:std:iso:3166","code":"US","display":"United States of America"}]}
.... extension:destination 0..1 Extension Country code of destination
..... extension 0..0
..... url 1..1 uri "destination"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Country Codes (preferred)
Example Valid Example: {"coding":[{"system":"urn:iso:std:iso:3166","code":"IL","display":"Israel"}]}
.... extension:date 0..1 Extension Date of immigration
..... extension 0..0
..... url 1..1 uri "date"
..... value[x] 1..1 date Value of extension
Example Valid Example: 2022-01-01
.... extension:status 0..1 Extension Immigration status code
..... extension 0..0
..... url 1..1 uri "status"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: LOINC Answer List LL5005-5 (required)
Example Valid Example: {"coding":[{"system":"http://loinc.org","code":"LA29155-1","display":"Naturalized citizen"}]}
... url 1..1 uri "http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Ext: Patient Immigration
... 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
.... extension:origin 0..1 Extension Country code of origin
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "origin"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Country Codes (preferred)
Example Valid Example: {"coding":[{"system":"urn:iso:std:iso:3166","code":"US","display":"United States of America"}]}
.... extension:destination 0..1 Extension Country code of destination
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "destination"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Country Codes (preferred)
Example Valid Example: {"coding":[{"system":"urn:iso:std:iso:3166","code":"IL","display":"Israel"}]}
.... extension:date 0..1 Extension Date of immigration
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "date"
..... value[x] 1..1 date Value of extension
Example Valid Example: 2022-01-01
.... extension:status 0..1 Extension Immigration status code
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "status"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: LOINC Answer List LL5005-5 (required)
Example Valid Example: {"coding":[{"system":"http://loinc.org","code":"LA29155-1","display":"Naturalized citizen"}]}
... url 1..1 uri "http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Extension: Immigration information for patient - for the purpose of this extension - immigration is an international movement of a person to a destination country in order to settle as permanent resident

  • origin: CodeableConcept: Country code corresponding to origin country of patient.
  • destination: CodeableConcept: Country code corresponding to destination country of patient. When missing, destination country is assumed to be Israel
  • date: date: Date of immigration.
  • status: CodeableConcept: Immigration status according to LOINC answer-list LL5005-5 [http://loinc.org/LL5005-5]

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Ext: Patient Immigration
... Slices for extension Content/Rules for all slices
.... extension:origin 0..1 Extension Country code of origin
..... extension 0..0
..... url 1..1 uri "origin"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Country Codes (preferred)
Example Valid Example: {"coding":[{"system":"urn:iso:std:iso:3166","code":"US","display":"United States of America"}]}
.... extension:destination 0..1 Extension Country code of destination
..... extension 0..0
..... url 1..1 uri "destination"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Country Codes (preferred)
Example Valid Example: {"coding":[{"system":"urn:iso:std:iso:3166","code":"IL","display":"Israel"}]}
.... extension:date 0..1 Extension Date of immigration
..... extension 0..0
..... url 1..1 uri "date"
..... value[x] 1..1 date Value of extension
Example Valid Example: 2022-01-01
.... extension:status 0..1 Extension Immigration status code
..... extension 0..0
..... url 1..1 uri "status"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: LOINC Answer List LL5005-5 (required)
Example Valid Example: {"coding":[{"system":"http://loinc.org","code":"LA29155-1","display":"Naturalized citizen"}]}
... url 1..1 uri "http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Ext: Patient Immigration
... 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
.... extension:origin 0..1 Extension Country code of origin
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "origin"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Country Codes (preferred)
Example Valid Example: {"coding":[{"system":"urn:iso:std:iso:3166","code":"US","display":"United States of America"}]}
.... extension:destination 0..1 Extension Country code of destination
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "destination"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Country Codes (preferred)
Example Valid Example: {"coding":[{"system":"urn:iso:std:iso:3166","code":"IL","display":"Israel"}]}
.... extension:date 0..1 Extension Date of immigration
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "date"
..... value[x] 1..1 date Value of extension
Example Valid Example: 2022-01-01
.... extension:status 0..1 Extension Immigration status code
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "status"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: LOINC Answer List LL5005-5 (required)
Example Valid Example: {"coding":[{"system":"http://loinc.org","code":"LA29155-1","display":"Naturalized citizen"}]}
... url 1..1 uri "http://fhir.health.gov.il/StructureDefinition/ext-patient-immigration"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:origin.value[x]preferredILCoreJurisdiction
http://fhir.health.gov.il/ValueSet/il-core-jurisdiction
from this IG
Extension.extension:destination.value[x]preferredILCoreJurisdiction
http://fhir.health.gov.il/ValueSet/il-core-jurisdiction
from this IG
Extension.extension:status.value[x]requiredLOINC LL5005-5
http://loinc.org/vs/LL5005-5