<<<<<<< HEAD # ╭─────────────────────────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: fhir.hivig canonical: http://localhost name: HIV-IG # title: Example Title # description: Example Implementation Guide for getting started with SUSHI status: draft # draft | active | retired | unknown version: 0.1.0 fhirVersion: 4.0.1 # https://www.hl7.org/fhir/valueset-FHIR-version.html copyrightYear: 2025+ releaseLabel: ci-build # license: CC0-1.0 # https://www.hl7.org/fhir/valueset-spdx-license.html # jurisdiction: urn:iso:std:iso:3166#US "United States of America" # https://www.hl7.org/fhir/valueset-jurisdiction.html publisher: name: hivig publisher url: http://example.org/example-publisher # email: test@example.org # 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: # excludettl: true # validation: [allow-any-extensions, no-broken-links] # # ╭────────────────────────────────────────────menu.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 provide a │ # │ custom menu.xml file, do not include this property and include a `menu.xml` file in │ # │ input/includes. To use a provided input/includes/menu.xml file, delete the "menu" │ # │ property below. │ # ╰────────────────────────────────────────────────────────────────────────────────────────────────╯ menu: Home: index.html Artifacts: artifacts.html ======= id: smart.who.int.ig-empty canonical: http://smart.who.int/ig-empty name: IGEmpty title: Empty IG description: An empty Implementation Guide to be used as a starting point for building SMART Guidelines Implementation Guides status: draft # draft | active | retired | unknown experimental: false version: 0.1.0 fhirVersion: 4.0.1 # https://www.hl7.org/fhir/valueset-FHIR-version.html #fhirVersion: 4.3.0 # https://www.hl7.org/fhir/valueset-FHIR-version.html copyrightYear: 2023+ releaseLabel: ci-build # ci-build | draft | qa-preview | ballot | trial-use | release | update | normative+trial-use license: CC-BY-SA-3.0-IGO # https://www.hl7.org/fhir/valueset-spdx-license.html jurisdiction: http://unstats.un.org/unsd/methods/m49/m49.htm#001 "World" # https://www.hl7.org/fhir/valueset-jurisdiction.html publisher: name: WHO url: http://who.int # email: test@example.org dependencies: # hl7.fhir.core: # id: r4b # version: 4.6.0 # reason: | # This IG leverages subscription constructs pre-adopted from R4B. Importing this IG makes the relevant terminologies available. # NOTE: These dependencies are required because SUSHI doesn't load transitive dependencies # See the zulip thread here: https://chat.fhir.org/#narrow/stream/215610-shorthand/search/transitive hl7.terminology: 5.5.0 hl7.fhir.uv.extensions.r4: 5.1.0 hl7.fhir.uv.cql: 1.0.0 hl7.fhir.uv.crmi: 1.0.0 hl7.fhir.uv.sdc: 3.0.0 hl7.fhir.uv.cpg: 2.0.0 hl7.fhir.us.cqfmeasures: 5.0.0 # Actual dependencies smart.who.int.base: id: sb version: 0.1.0 reason: This IG uses SMART base computable guideline capabilities # smart.who.int.base-clinical: # id: sbc # version: current # reason: This IG uses SMART base clinical capabilities meta: profile: - http://smart.who.int/base/StructureDefinition/SGImplementationGuide pages: index.md: title: Home changes.md: title: Changes dependencies.md: title: Dependencies references.md: title: References adapting.md: title: Adapting Guidelines for Country use license.md: title: License business-requirements.md: title: Business Requirements concepts.md: title: Concepts personas.md: title: Generic Personas scenarios.md: title: User Scenarios business-processes.md: title: Business Processes dictionary.md: title: Data Dictionary decision-logic.md: title: Decision-support logic indicators.md: title: Indicator and Performance Metrics functional-requirements.md: title: Functional Requirements non-functional-requirements.md: title: Non-functional Requirements data-models-and-exchange.md: title: Data Models and Exchange system-actors.md: title: System Actors sequence-diagrams.md: title: Sequence Diagrams transactions.md: title: Transactions # logical-models.md: # title: Logical Models indicators-measures.md: title: Indicators and Measures # profiles.xml: # title: Content profiles codings.md: title: Codings deployment.md: title: Deployment security-privacy.md: title: Security and Privacy Considerations testing.md: title: Testing test-data.md: title: Test Data reference-implementations.md: title: Reference Implementations trust_domain.md: title: Trust Domains downloads.md: title: Downloads indices.md: title: Indices artifacts.html: title: Artifact Index maps.md: title: Mappings menu: Home: Summary: index.html Changes: changes.html Dependencies: dependencies.html References: references.html Adapting Guidelines for Country use: adapting.html Business Requirements: Concepts: concepts.html Generic Personas: personas.html User Scenarios: scenarios.html Business Processes: business-processes.html Data Dictionary: dictionary.html Decision-support Logic: decision-logic.html Indicator and Performance Metrics: indicators.html Functional Requirements: functional-requirements.html Non-functional Requirements: non-functional-requirements.html Data Models and Exchange: System Actors: system-actors.html Sequence Diagrams: sequence-diagrams.html Transactions: transactions.html Indicators and Measures: indicators-measures.html Codings: codings.html Deployment: Security and Privacy Considerations: security-privacy.html Testing: testing.html Test Data: test-data.html Reference Implementations: reference-implementations.html Trust Domains: trust_domain.html Downloads: downloads.html Indices: Artifact Index: artifacts.html Mappings: maps.html >>>>>>> 34c7eb2c973e03b7dba2bfe19cce11213f4dfac0 # ╭───────────────────────────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: # # 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. 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. # <<<<<<< HEAD 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 ======= # instanceOptions: # 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 >>>>>>> 34c7eb2c973e03b7dba2bfe19cce11213f4dfac0