US-Core/sushi-config.yaml at master · HL7/US-Core · GitHub

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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
# ╭──────────────────────────────────────ImplementationGuide───────────────────────────────────────╮
# │  The properties below are used to create the ImplementationGuide resource. For a list of       │
# │  supported properties, see: https://fshschool.org/sushi/configuration/                         │
# ╰────────────────────────────────────────────────────────────────────────────────────────────────╯
id: hl7.fhir.us.core
canonical: 'http://hl7.org/fhir/us/core'
name: USCore
title: US Core Implementation Guide
status: active
extension:
  - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg  #<<< must include a http://hl7.org/fhir/StructureDefinition/structuredefinition-wg extension that identifies the workgroup responsible for the IG. This is the authoritative element.
    valueCode: cgp  # <<< The value must be the code for the workgroup
  - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    valueCode: trial-use
  - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm  #<<<<< this to to inform the publisher of the default FMM level for the artifacts in this IG
    valueInteger: 3
definition:
  extension:
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency  #<<<<< these are to inform the publisher link checker that links to this IG mostly in the change log are valid
      valueCode: hl7.fhir.us.core#8.0.1
    # - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency  #<<<<< these are to inform the publisher link checker that links to this IG mostly in the change log are valid
    #   valueCode: hl7.fhir.us.core#8.0.0
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency  #<<<<< these are to inform the publisher link checker that links to this IG mostly in the change log are valid
      valueCode: hl7.fhir.us.core#8.0.0-ballot
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency  #<<<<< these are to inform the publisher link checker that links to this IG mostly in the change log are valid
      valueCode: hl7.fhir.us.core#7.0.0
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency
      valueCode: hl7.fhir.us.core#7.0.0-ballot
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency
      valueCode: hl7.fhir.us.core#6.1.0
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency
      valueCode: hl7.fhir.us.core#6.0.0
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency
      valueCode: hl7.fhir.us.core#6.0.0-ballot
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency
      valueCode: hl7.fhir.us.core#5.0.1
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency
      valueCode: hl7.fhir.us.core#5.0.0
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency
      valueCode: hl7.fhir.us.core#4.1.0
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency
      valueCode: hl7.fhir.us.core#4.0.0
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency
      valueCode: hl7.fhir.us.core#3.2.0
    - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency
      valueCode: hl7.fhir.us.core#3.1.1

publisher:
  name: HL7 International / Cross-Group Projects # <<< The stated publisher must be "HL7 International / {wg-name"} where the wg-name is the display value for the code
  url: 'http://www.hl7.org/Special/committees/cgp'  # <<< the contacts for the resource must include the link to the group found in the definition
  email: cgp@lists.HL7.org
jurisdiction: 'urn:iso:std:iso:3166#US'
description: >-
  The US Core Implementation Guide defines the minimum set of FHIR RESTful interactions for each of the US Core Profiles to access patient data. The Data Access Framework and the Argonaut DSTU2 guides initially formed the basis for US Core. The Profiles are updated annually to support the latest requirements from The Office of the National Coordinator for Health Information Technology (ONC) U.S. Core Data for Interoperability (USCDI). For a summary of significant changes and a detailed list of the changes between versions, see the Change Notes at https://hl7.org/fhir/us/core/changes.html

license: CC0-1.0
date: 2026-05-01
version: '9.0.0'
fhirVersion: 4.0.1
dependencies:  # maintain array order - is referenced in spec using liquid variables
  hl7.fhir.uv.smart-app-launch:
    version: 2.2.0
    uri: http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch
    id: smart  #old hl7_fhir_uv_smart_app_launch

  hl7.fhir.uv.sdc:
    version: 4.0.0  #4.0.0 is coming  ... but not found by loader
    uri: http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc
    id: sdc  #old hl7_fhir_uv_sdc

  us.cdc.phinvads:
    id: uscdcphinvads
    # uri: 'http://fhir.org/packages/us.cdc.phinvads/ImplementationGuide/us.cdc.phinvads'
    uri: 'https://phinvads.cdc.gov/vads/fhir/ImplementationGuide/us.cdc.phinvads'
    version: 0.12.0
  hl7.fhir.uv.extensions.r4: 5.2.0 #hl7.fhir.uv.extensions: 5.1.0 #5.1.0-cibuild #5.1.0-ballot1  # <<<< If your WG is not in the older list, you need to add an explicit dependency to the current version of the extensions pack
  hl7.fhir.uv.xver-r5.r4: 0.1.0 # try this for cross version extension per Gino on Zulip

pages:
  index.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: informative
    title: Home
  conformance.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: trial-use
    general-requirements.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use
    must-support.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use
      observation-summary.md:
        title: Observation Summary Table
    scopes.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use
      title: SMART on FHIR Obligations and Capabilities
    security.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use
    requirements.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use
      title: Requirements Tables
  guidance.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: trial-use
    uscdi.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: informative
      title: USCDI
    general-guidance.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use
    clinical-notes.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use
    medication-list.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use
    basic-provenance.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use
      element-level-provenance.md:
        extension:
        - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
          valueCode: informative
        title: Using Provenance To Target Resource Elements
    screening-and-assessments.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use
      title:  Screening and Assessments
    # changes-between-versions.md:
    #   extension:
    #   - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    #     valueCode: trial-use
    relationship-with-other-igs.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: informative
      title: Relationship With Other IGs


  profiles-and-extensions.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: informative
  capability-statements.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: informative
    title:  Capability Statements and Requirements Resources
  search-parameters-and-operations.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: trial-use
  terminology.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: trial-use
    vsacname-fhiruri-map.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: informative
      title: VSAC to FHIR Code System Mapping Table
  examples.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: informative

  downloads.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: informative

  version-history.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: informative
    changes.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: informative
      title: Change Log
    changes-between-versions.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use

  looking-ahead.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: informative
    us-core-roadmap.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: trial-use
      title: US Core Roadmap
    writing-vital-signs.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: informative

    writing-clinical-notes.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: informative

    patient-data-feed.md:
      extension:
      - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
        valueCode: informative
      patient-data-feed-additional-resources.md:
        extension:
        - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
          valueCode: informative
  ImplementationGuide-hl7.fhir.us.core.md:
    extension:
    - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
      valueCode: informative
    title: US Core ImplementationGuide Resource
parameters:  # see https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters
  path-resource:
    - input/resources
    - fsh-generated/resources
  path-pages:
    - input/pagecontent
    - input/intro-notes
    # - fsh-generated/includes
    #- input/summaries
  path-liquid: input/liquid
    # path-data: input/examples # A relative path in which data files can be found (will go in _data for Jekyll).
  path-expansion-params: '../../input/resources/Parameters-manifest.json' # relative path from fsh-generated/resources (hence the "../..?")for using US ed of SNOMED
  active-tables: false
  apply-contact: true
  apply-jurisdiction: true
  apply-publisher: true
  apply-version: true
  show-inherited-invariants: false
  usage-stats-opt-out: true
  # excludexml: false
  # excludejson: false
  # excludettl: true
  # excludemap: true
  suppressed-ids: DocumentReference/discharge-summary
  tabbed-snapshots: true
  # generate: #what does this do - todo: remove and see4
  #   - xml
  #   - json
  no-narrative:
    # - Patient/example-targeted-provenance
    # - Provenance/example-targeted-provenance
    - DocumentReference/discharge-summary
    - Bundle/docref-example-1
    - Bundle/docref-example-2
  # no-validate:
  #   - '*/*'  # does not seems to work
  #   - 'StructureDefinition/*'
  version-comparison-master: 8.0.1

  # version-comparison:    # significantly increases build time - comment out to speed it up
  #   - 8.0.1
  #   - 7.0.0
  #   - 6.1.0
  #   - 5.0.1
  #   - 4.0.0
  #   - 3.1.1
  html-exempt:  # These pages are generated by the cli validator for comparison between Argo and US Core
    - comparison-argo/vs-manifestation-or-symptom-manifestation-or-symptom.html
    - comparison-argo/vs-observation-status-us-core-observation-smoking-status-status.html
    - comparison-argo/sd-argo-diagnosticreport-us-core-diagnosticreport-note.html
    - comparison-argo/vs-c80-doc-typecodes-us-core-documentreference-type.html
    - comparison-argo/vs-c80-practice-codes-c80-practice-codes.html
    - comparison-argo/vs-observation-methods-observation-methods.html
    - comparison-argo/sd-argo-procedure-us-core-procedure.html
    - comparison-argo/vs-procedure-followup-procedure-followup.html
    - comparison-argo/vs-procedure-category-procedure-category.html
    - comparison-argo/vs-condition-category-condition-category.html
    - comparison-argo/index.html
    - comparison-argo/vs-route-codes-route-codes.html
    - comparison-argo/sd-argo-goal-us-core-goal.html
    - comparison-argo/sd-argo-medication-us-core-medication.html
    - comparison-argo/sd-argo-allergyintolerance-us-core-allergyintolerance.html
    - comparison-argo/vs-medication-codes-medication-codes.html
    - comparison-argo/sd-argo-condition-us-core-condition-encounter-diagnosis.html
    - comparison-argo/vs-diagnostic-service-sections-diagnostic-service-sections.html
    - comparison-argo/sd-argo-documentreference-us-core-documentreference.html
    - comparison-argo/vs-formatcodes-v3-HL7FormatCodes.html
    - comparison-argo/sd-argo-birthsex-us-core-birthsex.html
    - comparison-argo/vs-goal-category-goal-category.html
    - comparison-argo/sd-argo-immunization-us-core-immunization.html
    - comparison-argo/vs-goal-start-event-goal-start-event.html
    - comparison-argo/sd-argo-diagnosticreport-us-core-diagnosticreport-lab.html
    - comparison-argo/vs-observation-category-observation-category.html
    - comparison-argo/vs-report-codes-us-core-diagnosticreport-report-and-note-codes.html
    - comparison-argo/sd-argo-condition-us-core-condition-problems-health-concerns.html
    - comparison-argo/vs-observation-codes-us-core-laboratory-test-codes.html
    - comparison-argo/vs-procedure-type-us-core-procedure-code.html
    - comparison-argo/vs-body-site-body-site.html
    - comparison-argo/vs-goal-priority-goal-priority.html
    - comparison-argo/sd-argo-careplan-us-core-careplan.html
    - comparison-argo/vs-c80-facilitycodes-c80-facilitycodes.html
    - comparison-argo/vs-immunization-site-immunization-site.html
    - comparison-argo/vs-substance-code-substance-code.html
    - comparison-argo/vs-observation-codes-observation-codes.html
    - comparison-argo/vs-immunization-route-immunization-route.html
    - comparison-argo/vs-condition-code-condition-code.html
    - comparison-argo/vs-procedure-outcome-procedure-outcome.html
    - comparison-argo/vs-condition-stage-condition-stage.html
    - comparison-argo/vs-condition-severity-condition-severity.html
    - comparison-argo/vs-report-codes-us-core-laboratory-test-codes.html
    - comparison-argo/vs-vacc-status-immunization-status.html
    - comparison-argo/vs-device-action-device-action.html
    - comparison-argo/vs-narrative-status-us-core-narrative-status.html

  ipa-comparison:
    - '{current}'

  ips-comparison:
    - '{current}'

  pin-canonicals: pin-all #<<<< comment out to speed up build by 30 minutes
  pin-manifest: manifest #<<<< comment out to speed up build by 30 minutes
  # pin-external: true  #<<<<<< documented, but not yet available

  # logging:
  #   - tx #tx: Messages describing the use of the terminology server (for debugging)
  #   - html #html: Log when validating an html page (troubleshooting only - leave off)
  #   - generate #generate: Log when producing an individual resource (troubleshooting only - leave off)
  #   - init #init: Messages describing the start up process (for debugging)
  #   - progress #progress: Overall progress messages
  auto-oid-root: 2.16.840.1.113883.4.642.40.2
  fmm-definition: changes-between-versions.html#us-core-maturity-levels

copyrightyear: '2026+'
# releaselabel: CI Build
# releaselabel: STU 9 Ballot
releaselabel: STU 9

# ╭────────────────────────────────────────────menu.xml────────────────────────────────────────────╮
# │  To use a provided ig-data/input/includes/menu.xml file, delete the "menu" property below.     │
# ╰────────────────────────────────────────────────────────────────────────────────────────────────╯
menu:
  Home: index.html
  Conformance: #conformance.html
      General Requirements: general-requirements.html
      Must Support: must-support.html
      SMART on FHIR Obligations and Capabilities: scopes.html
      Security: security.html
      Requirements Tables: requirements.html
  Guidance: #guidance.html
      USCDI: uscdi.html
      General Guidance: general-guidance.html
      Clinical Notes: clinical-notes.html
      Medication List: medication-list.html
      Basic Provenance: basic-provenance.html
      Screening and Assessments: screening-and-assessments.html
      # Changes Between Versions: changes-between-versions.html
      Relationship With Other IGs: relationship-with-other-igs.html

  FHIR Artifacts: #artifact.html
      Profiles: profiles-and-extensions.html#profiles
      Extensions: profiles-and-extensions.html#extensions
      Search Parameters: search-parameters-and-operations.html#search-parameters
      Operations: search-parameters-and-operations.html#operations
      Terminology: terminology.html
      Capability Statements: capability-statements.html#capability-statement
      Requirements: capability-statements.html#requirements-resource
      Examples: examples.html
  # Security: security.html
  # Examples: examples.html
  Downloads: downloads.html

  Version History: #version-history.html
      Change Log: changes.html
      Changes Between Versions: changes-between-versions.html

  Looking Ahead: #looking-ahead.html
      US Core Roadmap: us-core-roadmap.html
      Writing Vital Signs: writing-vital-signs.html
      Writing Clinical Notes: writing-clinical-notes.html
      Patient Data Feed: patient-data-feed.html