Skip to content
This repository has been archived by the owner on Oct 17, 2019. It is now read-only.

Commit

Permalink
Add documentation for package-list.json (#214)
Browse files Browse the repository at this point in the history
(cherry picked from commit 4b482e9)
  • Loading branch information
cmoesel committed Jun 6, 2019
1 parent 7accbbd commit 26062b8
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,22 +166,25 @@ These configurations are used to highlight specific elements as more important i

The contents of the `implementationGuide` object are as follows:

|Parameter |Type |Description |
|:-------------------------|:--------|:-----------------------------------------------------------------|
|`npmName` |`string` |The assigned npm-name for this IG (usually assign by HL7). |
|`version` |`string` |The version of this IG (not necessarily the version of FHIR). |
|`includeLogicalModels` |`boolean`|A value indicating whether to include logical models in the IG. |
|`includeModelDoc` |`boolean`|A value indicating whether to include the model doc in the IG. |
|`indexContent` |`string` |The name of the file or folder containing the IG index content. |
|`examples` |`string` |The name of the folder containing examples to include in the IG. |
|`primarySelectionStrategy`|`{}` |The strategy for selection of what is primary in the IG. |
|Parameter |Type |Description |
|:-------------------------|:--------|:--------------------------------------------------------------------|
|`npmName` |`string` |The assigned npm-name for this IG (usually assign by HL7). |
|`version` |`string` |The version of this IG (not necessarily the version of FHIR). |
|`packageList` |`string` |The name of the file to use as the package-list.json for publication.|
|`includeLogicalModels` |`boolean`|A value indicating whether to include logical models in the IG. |
|`includeModelDoc` |`boolean`|A value indicating whether to include the model doc in the IG. |
|`indexContent` |`string` |The name of the file or folder containing the IG index content. |
|`examples` |`string` |The name of the folder containing examples to include in the IG. |
|`primarySelectionStrategy`|`{}` |The strategy for selection of what is primary in the IG. |

If the `indexContent` value is a path to a folder (relative to the spec directory), then it should contain an `index.html` file whose contents will be used as the body of the IG landing page.

The folder indicated by `examples` should include one file per JSON-formatted example. Each example may be named as the author wishes, but we recommend the example name match the example `id` in the file (with a `.json` file extension added). The example JSON must contain an `id` and the example's `meta.profile` should include the canonical URL for the profile it exemplifies (e.g., `"meta": { "profile": [ "http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastCancerPresenceStatement" ] }`).

_NOTE: For backwards compatibility, if no `examples` folder is specified in the config, and a folder named "fhir-examples" exists in the spec directory, it will be used as the examples folder._

The file indicated by `packageList` will be used as the `package-list.json` file for publication. This file is required for all HL7 IGs. If a `packageList` file is not indicated, it will default to `package-list.json`. If a package file exists at the configured location, it will be used. Otherwise, if the configured `fhirURL` is an hl7.org or fhir.org URL (indicating it is an HL7 publication), a basic package list file will be created. In this case, the IG author should review and modify the file as needed and then check it into the version control system. For more information about the `package-list.json` file, see: [http://wiki.hl7.org/index.php?title=FHIR_IG_PackageList_doco](http://wiki.hl7.org/index.php?title=FHIR_IG_PackageList_doco).

The contents of the `primarySelectionStrategy` object are as follows:

|Parameter |Type |Description |
Expand Down

0 comments on commit 26062b8

Please sign in to comment.