HL7 Europe Base Profiles
0.0.1-ci - ci-build 150

HL7 Europe Base Profiles, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base/ and changes regularly. See the Directory of published versions

Logical Model: EHIC - Detailed Descriptions

Draft as of 2024-12-18

Definitions for the EHIC logical model.

Guidance on how to interpret the contents of this table can be found here

0. EHIC
Definition

A free card that gives access to medically necessary, state-provided healthcare during a temporary stay in any of the 27 EU countries, Iceland, Liechtenstein, Norway and Switzerland under the same conditions and at the same cost (free in some countries) as people insured in that country. The benefits covered include, for example, benefits provided in conjunction with chronic or existing illnesses as well as in conjunction with pregnancy and childbirth. Cards are issued by your national health insurance provider. Important – the European Health Insurance Card:

  • is not an alternative to travel insurance. It does not cover any private healthcare or costs such as a return flight to your home country or lost/stolen property,
  • does not cover your costs if you are travelling for the express purpose of obtaining medical treatment,
  • does not guarantee free services. As each country’s healthcare system is different services that cost nothing at home might not be free in another country.
ShortEuropean Health Insurance Card
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHIC.EHIC
Definition

European Health Insurance Card

ShortEuropean Health Insurance Card
Control1..1
TypeBackboneElement
4. EHIC.EHIC.country
Definition

Code of the Member State issuing the card

ShortCountry Code
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. EHIC.EHIC.name
Definition

Forename of the card holder

Short3 - Name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. EHIC.EHIC.givenName
Definition

Surname of the card holder

Short4 - Given names
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EHIC.EHIC.birthDate
Definition

Date of birth of the card holder

Short5 - Date of birth
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. EHIC.EHIC.personalId
Definition

Personal identification number of the card holder or, when no such number exists, the number of the insured person from whom the rights of the card holder derive,

Short6 - Personal identification number
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. EHIC.EHIC.istitutionId
Definition

Identification number and acronym of the competent institution

Short7 - Identification number of the institution
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. EHIC.EHIC.cardNumber
Definition

Logical number of the card.

Short8 - Identification number of the card
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. EHIC.EHIC.expiryDate
Definition

Expiry date of the card

Short9 - expiry date
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. EHIC
Definition

A free card that gives access to medically necessary, state-provided healthcare during a temporary stay in any of the 27 EU countries, Iceland, Liechtenstein, Norway and Switzerland under the same conditions and at the same cost (free in some countries) as people insured in that country. The benefits covered include, for example, benefits provided in conjunction with chronic or existing illnesses as well as in conjunction with pregnancy and childbirth. Cards are issued by your national health insurance provider. Important – the European Health Insurance Card:

  • is not an alternative to travel insurance. It does not cover any private healthcare or costs such as a return flight to your home country or lost/stolen property,
  • does not cover your costs if you are travelling for the express purpose of obtaining medical treatment,
  • does not guarantee free services. As each country’s healthcare system is different services that cost nothing at home might not be free in another country.

Base definition for all types defined in FHIR type system.

ShortEuropean Health Insurance CardBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHIC.EHIC
Definition

European Health Insurance Card

ShortEuropean Health Insurance Card
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. EHIC.EHIC.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeidstring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
6. EHIC.EHIC.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on EHIC.EHIC.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. EHIC.EHIC.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. EHIC.EHIC.country
    Definition

    Code of the Member State issuing the card

    ShortCountry Code
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. EHIC.EHIC.name
    Definition

    Forename of the card holder

    Short3 - Name
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. EHIC.EHIC.givenName
    Definition

    Surname of the card holder

    Short4 - Given names
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. EHIC.EHIC.birthDate
    Definition

    Date of birth of the card holder

    Short5 - Date of birth
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. EHIC.EHIC.personalId
    Definition

    Personal identification number of the card holder or, when no such number exists, the number of the insured person from whom the rights of the card holder derive,

    Short6 - Personal identification number
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. EHIC.EHIC.istitutionId
    Definition

    Identification number and acronym of the competent institution

    Short7 - Identification number of the institution
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    22. EHIC.EHIC.cardNumber
    Definition

    Logical number of the card.

    Short8 - Identification number of the card
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    24. EHIC.EHIC.expiryDate
    Definition

    Expiry date of the card

    Short9 - expiry date
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

    Guidance on how to interpret the contents of this table can be found here

    0. EHIC
    Definition

    A free card that gives access to medically necessary, state-provided healthcare during a temporary stay in any of the 27 EU countries, Iceland, Liechtenstein, Norway and Switzerland under the same conditions and at the same cost (free in some countries) as people insured in that country. The benefits covered include, for example, benefits provided in conjunction with chronic or existing illnesses as well as in conjunction with pregnancy and childbirth. Cards are issued by your national health insurance provider. Important – the European Health Insurance Card:

    • is not an alternative to travel insurance. It does not cover any private healthcare or costs such as a return flight to your home country or lost/stolen property,
    • does not cover your costs if you are travelling for the express purpose of obtaining medical treatment,
    • does not guarantee free services. As each country’s healthcare system is different services that cost nothing at home might not be free in another country.
    ShortEuropean Health Insurance Card
    Control0..*
    Is Modifierfalse
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. EHIC.EHIC
    Definition

    European Health Insurance Card

    ShortEuropean Health Insurance Card
    Control1..1
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. EHIC.EHIC.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typeid
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    6. EHIC.EHIC.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on EHIC.EHIC.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 8. EHIC.EHIC.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      10. EHIC.EHIC.country
      Definition

      Code of the Member State issuing the card

      ShortCountry Code
      Control1..1
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      12. EHIC.EHIC.name
      Definition

      Forename of the card holder

      Short3 - Name
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      14. EHIC.EHIC.givenName
      Definition

      Surname of the card holder

      Short4 - Given names
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. EHIC.EHIC.birthDate
      Definition

      Date of birth of the card holder

      Short5 - Date of birth
      Control1..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      18. EHIC.EHIC.personalId
      Definition

      Personal identification number of the card holder or, when no such number exists, the number of the insured person from whom the rights of the card holder derive,

      Short6 - Personal identification number
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      20. EHIC.EHIC.istitutionId
      Definition

      Identification number and acronym of the competent institution

      Short7 - Identification number of the institution
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      22. EHIC.EHIC.cardNumber
      Definition

      Logical number of the card.

      Short8 - Identification number of the card
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      24. EHIC.EHIC.expiryDate
      Definition

      Expiry date of the card

      Short9 - expiry date
      Control1..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension