Jump to text
On this page
Copy and source
Published source confirmed at last check

Source changed 2026-11-18 22:51:26 UTC · snapshot created 2026-11-18 22:54:45 UTC · last check 2026-11-18 23:10:20 UTC

SIE.9:4 - Solution

Design the interface from receiving actions and semantic branches, not from the internal store. Expose the smallest result that preserves interpretation, source/version, currentness, accepted loss, identity and claim status, provenance, access assumptions, errors, unresolved returns, and source-return paths. Bind every field and branch to the use contract, mapping rules, and selected realization.

SIE.9:4.1 - Pattern-Use Unfolding

  1. Name the receiver interaction. State who or what asks, the query/message/report action, timing, input parameters, and the next Work or decision that consumes the answer.
  2. Select the interface form. Choose query, view, API, message, schema, report, file, or mixed human/machine form based on the receiving Work. Do not inherit the internal realization shape automatically.
  3. Define semantic inputs. State the identifiers a request accepts, how the interface validates their form and how it resolves them. Supply any required issuer, assignment context, configuration or effectivity, time window, units, locale or code context, and permissions.
  4. Define result claims and interpretation. For each output, state meaning, grain, scope, interval/effectivity, units/codes, source identifier behavior, accepted loss, and permitted use.
  5. Expose qualified branches. Represent matched/qualified, unmatched, incompatible, unresolved identity, source-qualified conflict, non-comparability, stale, inaccessible, timeout/source error, and partial result where applicable.
  6. Expose provenance and currentness. Provide source/edition or a stable reference, observation/retrieval time, mapping/composition rule version, derivation/trace reference, and freshness status needed by the receiver.
  7. State access, protection, and authority assumptions. Explain what the interface verifies, what the caller supplies, what may be disclosed, and which actions remain unauthorized by the semantic result.
  8. Provide challenge and return paths. A receiver must be able to identify which source, correspondence, identity disposition, composition, mapping or operational result needs examination and where to return the issue.
  9. Bind service behavior without claiming it. State latency, availability, pagination/volume, ordering, idempotence or snapshot expectations only where semantic use depends on them; obtain implementation/operation evidence separately.
  10. Define conformance and reopen. Give representative requests, responses, error branches, compatibility conditions, deprecation/change behavior, and observations that reopen the interface.

SIE.9:4.2 - Record the Result

Interface positionRequired content
receiver interactioncaller/reader, receiving Work, request, timing, next action
interface formquery/view/API/message/schema/report/file and why it fits the Work
request semanticsparameters, acceptable identifier forms and resolution context, configuration/effectivity, windows, units/codes, permissions
response semanticsclaims, grain, scope, interval, units/codes, source IDs, accepted loss, permitted use
branch modelqualified, unmatched, incompatible, unresolved identity, conflict, non-comparable, stale, inaccessible, source error, partial
provenance/currentnesssource/edition, times, rule versions, derivation/trace, freshness status
protection/authorityverified and assumed conditions, disclosure limits, action not authorized
challenge/returnstable path to source, semantic premise, mapping, implementation, or direct decision owner
service/conformanceaction-sensitive service conditions, examples, errors, compatibility/deprecation, reopen

SIE.9:4.3 - What Changes in Practice

The receiver no longer has to infer semantic meaning from field names or call the integration team to understand a missing row. Qualified, incompatible, conflicting, stale, and source-error states become part of the normal interface contract, and every challenge can be returned to a specific premise or owner.