Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 4.45 KB

prog.md

File metadata and controls

79 lines (58 loc) · 4.45 KB
Raw

Programs, Workflows and States

Domain 'programs'

The programs subfolder contains CSV import files for saving programs in bulk. This is a possible example of its content:

programs/
  ├── opd_programs.csv
  └── ...

There is currently only one format for the program CSV line, here is an example:

Uuid Void/Retire Program concept Outcomes concept _order:1000
eae98b4c-e195-403b-b34a-82d94103b2c0 TB Program TB Program Outcomes


Let's review the headers.

Header Program concept

This is a reference (UUID, same as mapping or name) to the underlying concept that defines the program. The program name and description will be inferred from this concept and cannot be provided directly.

Header Outcomes concept

This is a reference (UUID, same as mapping or name) to the concept that defines the outcomes of the program, typically a set.

Domain 'programworkflows'

The programworkflows subfolder contains CSV import files for saving program workflows in bulk while linking them to their programs. This is a possible example of its content:

programworkflows/
  ├── opd_program_workflows.csv
  └── ...

There is currently only one format for the program CSV line, here is an example:

Uuid Void/Retire Program Workflow concept _order:1000
2b98bc76-245c-11e1-9cf0-00248140a5eb TB Program TB Treatment Status (workflow)


Let's review the headers.

Header Program

This is a reference to the program that the workflow should be added to. It can be either the program name, the program UUID or a reference to the program's underlying defining concept (concept name, concept UUID or 'same as' concept mapping).

A workflow can only added to one program, attempting to add to another program an existing workflow that is already added to a program will not produce any changes to the workflow (and an error will be logged.)

Header Workflow concept

This is a reference (UUID, same as mapping or name) to the underlying concept that defines the program workflow. The program workflow name and description will be inferred from this concept and cannot be provided directly.

Domain 'programworkflowstates'

The programworkflowstates subfolder contains CSV import files for saving program workflow states in bulk while linking them to their workflows. This is a possible example of its content:

programworkflows/
  ├── opd_program_workflow_states.csv
  └── ...

There is currently only one format for the program CSV line, here is an example:

Uuid Void/Retire Workflow State concept Initial Terminal _order:1000
cfa241f4-2700-102b-80cb-0017a47871b2 TB Treatment Status (workflow) Active treatment (initial) true
88b717c0-f580-497a-8d2b-026b60dd6bfd TB Treatment Status (workflow) Transferred out true


Let's review the headers.

Header Workflow

This is a reference to the workflow that the state should be added to. It can be either the workflow UUID or a reference to the workflow's underlying defining concept (concept name, concept UUID or 'same as' concept mapping).

A state can only added to one workflow, attempting to add to another workflow an existing state that is already added to a workflow will not produce any changes to the state (and an error will be logged.)

Header State concept

This is a reference (UUID, same as mapping or name) to the underlying concept that defines the program workflow state. The program workflow state name and description will be inferred from this concept and cannot be provided directly.

Header Initial

Set this to a true value to indicate that the state is an initial state of the workflow. Leave this blank or set this to a false value to indicate that the state is not an initial state of the workflow.

Header Terminal

Set this to a true value to indicate that the state is an terminal state of the workflow. Leave this blank or set this to a false value to indicate that the state is not an terminal state of the workflow.