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 Immunization Profile

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

Israel Core proposed constraints and extensions on the Immunization Resource

כללי

משאב הבסיסImmunization נועד לתעד אירוע של מתן חיסון למטופל, או דווח על מתן חיסון על ידי המטופל, הצוות רפואי או גורם אחר. משאב זה נועד לתיעוד של חיסוני המטופל, וכן לתשאול היסטוריית החיסונים של המטופל בכל תחומי הבריאות בכל settings קליני (קהילה, בית חולים וכו’). הגדרת הפרופיל מתייחסת לחיסון של בני אדם ובעלי חיים כאחד, ואינה כוללת מתן של חומרים שאינם חיסונים, אפילו כאלה שעשויים להיות להם או נטען לגביהם שיש להם השפעות אימונולוגיות חיסוניות. בעוד מתן החיסון (vaccine), ותהליך ההתחסנות של המטופל עקב מתן החיסון (immunization) אינם זהים מבחינה קלינית, למטרת אפיון משאבי ה- FHIR, נעשה שימוש במונחים נרדפים. הפרופיל הישראלי ILCoreImmunization נגזר ממשאב הבסיס Immunizationומגדיר סט אילוצים וחוקים שהוגדרו במטרה לאפשר אחידות בהעברתו בין גורמים שונים במדינת ישראל. תצורתו הנוכחית הותאמה למערכת הבריאות הישראלית תוך הסתכלות, למידה והתחשבות במגבלות של פרופילים דומים בעולם ובפרט על פרופיל Immunization מ- US Core, וכן מהדרישות העסקיות והאילוצים של מערכת הבריאות הישראלית.

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

מזהים עסקיים

התיעוד על חיסון בפרופיל זה כולל בין השאר את קוד החיסון (VaccineCode) שמורכב מ: • קוד סוג החיסון (סלייס חובה - Vaccine) - קוד ממערכת קידוד SNOMED-CT של סוג החיסון והמחלות אותן החיסון מונע - למשל חיסון משולש (MMR) [871831003] או covid mRNA [1119349007] • קוד מזהה של החומר הפעיל ו\או מוצר החיסון המסחרי (סלייס רשות - Product) - רשימת ערכים הכוללת קודי ירפ”א, CVX ו-ATC J07. כך, עבור חיסון covid mRNA עם קוד SNOMED-CT [1119349007] ייתכן שיהיה קוד CVX 208 עבור בקבוקון Pfizer-BioNTech מדולל לפני שימוש, או קוד CVX 217 עבור בקבוקון מוכן לשימוש, או קוד CVX 218 עבור בקבוקון מינון של 0.2 מ”ל או קוד ירפ”א, אך קוד החיסון עדיין זהה לכולם. כמו כן הפרופיל כולל את מספר האצווה של החיסון, פרטי המטופל שמקבל את החיסון, פרטי יצרן החיסון, האזור בגוף שבו ניתן החיסון למטופל, דרך המתן, הזמן שניתן החיסון, מבצע החיסון, וכן תיעוד של חומרי הסברה לגבי החיסון ופרוטוקול החיסון. בנוסף, ניתן לתעד בפרופיל אירוע תגובתי חריג לחיסון (reaction) בפרופיל ILCoreImmunization ReactionObservation. .במקרה שהתגובה היא אלרגיה או רגישות יש לתעד אותה גם בפרופיל AllergyIntolerance,זאת כיוון שמערכות בד”כ יתשאלו את פרופיל AllergyIntolerance כדי לקבל מידע לגבי אלרגיות, ולא את פרופיל החיסון. ע”מ להבטיח בקרת איכות, הוגדר כלל אכיפה (invariant) על הפרופיל שבודק שאם הגורם המתעד את החיסון הוא זה שנתן את החיסון בפועל, חייב להיות ערך באלמנט מס’ האצווה, וזאת לשם מעקב במקרה של דיווח על תופעות לוואי או recall של החיסון. יש לשים לב שמשאב זה מטפל רק בתרכיבים/תרופות הקשורים לחיסון בעוד שמשאב MedicationAdministration מטפל בתרופות שאינן קשורות לחיסון. לכן, מערכות אשר מתייחסות לתרופות הקשורות לחיסון באותו אופן כמו לשאר התרופות שאינן חיסון, צריכות להקפיד על הפרדה זו ולהשתמש בו רק לדווח של תרופות הקשורות לחיסון.

שדות חובה

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

  • קוד סוג חיסון אחד [vaccineCode.coding[vaccine
  • אינדיקציה אחת האם מקור תעוד החיסון הוא הגורם שנתן אותו primarySource))

Must Support

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

  • status
  • statusReason
  • vaccineCode.coding[product]
  • patient
  • occurrence[X]
  • occurrence[occurrenceDateTime]
  • lotNumber

