mpi

type Comparison struct {
	Score  float64       `json:"score"` // 0 to 1: the evidence found as a share of the evidence possible
	Fields []FieldResult `json:"fields"`
	// Safe is whether the pair may be linked without a person: family name and birth date both agree.
	Safe bool `json:"safe"`
}

type Counts struct {
	Persons int `json:"persons"`
	Records int `json:"records"`
	Reviews int `json:"reviews"`
	// Linked is how many persons have more than one record: the duplicates the index has joined.
	Linked int `json:"linked"`
}

type Estimate struct {
	// Weights are the m and u probabilities per field, ready for Settings.Weights.
	Weights map[string]Weights `json:"weights"`
	// Compared is how many pairs had each field on both sides: a field compared on few pairs is estimated loosely.
	Compared map[string]int `json:"compared"`
	// Pairs is the number of candidate pairs the estimate was made from.
	Pairs int `json:"pairs"`
	// MatchShare is the estimated share of those pairs that are the same person.
	MatchShare float64 `json:"matchShare"`
	// Iterations and Converged describe the fit.
	Iterations int  `json:"iterations"`
	Converged  bool `json:"converged"`
}

type Event struct {
	At        time.Time `json:"at"`
	Actor     string    `json:"actor"`
	Action    string    `json:"action"`
	RecordID  int64     `json:"recordId,omitempty"`
	EUID      string    `json:"euid,omitempty"`
	OtherEUID string    `json:"otherEuid,omitempty"`
	Detail    string    `json:"detail,omitempty"`
}

type Extracted struct {
	Record Record
	// MergeFrom is the prior identifier an A40 (or A34, A18) merges into the record, as system|value.
	MergeFrom string
}

type FieldResult struct {
	Field  string  `json:"field"`
	Result string  `json:"result"` // agree, partial, disagree, missing
	Weight float64 `json:"weight"`
}

type FromOptions struct {
	// Authorities maps an HL7 assigning authority's namespace (PID-3.4.1) to its system URI, for authorities that send no
	// universal identifier. Unmapped ones become urn:perfuse:aa:<namespace>.
	Authorities map[string]string
	// IDType is the identifier type code (PID-3.5) of the record's own number. Default MR; the first identifier when none has it.
	IDType string
	// SSNSystem names PID-19. Default http://hl7.org/fhir/sid/us-ssn.
	SSNSystem string
}

type Match struct {
	Person *Person    `json:"person"`
	Score  float64    `json:"score"`
	Grade  string     `json:"grade"` // certain, probable, possible (FHIR's match-grade)
	Why    Comparison `json:"why"`
}

type Outcome struct {
	Record *Record `json:"record"`
	// Action is linked (to an existing person, How saying why), new (a new person), updated (a known record's
	// demographics), or review (a new person, and a possible match queued for a person to decide).
	Action string  `json:"action"`
	How    string  `json:"how,omitempty"` // identifier, score
	Score  float64 `json:"score,omitempty"`
	// ReviewID is the queued decision, when there is one.
	ReviewID int64 `json:"reviewId,omitempty"`
	// Warnings are national numbers whose check digit failed (masked): kept on the record, never used to link it.
	Warnings []string `json:"warnings,omitempty"`
}

type Person struct {
	EUID    string    `json:"euid"`
	Records []*Record `json:"records"`
	Created time.Time `json:"created"`
}

type Record struct {
	ID int64 `json:"id"`
	// System is the assigning authority (a URI or OID) and Value the number it gave: what makes the record unique.
	System string `json:"system"`
	Value  string `json:"value"`

	Family    string `json:"family,omitempty"`
	Given     string `json:"given,omitempty"`
	BirthDate string `json:"birthDate,omitempty"` // YYYY-MM-DD, or digits
	Sex       string `json:"sex,omitempty"`       // M, F, O, U
	Phone     string `json:"phone,omitempty"`
	Line      string `json:"line,omitempty"`
	City      string `json:"city,omitempty"`
	Postal    string `json:"postal,omitempty"`
	// Identifiers are other identifiers the record carries (system|value): an enterprise number, a payer member number.
	Identifiers []string `json:"identifiers,omitempty"`
	// Source is where it came from, such as a channel name.
	Source string `json:"source,omitempty"`

	EUID      string    `json:"euid,omitempty"`
	UpdatedAt time.Time `json:"updatedAt"`
}

type Review struct {
	ID        int64      `json:"id"`
	Record    *Record    `json:"record"`
	Candidate *Person    `json:"candidate"`
	Score     float64    `json:"score"`
	Why       Comparison `json:"why"`
	Status    string     `json:"status"` // open, same, different
	Created   time.Time  `json:"created"`
	DecidedBy string     `json:"decidedBy,omitempty"`
}

type Settings struct {
	// Automatic links a record to a person by score without asking anybody. Off by default: linking two people into one
	// (an overlay) puts one patient's results in another's chart, so until a site has watched the review queue and trusts
	// what it would have done, every scored match goes to a person. Trusted identifiers link either way.
	Automatic bool `json:"automatic"`
	// AutoLink is the score at or above which a pair links without review, when Automatic is on and name and birth date
	// also agree. Default 0.9. With Automatic off, matches above it are still queued, marked certain.
	AutoLink float64 `json:"autoLink"`
	// Review is the score at or above which a pair goes to the review queue. Default 0.6: low enough that twins and a sex
	// keyed wrongly reach a person, since only a person can tell those apart.
	Review float64 `json:"review"`
	// Trusted are identifier systems unique per person (a national identifier, an enterprise number): records sharing one
	// link at once. An identifier system shared by family members, such as a payer's subscriber number, must not be listed.
	Trusted []string `json:"trusted"`
	// EUIDSystem names the enterprise identifier in FHIR and PIX answers.
	EUIDSystem string `json:"euidSystem"`
	// Weights replaces DefaultWeights field by field, typically with values estimated from the site's own records
	// (EstimateWeights). Empty: the defaults.
	Weights map[string]Weights `json:"weights,omitempty"`
	// NationalSystems replaces a national identifier scheme's system URI (natid scheme ID to URI) where the country's guide
	// names it differently from Perfuse's default.
	NationalSystems map[string]string `json:"nationalSystems,omitempty"`
	// ShowNumbersTo is the lowest role that sees national numbers in full: viewer, operator, editor (the default) or admin.
	// Everybody below sees the last few characters only.
	ShowNumbersTo string `json:"showNumbersTo,omitempty"`
}

type Store struct {
	// contains filtered or unexported fields
}

type Weights struct {
	M float64 `json:"m"`
	U float64 `json:"u"`
}