Terminology Syndication Feed Implementation Guide
0.1.0 - ci-build
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
| 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 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 |
| Short | Terminology Syndication Feed |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. syndication-feed.id | |
| Definition | Atom feed |
| Short | permanent globally-unique feed identifier |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. syndication-feed.title | |
| Definition | Atom feed |
| Short | human-readable feed name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. syndication-feed.subtitle | |
| Definition | Atom feed |
| Short | human-readable feed description |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. syndication-feed.updated | |
| Definition | Atom feed |
| Short | instant the feed was last meaningfully modified |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. syndication-feed.generator | |
| Definition | Atom feed |
| Short | publishing software identifier |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. syndication-feed.link | |
| Definition | Atom feed |
| Short | feed-level link |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on syndication-feed.link.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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: |
| Short | link relation (self | alternate) |
| Control | 0..1 |
| Type | code |
| Primitive Value | This 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 |
| Short | media type of the linked resource |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. syndication-feed.link.href | |
| Definition | target URI |
| Short | target URI |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. syndication-feed.atomSyndicationFormatProfile | |
| Definition |
|
| Short | ASF profile version the feed conforms to |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. syndication-feed.entry | |
| Definition | Atom |
| Short | syndicated artefact entry |
| Control | 0..* |
| Type | https://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 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 |
| Short | Terminology Syndication Feed |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. syndication-feed.id | |
| Definition | Atom feed |
| Short | permanent globally-unique feed identifier |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. syndication-feed.title | |
| Definition | Atom feed |
| Short | human-readable feed name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. syndication-feed.subtitle | |
| Definition | Atom feed |
| Short | human-readable feed description |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. syndication-feed.updated | |
| Definition | Atom feed |
| Short | instant the feed was last meaningfully modified |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. syndication-feed.generator | |
| Definition | Atom feed |
| Short | publishing software identifier |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. syndication-feed.link | |
| Definition | Atom feed |
| Short | feed-level link |
| Control | 0..* |
| Type | BackboneElement |
| 14. syndication-feed.link.rel | |
| Definition | Link relation. Common values: |
| Short | link relation (self | alternate) |
| Control | 0..1 |
| Type | code |
| Primitive Value | This 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 |
| Short | media type of the linked resource |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. syndication-feed.link.href | |
| Definition | target URI |
| Short | target URI |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. syndication-feed.atomSyndicationFormatProfile | |
| Definition |
|
| Short | ASF profile version the feed conforms to |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. syndication-feed.entry | |
| Definition | Atom |
| Short | syndicated artefact entry |
| Control | 0..* |
| Type | https://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 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 |
| Short | Terminology Syndication Feed |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. syndication-feed.id | |
| Definition | Atom feed |
| Short | permanent globally-unique feed identifier |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. syndication-feed.title | |
| Definition | Atom feed |
| Short | human-readable feed name |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. syndication-feed.subtitle | |
| Definition | Atom feed |
| Short | human-readable feed description |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. syndication-feed.updated | |
| Definition | Atom feed |
| Short | instant the feed was last meaningfully modified |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. syndication-feed.generator | |
| Definition | Atom feed |
| Short | publishing software identifier |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. syndication-feed.link | |
| Definition | Atom feed |
| Short | feed-level link |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-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. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 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. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on syndication-feed.link.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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: |
| Short | link relation (self | alternate) |
| Control | 0..1 |
| Type | code |
| Primitive Value | This 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 |
| Short | media type of the linked resource |
| Control | 0..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. syndication-feed.link.href | |
| Definition | target URI |
| Short | target URI |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. syndication-feed.atomSyndicationFormatProfile | |
| Definition |
|
| Short | ASF profile version the feed conforms to |
| Control | 0..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. syndication-feed.entry | |
| Definition | Atom |
| Short | syndicated artefact entry |
| Control | 0..* |
| Type | https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry |