generated from hl7-be/empty-ig-custom
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsushi-config.yaml
216 lines (194 loc) · 8.97 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
# ╭─────────────────────────────────ImplementationGuide-fish.json──────────────────────────────────╮
# │ The properties below are used to create the ImplementationGuide resource. │
# │ For a list of supported properties, see: │
# │ https://fshschool.org/docs/sushi/configuration/#full-configuration │
# │ SUSHI will use id as both id and packageId in the IG unless a │
# │ specific packageId is also provided in this file. │
# ╰────────────────────────────────────────────────────────────────────────────────────────────────╯
id: hl7.fhir.be.public-health
canonical: https://www.ehealth.fgov.be/standards/fhir/public-health
url: https://www.ehealth.fgov.be/standards/fhir/public-health
name: Public Health
title: "HL7 FHIR Implementation Guide: Public Health IG Release 1 - BE Realm | STU1"
description: Public Health
status: active
license: CC0-1.0
date: 2023-10-20
version: 1.0.2
# Although fhirVersions is 0..* in the ImplementationGuide resource
# it can be a single item OR and array here (but so far SUSHI only
# supports 4.0.1 anyway).
fhirVersion: 4.0.1
# The following two lines correspond to items that used to be in
# ig.ini but were moved to IG.definition.parameter. For
# consistency within this file, the names are represented using
# camelcase, but if authors use the formal parameter names, SUSHI
# will recognize them as well. In either case, they'll be copied
# to the IG JSON using the formal names.
copyrightYear: 2021+
releaseLabel: STU1
# The publisher can be a single item or a list, each with a name and
# optional url and/or email. The first publisher's name will be used
# as IG.publisher. The contact details and/or additional publishers
# will be translated into IG.contact values.
publisher:
name: eHealth Platform
url: https://www.ehealth.fgov.be/standards/fhir
email: [email protected]
# ContactDetail is required by the template.
contact:
- name: eHealth Platform
telecom:
- system: email
value: [email protected]
use: work
# The jurisdiction can be a single item or a list. The FHIR Shorthand
# code syntax can be used here.
jurisdiction: urn:iso:std:iso:3166#BE "Belgium"
#jurisdiction: http://unstats.un.org/unsd/methods/m49/m49.htm#001 "World"
# 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 `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 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.
#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
# * specify "omit" to omit a FSH-generated resource from the
# resource list.
# * 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.
#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 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
guidance.md:
changes.xml:
downloads.xml:
actors.md:
transactions.md:
# 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:
# * meta
# * implicitRules
# * language
# * text
# * contained
# * extension
# * modifierExtension
# * experimental
# * useContext
# * copyright
# * packageId
# 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.
menu:
Home: index.html
Guidance:
Overview: guidance.html
Actors: actors.html
Transactions: transactions.html
Artifacts:
Logical Models: artifacts.html#structures-logical-models
Profiles: artifacts.html#structures-resource-profiles
#Data Types: artifacts.html#structures-data-type-profiles
#Extensions: artifacts.html#structures-extension-definitions
Value Sets: artifacts.html#terminology-value-sets
Code Systems: artifacts.html#terminology-code-systems
Naming Systems: artifacts.html#terminology-naming-systems
Examples: artifacts.html#example-example-instances
Downloads: downloads.html
Changes: changes.html
History: https://www.ehealth.fgov.be/standards/fhir/public-health/history.html
# 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:
# excludettl: true
# validation: [allow-any-extensions, no-broken-links]
# 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: false
dependencies:
hl7.fhir.be.core: 2.0.1
hl7.fhir.be.core-clinical: 1.0.0
hl7.fhir.be.infsec: 1.1.0
parameters:
shownav: 'true'
apply-contact: 'true'
apply-jurisdiction: 'true'
apply-publisher: 'true'
apply-version: 'true'
propagate-status: true
display-warnings: true
resources:
Appointment/example-with-pseudonymization:
name: "[Example 7] Pseudonymized patient"
description: Appointment with pseudonymized patient