International Patient Summary Implementation Guide
2.0.0 - STU 2 International flag

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/costateixeira/fhir-ips/ and changes regularly. See the Directory of published versions

Logical Model: HealthcareProvider - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the HealthcareProvider logical model.

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

0. HealthcareProvider
Definition

Preferred Healthcare Provider

ShortHealthcare Provider
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HealthcareProvider.healthcareProviderPerson
Definition

Healthcare Provider Person

ShortHealthcare Provider Person
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. HealthcareProvider.healthcareProviderPerson.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. HealthcareProvider.healthcareProviderPerson.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 HealthcareProvider.healthcareProviderPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. HealthcareProvider.healthcareProviderPerson.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. HealthcareProvider.healthcareProviderPerson.name
    Definition

    Name

    ShortName
    Comments

    Required (Exceptions allowed)

    Control0..*
    Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/PersonName
    12. HealthcareProvider.healthcareProviderPerson.role
    Definition

    Role

    ShortRole
    Comments

    Optional

    Control0..*
    TypeCodeableConcept
    14. HealthcareProvider.healthcareProviderPerson.telecoms
    Definition

    Telecom

    ShortTelecom
    Comments

    Required if known

    Control0..*
    Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/Telecom
    16. HealthcareProvider.healthcareProviderOrganization
    Definition

    Healthcare Provider Organization

    ShortHealthcare Provider Organization
    Control0..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. HealthcareProvider.healthcareProviderOrganization.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
    20. HealthcareProvider.healthcareProviderOrganization.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 HealthcareProvider.healthcareProviderOrganization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 22. HealthcareProvider.healthcareProviderOrganization.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())
      24. HealthcareProvider.healthcareProviderOrganization.name
      Definition

      Name

      ShortName
      Comments

      Required (Exceptions allowed)

      Control0..*
      Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/PersonName
      26. HealthcareProvider.healthcareProviderOrganization.telecoms
      Definition

      Telecom

      ShortTelecom
      Comments

      Required if known

      Control0..*
      Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/Telecom

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

      0. HealthcareProvider
      Definition

      Preferred Healthcare Provider

      ShortHealthcare Provider
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      2. HealthcareProvider.healthcareProviderPerson
      Definition

      Healthcare Provider Person

      ShortHealthcare Provider Person
      Control0..*
      TypeBackboneElement
      4. HealthcareProvider.healthcareProviderPerson.name
      Definition

      Name

      ShortName
      Comments

      Required (Exceptions allowed)

      Control0..*
      Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/PersonName
      6. HealthcareProvider.healthcareProviderPerson.role
      Definition

      Role

      ShortRole
      Comments

      Optional

      Control0..*
      TypeCodeableConcept
      8. HealthcareProvider.healthcareProviderPerson.telecoms
      Definition

      Telecom

      ShortTelecom
      Comments

      Required if known

      Control0..*
      Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/Telecom
      10. HealthcareProvider.healthcareProviderOrganization
      Definition

      Healthcare Provider Organization

      ShortHealthcare Provider Organization
      Control0..*
      TypeBackboneElement
      12. HealthcareProvider.healthcareProviderOrganization.name
      Definition

      Name

      ShortName
      Comments

      Required (Exceptions allowed)

      Control0..*
      Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/PersonName
      14. HealthcareProvider.healthcareProviderOrganization.telecoms
      Definition

      Telecom

      ShortTelecom
      Comments

      Required if known

      Control0..*
      Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/Telecom

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

      0. HealthcareProvider
      Definition

      Preferred Healthcare Provider

      ShortHealthcare Provider
      Control0..*
      Is Modifierfalse
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      2. HealthcareProvider.healthcareProviderPerson
      Definition

      Healthcare Provider Person

      ShortHealthcare Provider Person
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      4. HealthcareProvider.healthcareProviderPerson.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. HealthcareProvider.healthcareProviderPerson.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 HealthcareProvider.healthcareProviderPerson.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 8. HealthcareProvider.healthcareProviderPerson.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. HealthcareProvider.healthcareProviderPerson.name
        Definition

        Name

        ShortName
        Comments

        Required (Exceptions allowed)

        Control0..*
        Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/PersonName
        12. HealthcareProvider.healthcareProviderPerson.role
        Definition

        Role

        ShortRole
        Comments

        Optional

        Control0..*
        TypeCodeableConcept
        14. HealthcareProvider.healthcareProviderPerson.telecoms
        Definition

        Telecom

        ShortTelecom
        Comments

        Required if known

        Control0..*
        Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/Telecom
        16. HealthcareProvider.healthcareProviderOrganization
        Definition

        Healthcare Provider Organization

        ShortHealthcare Provider Organization
        Control0..*
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        18. HealthcareProvider.healthcareProviderOrganization.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
        20. HealthcareProvider.healthcareProviderOrganization.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 HealthcareProvider.healthcareProviderOrganization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 22. HealthcareProvider.healthcareProviderOrganization.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())
          24. HealthcareProvider.healthcareProviderOrganization.name
          Definition

          Name

          ShortName
          Comments

          Required (Exceptions allowed)

          Control0..*
          Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/PersonName
          26. HealthcareProvider.healthcareProviderOrganization.telecoms
          Definition

          Telecom

          ShortTelecom
          Comments

          Required if known

          Control0..*
          Typehttp://hl7.org/fhir/uv/ips/StructureDefinition/Telecom