FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageaehrc.syndication
Resource TypeStructureDefinition
IdStructureDefinition-syndication-link.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/FHIR/fhir-syndication-ig/StructureDefinition-syndication-link.html
URLhttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-link
Version0.1.0
Statusdraft
Date2026-06-29T05:00:28+00:00
NameSyndicationLink
TitleTerminology Syndication Link
Realmuv
DescriptionAn 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.
Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-link
Kindlogical

Resources that use this resource

StructureDefinition
aehrc.syndication#currentsyndication-entryTerminology Syndication Entry

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition syndication-link

NameFlagsCard.TypeDescription & Constraintsdoco
.. syndication-link 0..*BaseTerminology Syndication Link
Instances of this type can be the target of a Reference
... rel 1..1codelink relation (alternate | related)
... type 1..1codemedia type of the linked artefact
... href 1..1uriartefact download URL
... length 0..1unsignedIntartefact size in bytes
... md5Hash 0..1stringMD5 hash of the artefact byte stream (32 hex chars)
... sha256Hash 0..1stringSHA-256 hash of the artefact byte stream (64 hex chars)
... validated 0..1booleanpublisher has re-verified the artefact

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "syndication-link",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "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-06-29T05:00:28+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"
          }
        ]
      }
    ]
  }
}