Usage:

Formal Views of Profile Content

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

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization ILCore Immunization Profile
il-immunization-lot-number: Immunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
... status S 1..1 code completed | entered-in-error | not-done
... statusReason S 0..1 CodeableConcept Reason not done
Binding: statusReason codes for Immunization profile (extensible)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"310376006","display":"Immunization consent not given"}]}
... vaccineCode S 1..1 CodeableConcept Vaccine product administered
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:vaccine S 1..1 Coding Code defined by a terminology system
Binding: Vaccine Codes (required)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"346313005","display":"Allergen extract vaccines"}]}
..... coding:product S 0..1 Coding Code defined by a terminology system
Binding: Vaccine Product Codes (required)
Example Valid Example: {"coding":[{"system":"http://www.whocc.no/atc","code":"J07AC","display":"Anthrax vaccines"}]}
... encounter 0..1 Reference(ILCore Encounter Profile) Encounter immunization was part of
... Slices for occurrence[x] S 1..1 dateTime, string Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime Vaccine administration date
... primarySource S 1..1 boolean Indicates context the data was recorded in
... location 0..1 Reference(ILCore Location Profile) Where immunization occurred
... manufacturer 0..1 Reference(ILCore Organization Profile) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunization Observation Body Site list (extensible)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"368208006","display":"Left upper arm structure (body structure)"}]}
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (extensible)
... performer
.... actor 1..1 Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile) Individual or organization who was performing
... reasonReference 0..* Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile) Why immunization occurred
... reaction
.... detail 0..1 Reference(ILCore ImmunizationReactionObservation Profile) Additional information on reaction
... protocolApplied
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: Target Disease Codes (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.statusReasonextensibleReasonNotDone
http://fhir.health.gov.il/ValueSet/reason-not-done
from this IG
Immunization.vaccineCode.coding:vaccinerequiredVaccineCode
http://fhir.health.gov.il/ValueSet/vaccine-code
from this IG
Immunization.vaccineCode.coding:productrequiredVaccineProductCode
http://fhir.health.gov.il/ValueSet/vaccine-product-code
from this IG
Immunization.siteextensibleImmunizationBodySite
http://fhir.health.gov.il/ValueSet/immunization-body-site
from this IG
Immunization.routeextensibleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
from the FHIR Standard
Immunization.protocolApplied.targetDiseasepreferredTargetDisease
http://fhir.health.gov.il/ValueSet/target-disease
from this IG

Constraints

IdGradePath(s)DetailsRequirements
il-immunization-lot-numbererrorImmunizationImmunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
: primarySource=true implies lotNumber.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization ILCore Immunization Profile
il-immunization-lot-number: Immunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:vaccine SΣ 1..1 Coding Code defined by a terminology system
Binding: Vaccine Codes (required)

Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"346313005","display":"Allergen extract vaccines"}]}
..... coding:product SΣ 0..1 Coding Code defined by a terminology system
Binding: Vaccine Product Codes (required)

Example Valid Example: {"coding":[{"system":"http://www.whocc.no/atc","code":"J07AC","display":"Anthrax vaccines"}]}
... patient SΣ 1..1 Reference(ILCore Patient Profile) Who was immunized
... encounter 0..1 Reference(ILCore Encounter Profile) Encounter immunization was part of
... Slices for occurrence[x] SΣ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
... primarySource SΣ 1..1 boolean Indicates context the data was recorded in
... location 0..1 Reference(ILCore Location Profile) Where immunization occurred
... manufacturer 0..1 Reference(ILCore Organization Profile) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunization Observation Body Site list (extensible)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"368208006","display":"Left upper arm structure (body structure)"}]}
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (extensible)
... reasonReference 0..* Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonextensibleReasonNotDone
http://fhir.health.gov.il/ValueSet/reason-not-done
from this IG
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
Immunization.vaccineCode.coding:vaccinerequiredVaccineCode
http://fhir.health.gov.il/ValueSet/vaccine-code
from this IG
Immunization.vaccineCode.coding:productrequiredVaccineProductCode
http://fhir.health.gov.il/ValueSet/vaccine-product-code
from this IG
Immunization.siteextensibleImmunizationBodySite
http://fhir.health.gov.il/ValueSet/immunization-body-site
from this IG
Immunization.routeextensibleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
il-immunization-lot-numbererrorImmunizationImmunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
: primarySource=true implies lotNumber.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization ILCore Immunization Profile
il-immunization-lot-number: Immunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S 0..1 CodeableConcept Reason not done
Binding: statusReason codes for Immunization profile (extensible)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"310376006","display":"Immunization consent not given"}]}
... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:vaccine SΣ 1..1 Coding Code defined by a terminology system
Binding: Vaccine Codes (required)

Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"346313005","display":"Allergen extract vaccines"}]}
..... coding:product SΣ 0..1 Coding Code defined by a terminology system
Binding: Vaccine Product Codes (required)

