Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions

Extension: ExtensionPlanDefinition_Endorser - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R4B-PlanDefinition.endorser extension.

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

0. Extension
Definition

R4B: PlanDefinition.endorser additional types (ContactDetail) additional types from child elements (name, telecom)


Optional Extension Element - found in all resources.

ShortR4B: Who endorsed the content additional typesOptional Extensions Element
Comments

Element PlanDefinition.endorser is mapped to FHIR STU3 element PlanDefinition.contributor as SourceIsBroaderThanTarget. The mappings for PlanDefinition.endorser do not cover the following types: ContactDetail. The mappings for PlanDefinition.endorser do not cover the following types based on type expansion: name, telecom.

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional 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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Extension.extension:_datatype
    Slice Name_datatype
    Definition

    Slice to indicate the presence of a R4B ContactDetail in FHIR STU3

    ShortDataType slice for a FHIR R4B `ContactDetail` valueAdditional Content defined by implementations
    Control10..1*
    TypeExtension
    6. Extension.extension:_datatype.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/_datatype
    8. Extension.extension:_datatype.value[x]
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Comments

    Must be: ContactDetail

    Control10..1
    Typestring, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Fixed ValueContactDetail
    10. Extension.extension:name
    Slice Namename
    Definition

    R4B: ContactDetail.name

    ShortR4B: nameAdditional Content defined by implementations
    Comments

    Element ContactDetail.name is mapped to FHIR STU3 element ContactDetail.name as Equivalent. If there is no named individual, the telecom information is for the organization as a whole.

    Control0..1*
    TypeExtension
    Requirements

    Element ContactDetail.name is mapped to FHIR STU3 element ContactDetail.name as Equivalent.

    12. Extension.extension:name.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuename
    14. Extension.extension:name.value[x]
    Definition

    The name of an individual to contact.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortName of an individual to contactValue of extension
    Comments

    If there is no named individual, the telecom information is for the organization as a whole.

    Control0..1
    Typestring, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. Extension.extension:telecom
    Slice Nametelecom
    Definition

    R4B: ContactDetail.telecom additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)

    ShortR4B: telecom additional typesAdditional Content defined by implementations
    Comments

    Element ContactDetail.telecom is mapped to FHIR STU3 element ContactDetail.telecom as SourceIsBroaderThanTarget. The mappings for ContactDetail.telecom do not cover the following types: ContactPoint. The mappings for ContactDetail.telecom do not cover the following types based on type expansion: period, rank, system, use, value.

    Control0..*
    TypeExtension
    Requirements

    Element ContactDetail.telecom is mapped to FHIR STU3 element ContactDetail.telecom as SourceIsBroaderThanTarget. The mappings for ContactDetail.telecom do not cover the following types: ContactPoint. The mappings for ContactDetail.telecom do not cover the following types based on type expansion: period, rank, system, use, value.

    18. Extension.extension:telecom.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuetelecom
    20. Extension.extension:telecom.value[x]
    Definition

    The contact details for the individual (if a name was provided) or the organization.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortContact details for individual or organizationValue of extension
    Control0..1
    TypeContactPoint, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    22. Extension.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-PlanDefinition.endorser
    24. Extension.value[x]
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
    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 foundhere

    0. Extension
    Definition

    R4B: PlanDefinition.endorser additional types (ContactDetail) additional types from child elements (name, telecom)

    ShortR4B: Who endorsed the content additional types
    Comments

    Element PlanDefinition.endorser is mapped to FHIR STU3 element PlanDefinition.contributor as SourceIsBroaderThanTarget. The mappings for PlanDefinition.endorser do not cover the following types: ContactDetail. The mappings for PlanDefinition.endorser do not cover the following types based on type expansion: name, telecom.

    Control0..*
    Is Modifierfalse
    2. Extension.extension
    Control0..*
    SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Extension.extension:_datatype
      Slice Name_datatype
      Definition

      Slice to indicate the presence of a R4B ContactDetail in FHIR STU3

      ShortDataType slice for a FHIR R4B `ContactDetail` value
      Control1..1
      6. Extension.extension:_datatype.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/StructureDefinition/_datatype
      8. Extension.extension:_datatype.value[x]
      Comments

      Must be: ContactDetail

      Control1..1
      Typestring
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Fixed ValueContactDetail
      10. Extension.extension:name
      Slice Namename
      Definition

      R4B: ContactDetail.name

      ShortR4B: name
      Comments

      Element ContactDetail.name is mapped to FHIR STU3 element ContactDetail.name as Equivalent. If there is no named individual, the telecom information is for the organization as a whole.

      Control0..1
      Requirements

      Element ContactDetail.name is mapped to FHIR STU3 element ContactDetail.name as Equivalent.

      12. Extension.extension:name.url
      Control1..1
      Fixed Valuename
      14. Extension.extension:name.value[x]
      Definition

      The name of an individual to contact.

      ShortName of an individual to contact
      Comments

      If there is no named individual, the telecom information is for the organization as a whole.

      Control0..1
      Typestring
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. Extension.extension:telecom
      Slice Nametelecom
      Definition

      R4B: ContactDetail.telecom additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)

      ShortR4B: telecom additional types
      Comments

      Element ContactDetail.telecom is mapped to FHIR STU3 element ContactDetail.telecom as SourceIsBroaderThanTarget. The mappings for ContactDetail.telecom do not cover the following types: ContactPoint. The mappings for ContactDetail.telecom do not cover the following types based on type expansion: period, rank, system, use, value.

      Control0..*
      Requirements

      Element ContactDetail.telecom is mapped to FHIR STU3 element ContactDetail.telecom as SourceIsBroaderThanTarget. The mappings for ContactDetail.telecom do not cover the following types: ContactPoint. The mappings for ContactDetail.telecom do not cover the following types based on type expansion: period, rank, system, use, value.

      18. Extension.extension:telecom.url
      Control1..1
      Fixed Valuetelecom
      20. Extension.extension:telecom.value[x]
      Definition

      The contact details for the individual (if a name was provided) or the organization.

      ShortContact details for individual or organization
      Control0..1
      TypeContactPoint
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      22. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-PlanDefinition.endorser
      24. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R4B: PlanDefinition.endorser additional types (ContactDetail) additional types from child elements (name, telecom)

      ShortR4B: Who endorsed the content additional types
      Comments

      Element PlanDefinition.endorser is mapped to FHIR STU3 element PlanDefinition.contributor as SourceIsBroaderThanTarget. The mappings for PlanDefinition.endorser do not cover the following types: ContactDetail. The mappings for PlanDefinition.endorser do not cover the following types based on type expansion: name, telecom.

      Control0..*
      This element is affected by the following invariants: ele-1
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      2. Extension.id
      Definition

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

      Shortxml:id (or equivalent in JSON)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      4. Extension.extension
      Definition

      An Extension

      ShortExtension
      Control0..*
      TypeExtension
      SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. Extension.extension:_datatype
        Slice Name_datatype
        Definition

        Slice to indicate the presence of a R4B ContactDetail in FHIR STU3

        ShortDataType slice for a FHIR R4B `ContactDetail` value
        Control1..1
        TypeExtension
        8. Extension.extension:_datatype.id
        Definition

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

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        10. Extension.extension:_datatype.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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
        Alternate Namesextensions, user content
        SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Extension.extension:_datatype.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

          Control1..1
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed Valuehttp://hl7.org/fhir/StructureDefinition/_datatype
          14. Extension.extension:_datatype.value[x]
          Definition

          Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

          ShortValue of extension
          Comments

          Must be: ContactDetail

          Control1..1
          Typestring
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Fixed ValueContactDetail
          16. Extension.extension:name
          Slice Namename
          Definition

          R4B: ContactDetail.name

          ShortR4B: name
          Comments

          Element ContactDetail.name is mapped to FHIR STU3 element ContactDetail.name as Equivalent. If there is no named individual, the telecom information is for the organization as a whole.

          Control0..1
          TypeExtension
          Requirements

          Element ContactDetail.name is mapped to FHIR STU3 element ContactDetail.name as Equivalent.

          18. Extension.extension:name.id
          Definition

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

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          20. Extension.extension:name.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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
          Alternate Namesextensions, user content
          SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. Extension.extension:name.url
            Definition

            Source of the definition for the extension code - a logical name or a URL.

            Shortidentifies the meaning of the extension
            Comments

            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

            Control1..1
            Typeuri
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed Valuename
            24. Extension.extension:name.value[x]
            Definition

            The name of an individual to contact.

            ShortName of an individual to contact
            Comments

            If there is no named individual, the telecom information is for the organization as a whole.

            Control0..1
            Typestring
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            26. Extension.extension:telecom
            Slice Nametelecom
            Definition

            R4B: ContactDetail.telecom additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)

            ShortR4B: telecom additional types
            Comments

            Element ContactDetail.telecom is mapped to FHIR STU3 element ContactDetail.telecom as SourceIsBroaderThanTarget. The mappings for ContactDetail.telecom do not cover the following types: ContactPoint. The mappings for ContactDetail.telecom do not cover the following types based on type expansion: period, rank, system, use, value.

            Control0..*
            TypeExtension
            Requirements

            Element ContactDetail.telecom is mapped to FHIR STU3 element ContactDetail.telecom as SourceIsBroaderThanTarget. The mappings for ContactDetail.telecom do not cover the following types: ContactPoint. The mappings for ContactDetail.telecom do not cover the following types based on type expansion: period, rank, system, use, value.

            28. Extension.extension:telecom.id
            Definition

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

            Shortxml:id (or equivalent in JSON)
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            30. Extension.extension:telecom.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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
            Alternate Namesextensions, user content
            SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 32. Extension.extension:telecom.url
              Definition

              Source of the definition for the extension code - a logical name or a URL.

              Shortidentifies the meaning of the extension
              Comments

              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

              Control1..1
              Typeuri
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed Valuetelecom
              34. Extension.extension:telecom.value[x]
              Definition

              The contact details for the individual (if a name was provided) or the organization.

              ShortContact details for individual or organization
              Control0..1
              TypeContactPoint
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              36. Extension.url
              Definition

              Source of the definition for the extension code - a logical name or a URL.

              Shortidentifies the meaning of the extension
              Comments

              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

              Control1..1
              Typeuri
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-PlanDefinition.endorser
              38. Extension.value[x]
              Definition

              Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

              ShortValue of extension
              Control0..0
              TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension