sushi-config.yaml

# ╭─────────────────────────Commonly Used ImplementationGuide Properties───────────────────────────╮
# │  The properties below are used to create the ImplementationGuide resource. The most commonly   │
# │  used properties are included. For a list of all supported properties and their functions,     │
# │  see: https://fshschool.org/docs/sushi/configuration/.                                         │
# ╰────────────────────────────────────────────────────────────────────────────────────────────────╯
id: hl7.fhir.uv.oo-incubator
canonical: http://hl7.org/fhir/uv/oo-incubator
packageId: hl7.fhir.uv.oo-incubator
url: http://hl7.org/fhir/uv/oo-incubator/ImplementationGuide/hl7.fhir.uv.oo-incubator
name: OOIncubatorImplementationGuide
title: OO Incubator Implementation Guide
# description: Example Implementation Guide for getting started with SUSHI
status: active # draft | active | retired | unknown
version: 0.1.0
fhirVersion: 6.0.0-ballot3 # https://www.hl7.org/fhir/valueset-FHIR-version.html
copyrightYear: 2026+
releaseLabel: ci-build
license: CC0-1.0 # https://www.hl7.org/fhir/valueset-spdx-license.html
jurisdiction: http://unstats.un.org/unsd/methods/m49/m49.htm#001 # https://www.hl7.org/fhir/valueset-jurisdiction.html
publisher:
  name: HL7 International / Orders and Observations 
contact:
  - name: HL7 Orders and Observations Workgroup
    telecom:
      - system: url
        value: http://www.hl7.org/Special/committees/orders
      - system: email
        value: ord@lists.HL7.org
extension:
  - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    valueCode: trial-use
  - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
    valueInteger: 1
  - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    valueCode: oo

# The dependencies property corresponds to IG.dependsOn. The key is the
# package id and the value is the version (or dev/current). For advanced
# use cases, the value can be an object with keys for id, uri, and version.
#
# dependencies:
#   hl7.fhir.us.core: 3.1.0
#   hl7.fhir.us.mcode:
#     id: mcode
#     uri: http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode
#     version: 1.0.0
#
#
# The pages property corresponds to IG.definition.page. SUSHI can
# auto-generate the page list, but if the author includes pages in
# this file, it is assumed that the author will fully manage the
# pages section and SUSHI will not generate any page entries.
# The page file name is used as the key. If title is not provided,
# then the title will be generated from the file name.  If a
# generation value is not provided, it will be inferred from the
# file name extension.  Any subproperties that are valid filenames
# with supported extensions (e.g., .md/.xml) will be treated as
# sub-pages.
#
#  pages:
#   index.md:
#     title: Example Home
#   implementation.xml:
#   examples.xml:
#     title: Examples Overview
#     simpleExamples.xml:
#     complexExamples.xml:
#
#
# The parameters property represents IG.definition.parameter. Rather
# than a list of code/value pairs (as in the ImplementationGuide
# resource), the code is the YAML key. If a parameter allows repeating
# values, the value in the YAML should be a sequence/array.
# For parameters defined by core FHIR see:
# http://build.fhir.org/codesystem-guide-parameter-code.html
# For parameters defined by the FHIR Tools IG see:
# http://build.fhir.org/ig/FHIR/fhir-tools-ig/branches/master/CodeSystem-ig-parameters.html
#

parameters:
  apply-publisher: true
  shownav: false
  default-version: true
  special-url-base: http://hl7.org/fhir
  pin-canonicals: pin-multiples
  path-history:
    - http://hl7.org/fhir/uv/oo-incubator/history.html
    
  path-resource:
    - input/resources/transport
    - input/resources/biologicallyderivedproductdispense
    - input/resources/devicedispense
    - input/resources/deviceusage
    - input/resources/inventoryitem
    - input/resources/inventoryreport
    - input/resources/supplydelivery
    - input/resources/supplyrequest

# Need to explicitly include the structure definitions as an additional-resource
# otherwise you get an ambiguous type error. It is possible this is caused by 
# FHIR Core 6.0.0-ballot3 still containing the resources, meaning in a future 
# release we could potentially eliminate this configuration.
  additional-resource:
    - input/resources/transport/StructureDefinition-Transport.xml
    - input/resources/biologicallyderivedproductdispense/StructureDefinition-BiologicallyDerivedProductDispense.xml
    - input/resources/devicedispense/StructureDefinition-DeviceDispense.xml
    - input/resources/deviceusage/StructureDefinition-DeviceUsage.xml
    - input/resources/inventoryitem/StructureDefinition-InventoryItem.xml
    - input/resources/inventoryreport/StructureDefinition-InventoryReport.xml
    - input/resources/supplydelivery/StructureDefinition-SupplyDelivery.xml
    - input/resources/supplyrequest/StructureDefinition-SupplyRequest.xml
    
# Need to include specific reference to the resource examples otherwise 
# they do not end up on the Examples tab on the resource page
resources:
  BiologicallyDerivedProductDispense/example:
    name: BiologicallyDerivedProductDispense example
    description: An example BiologicallyDerivedProductDispense resource
    exampleCanonical: http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProductDispense
  DeviceDispense/example:
    name: DeviceDispense example
    description: An example DeviceDispense resource
    exampleCanonical: http://hl7.org/fhir/StructureDefinition/DeviceDispense
  DeviceUsage/example:
    name: DeviceUsage example
    description: An example DeviceUsage resource
    exampleCanonical: http://hl7.org/fhir/StructureDefinition/DeviceUsage
  InventoryItem/example:
    name: InventoryItem example
    description: An example InventoryItem resource
    exampleCanonical: http://hl7.org/fhir/StructureDefinition/InventoryItem
  InventoryReport/example:
    name: InventoryReport example
    description: An example InventoryReport resource
    exampleCanonical: http://hl7.org/fhir/StructureDefinition/InventoryReport
  Transport/simpledelivery:
    name: Transport simple delivery example
    description: An example Transport resource for a simple delivery
    exampleCanonical: http://hl7.org/fhir/StructureDefinition/Transport
  SupplyDelivery/simpledelivery:
    name: SupplyDelivery simple delivery example
    description: An example SupplyDelivery resource for a simple delivery
    exampleCanonical: http://hl7.org/fhir/StructureDefinition/SupplyDelivery
  SupplyDelivery/mphodelivery:
    name: SupplyDelivery blood product delivery example
    description: An example SupplyDelivery resource for a blood product delivery
    exampleCanonical: http://hl7.org/fhir/StructureDefinition/SupplyDelivery
  SupplyDelivery/ISBT128:
    name: SupplyDelivery blood product delivery (ISBT128) example
    description: An example SupplyDelivery resource for a blood product (ISBT128) delivery
    exampleCanonical: http://hl7.org/fhir/StructureDefinition/SupplyDelivery
  SupplyDelivery/pumpdelivery:
    name: SupplyDelivery pump delivery example
    description: An example SupplyDelivery resource for a pump delivery
    exampleCanonical: http://hl7.org/fhir/StructureDefinition/SupplyDelivery
  SupplyRequest/simpleorder:
    name: SupplyRequest simple order example
    description: An example SupplyRequest resource for a simple order
    exampleCanonical: http://hl7.org/fhir/StructureDefinition/SupplyRequest
    
menu:
  Home: index.html
  Resources:
    Transport: StructureDefinition-Transport.html
    BiologicallyDerivedProductDispense: StructureDefinition-BiologicallyDerivedProductDispense.html
    DeviceDispense: StructureDefinition-DeviceDispense.html
    DeviceUsage: StructureDefinition-DeviceUsage.html
    InventoryItem: StructureDefinition-InventoryItem.html
    InventoryReport: StructureDefinition-InventoryReport.html
    SupplyDelivery: StructureDefinition-SupplyDelivery.html
    SupplyRequest: StructureDefinition-SupplyRequest.html
  Profiles:
    MedicalProductsOfHumanOrigin: StructureDefinition-medicalproductofhumanorigin.html
  FHIR Artifacts:
    Artifacts: artifacts.html
    Change Log: changes.html
    Still To Do: todo.html

pages:
  index.md:
    title: IG Home
  changes.md:
    title: Change Log
  todo.md:
    title: Still To Do

# ╭───────────────────────────Less Common Implementation Guide Properties──────────────────────────╮
# │  Uncomment the properties below to configure additional properties on the ImplementationGuide  │
# │  resource. These properties are less commonly needed than those above.                         │
# ╰────────────────────────────────────────────────────────────────────────────────────────────────╯
#
# Those who need more control or want to add additional details to the contact values can use
# contact directly and follow the format outlined in the ImplementationGuide resource and
# ContactDetail.
#
# contact:
#   - name: Bob Smith
#     telecom:
#       - system: email # phone | fax | email | pager | url | sms | other
#         value: bobsmith@example.org
#         use: work
#
#
# The global property corresponds to the IG.global property, but it
# uses the type as the YAML key and the profile as its value. Since
# FHIR does not explicitly disallow more than one profile per type,
# neither do we; the value can be a single profile URL or an array
# of profile URLs. If a value is an id or name, SUSHI will replace
# it with the correct canonical when generating the IG JSON.
#
# global:
#   Patient: http://example.org/fhir/StructureDefinition/my-patient-profile
#   Encounter: http://example.org/fhir/StructureDefinition/my-encounter-profile
#
#
# The resources property corresponds to IG.definition.resource.
# SUSHI can auto-generate all of the resource entries based on
# the FSH definitions and/or information in any user-provided
# JSON or XML resource files. If the generated entries are not
# sufficient or complete, however, the author can add entries
# here. If the reference matches a generated entry, it will
# replace the generated entry. If it doesn't match any generated
# entries, it will be added to the generated entries. The format
# follows IG.definition.resource with the following differences:
#   * use IG.definition.resource.reference.reference as the YAML key.
#   * if the key is an id or name, SUSHI will replace it with the
#     correct URL when generating the IG JSON.
#   * specify "omit" to omit a FSH-generated resource from the
#     resource list.
#   * if the exampleCanonical is an id or name, SUSHI will replace
#     it with the correct canonical when generating the IG JSON.
#   * groupingId can be used, but top-level groups syntax may be a
#     better option (see below).
# The following are simple examples to demonstrate what this might
# look like:
#
#   Patient/bad-example: omit
#
#
# Groups can control certain aspects of the IG generation.  The IG
# documentation recommends that authors use the default groups that
# are provided by the templating framework, but if authors want to
# use their own instead, they can use the mechanism below.  This will
# create IG.definition.grouping entries and associate the individual
# resource entries with the corresponding groupIds. If a resource
# is specified by id or name, SUSHI will replace it with the correct
# URL when generating the IG JSON.
#
# groups:
#   GroupA:
#     name: Group A
#     description: The Alpha Group
#     resources:
#     - StructureDefinition/animal-patient
#     - StructureDefinition/arm-procedure
#   GroupB:
#     name: Group B
#     description: The Beta Group
#     resources:
#     - StructureDefinition/bark-control
#     - StructureDefinition/bee-sting
#
#
# The ImplementationGuide resource defines several other properties
# not represented above. These properties can be used as-is and
# should follow the format defined in ImplementationGuide:
# * date
# * meta
# * implicitRules
# * language
# * text
# * contained
# * extension
# * modifierExtension
# * experimental
# * useContext
# * copyright
# * packageId
#
#
# ╭──────────────────────────────────────────SUSHI flags───────────────────────────────────────────╮
# │  The flags below configure aspects of how SUSHI processes FSH.                                 │
# ╰────────────────────────────────────────────────────────────────────────────────────────────────╯
# The FSHOnly flag indicates if only FSH resources should be exported.
# If set to true, no IG related content will be generated.
# The default value for this property is false.
#
# FSHOnly: false
#
#
# When set to true, the "short" and "definition" field on the root element of an Extension will
# be set to the "Title" and "Description" of that Extension. Default is true.
#
# applyExtensionMetadataToRoot: true
#
#
# The instanceOptions property is used to configure certain aspects of how SUSHI processes instances.
# See the individual option definitions below for more detail.
#
instanceOptions:
  # When set to true, slices must be referred to by name and not only by a numeric index in order to be used
  # in an Instance's assignment rule. All slices appear in the order in which they are specified in FSH rules.
  # While SUSHI defaults to false for legacy reasons, manualSliceOrding is recommended for new projects.
  manualSliceOrdering: true # true | false
  # Determines for which types of Instances SUSHI will automatically set meta.profile
  # if InstanceOf references a profile:
  #
  # setMetaProfile: always # always | never | inline-only | standalone-only
  #
  #
  # Determines for which types of Instances SUSHI will automatically set id
  # if InstanceOf references a profile:
  #
  # setId: always # always | standalone-only