Example Valid Example: {"coding":[{"system":"http://www.whocc.no/atc","code":"J07AC","display":"Anthrax vaccines"}]}
.... text Σ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(ILCore Patient Profile) Who was immunized
... encounter 0..1 Reference(ILCore Encounter Profile) Encounter immunization was part of
... Slices for occurrence[x] SΣ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource SΣ 1..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location 0..1 Reference(ILCore Location Profile) Where immunization occurred
... manufacturer 0..1 Reference(ILCore Organization Profile) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate 0..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunization Observation Body Site list (extensible)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"368208006","display":"Left upper arm structure (body structure)"}]}
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (extensible)
... doseQuantity 0..1 SimpleQuantity Amount of vaccine administered
... performer Σ 0..* BackboneElement Who performed event
.... 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
.... function Σ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ 1..1 Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile) Individual or organization who was performing
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..* Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C 0..* BackboneElement Educational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... 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
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... 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
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(ILCore ImmunizationReactionObservation Profile) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... 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
.... series 0..1 string Name of vaccine series
.... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: Target Disease Codes (preferred)
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonextensibleReasonNotDone
http://fhir.health.gov.il/ValueSet/reason-not-done
from this IG
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
Immunization.vaccineCode.coding:vaccinerequiredVaccineCode
http://fhir.health.gov.il/ValueSet/vaccine-code
from this IG
Immunization.vaccineCode.coding:productrequiredVaccineProductCode
http://fhir.health.gov.il/ValueSet/vaccine-product-code
from this IG
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard
Immunization.siteextensibleImmunizationBodySite
http://fhir.health.gov.il/ValueSet/immunization-body-site
from this IG
Immunization.routeextensibleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
from the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard
Immunization.protocolApplied.targetDiseasepreferredTargetDisease
http://fhir.health.gov.il/ValueSet/target-disease
from this IG

Constraints

IdGradePath(s)DetailsRequirements
il-immunization-lot-numbererrorImmunizationImmunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
: primarySource=true implies lotNumber.exists()

This structure is derived from Immunization

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization ILCore Immunization Profile
il-immunization-lot-number: Immunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
... status S 1..1 code completed | entered-in-error | not-done
... statusReason S 0..1 CodeableConcept Reason not done
Binding: statusReason codes for Immunization profile (extensible)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"310376006","display":"Immunization consent not given"}]}
... vaccineCode S 1..1 CodeableConcept Vaccine product administered
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:vaccine S 1..1 Coding Code defined by a terminology system
Binding: Vaccine Codes (required)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"346313005","display":"Allergen extract vaccines"}]}
..... coding:product S 0..1 Coding Code defined by a terminology system
Binding: Vaccine Product Codes (required)
Example Valid Example: {"coding":[{"system":"http://www.whocc.no/atc","code":"J07AC","display":"Anthrax vaccines"}]}
... encounter 0..1 Reference(ILCore Encounter Profile) Encounter immunization was part of
... Slices for occurrence[x] S 1..1 dateTime, string Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime Vaccine administration date
... primarySource S 1..1 boolean Indicates context the data was recorded in
... location 0..1 Reference(ILCore Location Profile) Where immunization occurred
... manufacturer 0..1 Reference(ILCore Organization Profile) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunization Observation Body Site list (extensible)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"368208006","display":"Left upper arm structure (body structure)"}]}
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (extensible)
... performer
.... actor 1..1 Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile) Individual or organization who was performing
... reasonReference 0..* Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile) Why immunization occurred
... reaction
.... detail 0..1 Reference(ILCore ImmunizationReactionObservation Profile) Additional information on reaction
... protocolApplied
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: Target Disease Codes (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.statusReasonextensibleReasonNotDone
http://fhir.health.gov.il/ValueSet/reason-not-done
from this IG
Immunization.vaccineCode.coding:vaccinerequiredVaccineCode
http://fhir.health.gov.il/ValueSet/vaccine-code
from this IG
Immunization.vaccineCode.coding:productrequiredVaccineProductCode
http://fhir.health.gov.il/ValueSet/vaccine-product-code
from this IG
Immunization.siteextensibleImmunizationBodySite
http://fhir.health.gov.il/ValueSet/immunization-body-site
from this IG
Immunization.routeextensibleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
from the FHIR Standard
Immunization.protocolApplied.targetDiseasepreferredTargetDisease
http://fhir.health.gov.il/ValueSet/target-disease
from this IG

Constraints

IdGradePath(s)DetailsRequirements
il-immunization-lot-numbererrorImmunizationImmunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
: primarySource=true implies lotNumber.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization ILCore Immunization Profile
il-immunization-lot-number: Immunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:vaccine SΣ 1..1 Coding Code defined by a terminology system
Binding: Vaccine Codes (required)

Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"346313005","display":"Allergen extract vaccines"}]}
..... coding:product SΣ 0..1 Coding Code defined by a terminology system
Binding: Vaccine Product Codes (required)

