SMART Base
0.2.0 - ci-build

SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base/tree/main and changes regularly. See the Directory of published versions

Logical Model: SUSHI Configuration Logical Model

Official URL: http://smart.who.int/base/StructureDefinition/SushiConfigLogicalModel Version: 0.2.0
Draft as of 2025-10-14 Computable Name: SushiConfigLogicalModel

Logical model defining the structure of sushi-config.yaml files used for FHIR Implementation Guide configuration. This model captures the essential metadata and configuration parameters needed for IG publishing.

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SushiConfigLogicalModel 0..* Base SUSHI Configuration Logical Model
... id 1..1 string IG Identifier
... canonical 1..1 url Canonical URL
... name 1..1 string IG Name
... description 1..1 string IG Description
... version 1..1 string IG Version
... status 1..1 code IG Status
Binding: PublicationStatus (required)
... license 1..1 code License
Binding: SPDXLicense (required)
... copyrightYear 0..1 string Copyright Year
... experimental 0..1 boolean Experimental
... releaseLabel 0..1 string Release Label
... publisher 1..1 BackboneElement Publisher
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
.... email 0..1 string Publisher Email
... fhirVersion 1..1 code FHIR Version
Binding: FHIRVersion (required)
... dependencies 0..* BackboneElement Dependencies
.... @id 1..1 string Dependency Package ID
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... version 1..1 string Dependency Version
.... reason 0..1 string Dependency Reason
... pages 0..* BackboneElement Pages
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... filename 1..1 string Page Filename
.... title 1..1 string Page Title
... menu 0..* BackboneElement Menu Structure
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... title 1..1 string Menu Title
.... url 1..1 string Menu URL
.... subItems 0..* BackboneElement Sub Menu Items
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Sub-item Title
..... url 1..1 string Sub-item URL
... resources 0..* BackboneElement Resource Definitions
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 1..1 string Resource Reference
.... name 0..1 string Resource Name
.... description 0..1 string Resource Description
.... exampleBoolean 0..1 boolean Is Example
.... exampleCanonical 0..1 canonical() Example Canonical
.... groupingId 0..1 string Grouping ID
... groups 0..* BackboneElement Resource Groups
.... @id 1..1 string Group ID
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Group Name
.... description 1..1 string Group Description
.... resources 0..* string Group Resources
... global 0..* BackboneElement Global Profiles
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 string Resource Type
.... profile 1..1 canonical() Profile URL
... meta 0..1 BackboneElement IG Metadata
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... profile 0..* canonical() Meta Profiles
... contact 0..* ContactDetail Contact Information
... useContext 0..* UsageContext Use Context
... jurisdiction 0..* CodeableConcept Jurisdiction
... FSHOnly 0..1 boolean FSH Only
... applyExtensionMetadataToRoot 0..1 boolean Apply Extension Metadata
... instanceOptions 0..1 BackboneElement Instance Options
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... setMetaProfile 0..1 code Set Meta Profile
.... setId 0..1 code Set ID

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SushiConfigLogicalModel.​status Base required PublicationStatus 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​license Base required SPDXLicense 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​fhirVersion Base required FHIRVersion 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

API Information

SUSHI Configuration Logical Model API

Logical model defining the structure of sushi-config.yaml files used for FHIR Implementation Guide configuration. This model captures the essential metadata and configuration parameters needed for IG publishing.

Version: 1.0.0

Endpoints

GET /StructureDefinition-SushiConfigLogicalModel.schema.json

JSON Schema definition for the Logical Model StructureDefinition-SushiConfigLogicalModel

This endpoint serves the JSON Schema definition for the Logical Model StructureDefinition-SushiConfigLogicalModel.

Schema Definition

StructureDefinition-SushiConfigLogicalModel

Description: Logical model defining the structure of sushi-config.yaml files used for FHIR Implementation Guide configuration. This model captures the essential metadata and configuration parameters needed for IG publishing.

Type: object

Schema ID: https://worldhealthorganization.github.io/smart-base/StructureDefinition-SushiConfigLogicalModel.schema.json

