Skip to main content
Version: v0.0.3

Interface: FindingLocus

The structural locus a finding refers to: segment name plus, where applicable, the field position, component, repetition, and segment occurrence. Every member is a name or an index: a locus is inherently PHI-free and never carries a field value.

A finding with no field is segment-level (presence / cardinality of the segment itself); a finding with a field is field-level. For a FINDING_CODES.PROFILE_MALFORMED diagnostic (a defect in the profile, not the message) segment may be the sentinel "(profile)".

Properties

component?

readonly optional component?: number

1-indexed component, when a component-scoped check (length / value-set) fired.


field?

readonly optional field?: number

1-indexed field position, when the finding is field-level.


occurrence?

readonly optional occurrence?: number

0-indexed segment occurrence, when the segment type repeats.


repetition?

readonly optional repetition?: number

0-indexed field repetition, when the finding is repetition-scoped.


segment

readonly segment: string

Segment name (e.g. "PID"), or "(profile)" for a profile-shape defect.