# ╭─────────────────────────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: nz.central.ihub.ig canonical: https://fhir-ig.digital.health.nz/crih ## If you change this, then the URLs of all the NZCentralRegion resource profiles in l4h-templates:/src/main/resources/hl7/message/*.yml need to be changed to match name: CRIntegrationHub title: Te Whatu Ora, Central Region Integration Hub description: Implementation Guide for Central Region's FHIR based Integration Hub status: active # draft | active | retired | unknown version: 1.0.12-rc2 fhirVersion: 4.0.1 # https://www.hl7.org/fhir/valueset-FHIR-version.html copyrightYear: 2024+ 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#NZ "New Zealand" publisher: name: Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral url: http://https://www.tewhatuora.govt.nz/ # email: test@example.org # 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.terminology.r4: 5.5.0 fhir.org.nz.ig.base: 2.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: Home technologyLandscape.md: title: Technology Landscape useCaseReferPatient.md: title: "Use Case: Refer Patient" useCaseUpdatePatient.md: title: "Use Case: Update Patient Details" clinicalResources.xml: title: Clinical Resources terminologyResources.xml: title: Terminology Resources foundationResources.xml: title: Foundation Resources devGuide-Onboarding.md: title: API Client Onboarding devGuide-Subscriptions.md: title: Patient Update Subscriptions ReleaseNotes.md: title: Release Notes # # # 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 excludexml: true autoload-resources: false ## Because we don't use the `canonical` URL above as the root of all the URLs for the artefacts we're defining. ## HISO has rules about how standards.digital.health.nz URLs are defined, that pre-date FHIR's plethora of URLs. ## So we have to list them all specifically here, so we don't get a "Canonical URL doesn't match actual URL" error. special-url: # Extension URLs - https://standards.digital.health.nz/ns/central-region/alert - https://standards.digital.health.nz/ns/central-region/referral - https://standards.digital.health.nz/ns/central-region/mental-health-status - https://standards.digital.health.nz/ns/central-region/nz-ethnicity - https://standards.digital.health.nz/ns/central-region/religion - https://standards.digital.health.nz/ns/central-region/nz-residency - https://standards.digital.health.nz/fhir/central-region/extn-contact-relationship - http://ibm.com/fhir/cdm/StructureDefinition/process-client-id - http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version - http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger - http://ibm.com/fhir/cdm/StructureDefinition/source-record-id - http://ibm.com/fhir/cdm/StructureDefinition/source-record-type - http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp - https://standards.digital.health.nz/ns/central-region/hl7v2-message - https://standards.digital.health.nz/ns/central-region/l4h-template-version ## ValueSet URLs - https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-allergy - https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-alert-code - https://standards.digital.health.nz/fhir/central-region/ValueSet-allergy-reaction - https://standards.digital.health.nz/fhir/central-region/ValueSet-clinic-code - https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-contact-relationship - https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-ethnicity - https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-language - https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-religion - https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-nz-residency - https://standards.digital.health.nz/fhir/central-region/ValueSet-contact-relationship - https://standards.digital.health.nz/fhir/central-region/ValueSet-department-code - https://standards.digital.health.nz/fhir/central-region/ValueSet-ethnicity-level-2 - https://standards.digital.health.nz/fhir/central-region/ValueSet-alert-type-flag - https://standards.digital.health.nz/fhir/central-region/ValueSet-flag-alert-code - https://standards.digital.health.nz/fhir/central-region/ValueSet-health-purchaser - https://standards.digital.health.nz/fhir/central-region/ValueSet-hospital-code - https://standards.digital.health.nz/fhir/central-region/ValueSet-language - https://standards.digital.health.nz/fhir/central-region/ValueSet-marital-status - https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-court-type - https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-legal-status - https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-review-location - https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-review-status - https://standards.digital.health.nz/fhir/central-region/ValueSet-raw-language - https://standards.digital.health.nz/fhir/central-region/ValueSet-raw-marital-status - https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-priority - https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-reason - https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-site - https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-source - https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-status - https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-type - https://standards.digital.health.nz/fhir/central-region/ValueSet-nz-residency ## CodeSystem URLs - https://standards.digital.health.nz/ns/central-region/alert-category - https://standards.digital.health.nz/ns/central-region/allergy-alert-code-h1 - https://standards.digital.health.nz/ns/central-region/allergy-alert-code-h3 - https://standards.digital.health.nz/ns/central-region/allergy-alert-code-a3-a4 - https://standards.digital.health.nz/ns/central-region/allergy-reaction-a3-a4 - https://standards.digital.health.nz/ns/central-region/allergy-reaction-h1-h3 - https://standards.digital.health.nz/ns/central-region/flag-alert-code-da - https://standards.digital.health.nz/ns/central-region/flag-alert-code-h2 - https://standards.digital.health.nz/ns/central-region/flag-alert-code-h4 - https://standards.digital.health.nz/ns/central-region/flag-alert-code-h5 - https://standards.digital.health.nz/ns/central-region/flag-alert-code-h6 - https://standards.digital.health.nz/ns/central-region/flag-alert-code-h7 - https://standards.digital.health.nz/ns/central-region/flag-alert-code-h8 - https://standards.digital.health.nz/ns/central-region/flag-alert-code-ls - https://standards.digital.health.nz/ns/central-region/health-purchaser - https://standards.digital.health.nz/ns/central-region/hospital-code - https://standards.digital.health.nz/ns/central-region/mental-health-court-type - https://standards.digital.health.nz/ns/central-region/mental-health-legal-status - https://standards.digital.health.nz/ns/central-region/mental-health-review-location - https://standards.digital.health.nz/ns/central-region/mental-health-review-status - https://standards.digital.health.nz/ns/central-region/clinic-code - https://standards.digital.health.nz/ns/central-region/contact-relationship - https://standards.digital.health.nz/ns/central-region/department-code - https://standards.digital.health.nz/ns/central-region/proposed-language - https://standards.digital.health.nz/ns/central-region/pas-language - https://standards.digital.health.nz/ns/central-region/raw-marital-status - https://standards.digital.health.nz/ns/central-region/pas-referral-category - https://standards.digital.health.nz/ns/central-region/pas-referral-priority - https://standards.digital.health.nz/ns/central-region/pas-referral-status - https://standards.digital.health.nz/ns/central-region/referral-reason - https://standards.digital.health.nz/ns/central-region/referral-site - https://standards.digital.health.nz/ns/central-region/referral-source - https://standards.digital.health.nz/ns/central-region/referral-type-ri - https://standards.digital.health.nz/ns/central-region/referral-type-wu - https://standards.digital.health.nz/ns/central-region/patient-religion - https://standards.digital.health.nz/ns/ethnic-group-level-2-code - https://standards.digital.health.nz/ns/central-region/nz-residency-code ## ValueSet urls - https://standards.digital.health.nz/fhir/central-region/ValueSet-combined-alert-type ## ConceptMap urls - https://standards.digital.health.nz/fhir/central-region/ConceptMap-flag-category - https://standards.digital.health.nz/fhir/central-region/ConceptMap-allergy-reaction-category - https://standards.digital.health.nz/fhir/central-region/ConceptMap-allergy-reaction-criticality - https://standards.digital.health.nz/fhir/central-region/ConceptMap-allergy-reaction-type - https://standards.digital.health.nz/fhir/central-region/ConceptMap-ethnicity - https://standards.digital.health.nz/fhir/central-region/ConceptMap-language - https://standards.digital.health.nz/fhir/central-region/ConceptMap-marital-status - https://standards.digital.health.nz/fhir/central-region/ConceptMap-nz-residency - https://standards.digital.health.nz/fhir/central-region/ConceptMap-religion - https://standards.digital.health.nz/fhir/central-region/ConceptMap-referral-priority ## HAPI FHIR extensions for Subscription resource - http://hapifhir.io/fhir/StructureDefinition/subscription-payload-search-criteria - http://hapifhir.io/fhir/StructureDefinition/subscription-delivery-retry-count ## SmileCDR extensions - https://smilecdr.com/fhir/ns/StructureDefinition/subscription-channel-rest-delivery-class # 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 Technology Landscape: technologyLandscape.html Use Cases: Refer Patient: useCaseReferPatient.html Update Patient: useCaseUpdatePatient.html APIs: Clinical Resources: clinicalResources.html Terminoloy Resources: terminologyResources.html FHIR Foundation Resources: foundationResources.html All Resources: CapabilityStatement-nzcr-SmileCDR.html Artifacts: artifacts.html Developer Guide: Onboarding: devGuide-Onboarding.html Subscriptions: devGuide-Subscriptions.html Support: Release Notes: ReleaseNotes.html IG Package: package.tgz IG Q&A: qa.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: bobsmith@example.org # 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: CapabilityStatement/nzcr-SmileCDR: name: Central Region Integration Hub Capabilities description: "FHIR Endpoints as a facade on Regional HL7 Messages, powered by Smile CDR" # # # 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