Properties

  • resourceType (string): Resource type identifier for SushiConfigLogicalModel logical model
  • @context (unknown): JSON-LD context for this logical model with ValueSet vocabularies
  • @type (string): JSON-LD type identifier for SushiConfigLogicalModel logical model
  • id (object): Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
  • canonical (string): Canonical URL for the IG, should match DAK publicationUrl (e.g., http://smart.who.int/trust)
  • name (string): Human-readable name for the group
  • title (string): Title of the sub-menu item
  • description (string): Description of the group
  • version (string): Version of the dependency
  • status (unknown): Publication status of the IG
  • license (unknown): License under which the IG is published, should match DAK license
  • copyrightYear (string): Year or year range for copyright, should match DAK
  • experimental (boolean): Whether this IG is experimental, should match DAK
  • releaseLabel (string): Label for this release (e.g., ci-build, draft, ballot)
  • publisher (object): Organization responsible for publishing the IG
  • modifierExtension (array): 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).
  • url (string): URL of the sub-menu item
  • email (string): Contact email for the publisher
  • fhirVersion (unknown): Version of FHIR this IG is built on
  • dependencies (array): Other IGs or packages this IG depends on
  • reason (string): Reason for this dependency
  • pages (array): Custom pages included in the IG
  • filename (string): Filename of the page (e.g., index.md)
  • menu (array): Navigation menu structure for the IG
  • subItems (array): Sub-menu items
  • resources (array): List of resources in this group
  • reference (string): Reference to the resource (used as YAML key)
  • exampleBoolean (boolean): Whether this resource is an example
  • exampleCanonical (string): Canonical URL this resource is an example of
  • groupingId (string): ID of the group this resource belongs to
  • groups (array): Logical groupings of resources in the IG
  • global (array): Global profile assignments
  • type (string): FHIR resource type
  • profile (array): Profiles this IG conforms to
  • meta (object): Additional metadata for the IG
  • contact (array): Contact details for this IG
  • useContext (array): Context where this IG is intended to be used
  • jurisdiction (array): Jurisdictions where this IG applies
  • FSHOnly (boolean): Whether to export only FSH resources without IG content
  • applyExtensionMetadataToRoot (boolean): Whether to apply extension metadata to root elements
  • instanceOptions (object): Configuration for instance processing
  • setMetaProfile (string): When to automatically set meta.profile
  • setId (string): When to automatically set id

Required fields: resourceType, id, canonical, name, title, description, version, status, license, publisher, name, fhirVersion, id, version, filename, title, title, url, title, url, reference, id, name, description, type, profile

