Generated Narrative: StructureDefinition syndication-entry Name Flags Card. Type Description & Constraints <a href="StructureDefinition-syndication-entry-definitions.html#syndication-entry" title="An Atom `⟨entry⟩` (RFC 4287 §4.1.2) representing a single syndicated#xA;artefact set — for example an RF2 release package, a FHIR#xA;CodeSystem, a FHIR ValueSet, or a FHIR NPM package.#xA;#xA;An entry combines the Atom 1.0 entry model with three extension#xA;namespaces: NCTS ASF (terminology metadata), SNOMED CT (package#xA;dependencies, MD5 hashes), and Ontoserver (permissions, validation#xA;state).#xA;#xA;## Cross-field semantics#xA;#xA;When an entry's artefact is a FHIR canonical resource (CodeSystem,#xA;ValueSet, ConceptMap, NamingSystem, StructureDefinition, …):#xA;#xA;- `contentItemIdentifier` SHOULD equal the resource's `⟨url⟩`.#xA;- `contentItemVersion` SHOULD equal `{url}|{version}` (the canonical URL,#xA; a pipe, and the version).#xA;- `published` SHOULD equal the resource's `date`.#xA;- `title` SHOULD equal the resource's `title` where present, else `name`.#xA;- `rights` SHOULD reflect the resource's `copyright`.#xA;#xA;When the artefact is a SNOMED CT module:#xA;#xA;- `contentItemIdentifier` SHOULD be the unversioned SNOMED CT module URI#xA; (`http://snomed.info/sct/{moduleId}`).#xA;- `contentItemVersion` SHOULD be the versioned SNOMED CT URI#xA; (`http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}`).">syndication-entry <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( entry-retract-no-alternate-link, entry-non-retract-has-link )">C 0..* Base Terminology Syndication Entry Instances of this logical model can be the target of a Reference Constraints: entry-retract-no-alternate-link, entry-non-retract-has-link #xD; id 1..1 uri permanent globally-unique entry identifier #xD; title 1..1 string human-readable entry name #xD; summary 0..1 string short description of the artefact #xD; rights 0..1 string copyright/licence statement #xD; published 0..1 dateTime instant the artefact set was first issued #xD; updated 1..1 dateTime instant this entry last meaningfully changed #xD; author 0..* BackboneElement party that produced the artefact #xD; name 1..1 string author display name #xD; uri 0..1 uri author URI (typically organisation homepage) #xD; email 0..1 string author contact email #xD; category 1..* syndication-category category classifying this entry #xD; <a href="StructureDefinition-syndication-entry-definitions.html#syndication-entry.link" title="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`.">link 0..* syndication-link link to artefact or related document #xD; source 0..1 syndication-feed-metadata originating feed metadata #xD; contentItemIdentifier 1..1 uri version-independent canonical identifier #xD; <a href="StructureDefinition-syndication-entry-definitions.html#syndication-entry.contentItemVersion" title="`ncts:contentItemVersion`. Canonical, version-specific identifier for this exact release. MUST be unique per entry within a feed (two entries with the same `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.">contentItemVersion 1..1 uri version-specific canonical identifier #xD; fhirVersion 0..1 string FHIR version the artefact targets #xD; fhirProfile 0..* uri FHIR profile(s) the artefact conforms to #xD; <a href="StructureDefinition-syndication-entry-definitions.html#syndication-entry.bundleInterpretation" title="`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.">bundleInterpretation 0..1 code publisher's view of a FHIR Bundle (batch | collection) #xD; packageDependency 0..1 BackboneElement SNOMED CT inter-package dependencies #xD; editionDependency 0..* uri versioned SNOMED CT URI of a required edition #xD; derivativeDependency 0..* uri versioned SNOMED CT URI of a required derivative #xD; permission 0..* BackboneElement authorisation tag gating access to this entry #xD; code 1..1 string permission tag matched against requester's permissions #xD; Documentation for this format
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}`).
Retract entries (any category term ending '_RETRACT') MUST NOT carry a link with rel='alternate' — there is nothing to download.
category.where(term.endsWith('_RETRACT')).empty() or link.where(rel = 'alternate').empty()
Non-retract entries MUST carry at least one link.
category.where(term.endsWith('_RETRACT')).exists() or link.exists()
permanent globally-unique entry identifier
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).
Atom `⟨title⟩` element. Human-readable entry name.
Atom `⟨summary⟩` element. Short description of the artefact's content and intended use.
Atom `⟨rights⟩` element. Copyright/licence statement applicable to the artefact.
instant the artefact set was first issued
Atom `⟨published⟩` element. The instant the artefact set was first issued by its publisher. For FHIR canonical resources, SHOULD equal the resource's `date`.
instant this entry last meaningfully changed
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`.
Atom `⟨author⟩` element. The party that produced the artefact.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
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.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Extensions that cannot be ignored even if unrecognized
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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
author URI (typically organisation homepage)
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).
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`.
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.
version-independent canonical identifier
`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.
`ncts:contentItemVersion`. Canonical, version-specific identifier for this exact release. MUST be unique per entry within a feed (two entries with the same `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.
`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.
FHIR profile(s) the artefact conforms to
`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.
publisher's view of a FHIR Bundle (batch | collection)
`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.
`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.
versioned SNOMED CT URI of a required edition
`sct:editionDependency`. Versioned SNOMED CT URI of an edition this package depends on. Format `http://snomed.info/sct/{moduleId}/version/{YYYYMMDD}`.
versioned SNOMED CT URI of a required derivative
`sct:derivativeDependency`. Versioned SNOMED CT URI of a derivative this package depends on.
authorisation tag gating access to this entry
`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.
permission tag matched against requester's permissions
Permission tag. Compared against the set of permissions held by the requesting principal.