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: SyndicationFeed - Detailed Descriptions

Draft as of 2026-05-09

Definitions for the syndication-feed logical model.

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

0. syndication-feed
Definition

An Atom 1.0 feed (RFC 4287) used to syndicate terminology releases.

The default XML namespace is http://www.w3.org/2005/Atom. Feeds that use the NCTS ASF profile additionally declare the ncts: namespace and SHOULD include the ncts:atomSyndicationFormatProfile element identifying the profile version.

A feed is an ordered collection of entries (RFC 4287 §4.1). Order is publisher-defined; consumers MUST NOT rely on order to determine recency — use the entry-level updated element instead.

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

Atom feed ⟨id⟩ element. A permanent, globally-unique identifier for the feed itself (not for any artefact). Conventionally urn:uuid:{uuid}. MUST NOT change across re-publications of the same feed (RFC 4287 §4.2.6).

Shortpermanent globally-unique feed identifier
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. syndication-feed.title
Definition

Atom feed ⟨title⟩ element. Human-readable feed name (RFC 4287 §4.2.14).

Shorthuman-readable feed name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. syndication-feed.subtitle
Definition

Atom feed ⟨subtitle⟩ element. Human-readable description of the feed (RFC 4287 §4.2.12).

Shorthuman-readable feed description
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. syndication-feed.updated
Definition

Atom feed ⟨updated⟩ element. The most recent instant the feed was meaningfully modified. RFC 3339 timestamp. SHOULD equal the maximum ⟨updated⟩ of any entry currently in the feed (RFC 4287 §4.2.15).

Shortinstant the feed was last meaningfully modified
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. syndication-feed.generator
Definition

Atom feed ⟨generator⟩ element. Identifies the publishing software (RFC 4287 §4.2.4).

Shortpublishing software identifier
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. syndication-feed.link
Definition

