sushi-config.yaml

id: hl7.fhir.uv.lab-report
canonical: http://hl7.org/fhir/uv/lab-report
name:  Hl7LaboratoryReportIg
title: HL7 Laboratory Report
description: This guide describes how the Laboratory Report can be represented in the UV REALM.
status: active # draft | active | retired | unknown
extension:
  - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    valueCode: oo
  - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    valueCode: trial-use
version: 1.0.0-ballot #
fhirVersion: 4.0.1 # https://www.hl7.org/fhir/valueset-FHIR-version.html
copyrightYear: 2023+
releaseLabel: STU 1 Ballot # ci-build | draft | qa-preview | ballot | trial-use | release | update | normative+trial-use
license: CC0-1.0 # https://www.hl7.org/fhir/valueset-spdx-license.html
# https://www.hl7.org/fhir/valueset-jurisdiction.html


jurisdiction: 	http://unstats.un.org/unsd/methods/m49/m49.htm#001 "World"

# 
publisher:
  name: HL7 International / Orders and Observations
  url: http://www.hl7.org/Special/committees/orders
  # email: test@example.org

# TO BE UPDATED
#copyright: >-
#  Used by permission of HL7 International, all rights reserved Creative Commons License

# 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.uv.ips: 1.1.0
  hl7.fhir.extensions.r5: 4.0.1
  hl7.fhir.extensions.r4: 4.0.1
#
# 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: Home
 # background.md:
 #   title: Background
    # to be removed --->
  # semantic-notes.md:
    # title: Laboratory Result Report
    # <--- to be removed
 # scenarios.md:
  #  title: Laboratory Report scenarios
  status-mgmt.md:
    title: Laboratory Report Workflow
  design-choice.md:
    title: Design choices
 # challenges.md:
 #   title: Challenges
  notes.md:
    title: Implementation notes
  crm.md:
    title: Certified reference material
  downloads.md:
    title: Downloads
  #logicalModel.md:
   # title: eHN guideline data set
  contributors.md:
    title: Authors and contributors
  obligations.md:
    title: Obligations
  knownIssues.md:
    title: Known Issues
 # overview.md:
 #   title: Profiles overview

 #  recommendations.md:
#    title: Recommendations
#
#
# 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: #see https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters
#  produce-jekyll-data: true
  special-url:
    - http://example.org/lab-codes

# see https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters
# path-resource:
#    - input/resources
#    - fsh-generated/resources
#  path-pages:
#    - input/pagecontent
#    - input/intro-notes
#  active-tables: false
  apply-contact: true
  apply-jurisdiction: true
  apply-publisher: true
  apply-version: true
  show-inherited-invariants: true
  usage-stats-opt-out: true
  # excludexml: false
  # excludejson: false
  # excludettl: true
  # excludemap: true
 # suppressed-ids: DocumentReference/discharge-summary
 # tabbed-snapshots: false
  # generate: #what does this do - todo: remove and see4
  #   - xml
  #   - json
 # no-narrative:
 #   - Patient/example-targeted-provenance
 #   - Bundle/docref-example-1
  # no-validate:
  #   - '*/*'  # does not seems to work
  #   - 'StructureDefinition/*'
 # version-comparison:
 #    - 5.0.1
 #    - 4.0.0

#   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
  Table of Contents: toc.html
  Background:
    # Background: background.html
    # Challenges: challenges.html
    Design Choices: design-choice.html
    Certified reference material: crm.html
  Functional Specifications:
    # Scenarios: scenarios.html
    Workflow Management: status-mgmt.html
    # eHN Guideline dataset: logicalModel.html
    Obligations: obligations.html
    Implementation notes: notes.html
  #  Profiles overview:  overview.html
  # Examples: examples.html
  Artifacts: artifacts.html
  About:
    Downloads: downloads.html
    Authors and contributors: contributors.html
    Known Issues: knownIssues.html


# ╭───────────────────────────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:

#----------- Examples -------------
  Specimen/Specimen-animal-example:
    name: "Specimen: animal example"
    description: Example of Specimen collected from an animal.

  DiagnosticReport/dr-lab-example:
    name: "DiagnosticReport: example"
    description: Example of DiagnosticReport conforming this guide.

  Composition/comp-lab-example:
    name: "Composition: example"
    description: Example of Composition conforming this guide.

  Patient/pat-lab-example:
    name: "Patient: example"
    description: Example of Patient conforming this guide.

  Patient/nl-core-NameInformation-complete:
    name: "Patient: Dutch complete name"
    description: Example of Patient including a complete Dutch name.

  PractitionerRole/prrole-lab-example:
    name: "PractitionerRole: example"
    description: Example of PractitionerRole conforming this guide.

  Practitioner/pr-lab-example:
    name: "Practitioner: example"
    description: Example of Practitioner conforming this guide.

  Observation/obs-gram-stain:
    name: "Observation: Gram Staining example"
    description: Example of Gram Staining result Observation conforming this guide.

  Observation/obs-wbc:
    name: "Observation: Leukocytes Presence example"
    description: Example of Leukocytes Presence by gram staining  Observation conforming this guide.

  Observation/obs-gs-org1:
    name: "Observation: Gram-positive cocci example"
    description: Example of Gram-positive cocci in clusters by gram staining  Observation conforming this guide.

  Observation/obs-gs-org1-quant:
    name: "Observation: Gram-positive cocci, observed quantity, example"
    description: Example of Gram-positive cocci in clusters by gram staining, observed quantity, Observation conforming this guide.


  Observation/obs-aerobic-culture:
    name: "Observation: Aerobic Culture example"
    description: Example of Aerobic Culture Observation conforming this guide.

  Observation/obs-anaerobic-culture:
    name: "Observation: Anaerobic Culture example"
    description: Example of Anaerobic Culture Observation conforming this guide.

  Observation/obs-org-id1:
    name: "Observation: Staphylococcus aureus identified example"
    description: Example of Staphylococcus aureus identified by Aerobe culture Observation conforming this guide.

  Observation/obs-org-id1-growth:
    name: "Observation: Staphylococcus aureus Growth example"
    description: Example of Staphylococcus aureus Growth Observation conforming this guide.

  Observation/obs-org-id1-susc-panel:
    name: "Observation: Staphylococcus aureus susceptibility panel example"
    description: Example of Staphylococcus aureus susceptibility panel Observation conforming this guide.

  Observation/obs-org-id1-susc-1:
    name: "Observation: Staphylococcus aureus Cephalothin susceptibility example"
    description: Example of Staphylococcus aureus Cephalothin susceptibility Observation conforming this guide.

  Observation/obs-org-id1-susc-2:
    name: "Observation: Staphylococcus aureus levoFLOXacin susceptibility example"
    description: Example of Staphylococcus aureus levoFLOXacin susceptibility Observation conforming this guide.

  Observation/obs-org-id1-susc-3:
    name: "Observation: Staphylococcus aureus Oxacillin susceptibility example"
    description: Example of Staphylococcus aureus Oxacillin susceptibility Observation conforming this guide.

  Observation/obs-org-id1-susc-4:
    name: "Observation: Staphylococcus aureus Vancomycin susceptibility example"
    description: Example of Staphylococcus aureus Vancomycin susceptibility Observation conforming this guide.

  ServiceRequest/srv-request-example:
    name: "ServiceRequest: example"
    description: Example of ServiceRequest conforming this guide.

  Patient/Patient-animal-example:
    name: "Patient: animal example"
    description: Example of Patient resource used for indicating an animal (cat) conforming this guide.

  BodyStructure/bodystruct-example:
    name: "BodyStructure: example"
    description: Example of BodyStructure conforming this guide.

  Substance/substance-example:
    name: "Substance: example"
    description: Example of Substance conforming this guide.

  # -------------  Obligations
  StructureDefinition/Patient-obl-uv-lab:
    name: Patient Obligations
    description: Specify the functional capabilities that the defined actors may, should or shall applied to the Patient profile elements.

  StructureDefinition/Specimen-obl-uv-lab:
    name: Specimen Obligations
    description: Specify the functional capabilities that the defined actors may, should or shall applied to the Specimen profile elements.

  StructureDefinition/ServiceRequest-obl-uv-lab:
    name: ServiceRequest Obligations
    description: Specify the functional capabilities that the defined actors may, should or shall applied to the ServiceRequest profile elements.

  StructureDefinition/Observation-obl-uv-lab:
    name: Observation Obligations
    description: Specify the functional capabilities that the defined actors may, should or shall applied to the Observation profile elements.


#  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:

  obligations:
    name:  Actors and Obligations (Informative)
    description: Actors and Obligations used to describe the Laboratory Report functional requirements for the specified data elements. Informative for this version of the guide.
    resources:
      - ActorDefinition/actor-consumer-uv-lab
      - ActorDefinition/actor-creator-uv-lab
      - ActorDefinition/actor-repos-uv-lab
      - StructureDefinition/Patient-obl-uv-lab
      - StructureDefinition/Specimen-obl-uv-lab
      - StructureDefinition/ServiceRequest-obl-uv-lab
      - StructureDefinition/Observation-obl-uv-lab


#
# 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
# * packagingId
#
#
# ╭──────────────────────────────────────────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:
  manualSliceOrdering: true
#
# 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