forked from NHSDigital/ra-sandbox
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sushi-config.yaml
228 lines (226 loc) · 12 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
# ╭─────────────────────────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: reasonable-adjustments.stu1
canonical: https://fhir.nhs.uk/England
name: Reasonable Adjustments - NHS England - Implementation Guide STU1
title: Reasonable Adjustments - NHS England - Implementation Guide STU1
# description: Example Implementation Guide for getting started with SUSHI
status: draft # draft | active | retired | unknown
version: 0.3.7
fhirVersion: 4.0.1 # https://www.hl7.org/fhir/valueset-FHIR-version.html
copyrightYear: Copyright © 2024+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.
releaseLabel: ci-build # 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: NHS England
url: https://fhir.nhs.uk
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:
careconnect.stu3.03.00.00: 3.1.0
fhir.r4.ukcore.stu2: 1.1.3
# 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
Data Model: data-model.html
Use Cases:
Consent to Share Information: consent-to-share-information.html
Add Reasonable Adjustment Record: add-reasonable-adjustment-record.html
Retrieve Reasonable Adjustment Record: retrieve-reasonable-adjustment-record.html
Remove Reasonable Adjustment Record: remove-reasonable-adjustment-record.html
Additional Examples:
CPIS/FGM demo: additional-examples.html
Server Examples: server-examples.html
Artifacts: artifacts.html
About:
Downloads: todo.html
Contact: todo.html
Glossary: todo.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: NHS England
# telecom:
# - system: email # phone | fax | email | pager | url | sms | other
# value: [email protected]
# use: work
# rank: 1
#
#
# 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:
# 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