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

Draft as of 2026-05-09

Definitions for the syndication-entry logical model.

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

0. syndication-entry
Definition

An Atom ⟨entry⟩ (RFC 4287 §4.1.2) representing a single syndicated artefact set — for example an RF2 release package, a FHIR CodeSystem, a FHIR ValueSet, or a FHIR NPM package.

An entry combines the Atom 1.0 entry model with three extension namespaces: NCTS ASF (terminology metadata), SNOMED CT (package dependencies, MD5 hashes), and Ontoserver (permissions, validation state).

Cross-field semantics

When an entry's artefact is a FHIR canonical resource (CodeSystem, ValueSet, ConceptMap, NamingSystem, StructureDefinition, …):

  • contentItemIdentifier SHOULD equal the resource's ⟨url⟩.
  • contentItemVersion SHOULD equal {url}|{version} (the canonical URL, a pipe, and the version).
  • published SHOULD equal the resource's date.
  • title SHOULD equal the resource's title where present, else name.
  • rights SHOULD reflect the resource's copyright.

When the artefact is a SNOMED CT module:

  • contentItemIdentifier SHOULD be the unversioned SNOMED CT module URI (http://snomed.info/sct/{moduleId}).
  • contentItemVersion SHOULD be the versioned SNOMED CT URI (http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}).
ShortTerminology Syndication Entry
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsentry-retract-no-alternate-link: Retract entries (any category term ending '_RETRACT') MUST NOT carry a link with rel='alternate' — there is nothing to download. (category.where(term.endsWith('_RETRACT')).empty() or link.where(rel = 'alternate').empty())
entry-non-retract-has-link: Non-retract entries MUST carry at least one link. (category.where(term.endsWith('_RETRACT')).exists() or link.exists())
2. syndication-entry.id
Definition

Atom ⟨id⟩ element. Permanent, globally-unique identifier for this entry. Conventionally urn:uuid:{uuid}. MUST NOT change when the entry is updated (RFC 4287 §4.2.6).

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

Atom ⟨title⟩ element. Human-readable entry name.

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

Atom ⟨summary⟩ element. Short description of the artefact's content and intended use.

Shortshort description of the artefact
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. syndication-entry.rights
Definition

Atom ⟨rights⟩ element. Copyright/licence statement applicable to the artefact.

Shortcopyright/licence statement
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. syndication-entry.published
Definition

Atom ⟨published⟩ element. The instant the artefact set was first issued by its publisher. For FHIR canonical resources, SHOULD equal the resource's date.

Shortinstant the artefact set was first issued
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. syndication-entry.updated
Definition

Atom ⟨updated⟩ element. The instant this entry's metadata or artefacts last meaningfully changed. For FHIR canonical resources whose content has changed, SHOULD equal the resource's meta.lastUpdated or date.

Shortinstant this entry last meaningfully changed
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. syndication-entry.author
Definition

Atom ⟨author⟩ element. The party that produced the artefact.

