MyHealth@Eu Medical Imaging Report
0.0.1 - ci-build 150

MyHealth@Eu Medical Imaging Report - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: SubjectMyH - Detailed Descriptions

Draft as of 2025-06-25

Definitions for the Subject logical model.

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

0. Subject
Definition

Medical Imaging Report - Subject data element

ShortA.1.1 - Identification and A.1.2 - related contact information of the Patient/subject (eHN)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Subject.identification
Definition

Identification of the patient/subject

ShortA.1.1 - Identification of the patient/subject
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Subject.identification.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
6. Subject.identification.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 manageable, 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 Subject.identification.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. Subject.identification.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 manageable, 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. Subject.identification.familyName
    Definition

    The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present.

    ShortA.1.1.1 - Family name/surname
    Control1..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. Subject.identification.givenName
    Definition

    The given name/first name of the patient (also known as forename or first name). This field can contain more than one element.

    ShortA.1.1.2 - Given name
    Control1..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. Subject.identification.dateOfBirth
    Definition

    The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601

    ShortA.1.1.3 - Date of birth
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. Subject.identification.identifier
    Definition

    An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for Czech patient. Multiple identifiers could be provided.

    ShortA.1.1.4 - Personal identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    18. Subject.identification.gender
    Definition

    This field must contain a recognised valid value for 'administrative gender'. If different, 'physiological gender' should be communicated elsewhere Preferred system(s): - Preferred system(s): HL7 Administrative Gender

    ShortA.1.1.5 - Gender
    Control0..1
    TypeCodeableConcept
    20. Subject.addressTelecom
    Definition

    Patient/subject related contact information

    ShortA.1.2 - Patient/subject related contact information
    Control0..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Subject.addressTelecom.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
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    24. Subject.addressTelecom.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 manageable, 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 Subject.addressTelecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 26. Subject.addressTelecom.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 manageable, 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())
      28. Subject.addressTelecom.address
      Definition

      Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. - Preferred system(s): ISO 3166

      ShortA.1.2.1 - Address
      Control0..*
      TypeAddress
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. Subject.addressTelecom.address.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
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      32. Subject.addressTelecom.address.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 manageable, 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 Subject.addressTelecom.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 34. Subject.addressTelecom.address.use
        Definition

        The purpose of this address.

        Shorthome | work | temp | old | billing - purpose of this address
        Comments

        Applications can assume that an address is current unless it explicitly says that it is temporary or old.

        Control0..1
        BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
        (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

        The use of an address.

        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Allows an appropriate address to be chosen from a list of many.

        Example<br/><b>General</b>:home
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Subject.addressTelecom.address.type
        Definition

        Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

        Shortpostal | physical | both
        Comments

        The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).


        The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

        Control0..1
        BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1
        (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

        The type of an address (physical / postal).

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Example<br/><b>General</b>:both
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. Subject.addressTelecom.address.text
        Definition

        Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

        ShortText representation of the address
        Comments

        Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        A renderable, unencoded form.

        Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. Subject.addressTelecom.address.line
        Definition

        This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

        ShortStreet name, number, direction & P.O. Box etc.
        Control0..*
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Example<br/><b>General</b>:137 Nowhere Street
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. Subject.addressTelecom.address.city
        Definition

        The city where the patient has his/her domicile. Example: London


        The name of the city, town, suburb, village or other community or delivery center.

        ShortCityName of city, town etc.
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate NamesMunicpality
        Example<br/><b>General</b>:Erewhon
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. Subject.addressTelecom.address.district
        Definition

        The name of the administrative area (county).

        ShortDistrict name (aka county)
        Comments

        District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate NamesCounty
        Example<br/><b>General</b>:Madison
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. Subject.addressTelecom.address.state
        Definition

        Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

        ShortSub-unit of country (abbreviations ok)
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate NamesProvince, Territory
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        48. Subject.addressTelecom.address.postalCode
        Definition

        The postal code where the patient has his/her domicile. Example: W1W 8LG


        A postal code designating a region defined by the postal service.

        ShortPostal CodePostal code for area
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Alternate NamesZip
        Example<br/><b>General</b>:9132
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        50. Subject.addressTelecom.address.country
        Definition

        Country - a nation as commonly understood or generally accepted.

        ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
        Comments

        ISO 3166 3 letter codes can be used in place of a human readable country name.

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. Subject.addressTelecom.address.period
        Definition

        Time period when address was/is in use.

        ShortTime period when address was/is in use
        Control0..1
        TypePeriod
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows addresses to be placed in historical context.

        Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. Subject.addressTelecom.address.street
        Definition

        The street where the patient has his/her domicile. Example: Oxford

        ShortStreet
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        56. Subject.addressTelecom.address.NumberofStreet
        Definition

        The number of the street where the patient has his/her domicile.

        Example: 221

        ShortNumber of Street
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        58. Subject.addressTelecom.address.stateOrProvince
        Definition

        The state or province where the patient has his/her domicile. Example: London

        ShortState or Province
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        60. Subject.addressTelecom.address.countryCode
        Definition

        The country where the patient has his/her domicile (Country of affiliation). Example: UK

        ShortCountry Code
        Control1..1
        TypeCodeableConcept
        62. Subject.addressTelecom.telecom
        Definition

        Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. - Preferred system(s):

        ShortA.1.2.2 - Telecom
        Control0..*
        TypeContactPoint

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

        0. Subject
        Definition

        Medical Imaging Report - Subject data element

        ShortA.1.1 - Identification and A.1.2 - related contact information of the Patient/subject (eHN)
        Logical ModelInstances of this logical model are not marked to be the target of a Reference
        2. Subject.identification
        Definition

        Identification of the patient/subject

        ShortA.1.1 - Identification of the patient/subject
        Control1..1
        TypeBackboneElement
        4. Subject.identification.familyName
        Definition

        The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present.

        ShortA.1.1.1 - Family name/surname
        Control1..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        6. Subject.identification.givenName
        Definition

        The given name/first name of the patient (also known as forename or first name). This field can contain more than one element.

        ShortA.1.1.2 - Given name
        Control1..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        8. Subject.identification.dateOfBirth
        Definition

        The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601

        ShortA.1.1.3 - Date of birth
        Control1..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        10. Subject.identification.identifier
        Definition

        An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for Czech patient. Multiple identifiers could be provided.

        ShortA.1.1.4 - Personal identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        12. Subject.identification.gender
        Definition

        This field must contain a recognised valid value for 'administrative gender'. If different, 'physiological gender' should be communicated elsewhere Preferred system(s): - Preferred system(s): HL7 Administrative Gender

        ShortA.1.1.5 - Gender
        Control0..1
        TypeCodeableConcept
        14. Subject.addressTelecom
        Definition

        Patient/subject related contact information

        ShortA.1.2 - Patient/subject related contact information
        Control0..*
        TypeBackboneElement
        16. Subject.addressTelecom.address
        Definition

        Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. - Preferred system(s): ISO 3166

        ShortA.1.2.1 - Address
        Control0..*
        TypeAddress
        18. Subject.addressTelecom.address.street
        Definition

        The street where the patient has his/her domicile. Example: Oxford

        ShortStreet
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        20. Subject.addressTelecom.address.NumberofStreet
        Definition

        The number of the street where the patient has his/her domicile.

        Example: 221

        ShortNumber of Street
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        22. Subject.addressTelecom.address.postalCode
        Definition

        The postal code where the patient has his/her domicile. Example: W1W 8LG

        ShortPostal Code
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        24. Subject.addressTelecom.address.stateOrProvince
        Definition

        The state or province where the patient has his/her domicile. Example: London

        ShortState or Province
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        26. Subject.addressTelecom.address.city
        Definition

        The city where the patient has his/her domicile. Example: London

        ShortCity
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        28. Subject.addressTelecom.address.countryCode
        Definition

        The country where the patient has his/her domicile (Country of affiliation). Example: UK

        ShortCountry Code
        Control1..1
        TypeCodeableConcept
        30. Subject.addressTelecom.telecom
        Definition

        Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. - Preferred system(s):

        ShortA.1.2.2 - Telecom
        Control0..*
        TypeContactPoint

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

        0. Subject
        Definition

        Medical Imaging Report - Subject data element

        ShortA.1.1 - Identification and A.1.2 - related contact information of the Patient/subject (eHN)
        Control0..*
        Is Modifierfalse
        Logical ModelInstances of this logical model are not marked to be the target of a Reference
        2. Subject.identification
        Definition

        Identification of the patient/subject

        ShortA.1.1 - Identification of the patient/subject
        Control1..1
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        4. Subject.identification.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
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        6. Subject.identification.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 manageable, 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 Subject.identification.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 8. Subject.identification.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 manageable, 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. Subject.identification.familyName
          Definition

          The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present.

          ShortA.1.1.1 - Family name/surname
          Control1..*
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          12. Subject.identification.givenName
          Definition

          The given name/first name of the patient (also known as forename or first name). This field can contain more than one element.

          ShortA.1.1.2 - Given name
          Control1..*
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          14. Subject.identification.dateOfBirth
          Definition

          The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601

          ShortA.1.1.3 - Date of birth
          Control1..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          16. Subject.identification.identifier
          Definition

          An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for Czech patient. Multiple identifiers could be provided.

          ShortA.1.1.4 - Personal identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          18. Subject.identification.gender
          Definition

          This field must contain a recognised valid value for 'administrative gender'. If different, 'physiological gender' should be communicated elsewhere Preferred system(s): - Preferred system(s): HL7 Administrative Gender

          ShortA.1.1.5 - Gender
          Control0..1
          TypeCodeableConcept
          20. Subject.addressTelecom
          Definition

          Patient/subject related contact information

          ShortA.1.2 - Patient/subject related contact information
          Control0..*
          TypeBackboneElement
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          22. Subject.addressTelecom.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
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          24. Subject.addressTelecom.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 manageable, 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 Subject.addressTelecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 26. Subject.addressTelecom.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 manageable, 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())
            28. Subject.addressTelecom.address
            Definition

            Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. - Preferred system(s): ISO 3166

            ShortA.1.2.1 - Address
            Control0..*
            TypeAddress
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            30. Subject.addressTelecom.address.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
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            32. Subject.addressTelecom.address.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 manageable, 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 Subject.addressTelecom.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 34. Subject.addressTelecom.address.use
              Definition

              The purpose of this address.

              Shorthome | work | temp | old | billing - purpose of this address
              Comments

              Applications can assume that an address is current unless it explicitly says that it is temporary or old.

              Control0..1
              BindingThe codes SHALL be taken from AddressUse
              (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

              The use of an address.

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Allows an appropriate address to be chosen from a list of many.

              Example<br/><b>General</b>:home
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              36. Subject.addressTelecom.address.type
              Definition

              Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

              Shortpostal | physical | both
              Comments

              The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

              Control0..1
              BindingThe codes SHALL be taken from AddressType
              (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

              The type of an address (physical / postal).

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Example<br/><b>General</b>:both
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              38. Subject.addressTelecom.address.text
              Definition

              Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

              ShortText representation of the address
              Comments

              Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              A renderable, unencoded form.

              Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              40. Subject.addressTelecom.address.line
              Definition

              This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

              ShortStreet name, number, direction & P.O. Box etc.
              Control0..*
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Example<br/><b>General</b>:137 Nowhere Street
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              42. Subject.addressTelecom.address.city
              Definition

              The city where the patient has his/her domicile. Example: London

              ShortCity
              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesMunicpality
              Example<br/><b>General</b>:Erewhon
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              44. Subject.addressTelecom.address.district
              Definition

              The name of the administrative area (county).

              ShortDistrict name (aka county)
              Comments

              District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesCounty
              Example<br/><b>General</b>:Madison
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              46. Subject.addressTelecom.address.state
              Definition

              Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

              ShortSub-unit of country (abbreviations ok)
              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesProvince, Territory
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              48. Subject.addressTelecom.address.postalCode
              Definition

              The postal code where the patient has his/her domicile. Example: W1W 8LG

              ShortPostal Code
              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesZip
              Example<br/><b>General</b>:9132
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              50. Subject.addressTelecom.address.country
              Definition

              Country - a nation as commonly understood or generally accepted.

              ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
              Comments

              ISO 3166 3 letter codes can be used in place of a human readable country name.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              52. Subject.addressTelecom.address.period
              Definition

              Time period when address was/is in use.

              ShortTime period when address was/is in use
              Control0..1
              TypePeriod
              Is Modifierfalse
              Summarytrue
              Requirements

              Allows addresses to be placed in historical context.

              Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              54. Subject.addressTelecom.address.street
              Definition

              The street where the patient has his/her domicile. Example: Oxford

              ShortStreet
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              56. Subject.addressTelecom.address.NumberofStreet
              Definition

              The number of the street where the patient has his/her domicile.

              Example: 221

              ShortNumber of Street
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              58. Subject.addressTelecom.address.stateOrProvince
              Definition

              The state or province where the patient has his/her domicile. Example: London

              ShortState or Province
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              60. Subject.addressTelecom.address.countryCode
              Definition

              The country where the patient has his/her domicile (Country of affiliation). Example: UK

              ShortCountry Code
              Control1..1
              TypeCodeableConcept
              62. Subject.addressTelecom.telecom
              Definition

              Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. - Preferred system(s):

              ShortA.1.2.2 - Telecom
              Control0..*
              TypeContactPoint