Atom feed ⟨link⟩ element. SHOULD include exactly one rel="self" link giving the canonical URL of the feed.

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

    Link relation. Common values: self (this feed), alternate (an alternative representation).

    Shortlink relation (self | alternate)
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    22. syndication-feed.link.type
    Definition

    Media type of the linked resource. For rel="self": application/atom+xml.

    Shortmedia type of the linked resource
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    24. syndication-feed.link.href
    Definition

    target URI

    Shorttarget URI
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    26. syndication-feed.atomSyndicationFormatProfile
    Definition

    ncts:atomSyndicationFormatProfile. Identifies the ASF profile version this feed conforms to. Current value: http://ns.electronichealth.net.au/ncts/syndication/asf/profile/1.0.0. Required when any NCTS ASF extension is used in the feed.

    ShortASF profile version the feed conforms to
    Control0..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    28. syndication-feed.entry
    Definition

    Atom ⟨entry⟩ element. One per syndicated artefact set.

    Shortsyndicated artefact entry
    Control0..*
    Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry

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

    0. syndication-feed
    Definition

    An Atom 1.0 feed (RFC 4287) used to syndicate terminology releases.

    The default XML namespace is http://www.w3.org/2005/Atom. Feeds that use the NCTS ASF profile additionally declare the ncts: namespace and SHOULD include the ncts:atomSyndicationFormatProfile element identifying the profile version.

    A feed is an ordered collection of entries (RFC 4287 §4.1). Order is publisher-defined; consumers MUST NOT rely on order to determine recency — use the entry-level updated element instead.

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

    Atom feed ⟨id⟩ element. A permanent, globally-unique identifier for the feed itself (not for any artefact). Conventionally urn:uuid:{uuid}. MUST NOT change across re-publications of the same feed (RFC 4287 §4.2.6).

    Shortpermanent globally-unique feed identifier
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    4. syndication-feed.title
    Definition

    Atom feed ⟨title⟩ element. Human-readable feed name (RFC 4287 §4.2.14).

    Shorthuman-readable feed name
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    6. syndication-feed.subtitle
    Definition

    Atom feed ⟨subtitle⟩ element. Human-readable description of the feed (RFC 4287 §4.2.12).

    Shorthuman-readable feed description
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    8. syndication-feed.updated
    Definition

    Atom feed ⟨updated⟩ element. The most recent instant the feed was meaningfully modified. RFC 3339 timestamp. SHOULD equal the maximum ⟨updated⟩ of any entry currently in the feed (RFC 4287 §4.2.15).

    Shortinstant the feed was last meaningfully modified
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. syndication-feed.generator
    Definition

    Atom feed ⟨generator⟩ element. Identifies the publishing software (RFC 4287 §4.2.4).

    Shortpublishing software identifier
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. syndication-feed.link
    Definition

    Atom feed ⟨link⟩ element. SHOULD include exactly one rel="self" link giving the canonical URL of the feed.

    Shortfeed-level link
    Control0..*
    TypeBackboneElement
    14. syndication-feed.link.rel
    Definition

    Link relation. Common values: self (this feed), alternate (an alternative representation).

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

    Media type of the linked resource. For rel="self": application/atom+xml.

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

    target URI

    Shorttarget URI
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. syndication-feed.atomSyndicationFormatProfile
    Definition

    ncts:atomSyndicationFormatProfile. Identifies the ASF profile version this feed conforms to. Current value: http://ns.electronichealth.net.au/ncts/syndication/asf/profile/1.0.0. Required when any NCTS ASF extension is used in the feed.

    ShortASF profile version the feed conforms to
    Control0..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    22. syndication-feed.entry
    Definition

    Atom ⟨entry⟩ element. One per syndicated artefact set.

    Shortsyndicated artefact entry
    Control0..*
    Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry

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

    0. syndication-feed
    Definition

    An Atom 1.0 feed (RFC 4287) used to syndicate terminology releases.

    The default XML namespace is http://www.w3.org/2005/Atom. Feeds that use the NCTS ASF profile additionally declare the ncts: namespace and SHOULD include the ncts:atomSyndicationFormatProfile element identifying the profile version.

    A feed is an ordered collection of entries (RFC 4287 §4.1). Order is publisher-defined; consumers MUST NOT rely on order to determine recency — use the entry-level updated element instead.

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

    Atom feed ⟨id⟩ element. A permanent, globally-unique identifier for the feed itself (not for any artefact). Conventionally urn:uuid:{uuid}. MUST NOT change across re-publications of the same feed (RFC 4287 §4.2.6).

    Shortpermanent globally-unique feed identifier
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    4. syndication-feed.title
    Definition

    Atom feed ⟨title⟩ element. Human-readable feed name (RFC 4287 §4.2.14).

    Shorthuman-readable feed name
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    6. syndication-feed.subtitle
    Definition

    Atom feed ⟨subtitle⟩ element. Human-readable description of the feed (RFC 4287 §4.2.12).

    Shorthuman-readable feed description
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    8. syndication-feed.updated
    Definition

    Atom feed ⟨updated⟩ element. The most recent instant the feed was meaningfully modified. RFC 3339 timestamp. SHOULD equal the maximum ⟨updated⟩ of any entry currently in the feed (RFC 4287 §4.2.15).

    Shortinstant the feed was last meaningfully modified
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. syndication-feed.generator
    Definition

    Atom feed ⟨generator⟩ element. Identifies the publishing software (RFC 4287 §4.2.4).

    Shortpublishing software identifier
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. syndication-feed.link
    Definition

    Atom feed ⟨link⟩ element. SHOULD include exactly one rel="self" link giving the canonical URL of the feed.

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

      Link relation. Common values: self (this feed), alternate (an alternative representation).

      Shortlink relation (self | alternate)
      Control0..1
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      22. syndication-feed.link.type
      Definition

      Media type of the linked resource. For rel="self": application/atom+xml.

      Shortmedia type of the linked resource
      Control0..1
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      24. syndication-feed.link.href
      Definition

      target URI

      Shorttarget URI
      Control1..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      26. syndication-feed.atomSyndicationFormatProfile
      Definition

      ncts:atomSyndicationFormatProfile. Identifies the ASF profile version this feed conforms to. Current value: http://ns.electronichealth.net.au/ncts/syndication/asf/profile/1.0.0. Required when any NCTS ASF extension is used in the feed.

      ShortASF profile version the feed conforms to
      Control0..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. syndication-feed.entry
      Definition

      Atom ⟨entry⟩ element. One per syndicated artefact set.

      Shortsyndicated artefact entry
      Control0..*
      Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry