Terminology Syndication Feed Implementation Guide
0.1.0 - ci-build
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 |
JSON representation of the syndication-link logical model.
{
"resourceType" : "StructureDefinition",
"id" : "syndication-link",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition syndication-link</b></p><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-syndication-link-definitions.html#syndication-link\" title=\"An Atom `⟨link⟩` element (RFC 4287 4.2.7) inside a syndication entry. The\ncore Atom attributes carry the artefact URL and media type; the\nextension namespaces add file-level integrity and validation\nmetadata.\n\n## Integrity\n\nA consumer MUST be able to verify a downloaded artefact's integrity.\nAt least one of `md5Hash` or `sha256Hash` SHOULD be present on every\nlink whose `rel` is `alternate` or `related`. Where both are\npresent, `sha256Hash` is authoritative.\n\nThe hash is computed over the byte stream that `href` resolves to,\nexactly as published — without any decompression or\ncontent-encoding negotiation.\n\n## Length\n\n`length` is the byte count of that same stream. When present, it\nMUST match what the `href` resolves to.\">syndication-link</a><a name=\"syndication-link\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://build.fhir.org/types.html#Base\">Base</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Terminology Syndication Link<br/><span style=\"font-weight:bold\">Instances of this logical model can be the target of a Reference</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-syndication-link-definitions.html#syndication-link.rel\" title=\"Link relation. `alternate` denotes the primary artefact; `related` denotes ancillary content (release notes, licence).\">rel</a><a name=\"syndication-link.rel\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">link relation (alternate | related)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-syndication-link-definitions.html#syndication-link.type\" title=\"Media type of the linked artefact (e.g. `application/zip`, `application/pdf`, `application/json`, `application/fhir+json`).\">type</a><a name=\"syndication-link.type\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">media type of the linked artefact</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-syndication-link-definitions.html#syndication-link.href\" title=\"artefact download URL\">href</a><a name=\"syndication-link.href\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">artefact download URL</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-syndication-link-definitions.html#syndication-link.length\" title=\"Artefact size in bytes. When present, MUST match the `href` resolution exactly.\">length</a><a name=\"syndication-link.length\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#unsignedInt\">unsignedInt</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">artefact size in bytes</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-syndication-link-definitions.html#syndication-link.md5Hash\" title=\"`sct:md5Hash`. Lowercase-hex MD5 of the artefact byte stream. 32 hex characters.\">md5Hash</a><a name=\"syndication-link.md5Hash\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">MD5 hash of the artefact byte stream (32 hex chars)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-syndication-link-definitions.html#syndication-link.sha256Hash\" title=\"`ncts:sha256Hash`. Lowercase-hex SHA-256 of the artefact byte stream. 64 hex characters. When both `md5Hash` and `sha256Hash` are present, `sha256Hash` is authoritative.\">sha256Hash</a><a name=\"syndication-link.sha256Hash\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">SHA-256 hash of the artefact byte stream (64 hex chars)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-syndication-link-definitions.html#syndication-link.validated\" title=\"`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`.\">validated</a><a name=\"syndication-link.validated\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">publisher has re-verified the artefact</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode" : "can-be-target"
}
],
"url" : "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-link",
"version" : "0.1.0",
"name" : "SyndicationLink",
"title" : "Terminology Syndication Link",
"status" : "draft",
"date" : "2026-05-09T20:23:33+00:00",
"publisher" : "Australian e-Health Research Centre",
"contact" : [
{
"name" : "Australian e-Health Research Centre",
"telecom" : [
{
"system" : "url",
"value" : "https://aehrc.csiro.au"
}
]
},
{
"name" : "Michael Lawley",
"telecom" : [
{
"system" : "email",
"value" : "michael.lawley@csiro.au"
}
]
}
],
"description" : "An Atom `⟨link⟩` element (RFC 4287 4.2.7) inside a syndication entry. The\ncore Atom attributes carry the artefact URL and media type; the\nextension namespaces add file-level integrity and validation\nmetadata.\n\n## Integrity\n\nA consumer MUST be able to verify a downloaded artefact's integrity.\nAt least one of `md5Hash` or `sha256Hash` SHOULD be present on every\nlink whose `rel` is `alternate` or `related`. Where both are\npresent, `sha256Hash` is authoritative.\n\nThe hash is computed over the byte stream that `href` resolves to,\nexactly as published — without any decompression or\ncontent-encoding negotiation.\n\n## Length\n\n`length` is the byte count of that same stream. When present, it\nMUST match what the `href` resolves to.",
"fhirVersion" : "4.0.1",
"kind" : "logical",
"abstract" : false,
"type" : "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-link",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
"derivation" : "specialization",
"snapshot" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString" : "4.0.1"
}
],
"element" : [
{
"id" : "syndication-link",
"path" : "syndication-link",
"short" : "Terminology Syndication Link",
"definition" : "An Atom `⟨link⟩` element (RFC 4287 4.2.7) inside a syndication entry. The\ncore Atom attributes carry the artefact URL and media type; the\nextension namespaces add file-level integrity and validation\nmetadata.\n\n## Integrity\n\nA consumer MUST be able to verify a downloaded artefact's integrity.\nAt least one of `md5Hash` or `sha256Hash` SHOULD be present on every\nlink whose `rel` is `alternate` or `related`. Where both are\npresent, `sha256Hash` is authoritative.\n\nThe hash is computed over the byte stream that `href` resolves to,\nexactly as published — without any decompression or\ncontent-encoding negotiation.\n\n## Length\n\n`length` is the byte count of that same stream. When present, it\nMUST match what the `href` resolves to.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false
},
{
"id" : "syndication-link.rel",
"path" : "syndication-link.rel",
"short" : "link relation (alternate | related)",
"definition" : "Link relation. `alternate` denotes the primary artefact; `related` denotes ancillary content (release notes, licence).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "syndication-link.rel",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "syndication-link.type",
"path" : "syndication-link.type",
"short" : "media type of the linked artefact",
"definition" : "Media type of the linked artefact (e.g. `application/zip`, `application/pdf`, `application/json`, `application/fhir+json`).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "syndication-link.type",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "syndication-link.href",
"path" : "syndication-link.href",
"short" : "artefact download URL",
"definition" : "artefact download URL",
"min" : 1,
"max" : "1",
"base" : {
"path" : "syndication-link.href",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
]
},
{
"id" : "syndication-link.length",
"path" : "syndication-link.length",
"short" : "artefact size in bytes",
"definition" : "Artefact size in bytes. When present, MUST match the `href` resolution exactly.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "syndication-link.length",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "unsignedInt"
}
]
},
{
"id" : "syndication-link.md5Hash",
"path" : "syndication-link.md5Hash",
"short" : "MD5 hash of the artefact byte stream (32 hex chars)",
"definition" : "`sct:md5Hash`. Lowercase-hex MD5 of the artefact byte stream. 32 hex characters.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "syndication-link.md5Hash",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "syndication-link.sha256Hash",
"path" : "syndication-link.sha256Hash",
"short" : "SHA-256 hash of the artefact byte stream (64 hex chars)",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "syndication-link.sha256Hash",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "syndication-link.validated",
"path" : "syndication-link.validated",
"short" : "publisher has re-verified the artefact",
"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`.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "syndication-link.validated",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "syndication-link",
"path" : "syndication-link",
"short" : "Terminology Syndication Link",
"definition" : "An Atom `⟨link⟩` element (RFC 4287 4.2.7) inside a syndication entry. The\ncore Atom attributes carry the artefact URL and media type; the\nextension namespaces add file-level integrity and validation\nmetadata.\n\n## Integrity\n\nA consumer MUST be able to verify a downloaded artefact's integrity.\nAt least one of `md5Hash` or `sha256Hash` SHOULD be present on every\nlink whose `rel` is `alternate` or `related`. Where both are\npresent, `sha256Hash` is authoritative.\n\nThe hash is computed over the byte stream that `href` resolves to,\nexactly as published — without any decompression or\ncontent-encoding negotiation.\n\n## Length\n\n`length` is the byte count of that same stream. When present, it\nMUST match what the `href` resolves to."
},
{
"id" : "syndication-link.rel",
"path" : "syndication-link.rel",
"short" : "link relation (alternate | related)",
"definition" : "Link relation. `alternate` denotes the primary artefact; `related` denotes ancillary content (release notes, licence).",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "syndication-link.type",
"path" : "syndication-link.type",
"short" : "media type of the linked artefact",
"definition" : "Media type of the linked artefact (e.g. `application/zip`, `application/pdf`, `application/json`, `application/fhir+json`).",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "syndication-link.href",
"path" : "syndication-link.href",
"short" : "artefact download URL",
"definition" : "artefact download URL",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "uri"
}
]
},
{
"id" : "syndication-link.length",
"path" : "syndication-link.length",
"short" : "artefact size in bytes",
"definition" : "Artefact size in bytes. When present, MUST match the `href` resolution exactly.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "unsignedInt"
}
]
},
{
"id" : "syndication-link.md5Hash",
"path" : "syndication-link.md5Hash",
"short" : "MD5 hash of the artefact byte stream (32 hex chars)",
"definition" : "`sct:md5Hash`. Lowercase-hex MD5 of the artefact byte stream. 32 hex characters.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "syndication-link.sha256Hash",
"path" : "syndication-link.sha256Hash",
"short" : "SHA-256 hash of the artefact byte stream (64 hex chars)",
"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.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "syndication-link.validated",
"path" : "syndication-link.validated",
"short" : "publisher has re-verified the artefact",
"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`.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "boolean"
}
]
}
]
}
}