Full Schema (JSON) 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-SushiConfigLogicalModel.schema.json",
  "title": "SUSHI Configuration Logical Model",
  "description": "Logical model defining the structure of sushi-config.yaml files used for FHIR Implementation Guide configuration. This model captures the essential metadata and configuration parameters needed for IG publishing.",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "SushiConfigLogicalModel",
      "description": "Resource type identifier for SushiConfigLogicalModel logical model"
    },
    "@context": {
      "description": "JSON-LD context for this logical model with ValueSet vocabularies",
      "anyOf": [
        {
          "type": "string",
          "format": "uri",
          "description": "URI reference to external JSON-LD context"
        },
        {
          "type": "object",
          "description": "Inline JSON-LD context",
          "properties": {
            "@version": {
              "type": "number",
              "const": 1.1
            },
            "fhir": {
              "type": "string",
              "const": "http://hl7.org/fhir/"
            }
          },
          "additionalProperties": {
            "type": "string",
            "format": "uri"
          }
        },
        {
          "type": "array",
          "description": "Array of JSON-LD context objects/URIs",
          "items": {
            "anyOf": [
              {
                "type": "string",
                "format": "uri"
              },
              {
                "type": "object"
              }
            ]
          }
        }
      ]
    },
    "@type": {
      "type": "string",
      "description": "JSON-LD type identifier for SushiConfigLogicalModel logical model",
      "examples": [
        "LogicalModel-SushiConfigLogicalModel"
      ]
    },
    "id": {
      "type": "object",
      "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."
    },
    "canonical": {
      "type": "string",
      "format": "uri",
      "description": "Canonical URL for the IG, should match DAK publicationUrl (e.g., http://smart.who.int/trust)"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the group"
    },
    "title": {
      "type": "string",
      "description": "Title of the sub-menu item"
    },
    "description": {
      "type": "string",
      "description": "Description of the group"
    },
    "version": {
      "type": "string",
      "description": "Version of the dependency"
    },
    "status": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet publication-status (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet publication-status (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-publication-status.jsonld",
              "description": "JSON-LD type reference to ValueSet publication-status"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet publication-status"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "Publication status of the IG"
    },
    "license": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet spdx-license (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet spdx-license (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-spdx-license.jsonld",
              "description": "JSON-LD type reference to ValueSet spdx-license"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet spdx-license"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "License under which the IG is published, should match DAK license"
    },
    "copyrightYear": {
      "type": "string",
      "description": "Year or year range for copyright, should match DAK"
    },
    "experimental": {
      "type": "boolean",
      "description": "Whether this IG is experimental, should match DAK"
    },
    "releaseLabel": {
      "type": "string",
      "description": "Label for this release (e.g., ci-build, draft, ballot)"
    },
    "publisher": {
      "type": "object",
      "description": "Organization responsible for publishing the IG"
    },
    "modifierExtension": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR Extension"
      },
      "description": "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)."
    },
    "url": {
      "type": "string",
      "description": "URL of the sub-menu item"
    },
    "email": {
      "type": "string",
      "description": "Contact email for the publisher"
    },
    "fhirVersion": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet FHIR-version (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet FHIR-version (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-FHIR-version.jsonld",
              "description": "JSON-LD type reference to ValueSet FHIR-version"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet FHIR-version"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "Version of FHIR this IG is built on"
    },
    "dependencies": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR BackboneElement"
      },
      "description": "Other IGs or packages this IG depends on"
    },
    "reason": {
      "type": "string",
      "description": "Reason for this dependency"
    },
    "pages": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR BackboneElement"
      },
      "description": "Custom pages included in the IG"
    },
    "filename": {
      "type": "string",
      "description": "Filename of the page (e.g., index.md)"
    },
    "menu": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR BackboneElement"
      },
      "description": "Navigation menu structure for the IG"
    },
    "subItems": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR BackboneElement"
      },
      "description": "Sub-menu items"
    },
    "resources": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of resources in this group"
    },
    "reference": {
      "type": "string",
      "description": "Reference to the resource (used as YAML key)"
    },
    "exampleBoolean": {
      "type": "boolean",
      "description": "Whether this resource is an example"
    },
    "exampleCanonical": {
      "type": "string",
      "format": "uri",
      "description": "Canonical URL this resource is an example of"
    },
    "groupingId": {
      "type": "string",
      "description": "ID of the group this resource belongs to"
    },
    "groups": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR BackboneElement"
      },
      "description": "Logical groupings of resources in the IG"
    },
    "global": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR BackboneElement"
      },
      "description": "Global profile assignments"
    },
    "type": {
      "type": "string",
      "description": "FHIR resource type"
    },
    "profile": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "Profiles this IG conforms to"
    },
    "meta": {
      "type": "object",
      "description": "Additional metadata for the IG"
    },
    "contact": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR ContactDetail"
      },
      "description": "Contact details for this IG"
    },
    "useContext": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR UsageContext"
      },
      "description": "Context where this IG is intended to be used"
    },
    "jurisdiction": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Jurisdictions where this IG applies"
    },
    "FSHOnly": {
      "type": "boolean",
      "description": "Whether to export only FSH resources without IG content"
    },
    "applyExtensionMetadataToRoot": {
      "type": "boolean",
      "description": "Whether to apply extension metadata to root elements"
    },
    "instanceOptions": {
      "type": "object",
      "description": "Configuration for instance processing"
    },
    "setMetaProfile": {
      "type": "string",
      "description": "When to automatically set meta.profile"
    },
    "setId": {
      "type": "string",
      "description": "When to automatically set id"
    }
  },
  "required": [
    "resourceType",
    "id",
    "canonical",
    "name",
    "title",
    "description",
    "version",
    "status",
    "license",
    "publisher",
    "name",
    "fhirVersion",
    "id",
    "version",
    "filename",
    "title",
    "title",
    "url",
    "title",
    "url",
    "reference",
    "id",
    "name",
    "description",
    "type",
    "profile"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/SushiConfigLogicalModel",
  "fhir:parent": "http://hl7.org/fhir/StructureDefinition/Base",
  "jsonld:valuesets": [
    "publication-status",
    "spdx-license",
    "FHIR-version"
  ],
  "jsonld:contextTemplate": {
    "@version": 1.1,
    "fhir": "http://hl7.org/fhir/",
    "publication-status": "http://smart.who.int/base/ValueSet-publication-status.jsonld",
    "spdx-license": "http://smart.who.int/base/ValueSet-spdx-license.jsonld",
    "FHIR-version": "http://smart.who.int/base/ValueSet-FHIR-version.jsonld"
  }
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SushiConfigLogicalModel 0..* Base SUSHI Configuration Logical Model
... id 1..1 string IG Identifier
... canonical 1..1 url Canonical URL
... name 1..1 string IG Name
... description 1..1 string IG Description
... version 1..1 string IG Version
... status 1..1 code IG Status
Binding: PublicationStatus (required)
... license 1..1 code License
Binding: SPDXLicense (required)
... copyrightYear 0..1 string Copyright Year
... experimental 0..1 boolean Experimental
... releaseLabel 0..1 string Release Label
... publisher 1..1 BackboneElement Publisher
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
.... email 0..1 string Publisher Email
... fhirVersion 1..1 code FHIR Version
Binding: FHIRVersion (required)
... dependencies 0..* BackboneElement Dependencies
.... @id 1..1 string Dependency Package ID
.... version 1..1 string Dependency Version
.... reason 0..1 string Dependency Reason
... pages 0..* BackboneElement Pages
.... filename 1..1 string Page Filename
.... title 1..1 string Page Title
... menu 0..* BackboneElement Menu Structure
.... title 1..1 string Menu Title
.... url 1..1 string Menu URL
.... subItems 0..* BackboneElement Sub Menu Items
..... title 1..1 string Sub-item Title
..... url 1..1 string Sub-item URL
... resources 0..* BackboneElement Resource Definitions
.... reference 1..1 string Resource Reference
.... name 0..1 string Resource Name
.... description 0..1 string Resource Description
.... exampleBoolean 0..1 boolean Is Example
.... exampleCanonical 0..1 canonical() Example Canonical
.... groupingId 0..1 string Grouping ID
... groups 0..* BackboneElement Resource Groups
.... @id 1..1 string Group ID
.... name 1..1 string Group Name
.... description 1..1 string Group Description
.... resources 0..* string Group Resources
... global 0..* BackboneElement Global Profiles
.... type 1..1 string Resource Type
.... profile 1..1 canonical() Profile URL
... meta 0..1 BackboneElement IG Metadata
.... profile 0..* canonical() Meta Profiles
... contact 0..* ContactDetail Contact Information
... useContext 0..* UsageContext Use Context
... jurisdiction 0..* CodeableConcept Jurisdiction
... FSHOnly 0..1 boolean FSH Only
... applyExtensionMetadataToRoot 0..1 boolean Apply Extension Metadata
... instanceOptions 0..1 BackboneElement Instance Options
.... setMetaProfile 0..1 code Set Meta Profile
.... setId 0..1 code Set ID

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SushiConfigLogicalModel.​status Base required PublicationStatus 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​license Base required SPDXLicense 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​fhirVersion Base required FHIRVersion 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SushiConfigLogicalModel 0..* Base SUSHI Configuration Logical Model
... id 1..1 string IG Identifier
... canonical 1..1 url Canonical URL
... name 1..1 string IG Name
... description 1..1 string IG Description
... version 1..1 string IG Version
... status 1..1 code IG Status
Binding: PublicationStatus (required)
... license 1..1 code License
Binding: SPDXLicense (required)
... copyrightYear 0..1 string Copyright Year
... experimental 0..1 boolean Experimental
... releaseLabel 0..1 string Release Label
... publisher 1..1 BackboneElement Publisher
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
.... email 0..1 string Publisher Email
... fhirVersion 1..1 code FHIR Version
Binding: FHIRVersion (required)
... dependencies 0..* BackboneElement Dependencies
.... @id 1..1 string Dependency Package ID
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... version 1..1 string Dependency Version
.... reason 0..1 string Dependency Reason
... pages 0..* BackboneElement Pages
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... filename 1..1 string Page Filename
.... title 1..1 string Page Title
... menu 0..* BackboneElement Menu Structure
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... title 1..1 string Menu Title
.... url 1..1 string Menu URL
.... subItems 0..* BackboneElement Sub Menu Items
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Sub-item Title
..... url 1..1 string Sub-item URL
... resources 0..* BackboneElement Resource Definitions
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 1..1 string Resource Reference
.... name 0..1 string Resource Name
.... description 0..1 string Resource Description
.... exampleBoolean 0..1 boolean Is Example
.... exampleCanonical 0..1 canonical() Example Canonical
.... groupingId 0..1 string Grouping ID
... groups 0..* BackboneElement Resource Groups
.... @id 1..1 string Group ID
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Group Name
.... description 1..1 string Group Description
.... resources 0..* string Group Resources
... global 0..* BackboneElement Global Profiles
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 string Resource Type
.... profile 1..1 canonical() Profile URL
... meta 0..1 BackboneElement IG Metadata
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... profile 0..* canonical() Meta Profiles
... contact 0..* ContactDetail Contact Information
... useContext 0..* UsageContext Use Context
... jurisdiction 0..* CodeableConcept Jurisdiction
... FSHOnly 0..1 boolean FSH Only
... applyExtensionMetadataToRoot 0..1 boolean Apply Extension Metadata
... instanceOptions 0..1 BackboneElement Instance Options
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... setMetaProfile 0..1 code Set Meta Profile
.... setId 0..1 code Set ID

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SushiConfigLogicalModel.​status Base required PublicationStatus 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​license Base required SPDXLicense 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​fhirVersion Base required FHIRVersion 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(25 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SushiConfigLogicalModel 0..* Base SUSHI Configuration Logical Model
... id 1..1 string IG Identifier
... canonical 1..1 url Canonical URL
... name 1..1 string IG Name
... description 1..1 string IG Description
... version 1..1 string IG Version
... status 1..1 code IG Status
Binding: PublicationStatus (required)
... license 1..1 code License
Binding: SPDXLicense (required)
... copyrightYear 0..1 string Copyright Year
... experimental 0..1 boolean Experimental
... releaseLabel 0..1 string Release Label
... publisher 1..1 BackboneElement Publisher
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
.... email 0..1 string Publisher Email
... fhirVersion 1..1 code FHIR Version
Binding: FHIRVersion (required)
... dependencies 0..* BackboneElement Dependencies
.... @id 1..1 string Dependency Package ID
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... version 1..1 string Dependency Version
.... reason 0..1 string Dependency Reason
... pages 0..* BackboneElement Pages
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... filename 1..1 string Page Filename
.... title 1..1 string Page Title
... menu 0..* BackboneElement Menu Structure
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... title 1..1 string Menu Title
.... url 1..1 string Menu URL
.... subItems 0..* BackboneElement Sub Menu Items
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Sub-item Title
..... url 1..1 string Sub-item URL
... resources 0..* BackboneElement Resource Definitions
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 1..1 string Resource Reference
.... name 0..1 string Resource Name
.... description 0..1 string Resource Description
.... exampleBoolean 0..1 boolean Is Example
.... exampleCanonical 0..1 canonical() Example Canonical
.... groupingId 0..1 string Grouping ID
... groups 0..* BackboneElement Resource Groups
.... @id 1..1 string Group ID
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Group Name
.... description 1..1 string Group Description
.... resources 0..* string Group Resources
... global 0..* BackboneElement Global Profiles
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 string Resource Type
.... profile 1..1 canonical() Profile URL
... meta 0..1 BackboneElement IG Metadata
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... profile 0..* canonical() Meta Profiles
... contact 0..* ContactDetail Contact Information
... useContext 0..* UsageContext Use Context
... jurisdiction 0..* CodeableConcept Jurisdiction
... FSHOnly 0..1 boolean FSH Only
... applyExtensionMetadataToRoot 0..1 boolean Apply Extension Metadata
... instanceOptions 0..1 BackboneElement Instance Options
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... setMetaProfile 0..1 code Set Meta Profile
.... setId 0..1 code Set ID

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SushiConfigLogicalModel.​status Base required PublicationStatus 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​license Base required SPDXLicense 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​fhirVersion Base required FHIRVersion 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SushiConfigLogicalModel 0..* Base SUSHI Configuration Logical Model
... id 1..1 string IG Identifier
... canonical 1..1 url Canonical URL
... name 1..1 string IG Name
... description 1..1 string IG Description
... version 1..1 string IG Version
... status 1..1 code IG Status
Binding: PublicationStatus (required)
... license 1..1 code License
Binding: SPDXLicense (required)
... copyrightYear 0..1 string Copyright Year
... experimental 0..1 boolean Experimental
... releaseLabel 0..1 string Release Label
... publisher 1..1 BackboneElement Publisher
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
.... email 0..1 string Publisher Email
... fhirVersion 1..1 code FHIR Version
Binding: FHIRVersion (required)
... dependencies 0..* BackboneElement Dependencies
.... @id 1..1 string Dependency Package ID
.... version 1..1 string Dependency Version
.... reason 0..1 string Dependency Reason
... pages 0..* BackboneElement Pages
.... filename 1..1 string Page Filename
.... title 1..1 string Page Title
... menu 0..* BackboneElement Menu Structure
.... title 1..1 string Menu Title
.... url 1..1 string Menu URL
.... subItems 0..* BackboneElement Sub Menu Items
..... title 1..1 string Sub-item Title
..... url 1..1 string Sub-item URL
... resources 0..* BackboneElement Resource Definitions
.... reference 1..1 string Resource Reference
.... name 0..1 string Resource Name
.... description 0..1 string Resource Description
.... exampleBoolean 0..1 boolean Is Example
.... exampleCanonical 0..1 canonical() Example Canonical
.... groupingId 0..1 string Grouping ID
... groups 0..* BackboneElement Resource Groups
.... @id 1..1 string Group ID
.... name 1..1 string Group Name
.... description 1..1 string Group Description
.... resources 0..* string Group Resources
... global 0..* BackboneElement Global Profiles
.... type 1..1 string Resource Type
.... profile 1..1 canonical() Profile URL
... meta 0..1 BackboneElement IG Metadata
.... profile 0..* canonical() Meta Profiles
... contact 0..* ContactDetail Contact Information
... useContext 0..* UsageContext Use Context
... jurisdiction 0..* CodeableConcept Jurisdiction
... FSHOnly 0..1 boolean FSH Only
... applyExtensionMetadataToRoot 0..1 boolean Apply Extension Metadata
... instanceOptions 0..1 BackboneElement Instance Options
.... setMetaProfile 0..1 code Set Meta Profile
.... setId 0..1 code Set ID

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SushiConfigLogicalModel.​status Base required PublicationStatus 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​license Base required SPDXLicense 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​fhirVersion Base required FHIRVersion 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SushiConfigLogicalModel 0..* Base SUSHI Configuration Logical Model
... id 1..1 string IG Identifier
... canonical 1..1 url Canonical URL
... name 1..1 string IG Name
... description 1..1 string IG Description
... version 1..1 string IG Version
... status 1..1 code IG Status
Binding: PublicationStatus (required)
... license 1..1 code License
Binding: SPDXLicense (required)
... copyrightYear 0..1 string Copyright Year
... experimental 0..1 boolean Experimental
... releaseLabel 0..1 string Release Label
... publisher 1..1 BackboneElement Publisher
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
.... email 0..1 string Publisher Email
... fhirVersion 1..1 code FHIR Version
Binding: FHIRVersion (required)
... dependencies 0..* BackboneElement Dependencies
.... @id 1..1 string Dependency Package ID
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... version 1..1 string Dependency Version
.... reason 0..1 string Dependency Reason
... pages 0..* BackboneElement Pages
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... filename 1..1 string Page Filename
.... title 1..1 string Page Title
... menu 0..* BackboneElement Menu Structure
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... title 1..1 string Menu Title
.... url 1..1 string Menu URL
.... subItems 0..* BackboneElement Sub Menu Items
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... title 1..1 string Sub-item Title
..... url 1..1 string Sub-item URL
... resources 0..* BackboneElement Resource Definitions
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 1..1 string Resource Reference
.... name 0..1 string Resource Name
.... description 0..1 string Resource Description
.... exampleBoolean 0..1 boolean Is Example
.... exampleCanonical 0..1 canonical() Example Canonical
.... groupingId 0..1 string Grouping ID
... groups 0..* BackboneElement Resource Groups
.... @id 1..1 string Group ID
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Group Name
.... description 1..1 string Group Description
.... resources 0..* string Group Resources
... global 0..* BackboneElement Global Profiles
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 string Resource Type
.... profile 1..1 canonical() Profile URL
... meta 0..1 BackboneElement IG Metadata
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... profile 0..* canonical() Meta Profiles
... contact 0..* ContactDetail Contact Information
... useContext 0..* UsageContext Use Context
... jurisdiction 0..* CodeableConcept Jurisdiction
... FSHOnly 0..1 boolean FSH Only
... applyExtensionMetadataToRoot 0..1 boolean Apply Extension Metadata
... instanceOptions 0..1 BackboneElement Instance Options
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... setMetaProfile 0..1 code Set Meta Profile
.... setId 0..1 code Set ID

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SushiConfigLogicalModel.​status Base required PublicationStatus 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​license Base required SPDXLicense 📦4.0.1 FHIR Std.
SushiConfigLogicalModel.​fhirVersion Base required FHIRVersion 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(25 nested mandatory elements)

 

Other representations of profile: CSV, Excel