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

FHIR IG analytics

Packageaehrc.syndication
Resource TypeStructureDefinition
IdStructureDefinition-syndication-category.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/FHIR/fhir-syndication-ig/StructureDefinition-syndication-category.html
URLhttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-category
Version0.1.0
Statusdraft
Date2026-06-29T05:00:28+00:00
NameSyndicationCategory
TitleTerminology Syndication Category
Realmuv
DescriptionAn Atom `⟨category⟩` element classifying a syndication entry. The `scheme` URI identifies the controlled vocabulary; `term` is the machine code; `label` is the human-readable form. The binding of `term` depends on `scheme`: | `scheme` | `term` ValueSet | |----------------------------------------------------------------------------|---------------------------| | `http://ns.electronichealth.net.au/ncts/syndication/asf/scheme/1.0.0` | SyndicationContentTypeVS | | `http://ontoserver.csiro.au/syndication/rf2/1.0.0` | OntoserverRf2IndexVS | | `http://ontoserver.csiro.au/syndication/rf2/2.0.0` | OntoserverRf2IndexVS | | any other scheme | unconstrained | This conditional rule is enforced by the `category-term-scheme-binding` invariant. Slicing would be a more natural FHIR-level expression, but slice declarations are not supported on Logical models.
Typehttps://ontoserver.csiro.au/syndication/StructureDefinition/syndication-category
Kindlogical

Resources that use this resource

StructureDefinition
aehrc.syndication#currentsyndication-entryTerminology Syndication Entry

Resources that this resource uses

ValueSet
aehrc.syndication#currentsyndication-content-typeTerminology Syndication Content Type Value Set

Narrative

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

Generated Narrative: StructureDefinition syndication-category

NameFlagsCard.TypeDescription & Constraintsdoco
.. syndication-category C0..*BaseTerminology Syndication Category
Instances of this type can be the target of a Reference
Constraints: category-term-scheme-binding
... term 1..1codemachine-readable code from the scheme
Binding: Terminology Syndication Content Type Value Set (example)
... scheme 1..1uricontrolled vocabulary the term comes from
... label 0..1stringhuman-readable label for the term

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "syndication-category",
  "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-category",
  "version": "0.1.0",
  "name": "SyndicationCategory",
  "title": "Terminology Syndication Category",
  "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 `⟨category⟩` element classifying a syndication entry. The\n`scheme` URI identifies the controlled vocabulary; `term` is the\nmachine code; `label` is the human-readable form.\n\nThe binding of `term` depends on `scheme`:\n\n| `scheme`                                                                   | `term` ValueSet           |\n|----------------------------------------------------------------------------|---------------------------|\n| `http://ns.electronichealth.net.au/ncts/syndication/asf/scheme/1.0.0`      | SyndicationContentTypeVS  |\n| `http://ontoserver.csiro.au/syndication/rf2/1.0.0`                         | OntoserverRf2IndexVS      |\n| `http://ontoserver.csiro.au/syndication/rf2/2.0.0`                         | OntoserverRf2IndexVS      |\n| any other scheme                                                            | unconstrained             |\n\nThis conditional rule is enforced by the `category-term-scheme-binding`\ninvariant. Slicing would be a more natural FHIR-level expression, but\nslice declarations are not supported on Logical models.",
  "fhirVersion": "4.0.1",
  "kind": "logical",
  "abstract": false,
  "type": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-category",
  "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-category",
        "path": "syndication-category",
        "short": "Terminology Syndication Category",
        "definition": "An Atom `⟨category⟩` element classifying a syndication entry. The\n`scheme` URI identifies the controlled vocabulary; `term` is the\nmachine code; `label` is the human-readable form.\n\nThe binding of `term` depends on `scheme`:\n\n| `scheme`                                                                   | `term` ValueSet           |\n|----------------------------------------------------------------------------|---------------------------|\n| `http://ns.electronichealth.net.au/ncts/syndication/asf/scheme/1.0.0`      | SyndicationContentTypeVS  |\n| `http://ontoserver.csiro.au/syndication/rf2/1.0.0`                         | OntoserverRf2IndexVS      |\n| `http://ontoserver.csiro.au/syndication/rf2/2.0.0`                         | OntoserverRf2IndexVS      |\n| any other scheme                                                            | unconstrained             |\n\nThis conditional rule is enforced by the `category-term-scheme-binding`\ninvariant. Slicing would be a more natural FHIR-level expression, but\nslice declarations are not supported on Logical models.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "category-term-scheme-binding",
            "severity": "error",
            "human": "When scheme is one of the schemes registered in this IG, term MUST be drawn from that scheme's ValueSet: NCTS ASF (`…/asf/scheme/1.0.0`) → SyndicationContentTypeVS; Ontoserver RF2 binary-index (`…/rf2/1.0.0` or `…/rf2/2.0.0`) → OntoserverRf2IndexVS. Other schemes are unconstrained.",
            "expression": "(scheme != 'http://ns.electronichealth.net.au/ncts/syndication/asf/scheme/1.0.0' or term.memberOf('https://ontoserver.csiro.au/syndication/ValueSet/syndication-content-type')) and (scheme != 'http://ontoserver.csiro.au/syndication/rf2/1.0.0' or term.memberOf('https://ontoserver.csiro.au/syndication/ValueSet/ontoserver-rf2-index')) and (scheme != 'http://ontoserver.csiro.au/syndication/rf2/2.0.0' or term.memberOf('https://ontoserver.csiro.au/syndication/ValueSet/ontoserver-rf2-index'))",
            "source": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-category"
          }
        ],
        "isModifier": false
      },
      {
        "id": "syndication-category.term",
        "path": "syndication-category.term",
        "short": "machine-readable code from the scheme",
        "definition": "Category term — machine-readable code from the scheme. The applicable ValueSet depends on `scheme`; the example binding below is the NCTS ASF ValueSet, the most common case. See `category-term-scheme-binding`.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "syndication-category.term",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "https://ontoserver.csiro.au/syndication/ValueSet/syndication-content-type"
        }
      },
      {
        "id": "syndication-category.scheme",
        "path": "syndication-category.scheme",
        "short": "controlled vocabulary the term comes from",
        "definition": "Category scheme — the controlled vocabulary the term comes from.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "syndication-category.scheme",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "syndication-category.label",
        "path": "syndication-category.label",
        "short": "human-readable label for the term",
        "definition": "human-readable label for the term",
        "min": 0,
        "max": "1",
        "base": {
          "path": "syndication-category.label",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "syndication-category",
        "path": "syndication-category",
        "short": "Terminology Syndication Category",
        "definition": "An Atom `⟨category⟩` element classifying a syndication entry. The\n`scheme` URI identifies the controlled vocabulary; `term` is the\nmachine code; `label` is the human-readable form.\n\nThe binding of `term` depends on `scheme`:\n\n| `scheme`                                                                   | `term` ValueSet           |\n|----------------------------------------------------------------------------|---------------------------|\n| `http://ns.electronichealth.net.au/ncts/syndication/asf/scheme/1.0.0`      | SyndicationContentTypeVS  |\n| `http://ontoserver.csiro.au/syndication/rf2/1.0.0`                         | OntoserverRf2IndexVS      |\n| `http://ontoserver.csiro.au/syndication/rf2/2.0.0`                         | OntoserverRf2IndexVS      |\n| any other scheme                                                            | unconstrained             |\n\nThis conditional rule is enforced by the `category-term-scheme-binding`\ninvariant. Slicing would be a more natural FHIR-level expression, but\nslice declarations are not supported on Logical models.",
        "constraint": [
          {
            "key": "category-term-scheme-binding",
            "severity": "error",
            "human": "When scheme is one of the schemes registered in this IG, term MUST be drawn from that scheme's ValueSet: NCTS ASF (`…/asf/scheme/1.0.0`) → SyndicationContentTypeVS; Ontoserver RF2 binary-index (`…/rf2/1.0.0` or `…/rf2/2.0.0`) → OntoserverRf2IndexVS. Other schemes are unconstrained.",
            "expression": "(scheme != 'http://ns.electronichealth.net.au/ncts/syndication/asf/scheme/1.0.0' or term.memberOf('https://ontoserver.csiro.au/syndication/ValueSet/syndication-content-type')) and (scheme != 'http://ontoserver.csiro.au/syndication/rf2/1.0.0' or term.memberOf('https://ontoserver.csiro.au/syndication/ValueSet/ontoserver-rf2-index')) and (scheme != 'http://ontoserver.csiro.au/syndication/rf2/2.0.0' or term.memberOf('https://ontoserver.csiro.au/syndication/ValueSet/ontoserver-rf2-index'))",
            "source": "https://ontoserver.csiro.au/syndication/StructureDefinition/syndication-category"
          }
        ]
      },
      {
        "id": "syndication-category.term",
        "path": "syndication-category.term",
        "short": "machine-readable code from the scheme",
        "definition": "Category term — machine-readable code from the scheme. The applicable ValueSet depends on `scheme`; the example binding below is the NCTS ASF ValueSet, the most common case. See `category-term-scheme-binding`.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "example",
          "valueSet": "https://ontoserver.csiro.au/syndication/ValueSet/syndication-content-type"
        }
      },
      {
        "id": "syndication-category.scheme",
        "path": "syndication-category.scheme",
        "short": "controlled vocabulary the term comes from",
        "definition": "Category scheme — the controlled vocabulary the term comes from.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "syndication-category.label",
        "path": "syndication-category.label",
        "short": "human-readable label for the term",
        "definition": "human-readable label for the term",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  }
}