{ "resourceType" : "StructureDefinition", "id" : "syndication-feed", "text" : { "status" : "extensions", "div" : "

Generated Narrative: StructureDefinition syndication-feed

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" syndication-feed 0..*BaseTerminology Syndication Feed
Instances of this logical model can be the target of a Reference
\".\"\".\"\".\" id 1..1uripermanent globally-unique feed identifier
\".\"\".\"\".\" title 1..1stringhuman-readable feed name
\".\"\".\"\".\" subtitle 0..1stringhuman-readable feed description
\".\"\".\"\".\" updated 1..1dateTimeinstant the feed was last meaningfully modified
\".\"\".\"\".\" generator 0..1stringpublishing software identifier
\".\"\".\"\".\" link 0..*BackboneElementfeed-level link
\".\"\".\"\".\"\".\" rel 0..1codelink relation (self | alternate)
\".\"\".\"\".\"\".\" type 0..1codemedia type of the linked resource
\".\"\".\"\".\"\".\" href 1..1uritarget URI
\".\"\".\"\".\" atomSyndicationFormatProfile 0..1uriASF profile version the feed conforms to
\".\"\".\"\".\" entry 0..*syndication-entrysyndicated artefact entry

\"doco\" Documentation for this format
" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics", "valueCode" : "can-be-target" }], "url" : "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-feed", "version" : "0.1.0", "name" : "SyndicationFeed", "title" : "Terminology Syndication Feed", "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 1.0 feed (RFC 4287) used to syndicate terminology releases.\n\nThe default XML namespace is `http://www.w3.org/2005/Atom`. Feeds\nthat use the NCTS ASF profile additionally declare the `ncts:`\nnamespace and SHOULD include the `ncts:atomSyndicationFormatProfile`\nelement identifying the profile version.\n\nA feed is an ordered collection of entries (RFC 4287 §4.1). Order\nis publisher-defined; consumers MUST NOT rely on order to determine\nrecency — use the entry-level `updated` element instead.", "fhirVersion" : "4.0.1", "kind" : "logical", "abstract" : false, "type" : "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-feed", "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-feed", "path" : "syndication-feed", "short" : "Terminology Syndication Feed", "definition" : "An Atom 1.0 feed (RFC 4287) used to syndicate terminology releases.\n\nThe default XML namespace is `http://www.w3.org/2005/Atom`. Feeds\nthat use the NCTS ASF profile additionally declare the `ncts:`\nnamespace and SHOULD include the `ncts:atomSyndicationFormatProfile`\nelement identifying the profile version.\n\nA feed is an ordered collection of entries (RFC 4287 §4.1). Order\nis publisher-defined; consumers MUST NOT rely on order to determine\nrecency — use the entry-level `updated` element instead.", "min" : 0, "max" : "*", "base" : { "path" : "Base", "min" : 0, "max" : "*" }, "isModifier" : false }, { "id" : "syndication-feed.id", "path" : "syndication-feed.id", "short" : "permanent globally-unique feed identifier", "definition" : "Atom feed `⟨id⟩` element. A permanent, globally-unique identifier for the feed itself (not for any artefact). Conventionally `urn:uuid:{uuid}`. MUST NOT change across re-publications of the same feed (RFC 4287 §4.2.6).", "min" : 1, "max" : "1", "base" : { "path" : "syndication-feed.id", "min" : 1, "max" : "1" }, "type" : [{ "code" : "uri" }] }, { "id" : "syndication-feed.title", "path" : "syndication-feed.title", "short" : "human-readable feed name", "definition" : "Atom feed `⟨title⟩` element. Human-readable feed name (RFC 4287 §4.2.14).", "min" : 1, "max" : "1", "base" : { "path" : "syndication-feed.title", "min" : 1, "max" : "1" }, "type" : [{ "code" : "string" }] }, { "id" : "syndication-feed.subtitle", "path" : "syndication-feed.subtitle", "short" : "human-readable feed description", "definition" : "Atom feed `⟨subtitle⟩` element. Human-readable description of the feed (RFC 4287 §4.2.12).", "min" : 0, "max" : "1", "base" : { "path" : "syndication-feed.subtitle", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }] }, { "id" : "syndication-feed.updated", "path" : "syndication-feed.updated", "short" : "instant the feed was last meaningfully modified", "definition" : "Atom feed `⟨updated⟩` element. The most recent instant the feed was meaningfully modified. RFC 3339 timestamp. SHOULD equal the maximum `⟨updated⟩` of any entry currently in the feed (RFC 4287 §4.2.15).", "min" : 1, "max" : "1", "base" : { "path" : "syndication-feed.updated", "min" : 1, "max" : "1" }, "type" : [{ "code" : "dateTime" }] }, { "id" : "syndication-feed.generator", "path" : "syndication-feed.generator", "short" : "publishing software identifier", "definition" : "Atom feed `⟨generator⟩` element. Identifies the publishing software (RFC 4287 §4.2.4).", "min" : 0, "max" : "1", "base" : { "path" : "syndication-feed.generator", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }] }, { "id" : "syndication-feed.link", "path" : "syndication-feed.link", "short" : "feed-level link", "definition" : "Atom feed `⟨link⟩` element. SHOULD include exactly one `rel=\"self\"` link giving the canonical URL of the feed.", "min" : 0, "max" : "*", "base" : { "path" : "syndication-feed.link", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }] }, { "id" : "syndication-feed.link.id", "path" : "syndication-feed.link.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "syndication-feed.link.extension", "path" : "syndication-feed.link.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Additional content defined by implementations", "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.", "comment" : "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "syndication-feed.link.modifierExtension", "path" : "syndication-feed.link.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment" : "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.", "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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "syndication-feed.link.rel", "path" : "syndication-feed.link.rel", "short" : "link relation (self | alternate)", "definition" : "Link relation. Common values: `self` (this feed), `alternate` (an alternative representation).", "min" : 0, "max" : "1", "base" : { "path" : "syndication-feed.link.rel", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code" }] }, { "id" : "syndication-feed.link.type", "path" : "syndication-feed.link.type", "short" : "media type of the linked resource", "definition" : "Media type of the linked resource. For `rel=\"self\"`: `application/atom+xml`.", "min" : 0, "max" : "1", "base" : { "path" : "syndication-feed.link.type", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code" }] }, { "id" : "syndication-feed.link.href", "path" : "syndication-feed.link.href", "short" : "target URI", "definition" : "target URI", "min" : 1, "max" : "1", "base" : { "path" : "syndication-feed.link.href", "min" : 1, "max" : "1" }, "type" : [{ "code" : "uri" }] }, { "id" : "syndication-feed.atomSyndicationFormatProfile", "path" : "syndication-feed.atomSyndicationFormatProfile", "short" : "ASF profile version the feed conforms to", "definition" : "`ncts:atomSyndicationFormatProfile`. Identifies the ASF profile version this feed conforms to. Current value: `http://ns.electronichealth.net.au/ncts/syndication/asf/profile/1.0.0`. Required when any NCTS ASF extension is used in the feed.", "min" : 0, "max" : "1", "base" : { "path" : "syndication-feed.atomSyndicationFormatProfile", "min" : 0, "max" : "1" }, "type" : [{ "code" : "uri" }] }, { "id" : "syndication-feed.entry", "path" : "syndication-feed.entry", "short" : "syndicated artefact entry", "definition" : "Atom `⟨entry⟩` element. One per syndicated artefact set.", "min" : 0, "max" : "*", "base" : { "path" : "syndication-feed.entry", "min" : 0, "max" : "*" }, "type" : [{ "code" : "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry" }] }] }, "differential" : { "element" : [{ "id" : "syndication-feed", "path" : "syndication-feed", "short" : "Terminology Syndication Feed", "definition" : "An Atom 1.0 feed (RFC 4287) used to syndicate terminology releases.\n\nThe default XML namespace is `http://www.w3.org/2005/Atom`. Feeds\nthat use the NCTS ASF profile additionally declare the `ncts:`\nnamespace and SHOULD include the `ncts:atomSyndicationFormatProfile`\nelement identifying the profile version.\n\nA feed is an ordered collection of entries (RFC 4287 §4.1). Order\nis publisher-defined; consumers MUST NOT rely on order to determine\nrecency — use the entry-level `updated` element instead." }, { "id" : "syndication-feed.id", "path" : "syndication-feed.id", "short" : "permanent globally-unique feed identifier", "definition" : "Atom feed `⟨id⟩` element. A permanent, globally-unique identifier for the feed itself (not for any artefact). Conventionally `urn:uuid:{uuid}`. MUST NOT change across re-publications of the same feed (RFC 4287 §4.2.6).", "min" : 1, "max" : "1", "type" : [{ "code" : "uri" }] }, { "id" : "syndication-feed.title", "path" : "syndication-feed.title", "short" : "human-readable feed name", "definition" : "Atom feed `⟨title⟩` element. Human-readable feed name (RFC 4287 §4.2.14).", "min" : 1, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "syndication-feed.subtitle", "path" : "syndication-feed.subtitle", "short" : "human-readable feed description", "definition" : "Atom feed `⟨subtitle⟩` element. Human-readable description of the feed (RFC 4287 §4.2.12).", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "syndication-feed.updated", "path" : "syndication-feed.updated", "short" : "instant the feed was last meaningfully modified", "definition" : "Atom feed `⟨updated⟩` element. The most recent instant the feed was meaningfully modified. RFC 3339 timestamp. SHOULD equal the maximum `⟨updated⟩` of any entry currently in the feed (RFC 4287 §4.2.15).", "min" : 1, "max" : "1", "type" : [{ "code" : "dateTime" }] }, { "id" : "syndication-feed.generator", "path" : "syndication-feed.generator", "short" : "publishing software identifier", "definition" : "Atom feed `⟨generator⟩` element. Identifies the publishing software (RFC 4287 §4.2.4).", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "syndication-feed.link", "path" : "syndication-feed.link", "short" : "feed-level link", "definition" : "Atom feed `⟨link⟩` element. SHOULD include exactly one `rel=\"self\"` link giving the canonical URL of the feed.", "min" : 0, "max" : "*", "type" : [{ "code" : "BackboneElement" }] }, { "id" : "syndication-feed.link.rel", "path" : "syndication-feed.link.rel", "short" : "link relation (self | alternate)", "definition" : "Link relation. Common values: `self` (this feed), `alternate` (an alternative representation).", "min" : 0, "max" : "1", "type" : [{ "code" : "code" }] }, { "id" : "syndication-feed.link.type", "path" : "syndication-feed.link.type", "short" : "media type of the linked resource", "definition" : "Media type of the linked resource. For `rel=\"self\"`: `application/atom+xml`.", "min" : 0, "max" : "1", "type" : [{ "code" : "code" }] }, { "id" : "syndication-feed.link.href", "path" : "syndication-feed.link.href", "short" : "target URI", "definition" : "target URI", "min" : 1, "max" : "1", "type" : [{ "code" : "uri" }] }, { "id" : "syndication-feed.atomSyndicationFormatProfile", "path" : "syndication-feed.atomSyndicationFormatProfile", "short" : "ASF profile version the feed conforms to", "definition" : "`ncts:atomSyndicationFormatProfile`. Identifies the ASF profile version this feed conforms to. Current value: `http://ns.electronichealth.net.au/ncts/syndication/asf/profile/1.0.0`. Required when any NCTS ASF extension is used in the feed.", "min" : 0, "max" : "1", "type" : [{ "code" : "uri" }] }, { "id" : "syndication-feed.entry", "path" : "syndication-feed.entry", "short" : "syndicated artefact entry", "definition" : "Atom `⟨entry⟩` element. One per syndicated artefact set.", "min" : 0, "max" : "*", "type" : [{ "code" : "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry" }] }] } }