BPMN → FHIR Shorthand
Derive FSH from a DAK’s BPMN business processes (the inverse of the extractors).
| Tool | bpmn-to-fsh |
| IRI | http://smart.who.int/base/tools/bpmn-to-fsh.jsonld |
| part of | http://smart.who.int/base/smart-base.jsonld |
| type | https://litlfred.github.io/cat-harness/v0/ns/Tool |
| declared by | smart-base |
| invoked | shell |
| qa | qa-reports |
Skills it satisfies
A skill states the capability; this Tool is one way to exercise it. Each skill’s declared input and output contract follows, where it has one.
smart-base-tools
Source: smart-base/skills/content/authoring-who-smart-guidelines/smart-base-tools.md.
Also satisfied by: extract-dak, kg-extract-dak, bpmn-graphviz-layout, bpmn-validate, kg-extract-bpmn, kg-extract-citations, kg-extract-dmn, kg-extract-l3.
The skill declares no I/O contract (schemas/skills/smart-base-tools/{input,output}.schema.json).
Inputs and outputs
Each port names a shared type by IRI, so two Tools for one skill can be checked for interchangeability.
| port | type | required | description | constraint | |
|---|---|---|---|---|---|
| in | bpmn | FilesystemPath | yes | string · A filesystem path, possibly outside the repository. Not admissible as a command-line argument. | |
| out | fsh | RepoPath | Generated FSH, for SUSHI to compile. | string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments. |
Processes and tasks
Steps this Tool can carry out, because each names a skill it satisfies:
| process | step | lane | via skill |
|---|---|---|---|
| SMART Guideline end to end | 3 · Choose L2 dependencies (WHO / jurisdiction DAKs) | Authoring agent | smart-base-tools |
| SMART Guideline end to end | 4 · Create / adapt L2 DAK assets | Authoring agent | smart-base-tools |
| SMART Guideline end to end | 5 · Choose L3 dependencies (WHO / jurisdiction IGs) | Authoring agent | smart-base-tools |
| SMART Guideline end to end | 6 · Produce L3 assets | Authoring agent | smart-base-tools |
How it is deployed and reached
- Command line. From the repository root:
python3 smart-base/scripts/smart-base-transform.py bpmn2fsh <file.bpmn|dir> [-o OUTDIR]. - GitHub Actions. No workflow in this checkout runs its command.
As an API: its operation in the OpenAPI document and the MCP tool list of its layer.
| install | none |
| runtime | python3 |
| network | no |
| when to choose it | |
|---|---|
| when | An L2 business process is to reach L3 as a computable artefact, not only a picture. |
| limits | Requires a smart-base checkout at SMART_BASE_HOME; without one the capability is ABSENT, not a clean run. |
| cost | Seconds, plus the upstream checkout. |
What it is made of
| role | file | |
|---|---|---|
| script | smart-base/scripts/smart-base-transform.py |
Linked data
The Tool is published as its own JSON-LD document at its IRI, http://smart.who.int/base/tools/bpmn-to-fsh.jsonld, partOf its layer’s document. The node below is the definition this page was drawn from, and is embedded in the page as application/ld+json.
{
"@context": "http://smart.who.int/base/smart-base.context.jsonld",
"@id": "http://smart.who.int/base/tools/bpmn-to-fsh.jsonld",
"@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
"partOf": "http://smart.who.int/base/smart-base.jsonld",
"name": "bpmn-to-fsh",
"title": "BPMN → FHIR Shorthand",
"description": "Derive FSH from a DAK's BPMN business processes (the inverse of the extractors).",
"install": {
"none": true
},
"invoke": {
"shell": "python3 smart-base/scripts/smart-base-transform.py bpmn2fsh <file.bpmn|dir> [-o OUTDIR]"
},
"io": {
"inputs": [
{
"name": "bpmn",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/FilesystemPath",
"required": true
}
],
"outputs": [
{
"name": "fsh",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
"description": "Generated FSH, for SUSHI to compile."
}
]
},
"satisfies": [
"smart-base-tools"
],
"requirements": {
"runtime": [
"python3"
],
"network": false
},
"selection": {
"when": "An L2 business process is to reach L3 as a computable artefact, not only a picture.",
"limits": "Requires a `smart-base` checkout at `SMART_BASE_HOME`; without one the capability is ABSENT, not a clean run.",
"cost": "Seconds, plus the upstream checkout."
}
}