-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathsushi-config.yaml
323 lines (305 loc) · 14.3 KB
/
sushi-config.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
# ╭─────────────────────────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.us.ndh
extension:
- url: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
valueCode: pa
canonical: http://hl7.org/fhir/us/ndh
name: NationalDirectoryHealthcare
title: National Directory of Healthcare Providers & Services (NDH) Implementation Guide
# description: Example Implementation Guide for getting started with SUSHI
status: active # draft | active | retired | unknown
version: 1.0.0-ballot
fhirVersion: 4.0.1 # https://www.hl7.org/fhir/valueset-FHIR-version.html
copyrightYear: 2023+
releaseLabel: 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
jurisdiction: urn:iso:std:iso:3166#US "United States of America" # https://www.hl7.org/fhir/valueset-jurisdiction.html
publisher:
name: HL7 International / Patient Administration
#rl: http://hl7.org/Special/committees/pafm
url: http://www.hl7.org/Special/committees/pafm
email: [email protected]
# 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: 5.0.1
hl7.fhir.us.core: 6.1.0
#hl7.fhir.us.core: 7.0.0
hl7.fhir.us.udap-security: 1.0.0
hl7.fhir.uv.extensions.r4: 1.0.0
#hl7.fhir.uv.subscriptions-backport: 0.1.0
hl7.fhir.uv.subscriptions-backport.r4: 1.1.0
hl7.fhir.uv.bulkdata: 2.0.0
#hl7.terminology.r4: 3.1.0
#hl7.teminology.r4: 6.1.0
ihe.iti.mcsd:
id: iheitimcsd
uri: https://profiles.ihe.net/ITI/mCSD/ImplementationGuide/ihe.iti.mcsd
version: 3.8.x
#
# 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
base-artifacts.md:
title: Base Artifacts
ndapi-use-cases.md:
title: National Directory API Use Cases
#ndapi-flow-diagrams.md:
#title: National Directory API Flow Diagrams
ndapi-ig.md:
title: National Directory API Implementation Guidance
ndapi-artifacts.md:
title: National Directory API Artifacts
ndapi-capability.md:
title: National Directory API Capability Satement
ndapi-examples.md:
title: National Directory API Examples
attestation-use-cases.md:
title: Attestation Use Cases
attestation-flow-diagrams.md:
title: Attestation Flow Diagrams
attestation-ig.md:
title: Attestation Implementation Guidance
attestation-artifacts.md:
title: Attestation Artifacts
attestation-capability.md:
title: Attestation CapabilityStatement
#attestation-examples.md:
#title: Attestation Examples
verification-use-cases.md:
title: Validation & Verification Use Cases
verification-flow-diagrams.md:
title: Validation & Verification Flow Diagrams
verification-ig.md:
title: Validation & Verification Implementation Guidance
verification-artifacts.md:
title: Validation & Verification Artifacts
verification-capability.md:
title: Validation & Verification CapabilityStatement
#verification-examples.md:
#title: Validation & Verification Examples
ldapi-use-cases.md:
title: Local Directory API Use Cases
#query-flow-diagrams.md:
#title: Distributed Query Flow Diagrams
ldapi-ig.md:
title: Local Directory API Implementation Guidance
ldapi-artifacts.md:
title: Local Directory API Artifacts
ldapi-capability.md:
title: Local Directory API CapabilityStatement
ldapi-examples.md:
title: Local Directory API Examples
downloads.md:
title: Download Specification
other.md:
title: other
change-log.md:
title: Release Notes
#
# The parameters property represents IG.definition.parameter. Rather
# than a list of code/value pairs (as in the Implementation Guide
# 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:
show-inherited-invariants: false
version-comparison: n/a
path-liquid: "liquid"
path-expansion-params: 'Parameters-parameters-snomed-us.json'
#shownaves: true
# 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
Base Artifacts: base-artifacts.html
National Directory API Standard:
National Directory API Implementation Guidance: ndapi-ig.html
National Directory API Artifacts: ndapi-artifacts.html
National Directory API CapabilityStatement: ndapi-capability.html
#National Directory API Flow Diagrams: ndapi-flow-diagrams.html
National Directory API Use Cases: ndapi-use-cases.html
National Directory API Examples: ndapi-examples.html
Attestation Standard:
Attestation Implementation Guidance: attestation-ig.html
Attestation Artifacts: attestation-artifacts.html
Attestation CapabilityStatement: attestation-capability.html
Attestation Flow Diagrams: attestation-flow-diagrams.html
Attestation Use Cases: attestation-use-cases.html
# Attestation Examples: attestation-examples.html
Validation & Verification Standard:
Validation & Verification Implementation Guidance: verification-ig.html
Validation & Verification Artifacts: verification-artifacts.html
Validation & Verification CapabilityStatement: verification-capability.html
Validation & Verification Flow Diagrams: verification-flow-diagrams.html
Validation & Verification Use Cases: verification-use-cases.html
#Validation & Verification Examples: verification-examples.html
Local Directory API Standard:
Local Directory API Implementation Guidance: ldapi-ig.html
Local Directory API Artifacts: ldapi-artifacts.html
Local Directory API CapabilityStatement: ldapi-capability.html
Local Directory API Use Cases: ldapi-use-cases.html
#Distributed Query ation Flow Diagrams: query-flow-diagrams.html
Local Directory API Examples: ldapi-examples.html
Release Notes: change-log.html
More:
Artifacts: artifacts.html
Downloads: downloads.html
Other: other.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: [email protected]
# 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.
#
# 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