Skip to content

Commit 105bbb7

Browse files
vadi2vadi2
committed
Add scaffolding scripts
1 parent bc80e13 commit 105bbb7

File tree

4 files changed

+240
-0
lines changed

4 files changed

+240
-0
lines changed

‎OTHER-cds-hooks.xml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<specification xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ciUrl="" defaultVersion="current" defaultWorkgroup="cds" url="https://cds-hooks.hl7.org">
3+
<version code="current" url=""/>
4+
<artifactPageExtension value="-definitions"/>
5+
<artifactPageExtension value="-examples"/>
6+
<artifactPageExtension value="-mappings"/>
7+
<artifact id="StructureDefinition/MyPatient" key="StructureDefinition-MyPatient" name="MyPatient"/>
8+
<artifact id="Patient/PatientExample" key="Patient-PatientExample" name="PatientExample"/>
9+
<page key="NA" name="(NA)"/>
10+
<page key="many" name="(many)"/>
11+
<page key="artifacts" name="Artifacts Summary"/>
12+
<page key="extensions-datatypes" name="Extensions Datatypes"/>
13+
<page key="index" name="Home"/>
14+
<page key="hooks" name="Hooks"/>
15+
<page key="security" name="Security"/>
16+
<page key="services" name="Services"/>
17+
<page key="toc" name="Table of Contents"/>
18+
</specification>

‎ig.ini

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[IG]
2+
ig = fsh-generated/resources/ImplementationGuide-hl7.other.uv.cds-hooks.json
3+
template = hl7.fhir.template#current

‎input/ignoreWarnings.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
== Suppressed Messages ==
2+
3+
# Add warning and/or information messages here after you've confirmed that they aren't really a problem
4+
# (And include comments like this justifying why)
5+
# See https://github.com/FHIR/sample-ig/blob/master/input/ignoreWarnings.txt for examples

‎sushi-config.yaml

Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
# ╭─────────────────────────Commonly Used ImplementationGuide Properties───────────────────────────╮
2+
# │ The properties below are used to create the ImplementationGuide resource. The most commonly │
3+
# │ used properties are included. For a list of all supported properties and their functions, │
4+
# │ see: https://fshschool.org/docs/sushi/configuration/. │
5+
# ╰────────────────────────────────────────────────────────────────────────────────────────────────╯
6+
id: hl7.other.uv.cds-hooks
7+
canonical: https://cds-hooks.hl7.org
8+
name: CDSHooks
9+
title: CDS Hooks
10+
description: CDS Hooks describes a "hook"-based pattern for invoking decision support from within a clinician's workflow.
11+
status: draft # draft | active | retired | unknown
12+
version: 2.0.0
13+
fhirVersion: 4.0.1 # https://www.hl7.org/fhir/valueset-FHIR-version.html
14+
copyrightYear: 2019+
15+
copyrightLabel: "HL7 & Boston Children's Hospital"
16+
releaseLabel: ci-build # ci-build | draft | qa-preview | ballot | trial-use | release | update | normative+trial-use
17+
license: CC0-1.0 # https://www.hl7.org/fhir/valueset-spdx-license.html
18+
jurisdiction: 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
19+
publisher:
20+
name: Clinical Decision Support WG
21+
url: http://www.hl7.org/Special/committees/dss/index.cfm
22+
email: [email protected]
23+
24+
# The dependencies property corresponds to IG.dependsOn. The key is the
25+
# package id and the value is the version (or dev/current). For advanced
26+
# use cases, the value can be an object with keys for id, uri, and version.
27+
#
28+
# dependencies:
29+
# hl7.fhir.us.core: 3.1.0
30+
# hl7.fhir.us.mcode:
31+
# id: mcode
32+
# uri: http://hl7.org/fhir/us/mcode/ImplementationGuide/hl7.fhir.us.mcode
33+
# version: 1.0.0
34+
#
35+
#
36+
# The pages property corresponds to IG.definition.page. SUSHI can
37+
# auto-generate the page list, but if the author includes pages in
38+
# this file, it is assumed that the author will fully manage the
39+
# pages section and SUSHI will not generate any page entries.
40+
# The page file name is used as the key. If title is not provided,
41+
# then the title will be generated from the file name. If a
42+
# generation value is not provided, it will be inferred from the
43+
# file name extension. Any subproperties that are valid filenames
44+
# with supported extensions (e.g., .md/.xml) will be treated as
45+
# sub-pages.
46+
#
47+
# pages:
48+
# index.md:
49+
# title: Example Home
50+
# implementation.xml:
51+
# examples.xml:
52+
# title: Examples Overview
53+
# simpleExamples.xml:
54+
# complexExamples.xml:
55+
#
56+
#
57+
# The parameters property represents IG.definition.parameter. Rather
58+
# than a list of code/value pairs (as in the ImplementationGuide
59+
# resource), the code is the YAML key. If a parameter allows repeating
60+
# values, the value in the YAML should be a sequence/array.
61+
# For parameters defined by core FHIR see:
62+
# http://build.fhir.org/codesystem-guide-parameter-code.html
63+
# For parameters defined by the FHIR Tools IG see:
64+
# http://build.fhir.org/ig/FHIR/fhir-tools-ig/branches/master/CodeSystem-ig-parameters.html
65+
#
66+
# parameters:
67+
# excludettl: true
68+
# validation: [allow-any-extensions, no-broken-links]
69+
#
70+
# ╭────────────────────────────────────────────menu.xml────────────────────────────────────────────╮
71+
# │ The menu property will be used to generate the input/menu.xml file. The menu is represented │
72+
# │ as a simple structure where the YAML key is the menu item name and the value is the URL. │
73+
# │ The IG publisher currently only supports one level deep on sub-menus. To provide a │
74+
# │ custom menu.xml file, do not include this property and include a `menu.xml` file in │
75+
# │ input/includes. To use a provided input/includes/menu.xml file, delete the "menu" │
76+
# │ property below. │
77+
# ╰────────────────────────────────────────────────────────────────────────────────────────────────╯
78+
menu:
79+
Home: index.html
80+
Service interaction: services.html
81+
Security: security.html
82+
Extensions and data types: extensions-datatypes.html
83+
Hooks: hooks.html
84+
85+
86+
# ╭───────────────────────────Less Common Implementation Guide Properties──────────────────────────╮
87+
# │ Uncomment the properties below to configure additional properties on the ImplementationGuide │
88+
# │ resource. These properties are less commonly needed than those above. │
89+
# ╰────────────────────────────────────────────────────────────────────────────────────────────────╯
90+
#
91+
# Those who need more control or want to add additional details to the contact values can use
92+
# contact directly and follow the format outlined in the ImplementationGuide resource and
93+
# ContactDetail.
94+
#
95+
# contact:
96+
# - name: Bob Smith
97+
# telecom:
98+
# - system: email # phone | fax | email | pager | url | sms | other
99+
# value: [email protected]
100+
# use: work
101+
#
102+
#
103+
# The global property corresponds to the IG.global property, but it
104+
# uses the type as the YAML key and the profile as its value. Since
105+
# FHIR does not explicitly disallow more than one profile per type,
106+
# neither do we; the value can be a single profile URL or an array
107+
# of profile URLs. If a value is an id or name, SUSHI will replace
108+
# it with the correct canonical when generating the IG JSON.
109+
#
110+
# global:
111+
# Patient: http://example.org/fhir/StructureDefinition/my-patient-profile
112+
# Encounter: http://example.org/fhir/StructureDefinition/my-encounter-profile
113+
#
114+
#
115+
# The resources property corresponds to IG.definition.resource.
116+
# SUSHI can auto-generate all of the resource entries based on
117+
# the FSH definitions and/or information in any user-provided
118+
# JSON or XML resource files. If the generated entries are not
119+
# sufficient or complete, however, the author can add entries
120+
# here. If the reference matches a generated entry, it will
121+
# replace the generated entry. If it doesn't match any generated
122+
# entries, it will be added to the generated entries. The format
123+
# follows IG.definition.resource with the following differences:
124+
# * use IG.definition.resource.reference.reference as the YAML key.
125+
# * if the key is an id or name, SUSHI will replace it with the
126+
# correct URL when generating the IG JSON.
127+
# * specify "omit" to omit a FSH-generated resource from the
128+
# resource list.
129+
# * if the exampleCanonical is an id or name, SUSHI will replace
130+
# it with the correct canonical when generating the IG JSON.
131+
# * groupingId can be used, but top-level groups syntax may be a
132+
# better option (see below).
133+
# The following are simple examples to demonstrate what this might
134+
# look like:
135+
#
136+
# resources:
137+
# Patient/my-example-patient:
138+
# name: My Example Patient
139+
# description: An example Patient
140+
# exampleBoolean: true
141+
# Patient/bad-example: omit
142+
#
143+
#
144+
# Groups can control certain aspects of the IG generation. The IG
145+
# documentation recommends that authors use the default groups that
146+
# are provided by the templating framework, but if authors want to
147+
# use their own instead, they can use the mechanism below. This will
148+
# create IG.definition.grouping entries and associate the individual
149+
# resource entries with the corresponding groupIds. If a resource
150+
# is specified by id or name, SUSHI will replace it with the correct
151+
# URL when generating the IG JSON.
152+
#
153+
# groups:
154+
# GroupA:
155+
# name: Group A
156+
# description: The Alpha Group
157+
# resources:
158+
# - StructureDefinition/animal-patient
159+
# - StructureDefinition/arm-procedure
160+
# GroupB:
161+
# name: Group B
162+
# description: The Beta Group
163+
# resources:
164+
# - StructureDefinition/bark-control
165+
# - StructureDefinition/bee-sting
166+
#
167+
#
168+
# The ImplementationGuide resource defines several other properties
169+
# not represented above. These properties can be used as-is and
170+
# should follow the format defined in ImplementationGuide:
171+
# * date
172+
# * meta
173+
# * implicitRules
174+
# * language
175+
# * text
176+
# * contained
177+
# * extension
178+
# * modifierExtension
179+
# * experimental
180+
# * useContext
181+
# * copyright
182+
# * packageId
183+
#
184+
#
185+
# ╭──────────────────────────────────────────SUSHI flags───────────────────────────────────────────╮
186+
# │ The flags below configure aspects of how SUSHI processes FSH. │
187+
# ╰────────────────────────────────────────────────────────────────────────────────────────────────╯
188+
# The FSHOnly flag indicates if only FSH resources should be exported.
189+
# If set to true, no IG related content will be generated.
190+
# The default value for this property is false.
191+
#
192+
# FSHOnly: false
193+
#
194+
#
195+
# When set to true, the "short" and "definition" field on the root element of an Extension will
196+
# be set to the "Title" and "Description" of that Extension. Default is true.
197+
#
198+
# applyExtensionMetadataToRoot: true
199+
#
200+
#
201+
# The instanceOptions property is used to configure certain aspects of how SUSHI processes instances.
202+
# See the individual option definitions below for more detail.
203+
#
204+
# instanceOptions:
205+
# Determines for which types of Instances SUSHI will automatically set meta.profile
206+
# if InstanceOf references a profile:
207+
#
208+
# setMetaProfile: always # always | never | inline-only | standalone-only
209+
#
210+
#
211+
# Determines for which types of Instances SUSHI will automatically set id
212+
# if InstanceOf references a profile:
213+
#
214+
# setId: always # always | standalone-only

0 commit comments

Comments
 (0)