codeset

type Diff struct {
	Added   []Entry       `json:"added"`
	Removed []Entry       `json:"removed"`
	Changed []EntryChange `json:"changed"`
}

type Entry struct {
	// From is the incoming value.
	From string `yaml:"from" json:"from"`

	// To is what it becomes.
	To string `yaml:"to" json:"to"`

	// Why records why this particular entry exists, when it is not obvious.
	//
	// Per entry rather than only per table, because the unobvious ones are usually individual: a table of
	// twelve sex codes has one strange row, and that row is the one somebody will want to delete in three
	// years.
	Why string `yaml:"why,omitempty" json:"why,omitempty"`

	// Since records when this entry was added, for a table that grew over time.
	Since string `yaml:"since,omitempty" json:"since,omitempty"`
}

type EntryChange struct {
	From   string `json:"from"`
	Before string `json:"before"`
	After  string `json:"after"`
}

type Set struct {
	Tables []Table `yaml:"tables" json:"tables"`

	// Observe, when set, is told every value a map step could not find in a table, so unmapped codes can be listed for
	// somebody to map. Called on the message's goroutine; it must not block.
	Observe func(table, value string) `yaml:"-" json:"-"`
	// contains filtered or unexported fields
}

type Table struct {
	// Name is how channels refer to it.
	Name string `yaml:"name" json:"name"`

	// Describes says what this table is for, in words.
	//
	// Required, not optional. A table called "sex" tells the next person nothing about whether it maps into the
	// hospital's codes or out of them, and getting that backwards is a silent data error rather than a
	// failure.
	Describes string `yaml:"describes" json:"describes"`

	// Entries are the mappings.
	Entries []Entry `yaml:"entries" json:"entries"`

	// Default applies when a value is not in the table. Empty means keep the original.
	Default string `yaml:"default,omitempty" json:"default,omitempty"`

	// Strict makes an unmapped value an error rather than a pass-through.
	Strict bool `yaml:"strict,omitempty" json:"strict,omitempty"`

	// DecidedBy and DecidedOn are the provenance of the table as a whole.
	//
	// Free text, deliberately. A name, a team, a ticket number and "the 2019 migration" are all real answers,
	// and a schema that only accepted one of them would get an empty field or a lie.
	DecidedBy string `yaml:"decided_by,omitempty" json:"decidedBy,omitempty"`
	DecidedOn string `yaml:"decided_on,omitempty" json:"decidedOn,omitempty"`

	// Source records where the mapping came from - a specification, a conversation, an observed feed.
	Source string `yaml:"source,omitempty" json:"source,omitempty"`

	// Version names this edition of the table, so several can be kept under one name: the one in force, a draft waiting
	// for sign-off, and the ones before. Empty is a table with one edition.
	Version string `yaml:"version,omitempty" json:"version,omitempty"`

	// EffectiveFrom is the first day (YYYY-MM-DD, UTC) this edition is used; empty means from the start. A later approved
	// edition's EffectiveFrom ends this one, so a new mapping can be approved today and take over on the first of the month.
	EffectiveFrom string `yaml:"effective_from,omitempty" json:"effectiveFrom,omitempty"`

	// EffectiveUntil is the last day this edition is used, inclusive; empty means until a later edition takes over.
	EffectiveUntil string `yaml:"effective_until,omitempty" json:"effectiveUntil,omitempty"`

	// Status is approved (the default: in use within its dates), draft (written, waiting for sign-off, never used) or
	// retired (kept for the record, never used).
	Status string `yaml:"status,omitempty" json:"status,omitempty"`

	// Author is the account that saved this edition from the console, which sign-off is checked against.
	Author string `yaml:"author,omitempty" json:"author,omitempty"`

	// ApprovedBy and ApprovedOn record the sign-off of an edition that needed one.
	ApprovedBy string `yaml:"approved_by,omitempty" json:"approvedBy,omitempty"`
	ApprovedOn string `yaml:"approved_on,omitempty" json:"approvedOn,omitempty"`

	// SourceSystem and TargetSystem name the code systems of From and To (http://loinc.org, http://snomed.info/sct, a
	// local URL), so the console can check each entry against an imported code system and FHIR can publish the map.
	SourceSystem string `yaml:"source_system,omitempty" json:"sourceSystem,omitempty"`
	TargetSystem string `yaml:"target_system,omitempty" json:"targetSystem,omitempty"`
	// contains filtered or unexported fields
}