Terminology Syndication Feed Implementation Guide
0.1.0 - ci-build International flag

Terminology Syndication Feed Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: SyndicationFeedMetadata - Detailed Descriptions

Draft as of 2026-05-09

Definitions for the syndication-feed-metadata logical model.

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

0. syndication-feed-metadata
Definition

A reduced description of a feed, used inside an entry's ⟨source⟩ element (Atom RFC 4287 §4.2.11).

When an entry is copied, mirrored, or aggregated from one feed into another, the receiving feed SHOULD preserve the originating feed's identity by including a ⟨source⟩ element on the entry. The ⟨source⟩ element carries enough metadata to recover the originating feed even if the entry is later detached from any feed document.

A consumer that re-encounters the same entry ⟨id⟩ in two different feeds can use ⟨source⟩ to disambiguate origin.

ShortTerminology Syndication Feed Metadata
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. syndication-feed-metadata.id
Definition

Atom ⟨id⟩ of the source feed. Conventionally urn:uuid:{uuid}. Same value as the originating feed's ⟨id⟩.

Shortsource feed permanent identifier
Control0..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. syndication-feed-metadata.title
Definition

Atom ⟨title⟩ of the source feed.

Shortsource feed human-readable name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. syndication-feed-metadata.link
Definition

Atom ⟨link⟩ elements from the source feed — typically the source feed's rel="self" link.

Shortsource feed link (typically rel=self)
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. syndication-feed-metadata.link.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
10. syndication-feed-metadata.link.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 syndication-feed-metadata.link.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 12. syndication-feed-metadata.link.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())
    14. syndication-feed-metadata.link.rel
    Definition

    link relation

    Shortlink relation
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. syndication-feed-metadata.link.type
    Definition

    media type

    Shortmedia type
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. syndication-feed-metadata.link.href
    Definition

    target URI

    Shorttarget URI
    Control1..1
    Typeuri
    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. syndication-feed-metadata
    Definition

    A reduced description of a feed, used inside an entry's ⟨source⟩ element (Atom RFC 4287 §4.2.11).

    When an entry is copied, mirrored, or aggregated from one feed into another, the receiving feed SHOULD preserve the originating feed's identity by including a ⟨source⟩ element on the entry. The ⟨source⟩ element carries enough metadata to recover the originating feed even if the entry is later detached from any feed document.

    A consumer that re-encounters the same entry ⟨id⟩ in two different feeds can use ⟨source⟩ to disambiguate origin.

    ShortTerminology Syndication Feed Metadata
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. syndication-feed-metadata.id
    Definition

    Atom ⟨id⟩ of the source feed. Conventionally urn:uuid:{uuid}. Same value as the originating feed's ⟨id⟩.

    Shortsource feed permanent identifier
    Control0..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    4. syndication-feed-metadata.title
    Definition

    Atom ⟨title⟩ of the source feed.

    Shortsource feed human-readable name
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    6. syndication-feed-metadata.link
    Definition

    Atom ⟨link⟩ elements from the source feed — typically the source feed's rel="self" link.

    Shortsource feed link (typically rel=self)
    Control0..*
    TypeBackboneElement
    8. syndication-feed-metadata.link.rel
    Definition

    link relation

    Shortlink relation
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. syndication-feed-metadata.link.type
    Definition

    media type

    Shortmedia type
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. syndication-feed-metadata.link.href
    Definition

    target URI

    Shorttarget URI
    Control1..1
    Typeuri
    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. syndication-feed-metadata
    Definition

    A reduced description of a feed, used inside an entry's ⟨source⟩ element (Atom RFC 4287 §4.2.11).

    When an entry is copied, mirrored, or aggregated from one feed into another, the receiving feed SHOULD preserve the originating feed's identity by including a ⟨source⟩ element on the entry. The ⟨source⟩ element carries enough metadata to recover the originating feed even if the entry is later detached from any feed document.

    A consumer that re-encounters the same entry ⟨id⟩ in two different feeds can use ⟨source⟩ to disambiguate origin.

    ShortTerminology Syndication Feed Metadata
    Control0..*
    Is Modifierfalse
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. syndication-feed-metadata.id
    Definition

    Atom ⟨id⟩ of the source feed. Conventionally urn:uuid:{uuid}. Same value as the originating feed's ⟨id⟩.

    Shortsource feed permanent identifier
    Control0..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    4. syndication-feed-metadata.title
    Definition

    Atom ⟨title⟩ of the source feed.

    Shortsource feed human-readable name
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    6. syndication-feed-metadata.link
    Definition

    Atom ⟨link⟩ elements from the source feed — typically the source feed's rel="self" link.

    Shortsource feed link (typically rel=self)
    Control0..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. syndication-feed-metadata.link.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
    10. syndication-feed-metadata.link.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 syndication-feed-metadata.link.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 12. syndication-feed-metadata.link.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())
      14. syndication-feed-metadata.link.rel
      Definition

      link relation

      Shortlink relation
      Control0..1
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. syndication-feed-metadata.link.type
      Definition

      media type

      Shortmedia type
      Control0..1
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      18. syndication-feed-metadata.link.href
      Definition

      target URI

      Shorttarget URI
      Control1..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension