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

Draft as of 2026-05-09

Definitions for the syndication-link logical model.

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

0. syndication-link
Definition

An Atom ⟨link⟩ element (RFC 4287 §4.2.7) inside a syndication entry. The core Atom attributes carry the artefact URL and media type; the extension namespaces add file-level integrity and validation metadata.

Integrity

A consumer MUST be able to verify a downloaded artefact's integrity. At least one of md5Hash or sha256Hash SHOULD be present on every link whose rel is alternate or related. Where both are present, sha256Hash is authoritative.

The hash is computed over the byte stream that href resolves to, exactly as published — without any decompression or content-encoding negotiation.

Length

length is the byte count of that same stream. When present, it MUST match what the href resolves to.

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

Link relation. alternate denotes the primary artefact; related denotes ancillary content (release notes, licence).

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

Media type of the linked artefact (e.g. application/zip, application/pdf, application/json, application/fhir+json).

Shortmedia type of the linked artefact
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. syndication-link.href
Definition

artefact download URL

Shortartefact download URL
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. syndication-link.length
Definition

Artefact size in bytes. When present, MUST match the href resolution exactly.

Shortartefact size in bytes
Control0..1
TypeunsignedInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. syndication-link.md5Hash
Definition

sct:md5Hash. Lowercase-hex MD5 of the artefact byte stream. 32 hex characters.

ShortMD5 hash of the artefact byte stream (32 hex chars)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. syndication-link.sha256Hash
Definition

ncts:sha256Hash. Lowercase-hex SHA-256 of the artefact byte stream. 64 hex characters. When both md5Hash and sha256Hash are present, sha256Hash is authoritative.

ShortSHA-256 hash of the artefact byte stream (64 hex chars)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. syndication-link.validated
Definition

onto:validated. Asserts that the publisher has re-verified the artefact at href against length and any hash since it was last published. Absence is equivalent to false.

Shortpublisher has re-verified the artefact
Control0..1
Typeboolean
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-link
Definition

An Atom ⟨link⟩ element (RFC 4287 §4.2.7) inside a syndication entry. The core Atom attributes carry the artefact URL and media type; the extension namespaces add file-level integrity and validation metadata.

Integrity

A consumer MUST be able to verify a downloaded artefact's integrity. At least one of md5Hash or sha256Hash SHOULD be present on every link whose rel is alternate or related. Where both are present, sha256Hash is authoritative.

The hash is computed over the byte stream that href resolves to, exactly as published — without any decompression or content-encoding negotiation.

Length

length is the byte count of that same stream. When present, it MUST match what the href resolves to.

ShortTerminology Syndication Link
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. syndication-link.rel
Definition

Link relation. alternate denotes the primary artefact; related denotes ancillary content (release notes, licence).

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

Media type of the linked artefact (e.g. application/zip, application/pdf, application/json, application/fhir+json).

Shortmedia type of the linked artefact
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. syndication-link.href
Definition

artefact download URL

Shortartefact download URL
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. syndication-link.length
Definition

Artefact size in bytes. When present, MUST match the href resolution exactly.

Shortartefact size in bytes
Control0..1
TypeunsignedInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. syndication-link.md5Hash
Definition

sct:md5Hash. Lowercase-hex MD5 of the artefact byte stream. 32 hex characters.

ShortMD5 hash of the artefact byte stream (32 hex chars)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. syndication-link.sha256Hash
Definition

ncts:sha256Hash. Lowercase-hex SHA-256 of the artefact byte stream. 64 hex characters. When both md5Hash and sha256Hash are present, sha256Hash is authoritative.

ShortSHA-256 hash of the artefact byte stream (64 hex chars)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. syndication-link.validated
Definition

onto:validated. Asserts that the publisher has re-verified the artefact at href against length and any hash since it was last published. Absence is equivalent to false.

Shortpublisher has re-verified the artefact
Control0..1
Typeboolean
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-link
Definition

An Atom ⟨link⟩ element (RFC 4287 §4.2.7) inside a syndication entry. The core Atom attributes carry the artefact URL and media type; the extension namespaces add file-level integrity and validation metadata.

Integrity

A consumer MUST be able to verify a downloaded artefact's integrity. At least one of md5Hash or sha256Hash SHOULD be present on every link whose rel is alternate or related. Where both are present, sha256Hash is authoritative.

The hash is computed over the byte stream that href resolves to, exactly as published — without any decompression or content-encoding negotiation.

Length

length is the byte count of that same stream. When present, it MUST match what the href resolves to.

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

Link relation. alternate denotes the primary artefact; related denotes ancillary content (release notes, licence).

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

Media type of the linked artefact (e.g. application/zip, application/pdf, application/json, application/fhir+json).

Shortmedia type of the linked artefact
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. syndication-link.href
Definition

artefact download URL

Shortartefact download URL
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. syndication-link.length
Definition

Artefact size in bytes. When present, MUST match the href resolution exactly.

Shortartefact size in bytes
Control0..1
TypeunsignedInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. syndication-link.md5Hash
Definition

sct:md5Hash. Lowercase-hex MD5 of the artefact byte stream. 32 hex characters.

ShortMD5 hash of the artefact byte stream (32 hex chars)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. syndication-link.sha256Hash
Definition

ncts:sha256Hash. Lowercase-hex SHA-256 of the artefact byte stream. 64 hex characters. When both md5Hash and sha256Hash are present, sha256Hash is authoritative.

ShortSHA-256 hash of the artefact byte stream (64 hex chars)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. syndication-link.validated
Definition

onto:validated. Asserts that the publisher has re-verified the artefact at href against length and any hash since it was last published. Absence is equivalent to false.

Shortpublisher has re-verified the artefact
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension