FHIR Chat · SUSHI Configuration · shorthand

# This IG YML file is inspired by the ImplementationGuide resource
# and also draws from package.json, package-list.json, and ig.ini.
# That said, it is structured for ease-of-use, so it is not strictly
# conformant to any of those existing configuration formats.

# SUSHI will use id as both id and packageId in the IG unless a
# specific packageId is also provided in this file.
id: fhir.us.mcode
url: http://hl7.org/fhir/us/mcode
name: mCODE IG
title: "HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1"
description: mCODE™ (short for Minimal Common Oncology Data Elements) is an initiative intended to assemble a core set of structured data elements for oncology electronic health records.
status: active
license: CC0-1.0
date: 2020-02-26
version: 1.0.0

# Although fhirVersions is 0..* in the ImplementationGuide resource
# it can be a single item OR and array here (but so far SUSHI only
# support 4.0.1 anyway).
fhirVersion: 4.0.1

# The template property will be copied into the ig.ini file.
# If the value of template is "none", then only the resources will be
# generated (with no supporting ImplementationGuide sources).
template: hl7.fhir.template#0.0.5

# The following two lines correspond to items that used to be in
# ig.ini but were recently moved to IG.definition.parameter. For
# consistency within this file, the names are represented using
# camelcase, but if authors use the formal parameter names, SUSHI
# will recognize them as well. In either case, they'll be copied
# to the IG JSON using the formal names.
copyrightYear: 2019+
releaseLabel: STU1

# The publisher can be a single item or a list, each with a name and
# optional url and/or email. The first publisher's name will be used
# as IG.publisher.  The contact details and/or additional publishers
# will be translated into IG.contact values.
publisher:
  name: HL7 International Clinical Interoperability Council
  url: http://www.hl7.org/Special/committees/cic
  email: ciclist@lists.HL7.org

# 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.  E.g.,
#   contact:
#   - name: Bob Smith
#     - telecom:
#         system: email
#         value: bobsmith@example.org
#         use: work

# The jurisdiction can be a single item or a list. The FHIR Shorthand
# code syntax can be used here.
jurisdiction: urn:iso:std:iso:3166#US "United States of America"

# The dependencies property corresponds to IG.dependsOn. They key is the
# package id and the value is the version (or dev/current).
dependencies:
  hl7.fhir.us.core: 3.1.0

# 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.
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 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
#   * specify "omit" to omit a FSH-generated resource from the
#     resource list.
#   * 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:
resources:
  Patient/my-example-patient:
    name: My Example Patient
    description: An example Patient
    exampleBoolean: true
  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.
groups:
  GroupA:
    description: The Alpha Group
    resources:
    - StructureDefinition/animal-patient
    - StructureDefinition/arm-procedure
  GroupB:
    description: The Beta Group
    resources:
    - StructureDefinition/bark-control
    - StructureDefinition/bee-sting

# 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: mCODE Home
  implementation.xml:
  examples.xml:
    title: Examples Overview
    simpleExamples.xml:
    complexExamples.xml:

# The menu property will be used to generate the input/menu.xml file.
# The menu is represented as a simple structure where the YAML key
# is the menu item name and the value is the URL. The IG publisher
# currently only supports one level deep on sub-menus.
# TO CONSIDER: If no menu data is provided, can we generate the menu
# based on the pages order or should we just generate a very standard
# menu (since there may be too many pages to fit in a menu).
menu:
  Home: index.html
  Artifacts:
    Profiles: artifacts.html#2
    Extensions: artifacts.html#3
    Value Sets: artifacts.html#4
  Downloads: downloads.html
  History: http://hl7.org/fhir/us/mcode/history.html

# 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 a
# partial list of allowed parameters see:
# https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters
parameters:
  excludettl: true
  validation: [allow-any-extensions, no-broken-links]

# The history property corresponds to package-list.json. SUSHI will
# use the existing top-level properties in its config to populate the
# top-level package-list.json properties: packageId, canonical, title,
# and introduction. Authors that wish to provide different values can
# supply them as properties under history. All other properties under
# history are assumed to be versions.
history:
  # The current version is special. If the author provides only a
  # single value, it is assumed to be the URL path to the current
  # build. The following default values will then be used:
  #   desc: Continuous Integration Build (latest in version control)
  #   status: ci-build
  #   current: true
  current: http://build.fhir.org/ig/HL7/fhir-mCODE-ig/
  # All other versions need each of their values fully specified.
  # See: https://confluence.hl7.org/pages/viewpage.action?pageId=66928420#FHIRIGPackageListdoco-PublicationObject
  1.0.0:
    fhirversion: 4.0.1
    date: 2020-03-06
    desc: STU 1 Release
    path: https://hl7.org/fhir/us/mcode/STU1/
    status: trial-use
    sequence: STU 1
    current: true
  0.9.1:
    fhirversion: 4.0.0
    date: 2019-06-10
    desc: Initial STU ballot (Sep 2019 Ballot)
    path: https://hl7.org/fhir/us/mcode/2019Sep/
    status: ballot
    sequence: STU 1

# 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:
# * experimental
# * useContext
# * copyright
# * definition.template (but use a top-level "templates" property)

resources:
  Patient/my-example-patient:
    name: My Example Patient
    description: An example Patient
    exampleBoolean: true
    extension:
      http://clinfhir.com/StructureDefinition/igEntryType: logical

  Patient/my-nextexample-patient:
    name: My Example Patient
    description: An example Patient
    exampleBoolean: true

resources:
  Patient/my-example-patient:
    extension:
      http://clinfhir.com/StructureDefinition/igEntryType: logical

{
 "name": "myproject",
 "version" : "0.1.0",
 "canonical" : "http://example.org/fhir/myproject",
 "url" : "http://example.org/fhir/myproject",
 "title" : "My Project",
 "description": "A description of my project",
 "dependencies": {
    "hl7.fhir.r4.core": "4.0.1",
    "hl7.fhir.us.core": "3.1.0"
 },
 "author": "Cameron Cod",
 "maintainers": [
   {
     "name": "Cod Fans",
     "url": "http://example.org/codfans"
   }
 ],
 "license": "CC0-1.0"
}