FHIR IG analytics| Package | aehrc.syndication |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-syndication-entry.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/FHIR/fhir-syndication-ig/StructureDefinition-syndication-entry.html |
| URL | https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry |
| Version | 0.1.0 |
| Status | draft |
| Date | 2026-06-29T05:00:28+00:00 |
| Name | SyndicationEntry |
| Title | Terminology Syndication Entry |
| Realm | uv |
| Description | 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}`). |
| Type | https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry |
| Kind | logical |
| StructureDefinition | ||
| aehrc.syndication#current | syndication-feed | Terminology Syndication Feed |
| StructureDefinition | ||
| aehrc.syndication#current | syndication-category | Terminology Syndication Category |
| aehrc.syndication#current | syndication-feed-metadata | Terminology Syndication Feed Metadata |
| aehrc.syndication#current | syndication-link | Terminology Syndication Link |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition syndication-entry
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  syndication-entry | C | 0..* | Base | Terminology Syndication Entry Instances of this type can be the target of a Reference Constraints: entry-retract-no-alternate-link, entry-non-retract-has-link |
  id | 1..1 | uri | permanent globally-unique entry identifier | |
| title | 1..1 | string | human-readable entry name | |
| summary | 0..1 | string | short description of the artefact | |
| rights | 0..1 | string | copyright/licence statement | |
| published | 0..1 | dateTime | instant the artefact set was first issued | |
| updated | 1..1 | dateTime | instant this entry last meaningfully changed | |
 author | 0..* | BackboneElement | party that produced the artefact | |
 name | 1..1 | string | author display name | |
| uri | 0..1 | uri | author URI (typically organisation homepage) | |
 email | 0..1 | string | author contact email | |
 category | 1..* | syndication-category | category classifying this entry | |
| link | 0..* | syndication-link | link to artefact or related document | |
| source | 0..1 | syndication-feed-metadata | originating feed metadata | |
| contentItemIdentifier | 1..1 | uri | version-independent canonical identifier | |
| contentItemVersion | 1..1 | uri | version-specific canonical identifier | |
| fhirVersion | 0..1 | string | FHIR version the artefact targets | |
| fhirProfile | 0..* | uri | FHIR profile(s) the artefact conforms to | |
| bundleInterpretation | 0..1 | code | publisher's view of a FHIR Bundle (batch | collection) | |
| packageDependency | 0..1 | BackboneElement | SNOMED CT inter-package dependencies | |
| editionDependency | 0..* | uri | versioned SNOMED CT URI of a required edition | |
| derivativeDependency | 0..* | uri | versioned SNOMED CT URI of a required derivative | |
| permission | 0..* | BackboneElement | authorisation tag gating access to this entry | |
 code | 1..1 | string | permission tag matched against requester's permissions | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "syndication-entry",
"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-entry",
"version": "0.1.0",
"name": "SyndicationEntry",
"title": "Terminology Syndication Entry",
"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 `⟨entry⟩` (RFC 4287 §4.1.2) representing a single syndicated\nartefact set — for example an RF2 release package, a FHIR\nCodeSystem, a FHIR ValueSet, or a FHIR NPM package.\n\nAn entry combines the Atom 1.0 entry model with three extension\nnamespaces: NCTS ASF (terminology metadata), SNOMED CT (package\ndependencies, MD5 hashes), and Ontoserver (permissions, validation\nstate).\n\n## Cross-field semantics\n\nWhen an entry's artefact is a FHIR canonical resource (CodeSystem,\nValueSet, ConceptMap, NamingSystem, StructureDefinition, …):\n\n- `contentItemIdentifier` SHOULD equal the resource's `⟨url⟩`.\n- `contentItemVersion` SHOULD equal `{url}|{version}` (the canonical URL,\n a pipe, and the version).\n- `published` SHOULD equal the resource's `date`.\n- `title` SHOULD equal the resource's `title` where present, else `name`.\n- `rights` SHOULD reflect the resource's `copyright`.\n\nWhen the artefact is a SNOMED CT module:\n\n- `contentItemIdentifier` SHOULD be the unversioned SNOMED CT module URI\n (`http://snomed.info/sct/{moduleId}`).\n- `contentItemVersion` SHOULD be the versioned SNOMED CT URI\n (`http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}`).",
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry",
"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-entry",
"path": "syndication-entry",
"short": "Terminology Syndication Entry",
"definition": "An Atom `⟨entry⟩` (RFC 4287 §4.1.2) representing a single syndicated\nartefact set — for example an RF2 release package, a FHIR\nCodeSystem, a FHIR ValueSet, or a FHIR NPM package.\n\nAn entry combines the Atom 1.0 entry model with three extension\nnamespaces: NCTS ASF (terminology metadata), SNOMED CT (package\ndependencies, MD5 hashes), and Ontoserver (permissions, validation\nstate).\n\n## Cross-field semantics\n\nWhen an entry's artefact is a FHIR canonical resource (CodeSystem,\nValueSet, ConceptMap, NamingSystem, StructureDefinition, …):\n\n- `contentItemIdentifier` SHOULD equal the resource's `⟨url⟩`.\n- `contentItemVersion` SHOULD equal `{url}|{version}` (the canonical URL,\n a pipe, and the version).\n- `published` SHOULD equal the resource's `date`.\n- `title` SHOULD equal the resource's `title` where present, else `name`.\n- `rights` SHOULD reflect the resource's `copyright`.\n\nWhen the artefact is a SNOMED CT module:\n\n- `contentItemIdentifier` SHOULD be the unversioned SNOMED CT module URI\n (`http://snomed.info/sct/{moduleId}`).\n- `contentItemVersion` SHOULD be the versioned SNOMED CT URI\n (`http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}`).",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "entry-retract-no-alternate-link",
"severity": "error",
"human": "Retract entries (any category term ending '_RETRACT') MUST NOT carry a link with rel='alternate' — there is nothing to download.",
"expression": "category.where(term.endsWith('_RETRACT')).empty() or link.where(rel = 'alternate').empty()",
"source": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry"
},
{
"key": "entry-non-retract-has-link",
"severity": "error",
"human": "Non-retract entries MUST carry at least one link.",
"expression": "category.where(term.endsWith('_RETRACT')).exists() or link.exists()",
"source": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry"
}
],
"isModifier": false
},
{
"id": "syndication-entry.id",
"path": "syndication-entry.id",
"short": "permanent globally-unique entry identifier",
"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).",
"min": 1,
"max": "1",
"base": {
"path": "syndication-entry.id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.title",
"path": "syndication-entry.title",
"short": "human-readable entry name",
"definition": "Atom `⟨title⟩` element. Human-readable entry name.",
"min": 1,
"max": "1",
"base": {
"path": "syndication-entry.title",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.summary",
"path": "syndication-entry.summary",
"short": "short description of the artefact",
"definition": "Atom `⟨summary⟩` element. Short description of the artefact's content and intended use.",
"min": 0,
"max": "1",
"base": {
"path": "syndication-entry.summary",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.rights",
"path": "syndication-entry.rights",
"short": "copyright/licence statement",
"definition": "Atom `⟨rights⟩` element. Copyright/licence statement applicable to the artefact.",
"min": 0,
"max": "1",
"base": {
"path": "syndication-entry.rights",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.published",
"path": "syndication-entry.published",
"short": "instant the artefact set was first issued",
"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`.",
"min": 0,
"max": "1",
"base": {
"path": "syndication-entry.published",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "syndication-entry.updated",
"path": "syndication-entry.updated",
"short": "instant this entry last meaningfully changed",
"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`.",
"min": 1,
"max": "1",
"base": {
"path": "syndication-entry.updated",
"min": 1,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "syndication-entry.author",
"path": "syndication-entry.author",
"short": "party that produced the artefact",
"definition": "Atom `⟨author⟩` element. The party that produced the artefact.",
"min": 0,
"max": "*",
"base": {
"path": "syndication-entry.author",
"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-entry.author.id",
"path": "syndication-entry.author.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-entry.author.extension",
"path": "syndication-entry.author.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-entry.author.modifierExtension",
"path": "syndication-entry.author.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-entry.author.name",
"path": "syndication-entry.author.name",
"short": "author display name",
"definition": "author display name",
"min": 1,
"max": "1",
"base": {
"path": "syndication-entry.author.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.author.uri",
"path": "syndication-entry.author.uri",
"short": "author URI (typically organisation homepage)",
"definition": "author URI (typically organisation homepage)",
"min": 0,
"max": "1",
"base": {
"path": "syndication-entry.author.uri",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.author.email",
"path": "syndication-entry.author.email",
"short": "author contact email",
"definition": "author contact email",
"min": 0,
"max": "1",
"base": {
"path": "syndication-entry.author.email",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.category",
"path": "syndication-entry.category",
"short": "category classifying this entry",
"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).",
"min": 1,
"max": "*",
"base": {
"path": "syndication-entry.category",
"min": 1,
"max": "*"
},
"type": [
{
"code": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-category"
}
]
},
{
"id": "syndication-entry.link",
"path": "syndication-entry.link",
"short": "link to artefact or related document",
"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`.",
"min": 0,
"max": "*",
"base": {
"path": "syndication-entry.link",
"min": 0,
"max": "*"
},
"type": [
{
"code": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-link"
}
]
},
{
"id": "syndication-entry.source",
"path": "syndication-entry.source",
"short": "originating feed metadata",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "syndication-entry.source",
"min": 0,
"max": "1"
},
"type": [
{
"code": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-feed-metadata"
}
]
},
{
"id": "syndication-entry.contentItemIdentifier",
"path": "syndication-entry.contentItemIdentifier",
"short": "version-independent canonical identifier",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "syndication-entry.contentItemIdentifier",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.contentItemVersion",
"path": "syndication-entry.contentItemVersion",
"short": "version-specific canonical identifier",
"definition": "`⟨ncts:contentItemVersion⟩`. Canonical, version-specific identifier for this exact release. MUST be unique per entry within a feed (two entries with the same `⟨ncts: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.",
"min": 1,
"max": "1",
"base": {
"path": "syndication-entry.contentItemVersion",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.fhirVersion",
"path": "syndication-entry.fhirVersion",
"short": "FHIR version the artefact targets",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "syndication-entry.fhirVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.fhirProfile",
"path": "syndication-entry.fhirProfile",
"short": "FHIR profile(s) the artefact conforms to",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "syndication-entry.fhirProfile",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.bundleInterpretation",
"path": "syndication-entry.bundleInterpretation",
"short": "publisher's view of a FHIR Bundle (batch | collection)",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "syndication-entry.bundleInterpretation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "syndication-entry.packageDependency",
"path": "syndication-entry.packageDependency",
"short": "SNOMED CT inter-package dependencies",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "syndication-entry.packageDependency",
"min": 0,
"max": "1"
},
"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-entry.packageDependency.id",
"path": "syndication-entry.packageDependency.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-entry.packageDependency.extension",
"path": "syndication-entry.packageDependency.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-entry.packageDependency.modifierExtension",
"path": "syndication-entry.packageDependency.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-entry.packageDependency.editionDependency",
"path": "syndication-entry.packageDependency.editionDependency",
"short": "versioned SNOMED CT URI of a required edition",
"definition": "`⟨sct:editionDependency⟩`. Versioned SNOMED CT URI of an edition this package depends on. Format `http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}`.",
"min": 0,
"max": "*",
"base": {
"path": "syndication-entry.packageDependency.editionDependency",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.packageDependency.derivativeDependency",
"path": "syndication-entry.packageDependency.derivativeDependency",
"short": "versioned SNOMED CT URI of a required derivative",
"definition": "`⟨sct:derivativeDependency⟩`. Versioned SNOMED CT URI of a derivative this package depends on.",
"min": 0,
"max": "*",
"base": {
"path": "syndication-entry.packageDependency.derivativeDependency",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.permission",
"path": "syndication-entry.permission",
"short": "authorisation tag gating access to this entry",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "syndication-entry.permission",
"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-entry.permission.id",
"path": "syndication-entry.permission.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-entry.permission.extension",
"path": "syndication-entry.permission.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-entry.permission.modifierExtension",
"path": "syndication-entry.permission.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-entry.permission.code",
"path": "syndication-entry.permission.code",
"short": "permission tag matched against requester's permissions",
"definition": "Permission tag. Compared against the set of permissions held by the requesting principal.",
"min": 1,
"max": "1",
"base": {
"path": "syndication-entry.permission.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"id": "syndication-entry",
"path": "syndication-entry",
"short": "Terminology Syndication Entry",
"definition": "An Atom `⟨entry⟩` (RFC 4287 §4.1.2) representing a single syndicated\nartefact set — for example an RF2 release package, a FHIR\nCodeSystem, a FHIR ValueSet, or a FHIR NPM package.\n\nAn entry combines the Atom 1.0 entry model with three extension\nnamespaces: NCTS ASF (terminology metadata), SNOMED CT (package\ndependencies, MD5 hashes), and Ontoserver (permissions, validation\nstate).\n\n## Cross-field semantics\n\nWhen an entry's artefact is a FHIR canonical resource (CodeSystem,\nValueSet, ConceptMap, NamingSystem, StructureDefinition, …):\n\n- `contentItemIdentifier` SHOULD equal the resource's `⟨url⟩`.\n- `contentItemVersion` SHOULD equal `{url}|{version}` (the canonical URL,\n a pipe, and the version).\n- `published` SHOULD equal the resource's `date`.\n- `title` SHOULD equal the resource's `title` where present, else `name`.\n- `rights` SHOULD reflect the resource's `copyright`.\n\nWhen the artefact is a SNOMED CT module:\n\n- `contentItemIdentifier` SHOULD be the unversioned SNOMED CT module URI\n (`http://snomed.info/sct/{moduleId}`).\n- `contentItemVersion` SHOULD be the versioned SNOMED CT URI\n (`http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}`).",
"constraint": [
{
"key": "entry-retract-no-alternate-link",
"severity": "error",
"human": "Retract entries (any category term ending '_RETRACT') MUST NOT carry a link with rel='alternate' — there is nothing to download.",
"expression": "category.where(term.endsWith('_RETRACT')).empty() or link.where(rel = 'alternate').empty()",
"source": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry"
},
{
"key": "entry-non-retract-has-link",
"severity": "error",
"human": "Non-retract entries MUST carry at least one link.",
"expression": "category.where(term.endsWith('_RETRACT')).exists() or link.exists()",
"source": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-entry"
}
]
},
{
"id": "syndication-entry.id",
"path": "syndication-entry.id",
"short": "permanent globally-unique entry identifier",
"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).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.title",
"path": "syndication-entry.title",
"short": "human-readable entry name",
"definition": "Atom `⟨title⟩` element. Human-readable entry name.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.summary",
"path": "syndication-entry.summary",
"short": "short description of the artefact",
"definition": "Atom `⟨summary⟩` element. Short description of the artefact's content and intended use.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.rights",
"path": "syndication-entry.rights",
"short": "copyright/licence statement",
"definition": "Atom `⟨rights⟩` element. Copyright/licence statement applicable to the artefact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.published",
"path": "syndication-entry.published",
"short": "instant the artefact set was first issued",
"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`.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "syndication-entry.updated",
"path": "syndication-entry.updated",
"short": "instant this entry last meaningfully changed",
"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`.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "syndication-entry.author",
"path": "syndication-entry.author",
"short": "party that produced the artefact",
"definition": "Atom `⟨author⟩` element. The party that produced the artefact.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "syndication-entry.author.name",
"path": "syndication-entry.author.name",
"short": "author display name",
"definition": "author display name",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.author.uri",
"path": "syndication-entry.author.uri",
"short": "author URI (typically organisation homepage)",
"definition": "author URI (typically organisation homepage)",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.author.email",
"path": "syndication-entry.author.email",
"short": "author contact email",
"definition": "author contact email",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.category",
"path": "syndication-entry.category",
"short": "category classifying this entry",
"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).",
"min": 1,
"max": "*",
"type": [
{
"code": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-category"
}
]
},
{
"id": "syndication-entry.link",
"path": "syndication-entry.link",
"short": "link to artefact or related document",
"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`.",
"min": 0,
"max": "*",
"type": [
{
"code": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-link"
}
]
},
{
"id": "syndication-entry.source",
"path": "syndication-entry.source",
"short": "originating feed metadata",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-feed-metadata"
}
]
},
{
"id": "syndication-entry.contentItemIdentifier",
"path": "syndication-entry.contentItemIdentifier",
"short": "version-independent canonical identifier",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.contentItemVersion",
"path": "syndication-entry.contentItemVersion",
"short": "version-specific canonical identifier",
"definition": "`⟨ncts:contentItemVersion⟩`. Canonical, version-specific identifier for this exact release. MUST be unique per entry within a feed (two entries with the same `⟨ncts: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.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.fhirVersion",
"path": "syndication-entry.fhirVersion",
"short": "FHIR version the artefact targets",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "syndication-entry.fhirProfile",
"path": "syndication-entry.fhirProfile",
"short": "FHIR profile(s) the artefact conforms to",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.bundleInterpretation",
"path": "syndication-entry.bundleInterpretation",
"short": "publisher's view of a FHIR Bundle (batch | collection)",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "syndication-entry.packageDependency",
"path": "syndication-entry.packageDependency",
"short": "SNOMED CT inter-package dependencies",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "syndication-entry.packageDependency.editionDependency",
"path": "syndication-entry.packageDependency.editionDependency",
"short": "versioned SNOMED CT URI of a required edition",
"definition": "`⟨sct:editionDependency⟩`. Versioned SNOMED CT URI of an edition this package depends on. Format `http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}`.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.packageDependency.derivativeDependency",
"path": "syndication-entry.packageDependency.derivativeDependency",
"short": "versioned SNOMED CT URI of a required derivative",
"definition": "`⟨sct:derivativeDependency⟩`. Versioned SNOMED CT URI of a derivative this package depends on.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"id": "syndication-entry.permission",
"path": "syndication-entry.permission",
"short": "authorisation tag gating access to this entry",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "syndication-entry.permission.code",
"path": "syndication-entry.permission.code",
"short": "permission tag matched against requester's permissions",
"definition": "Permission tag. Compared against the set of permissions held by the requesting principal.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}