Shortparty that produced the artefact
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. syndication-entry.author.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
18. syndication-entry.author.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-entry.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 20. syndication-entry.author.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())
    22. syndication-entry.author.name
    Definition

    author display name

    Shortauthor display name
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    24. syndication-entry.author.uri
    Definition

    author URI (typically organisation homepage)

    Shortauthor URI (typically organisation homepage)
    Control0..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    26. syndication-entry.author.email
    Definition

    author contact email

    Shortauthor contact email
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    28. syndication-entry.category
    Definition

    Atom ⟨category⟩ element. At least one category MUST be present, and at least one category SHOULD use a registered scheme so consumers can determine the artefact type (see SyndicationContentType).

    Shortcategory classifying this entry
    Control1..*
    Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-category
    30. syndication-entry.link
    Definition

    Atom ⟨link⟩ element. For non-retract entries at least one link MUST be present — the primary artefact uses rel="alternate"; ancillary documents (release notes, licence) use rel="related". Retract entries MUST NOT carry any rel="alternate" link (there is nothing to download); they MAY carry rel="related" links — see entry-retract-no-alternate-link and entry-non-retract-has-link.

    Shortlink to artefact or related document
    Control0..*
    Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-link
    32. syndication-entry.source
    Definition

    Atom ⟨source⟩ element (RFC 4287 §4.2.11). Identifies the originating feed when this entry has been copied, mirrored, or aggregated from another feed. SHOULD be set whenever the entry has been included in a feed other than its publisher's primary feed.

    Shortoriginating feed metadata
    Control0..1
    Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-feed-metadata
    34. syndication-entry.contentItemIdentifier
    Definition

    ncts:contentItemIdentifier. Canonical, version-independent identifier for the artefact. Stable across versions of the same logical artefact. For FHIR canonical resources, equals the resource's url. For SNOMED CT modules, the unversioned module URI.

    Shortversion-independent canonical identifier
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    36. syndication-entry.contentItemVersion
    Definition

    ncts:contentItemVersion. Canonical, version-specific identifier for this exact release. MUST be unique per entry within a feed (two entries with the same contentItemVersion are duplicates). For FHIR canonical resources, equals the canonical URL, a pipe, and the version (e.g. http://example.org/ValueSet/foo|1.2.0). For SNOMED CT modules, the versioned module URI.

    Shortversion-specific canonical identifier
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    38. syndication-entry.fhirVersion
    Definition

    ncts:fhirVersion. The FHIR version the artefact targets, when the artefact is FHIR. Format {major}.{minor} or {major}.{minor}.{patch} (e.g. 4.0.1). Maximum length 5. MUST be present when at least one category has a FHIR_* term — including the FHIR_*_RETRACT retraction terms.

    ShortFHIR version the artefact targets
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    40. syndication-entry.fhirProfile
    Definition

    ncts:fhirProfile. Canonical URL(s) of the FHIR StructureDefinition(s) the artefact claims conformance to. Repeats for multiple profiles. Only meaningful when the artefact is FHIR.

    ShortFHIR profile(s) the artefact conforms to
    Control0..*
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    42. syndication-entry.bundleInterpretation
    Definition

    ncts:bundleInterpretation. For artefacts that are FHIR Bundles: a publisher hint describing how the publisher views the Bundle's contents — batch (independent operations) or collection (a curated set of resources). It is a hint, not a directive: a consumer that retrieves the Bundle remains free to handle it however it sees fit, and absence simply means the publisher offers no hint. SHOULD be absent on retract entries.

    Shortpublisher's view of a FHIR Bundle (batch | collection)
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    44. syndication-entry.packageDependency
    Definition

    sct:packageDependency. Inter-package dependencies. Present only when the artefact requires other SNOMED CT packages (i.e. is an extension or derivative — not for an Edition itself). SHOULD be absent on retract entries.

    ShortSNOMED CT inter-package dependencies
    Control0..1
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. syndication-entry.packageDependency.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
    48. syndication-entry.packageDependency.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-entry.packageDependency.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 50. syndication-entry.packageDependency.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())
      52. syndication-entry.packageDependency.editionDependency
      Definition

      sct:editionDependency. Versioned SNOMED CT URI of an edition this package depends on. Format http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}.

      Shortversioned SNOMED CT URI of a required edition
      Control0..*
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      54. syndication-entry.packageDependency.derivativeDependency
      Definition

      sct:derivativeDependency. Versioned SNOMED CT URI of a derivative this package depends on.

      Shortversioned SNOMED CT URI of a required derivative
      Control0..*
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      56. syndication-entry.permission
      Definition

      onto:permission. Authorisation tag(s) that gate access to this entry's artefacts. An empty permission set means no entry-specific authorisation is required beyond feed-level access.

      Shortauthorisation tag gating access to this entry
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      58. syndication-entry.permission.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
      60. syndication-entry.permission.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-entry.permission.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 62. syndication-entry.permission.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())
        64. syndication-entry.permission.code
        Definition

        Permission tag. Compared against the set of permissions held by the requesting principal.

        Shortpermission tag matched against requester's permissions
        Control1..1
        Typestring
        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-entry
        Definition

        An Atom ⟨entry⟩ (RFC 4287 §4.1.2) representing a single syndicated artefact set — for example an RF2 release package, a FHIR CodeSystem, a FHIR ValueSet, or a FHIR NPM package.

        An entry combines the Atom 1.0 entry model with three extension namespaces: NCTS ASF (terminology metadata), SNOMED CT (package dependencies, MD5 hashes), and Ontoserver (permissions, validation state).

        Cross-field semantics

        When an entry's artefact is a FHIR canonical resource (CodeSystem, ValueSet, ConceptMap, NamingSystem, StructureDefinition, …):

        • contentItemIdentifier SHOULD equal the resource's ⟨url⟩.
        • contentItemVersion SHOULD equal {url}|{version} (the canonical URL, a pipe, and the version).
        • published SHOULD equal the resource's date.
        • title SHOULD equal the resource's title where present, else name.
        • rights SHOULD reflect the resource's copyright.

        When the artefact is a SNOMED CT module:

        • contentItemIdentifier SHOULD be the unversioned SNOMED CT module URI (http://snomed.info/sct/{moduleId}).
        • contentItemVersion SHOULD be the versioned SNOMED CT URI (http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}).
        ShortTerminology Syndication Entry
        Logical ModelInstances of this logical model are not marked to be the target of a Reference
        Invariantsentry-retract-no-alternate-link: Retract entries (any category term ending '_RETRACT') MUST NOT carry a link with rel='alternate' — there is nothing to download. (category.where(term.endsWith('_RETRACT')).empty() or link.where(rel = 'alternate').empty())
        entry-non-retract-has-link: Non-retract entries MUST carry at least one link. (category.where(term.endsWith('_RETRACT')).exists() or link.exists())
        2. syndication-entry.id
        Definition

        Atom ⟨id⟩ element. Permanent, globally-unique identifier for this entry. Conventionally urn:uuid:{uuid}. MUST NOT change when the entry is updated (RFC 4287 §4.2.6).

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

        Atom ⟨title⟩ element. Human-readable entry name.

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

        Atom ⟨summary⟩ element. Short description of the artefact's content and intended use.

        Shortshort description of the artefact
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        8. syndication-entry.rights
        Definition

        Atom ⟨rights⟩ element. Copyright/licence statement applicable to the artefact.

        Shortcopyright/licence statement
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        10. syndication-entry.published
        Definition

        Atom ⟨published⟩ element. The instant the artefact set was first issued by its publisher. For FHIR canonical resources, SHOULD equal the resource's date.

        Shortinstant the artefact set was first issued
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        12. syndication-entry.updated
        Definition

        Atom ⟨updated⟩ element. The instant this entry's metadata or artefacts last meaningfully changed. For FHIR canonical resources whose content has changed, SHOULD equal the resource's meta.lastUpdated or date.

        Shortinstant this entry last meaningfully changed
        Control1..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        14. syndication-entry.author
        Definition

        Atom ⟨author⟩ element. The party that produced the artefact.

        Shortparty that produced the artefact
        Control0..*
        TypeBackboneElement
        16. syndication-entry.author.name
        Definition

        author display name

        Shortauthor display name
        Control1..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        18. syndication-entry.author.uri
        Definition

        author URI (typically organisation homepage)

        Shortauthor URI (typically organisation homepage)
        Control0..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        20. syndication-entry.author.email
        Definition

        author contact email

        Shortauthor contact email
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        22. syndication-entry.category
        Definition

        Atom ⟨category⟩ element. At least one category MUST be present, and at least one category SHOULD use a registered scheme so consumers can determine the artefact type (see SyndicationContentType).

        Shortcategory classifying this entry
        Control1..*
        Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-category
        24. syndication-entry.link
        Definition

        Atom ⟨link⟩ element. For non-retract entries at least one link MUST be present — the primary artefact uses rel="alternate"; ancillary documents (release notes, licence) use rel="related". Retract entries MUST NOT carry any rel="alternate" link (there is nothing to download); they MAY carry rel="related" links — see entry-retract-no-alternate-link and entry-non-retract-has-link.

        Shortlink to artefact or related document
        Control0..*
        Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-link
        26. syndication-entry.source
        Definition

        Atom ⟨source⟩ element (RFC 4287 §4.2.11). Identifies the originating feed when this entry has been copied, mirrored, or aggregated from another feed. SHOULD be set whenever the entry has been included in a feed other than its publisher's primary feed.

        Shortoriginating feed metadata
        Control0..1
        Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-feed-metadata
        28. syndication-entry.contentItemIdentifier
        Definition

        ncts:contentItemIdentifier. Canonical, version-independent identifier for the artefact. Stable across versions of the same logical artefact. For FHIR canonical resources, equals the resource's url. For SNOMED CT modules, the unversioned module URI.

        Shortversion-independent canonical identifier
        Control1..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        30. syndication-entry.contentItemVersion
        Definition

        ncts:contentItemVersion. Canonical, version-specific identifier for this exact release. MUST be unique per entry within a feed (two entries with the same contentItemVersion are duplicates). For FHIR canonical resources, equals the canonical URL, a pipe, and the version (e.g. http://example.org/ValueSet/foo|1.2.0). For SNOMED CT modules, the versioned module URI.

        Shortversion-specific canonical identifier
        Control1..1
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        32. syndication-entry.fhirVersion
        Definition

        ncts:fhirVersion. The FHIR version the artefact targets, when the artefact is FHIR. Format {major}.{minor} or {major}.{minor}.{patch} (e.g. 4.0.1). Maximum length 5. MUST be present when at least one category has a FHIR_* term — including the FHIR_*_RETRACT retraction terms.

        ShortFHIR version the artefact targets
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        34. syndication-entry.fhirProfile
        Definition

        ncts:fhirProfile. Canonical URL(s) of the FHIR StructureDefinition(s) the artefact claims conformance to. Repeats for multiple profiles. Only meaningful when the artefact is FHIR.

        ShortFHIR profile(s) the artefact conforms to
        Control0..*
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        36. syndication-entry.bundleInterpretation
        Definition

        ncts:bundleInterpretation. For artefacts that are FHIR Bundles: a publisher hint describing how the publisher views the Bundle's contents — batch (independent operations) or collection (a curated set of resources). It is a hint, not a directive: a consumer that retrieves the Bundle remains free to handle it however it sees fit, and absence simply means the publisher offers no hint. SHOULD be absent on retract entries.

        Shortpublisher's view of a FHIR Bundle (batch | collection)
        Control0..1
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        38. syndication-entry.packageDependency
        Definition

        sct:packageDependency. Inter-package dependencies. Present only when the artefact requires other SNOMED CT packages (i.e. is an extension or derivative — not for an Edition itself). SHOULD be absent on retract entries.

        ShortSNOMED CT inter-package dependencies
        Control0..1
        TypeBackboneElement
        40. syndication-entry.packageDependency.editionDependency
        Definition

        sct:editionDependency. Versioned SNOMED CT URI of an edition this package depends on. Format http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}.

        Shortversioned SNOMED CT URI of a required edition
        Control0..*
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        42. syndication-entry.packageDependency.derivativeDependency
        Definition

        sct:derivativeDependency. Versioned SNOMED CT URI of a derivative this package depends on.

        Shortversioned SNOMED CT URI of a required derivative
        Control0..*
        Typeuri
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        44. syndication-entry.permission
        Definition

        onto:permission. Authorisation tag(s) that gate access to this entry's artefacts. An empty permission set means no entry-specific authorisation is required beyond feed-level access.

        Shortauthorisation tag gating access to this entry
        Control0..*
        TypeBackboneElement
        46. syndication-entry.permission.code
        Definition

        Permission tag. Compared against the set of permissions held by the requesting principal.

        Shortpermission tag matched against requester's permissions
        Control1..1
        Typestring
        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-entry
        Definition

        An Atom ⟨entry⟩ (RFC 4287 §4.1.2) representing a single syndicated artefact set — for example an RF2 release package, a FHIR CodeSystem, a FHIR ValueSet, or a FHIR NPM package.

        An entry combines the Atom 1.0 entry model with three extension namespaces: NCTS ASF (terminology metadata), SNOMED CT (package dependencies, MD5 hashes), and Ontoserver (permissions, validation state).

        Cross-field semantics

        When an entry's artefact is a FHIR canonical resource (CodeSystem, ValueSet, ConceptMap, NamingSystem, StructureDefinition, …):

        • contentItemIdentifier SHOULD equal the resource's ⟨url⟩.
        • contentItemVersion SHOULD equal {url}|{version} (the canonical URL, a pipe, and the version).
        • published SHOULD equal the resource's date.
        • title SHOULD equal the resource's title where present, else name.
        • rights SHOULD reflect the resource's copyright.

        When the artefact is a SNOMED CT module:

        • contentItemIdentifier SHOULD be the unversioned SNOMED CT module URI (http://snomed.info/sct/{moduleId}).
        • contentItemVersion SHOULD be the versioned SNOMED CT URI (http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}).
        ShortTerminology Syndication Entry
        Control0..*
        Is Modifierfalse
        Logical ModelInstances of this logical model are not marked to be the target of a Reference
        Invariantsentry-retract-no-alternate-link: Retract entries (any category term ending '_RETRACT') MUST NOT carry a link with rel='alternate' — there is nothing to download. (category.where(term.endsWith('_RETRACT')).empty() or link.where(rel = 'alternate').empty())
        entry-non-retract-has-link: Non-retract entries MUST carry at least one link. (category.where(term.endsWith('_RETRACT')).exists() or link.exists())
        2. syndication-entry.id
        Definition

        Atom ⟨id⟩ element. Permanent, globally-unique identifier for this entry. Conventionally urn:uuid:{uuid}. MUST NOT change when the entry is updated (RFC 4287 §4.2.6).

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

        Atom ⟨title⟩ element. Human-readable entry name.

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

        Atom ⟨summary⟩ element. Short description of the artefact's content and intended use.

        Shortshort description of the artefact
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        8. syndication-entry.rights
        Definition

        Atom ⟨rights⟩ element. Copyright/licence statement applicable to the artefact.

        Shortcopyright/licence statement
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        10. syndication-entry.published
        Definition

        Atom ⟨published⟩ element. The instant the artefact set was first issued by its publisher. For FHIR canonical resources, SHOULD equal the resource's date.

        Shortinstant the artefact set was first issued
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        12. syndication-entry.updated
        Definition

        Atom ⟨updated⟩ element. The instant this entry's metadata or artefacts last meaningfully changed. For FHIR canonical resources whose content has changed, SHOULD equal the resource's meta.lastUpdated or date.

        Shortinstant this entry last meaningfully changed
        Control1..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        14. syndication-entry.author
        Definition

        Atom ⟨author⟩ element. The party that produced the artefact.

        Shortparty that produced the artefact
        Control0..*
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. syndication-entry.author.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
        18. syndication-entry.author.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-entry.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 20. syndication-entry.author.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())
          22. syndication-entry.author.name
          Definition

          author display name

          Shortauthor display name
          Control1..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          24. syndication-entry.author.uri
          Definition

          author URI (typically organisation homepage)

          Shortauthor URI (typically organisation homepage)
          Control0..1
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          26. syndication-entry.author.email
          Definition

          author contact email

          Shortauthor contact email
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          28. syndication-entry.category
          Definition

          Atom ⟨category⟩ element. At least one category MUST be present, and at least one category SHOULD use a registered scheme so consumers can determine the artefact type (see SyndicationContentType).

          Shortcategory classifying this entry
          Control1..*
          Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-category
          30. syndication-entry.link
          Definition

          Atom ⟨link⟩ element. For non-retract entries at least one link MUST be present — the primary artefact uses rel="alternate"; ancillary documents (release notes, licence) use rel="related". Retract entries MUST NOT carry any rel="alternate" link (there is nothing to download); they MAY carry rel="related" links — see entry-retract-no-alternate-link and entry-non-retract-has-link.

          Shortlink to artefact or related document
          Control0..*
          Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-link
          32. syndication-entry.source
          Definition

          Atom ⟨source⟩ element (RFC 4287 §4.2.11). Identifies the originating feed when this entry has been copied, mirrored, or aggregated from another feed. SHOULD be set whenever the entry has been included in a feed other than its publisher's primary feed.

          Shortoriginating feed metadata
          Control0..1
          Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-feed-metadata
          34. syndication-entry.contentItemIdentifier
          Definition

          ncts:contentItemIdentifier. Canonical, version-independent identifier for the artefact. Stable across versions of the same logical artefact. For FHIR canonical resources, equals the resource's url. For SNOMED CT modules, the unversioned module URI.

          Shortversion-independent canonical identifier
          Control1..1
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          36. syndication-entry.contentItemVersion
          Definition

          ncts:contentItemVersion. Canonical, version-specific identifier for this exact release. MUST be unique per entry within a feed (two entries with the same contentItemVersion are duplicates). For FHIR canonical resources, equals the canonical URL, a pipe, and the version (e.g. http://example.org/ValueSet/foo|1.2.0). For SNOMED CT modules, the versioned module URI.

          Shortversion-specific canonical identifier
          Control1..1
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          38. syndication-entry.fhirVersion
          Definition

          ncts:fhirVersion. The FHIR version the artefact targets, when the artefact is FHIR. Format {major}.{minor} or {major}.{minor}.{patch} (e.g. 4.0.1). Maximum length 5. MUST be present when at least one category has a FHIR_* term — including the FHIR_*_RETRACT retraction terms.

          ShortFHIR version the artefact targets
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          40. syndication-entry.fhirProfile
          Definition

          ncts:fhirProfile. Canonical URL(s) of the FHIR StructureDefinition(s) the artefact claims conformance to. Repeats for multiple profiles. Only meaningful when the artefact is FHIR.

          ShortFHIR profile(s) the artefact conforms to
          Control0..*
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          42. syndication-entry.bundleInterpretation
          Definition

          ncts:bundleInterpretation. For artefacts that are FHIR Bundles: a publisher hint describing how the publisher views the Bundle's contents — batch (independent operations) or collection (a curated set of resources). It is a hint, not a directive: a consumer that retrieves the Bundle remains free to handle it however it sees fit, and absence simply means the publisher offers no hint. SHOULD be absent on retract entries.

          Shortpublisher's view of a FHIR Bundle (batch | collection)
          Control0..1
          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          44. syndication-entry.packageDependency
          Definition

          sct:packageDependency. Inter-package dependencies. Present only when the artefact requires other SNOMED CT packages (i.e. is an extension or derivative — not for an Edition itself). SHOULD be absent on retract entries.

          ShortSNOMED CT inter-package dependencies
          Control0..1
          TypeBackboneElement
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          46. syndication-entry.packageDependency.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
          48. syndication-entry.packageDependency.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-entry.packageDependency.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 50. syndication-entry.packageDependency.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())
            52. syndication-entry.packageDependency.editionDependency
            Definition

            sct:editionDependency. Versioned SNOMED CT URI of an edition this package depends on. Format http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}.

            Shortversioned SNOMED CT URI of a required edition
            Control0..*
            Typeuri
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            54. syndication-entry.packageDependency.derivativeDependency
            Definition

            sct:derivativeDependency. Versioned SNOMED CT URI of a derivative this package depends on.

            Shortversioned SNOMED CT URI of a required derivative
            Control0..*
            Typeuri
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            56. syndication-entry.permission
            Definition

            onto:permission. Authorisation tag(s) that gate access to this entry's artefacts. An empty permission set means no entry-specific authorisation is required beyond feed-level access.

            Shortauthorisation tag gating access to this entry
            Control0..*
            TypeBackboneElement
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            58. syndication-entry.permission.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
            60. syndication-entry.permission.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-entry.permission.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 62. syndication-entry.permission.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())
              64. syndication-entry.permission.code
              Definition

              Permission tag. Compared against the set of permissions held by the requesting principal.

              Shortpermission tag matched against requester's permissions
              Control1..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension