-
Notifications
You must be signed in to change notification settings - Fork 0
API Reference
Every exported symbol, grouped. For usage, see Guides. For meaning, see Concepts.
import { ErrorCode, HolonError, ValidationError } from "@ontomorph/holon-types";The enum every HOLON error and error response uses (CONCEPT_NOT_FOUND, NO_MAPPING_FOUND, INTERACTION_CHECK_FAILED, UNAUTHORIZED, RATE_LIMIT_EXCEEDED, VALIDATION_ERROR, and more).
The base error class. Carries .code: ErrorCode and .details?: unknown.
Subclass thrown by the query layer for a malformed ECL query.
Subclass thrown by the query layer for a malformed CQL query.
Subclass thrown by the validation layer when input fails validation.
Subclass thrown when a transaction fails.
import { ok, err, type ServiceResult } from "@ontomorph/holon-types";A lightweight discriminated-union result type used across the HOLON services. Callers branch on .success.
Constructor for a success result: ok(data).
Constructor for a failure result: err(message, code).
import { VocabularyId, DomainId, StandardConcept, MappingEquivalence, MappingOrigin } from "@ontomorph/holon-types";The supported source vocabularies (SNOMED-CT, RxNorm, LOINC, ICD11, HPO, FMA, and others). VocabularyId.SNOMED_CT === "SNOMED-CT", VocabularyId.RXNORM === "RxNorm", VocabularyId.LOINC === "LOINC".
The concept domains, naming what kind of thing a concept is (a Drug, a Measurement, a Condition).
The standard-concept flags.
A classifier for how two mapped concepts relate.
A classifier for where a mapping came from.
import { HOLON_URI_SCHEME, type HolonUriParts, MIME_TURTLE } from "@ontomorph/holon-types";The URI scheme, equal to "holon".
The parsed pieces of a holon: concept URI.
The text/turtle MIME type, for serializing concepts as Turtle.
Interfaces mirroring exactly what the API returns, so client and server share one definition.
A single clinical idea with a stable id.
A projected view of a concept.
The concept shape used for indexing.
An ancestor relationship for a concept.
A mapping from one concept to another.
A concept identifier.
The severity of a drug interaction.
The grade of supporting evidence.
The equivalence of a concept map entry.
The type of a concept relationship.
The response shape for a single concept.
The response shape for a concept's ancestry.
The response shape for a concept's descendants.
The response shape for a translation between vocabularies.
The response shape for a health check.
The status of a curation item.
A consumer role.
The release status of a vocabulary.
A concept with no mapping.
A page of unmapped concepts.