Example Valid Example: {"coding":[{"system":"http://www.whocc.no/atc","code":"J07AC","display":"Anthrax vaccines"}]}
... patient SΣ 1..1 Reference(ILCore Patient Profile) Who was immunized
... encounter 0..1 Reference(ILCore Encounter Profile) Encounter immunization was part of
... Slices for occurrence[x] SΣ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
... primarySource SΣ 1..1 boolean Indicates context the data was recorded in
... location 0..1 Reference(ILCore Location Profile) Where immunization occurred
... manufacturer 0..1 Reference(ILCore Organization Profile) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunization Observation Body Site list (extensible)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"368208006","display":"Left upper arm structure (body structure)"}]}
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (extensible)
... reasonReference 0..* Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonextensibleReasonNotDone
http://fhir.health.gov.il/ValueSet/reason-not-done
from this IG
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
Immunization.vaccineCode.coding:vaccinerequiredVaccineCode
http://fhir.health.gov.il/ValueSet/vaccine-code
from this IG
Immunization.vaccineCode.coding:productrequiredVaccineProductCode
http://fhir.health.gov.il/ValueSet/vaccine-product-code
from this IG
Immunization.siteextensibleImmunizationBodySite
http://fhir.health.gov.il/ValueSet/immunization-body-site
from this IG
Immunization.routeextensibleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
il-immunization-lot-numbererrorImmunizationImmunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
: primarySource=true implies lotNumber.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization ILCore Immunization Profile
il-immunization-lot-number: Immunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S 0..1 CodeableConcept Reason not done
Binding: statusReason codes for Immunization profile (extensible)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"310376006","display":"Immunization consent not given"}]}
... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:vaccine SΣ 1..1 Coding Code defined by a terminology system
Binding: Vaccine Codes (required)

Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"346313005","display":"Allergen extract vaccines"}]}
..... coding:product SΣ 0..1 Coding Code defined by a terminology system
Binding: Vaccine Product Codes (required)

Example Valid Example: {"coding":[{"system":"http://www.whocc.no/atc","code":"J07AC","display":"Anthrax vaccines"}]}
.... text Σ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(ILCore Patient Profile) Who was immunized
... encounter 0..1 Reference(ILCore Encounter Profile) Encounter immunization was part of
... Slices for occurrence[x] SΣ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource SΣ 1..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location 0..1 Reference(ILCore Location Profile) Where immunization occurred
... manufacturer 0..1 Reference(ILCore Organization Profile) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate 0..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: Immunization Observation Body Site list (extensible)
Example Valid Example: {"coding":[{"system":"http://snomed.info/sct","code":"368208006","display":"Left upper arm structure (body structure)"}]}
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (extensible)
... doseQuantity 0..1 SimpleQuantity Amount of vaccine administered
... performer Σ 0..* BackboneElement Who performed event
.... 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
.... function Σ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ 1..1 Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile) Individual or organization who was performing
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..* Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C 0..* BackboneElement Educational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... 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
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... 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
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(ILCore ImmunizationReactionObservation Profile) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... 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
.... series 0..1 string Name of vaccine series
.... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: Target Disease Codes (preferred)
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonextensibleReasonNotDone
http://fhir.health.gov.il/ValueSet/reason-not-done
from this IG
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
Immunization.vaccineCode.coding:vaccinerequiredVaccineCode
http://fhir.health.gov.il/ValueSet/vaccine-code
from this IG
Immunization.vaccineCode.coding:productrequiredVaccineProductCode
http://fhir.health.gov.il/ValueSet/vaccine-product-code
from this IG
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard
Immunization.siteextensibleImmunizationBodySite
http://fhir.health.gov.il/ValueSet/immunization-body-site
from this IG
Immunization.routeextensibleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
from the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard
Immunization.protocolApplied.targetDiseasepreferredTargetDisease
http://fhir.health.gov.il/ValueSet/target-disease
from this IG

Constraints

IdGradePath(s)DetailsRequirements
il-immunization-lot-numbererrorImmunizationImmunization.lotNumber SHALL have a value if Immunization.primarySource is TRUE.
: primarySource=true implies lotNumber.exists()

This structure is derived from Immunization

 

Other representations of profile: CSV, Excel, Schematron