@precisa-saude/fhir 0.36.0 → 0.37.0

package/dist/index.d.cts

@@ -344,4 +344,144 @@ declare const HL7_SPECIMEN_TYPE_SYSTEM = "http://terminology.hl7.org/CodeSystem/
  */
 declare const specimenTypeCoding: (text: string) => FHIRCoding | undefined;
 
-export { AGE_BRACKETS, Addressable, BIOMARKER_CODE_SYSTEM, BODY_FAT_ZONES, BR_TIPO_AMOSTRA_VALUESET, type BodyFatZone, CATEGORY_GROUPS, CATEGORY_SCREENING_INTERVALS, type CategoryGroup, type CategoryGroupInfo, type CategoryScreeningInterval, FHIRBundle, FHIRCoding, FHIRIdentifier, FHIRMedicationStatement, FHIRObservation, FHIR_BRASIL_EXTENSIONS, HL7_SPECIMEN_TYPE_SYSTEM, IG_CANONICAL, InterventionData, LOINC_SYSTEM, type ScreeningIntervalMonths, type TScoreZone, T_SCORE_ZONES, UserProfileData, ZONE_DEFS, calculateNextScreeningDate, cnsToFHIRIdentifier, cpfToFHIRIdentifier, formatCNS, formatCPF, getCategoriesByInterval, getCategoryGroup, getDaysUntilScreening, getDueCategories, getScreeningInterval, interventionToFHIRMedicationStatement, interventionToFHIRObservation, interventionsToFHIRBundle, isScreeningDue, listMappedSubcategories, plural, pluralCount, pluralPhrase, pluralPhraseCount, specimenTypeCoding, validateCNS, validateCPF };
+declare const LOINC_SNAPSHOT: LoincSnapshot;
+
+/**
+ * Os eixos e os grupos LOINC de cada código do catálogo, como o servidor
+ * oficial os publica, conferidos todo mês pelo `scripts/verify-loinc.ts`.
+ *
+ * Os dados vêm de `loinc-snapshot.generated.ts`, cópia do
+ * `scripts/loinc-snapshot.json` feita pelo gerador. Toda leitura daqui carrega
+ * o código e o display juntos, e quem republicar deve levar `LOINC_SNAPSHOT._notice`.
+ */
+
+/** Um código LOINC no snapshot, com os eixos na grafia em que o LOINC os exibe. */
+interface LoincEntry {
+    component: string | null;
+    display: string;
+    /** LOINC Groups (`LG…`) a que o código pertence, com o nome de cada um. */
+    groups?: Record<string, string>;
+    /** Único eixo opcional: a maioria dos códigos não afirma método. */
+    method: string | null;
+    property: string | null;
+    scale: string | null;
+    status: string | null;
+    system: string | null;
+    time: string | null;
+}
+interface LoincSnapshot {
+    _checkedAt: string;
+    _loincVersion: string | null;
+    /** Aviso da seção 10.1 da licença do LOINC. */
+    _notice: string;
+    codes: Record<string, LoincEntry>;
+}
+
+/** Os eixos de um código do catálogo, ou `undefined` se ele não está no snapshot. */
+declare function getLoincEntry(loinc: string): LoincEntry | undefined;
+
+/**
+ * Registro de decisão de cada mapeamento LOINC do catálogo.
+ *
+ * O catálogo em `biomarkers.ts` guarda a conclusão (o código). Este arquivo
+ * guarda por que aquele código e não outro: o que o laudo mostrou, o que
+ * decidiu, os irmãos descartados e quem revisou. É o diff que uma revisão de
+ * mapeamento lê.
+ *
+ * A maioria das entradas é `nameOnly`: o código foi escolhido pelo nome do
+ * exame, sem registro de unidade, método, material ou bula, e ninguém revisou
+ * de fora. É o registro honesto do que existe, e não justificativa inventada.
+ * As entradas com evidência vieram dos comentários em `biomarkers.ts` que já
+ * documentavam a troca. `reviewer` fica vazio até uma revisão independente.
+ *
+ * `loinc` repete o código do catálogo de propósito: trocar o código em
+ * `biomarkers.ts` sem tocar aqui falha em `mapping-decisions.test.ts`, e a
+ * troca chega à revisão com o registro ao lado.
+ *
+ * Sem import em runtime: o `scripts/verify-loinc.ts` lê este arquivo direto com
+ * o type stripping do Node, que não resolve import sem extensão. A ficha que
+ * junta registro, catálogo e eixos fica em `mapping-sheet.ts`.
+ */
+/** O que o laudo mostrou e pesou na escolha do código. */
+type MappingEvidence = 'assay-insert' | 'method-line' | 'name' | 'specimen' | 'unit';
+interface RejectedSibling {
+    loinc: string;
+    reason: string;
+}
+interface MappingDecision {
+    evidence: MappingEvidence[];
+    /** O código escolhido. Tem que ser o `loinc` do biomarcador no catálogo. */
+    loinc: string;
+    /** Versão do LOINC em que a revisão conferiu o código. */
+    loincVersion?: string;
+    note?: string;
+    reviewedAt?: string;
+    reviewer?: string;
+    /** Qual evidência decidiu. Está sempre em `evidence`. */
+    settledBy: MappingEvidence;
+    siblingsRejected: RejectedSibling[];
+}
+/**
+ * Por que uma entrada não tem LOINC.
+ *
+ * - `no-concept`: procurado, e o LOINC não tem o conceito.
+ * - `ambiguous`: há candidatos, e nenhum é a mesma grandeza.
+ * - `pending-review`: ninguém registrou a busca.
+ * - `not-lab`: fora do escopo de exame laboratorial.
+ */
+type NoLoincReason = 'ambiguous' | 'no-concept' | 'not-lab' | 'pending-review';
+interface NoLoincDecision {
+    note: string;
+    reason: NoLoincReason;
+}
+declare const MAPPING_DECISIONS: Record<string, MappingDecision>;
+declare const NO_LOINC_DECISIONS: Record<string, NoLoincDecision>;
+declare function getMappingDecision(code: string): MappingDecision | undefined;
+declare function getNoLoincDecision(code: string): NoLoincDecision | undefined;
+
+/** Um código candidato com os eixos que o snapshot guarda dele. */
+interface MappingCandidate {
+    axes?: LoincEntry;
+    loinc: string;
+    role: 'chosen' | 'method-variant' | 'rejected';
+    /** Pista impressa da variante, ou o motivo da rejeição. */
+    why?: string;
+}
+/** A ficha de um mapeamento, no formato da planilha de um mapeador. */
+interface MappingSheet {
+    candidates: MappingCandidate[];
+    code: string;
+    decision?: MappingDecision;
+    /** LOINC Groups do código escolhido. */
+    groups: Record<string, string>;
+    localNames: string[];
+    method: string | null;
+    noLoinc?: NoLoincDecision;
+    specimen: string | null;
+    unit?: string;
+}
+/** Aceita o código interno ou qualquer LOINC que resolva para o biomarcador. */
+declare function getMappingSheet(codeOrLoinc: string): MappingSheet | undefined;
+
+type SpecimenClass = 'blood' | 'urine';
+/** Classe do material impresso, ou `undefined` quando a palavra inicial não diz. */
+declare function specimenClassOf(material: string): SpecimenClass | undefined;
+/** Classe do eixo System do código, ou `undefined` fora do snapshot ou das duas classes. */
+declare function loincSpecimenClass(loinc: string): SpecimenClass | undefined;
+interface SpecimenMismatch {
+    /** Classe do eixo System do código. */
+    code: SpecimenClass;
+    loinc: string;
+    /** Classe do material impresso. */
+    material: SpecimenClass;
+    reason: 'specimen-mismatch';
+    system: string;
+}
+/**
+ * O conflito entre o material impresso e o código, ou `null` sem conflito
+ * afirmável. Quem chama decide o que fazer com o resultado, e a decisão que não
+ * existe é trocar o código por um palpite: conflito é lacuna, e sai como tal.
+ */
+declare function specimenMismatch(material: string, loinc: string): SpecimenMismatch | null;
+
+export { AGE_BRACKETS, Addressable, BIOMARKER_CODE_SYSTEM, BODY_FAT_ZONES, BR_TIPO_AMOSTRA_VALUESET, type BodyFatZone, CATEGORY_GROUPS, CATEGORY_SCREENING_INTERVALS, type CategoryGroup, type CategoryGroupInfo, type CategoryScreeningInterval, FHIRBundle, FHIRCoding, FHIRIdentifier, FHIRMedicationStatement, FHIRObservation, FHIR_BRASIL_EXTENSIONS, HL7_SPECIMEN_TYPE_SYSTEM, IG_CANONICAL, InterventionData, LOINC_SNAPSHOT, LOINC_SYSTEM, type LoincEntry, type LoincSnapshot, MAPPING_DECISIONS, type MappingCandidate, type MappingDecision, type MappingEvidence, type MappingSheet, NO_LOINC_DECISIONS, type NoLoincDecision, type NoLoincReason, type RejectedSibling, type ScreeningIntervalMonths, type SpecimenClass, type SpecimenMismatch, type TScoreZone, T_SCORE_ZONES, UserProfileData, ZONE_DEFS, calculateNextScreeningDate, cnsToFHIRIdentifier, cpfToFHIRIdentifier, formatCNS, formatCPF, getCategoriesByInterval, getCategoryGroup, getDaysUntilScreening, getDueCategories, getLoincEntry, getMappingDecision, getMappingSheet, getNoLoincDecision, getScreeningInterval, interventionToFHIRMedicationStatement, interventionToFHIRObservation, interventionsToFHIRBundle, isScreeningDue, listMappedSubcategories, loincSpecimenClass, plural, pluralCount, pluralPhrase, pluralPhraseCount, specimenClassOf, specimenMismatch, specimenTypeCoding, validateCNS, validateCPF };

package/dist/index.d.ts

@@ -344,4 +344,144 @@ declare const HL7_SPECIMEN_TYPE_SYSTEM = "http://terminology.hl7.org/CodeSystem/
  */
 declare const specimenTypeCoding: (text: string) => FHIRCoding | undefined;
 
-export { AGE_BRACKETS, Addressable, BIOMARKER_CODE_SYSTEM, BODY_FAT_ZONES, BR_TIPO_AMOSTRA_VALUESET, type BodyFatZone, CATEGORY_GROUPS, CATEGORY_SCREENING_INTERVALS, type CategoryGroup, type CategoryGroupInfo, type CategoryScreeningInterval, FHIRBundle, FHIRCoding, FHIRIdentifier, FHIRMedicationStatement, FHIRObservation, FHIR_BRASIL_EXTENSIONS, HL7_SPECIMEN_TYPE_SYSTEM, IG_CANONICAL, InterventionData, LOINC_SYSTEM, type ScreeningIntervalMonths, type TScoreZone, T_SCORE_ZONES, UserProfileData, ZONE_DEFS, calculateNextScreeningDate, cnsToFHIRIdentifier, cpfToFHIRIdentifier, formatCNS, formatCPF, getCategoriesByInterval, getCategoryGroup, getDaysUntilScreening, getDueCategories, getScreeningInterval, interventionToFHIRMedicationStatement, interventionToFHIRObservation, interventionsToFHIRBundle, isScreeningDue, listMappedSubcategories, plural, pluralCount, pluralPhrase, pluralPhraseCount, specimenTypeCoding, validateCNS, validateCPF };
+declare const LOINC_SNAPSHOT: LoincSnapshot;
+
+/**
+ * Os eixos e os grupos LOINC de cada código do catálogo, como o servidor
+ * oficial os publica, conferidos todo mês pelo `scripts/verify-loinc.ts`.
+ *
+ * Os dados vêm de `loinc-snapshot.generated.ts`, cópia do
+ * `scripts/loinc-snapshot.json` feita pelo gerador. Toda leitura daqui carrega
+ * o código e o display juntos, e quem republicar deve levar `LOINC_SNAPSHOT._notice`.
+ */
+
+/** Um código LOINC no snapshot, com os eixos na grafia em que o LOINC os exibe. */
+interface LoincEntry {
+    component: string | null;
+    display: string;
+    /** LOINC Groups (`LG…`) a que o código pertence, com o nome de cada um. */
+    groups?: Record<string, string>;
+    /** Único eixo opcional: a maioria dos códigos não afirma método. */
+    method: string | null;
+    property: string | null;
+    scale: string | null;
+    status: string | null;
+    system: string | null;
+    time: string | null;
+}
+interface LoincSnapshot {
+    _checkedAt: string;
+    _loincVersion: string | null;
+    /** Aviso da seção 10.1 da licença do LOINC. */
+    _notice: string;
+    codes: Record<string, LoincEntry>;
+}
+
+/** Os eixos de um código do catálogo, ou `undefined` se ele não está no snapshot. */
+declare function getLoincEntry(loinc: string): LoincEntry | undefined;
+
+/**
+ * Registro de decisão de cada mapeamento LOINC do catálogo.
+ *
+ * O catálogo em `biomarkers.ts` guarda a conclusão (o código). Este arquivo
+ * guarda por que aquele código e não outro: o que o laudo mostrou, o que
+ * decidiu, os irmãos descartados e quem revisou. É o diff que uma revisão de
+ * mapeamento lê.
+ *
+ * A maioria das entradas é `nameOnly`: o código foi escolhido pelo nome do
+ * exame, sem registro de unidade, método, material ou bula, e ninguém revisou
+ * de fora. É o registro honesto do que existe, e não justificativa inventada.
+ * As entradas com evidência vieram dos comentários em `biomarkers.ts` que já
+ * documentavam a troca. `reviewer` fica vazio até uma revisão independente.
+ *
+ * `loinc` repete o código do catálogo de propósito: trocar o código em
+ * `biomarkers.ts` sem tocar aqui falha em `mapping-decisions.test.ts`, e a
+ * troca chega à revisão com o registro ao lado.
+ *
+ * Sem import em runtime: o `scripts/verify-loinc.ts` lê este arquivo direto com
+ * o type stripping do Node, que não resolve import sem extensão. A ficha que
+ * junta registro, catálogo e eixos fica em `mapping-sheet.ts`.
+ */
+/** O que o laudo mostrou e pesou na escolha do código. */
+type MappingEvidence = 'assay-insert' | 'method-line' | 'name' | 'specimen' | 'unit';
+interface RejectedSibling {
+    loinc: string;
+    reason: string;
+}
+interface MappingDecision {
+    evidence: MappingEvidence[];
+    /** O código escolhido. Tem que ser o `loinc` do biomarcador no catálogo. */
+    loinc: string;
+    /** Versão do LOINC em que a revisão conferiu o código. */
+    loincVersion?: string;
+    note?: string;
+    reviewedAt?: string;
+    reviewer?: string;
+    /** Qual evidência decidiu. Está sempre em `evidence`. */
+    settledBy: MappingEvidence;
+    siblingsRejected: RejectedSibling[];
+}
+/**
+ * Por que uma entrada não tem LOINC.
+ *
+ * - `no-concept`: procurado, e o LOINC não tem o conceito.
+ * - `ambiguous`: há candidatos, e nenhum é a mesma grandeza.
+ * - `pending-review`: ninguém registrou a busca.
+ * - `not-lab`: fora do escopo de exame laboratorial.
+ */
+type NoLoincReason = 'ambiguous' | 'no-concept' | 'not-lab' | 'pending-review';
+interface NoLoincDecision {
+    note: string;
+    reason: NoLoincReason;
+}
+declare const MAPPING_DECISIONS: Record<string, MappingDecision>;
+declare const NO_LOINC_DECISIONS: Record<string, NoLoincDecision>;
+declare function getMappingDecision(code: string): MappingDecision | undefined;
+declare function getNoLoincDecision(code: string): NoLoincDecision | undefined;
+
+/** Um código candidato com os eixos que o snapshot guarda dele. */
+interface MappingCandidate {
+    axes?: LoincEntry;
+    loinc: string;
+    role: 'chosen' | 'method-variant' | 'rejected';
+    /** Pista impressa da variante, ou o motivo da rejeição. */
+    why?: string;
+}
+/** A ficha de um mapeamento, no formato da planilha de um mapeador. */
+interface MappingSheet {
+    candidates: MappingCandidate[];
+    code: string;
+    decision?: MappingDecision;
+    /** LOINC Groups do código escolhido. */
+    groups: Record<string, string>;
+    localNames: string[];
+    method: string | null;
+    noLoinc?: NoLoincDecision;
+    specimen: string | null;
+    unit?: string;
+}
+/** Aceita o código interno ou qualquer LOINC que resolva para o biomarcador. */
+declare function getMappingSheet(codeOrLoinc: string): MappingSheet | undefined;
+
+type SpecimenClass = 'blood' | 'urine';
+/** Classe do material impresso, ou `undefined` quando a palavra inicial não diz. */
+declare function specimenClassOf(material: string): SpecimenClass | undefined;
+/** Classe do eixo System do código, ou `undefined` fora do snapshot ou das duas classes. */
+declare function loincSpecimenClass(loinc: string): SpecimenClass | undefined;
+interface SpecimenMismatch {
+    /** Classe do eixo System do código. */
+    code: SpecimenClass;
+    loinc: string;
+    /** Classe do material impresso. */
+    material: SpecimenClass;
+    reason: 'specimen-mismatch';
+    system: string;
+}
+/**
+ * O conflito entre o material impresso e o código, ou `null` sem conflito
+ * afirmável. Quem chama decide o que fazer com o resultado, e a decisão que não
+ * existe é trocar o código por um palpite: conflito é lacuna, e sai como tal.
+ */
+declare function specimenMismatch(material: string, loinc: string): SpecimenMismatch | null;
+
+export { AGE_BRACKETS, Addressable, BIOMARKER_CODE_SYSTEM, BODY_FAT_ZONES, BR_TIPO_AMOSTRA_VALUESET, type BodyFatZone, CATEGORY_GROUPS, CATEGORY_SCREENING_INTERVALS, type CategoryGroup, type CategoryGroupInfo, type CategoryScreeningInterval, FHIRBundle, FHIRCoding, FHIRIdentifier, FHIRMedicationStatement, FHIRObservation, FHIR_BRASIL_EXTENSIONS, HL7_SPECIMEN_TYPE_SYSTEM, IG_CANONICAL, InterventionData, LOINC_SNAPSHOT, LOINC_SYSTEM, type LoincEntry, type LoincSnapshot, MAPPING_DECISIONS, type MappingCandidate, type MappingDecision, type MappingEvidence, type MappingSheet, NO_LOINC_DECISIONS, type NoLoincDecision, type NoLoincReason, type RejectedSibling, type ScreeningIntervalMonths, type SpecimenClass, type SpecimenMismatch, type TScoreZone, T_SCORE_ZONES, UserProfileData, ZONE_DEFS, calculateNextScreeningDate, cnsToFHIRIdentifier, cpfToFHIRIdentifier, formatCNS, formatCPF, getCategoriesByInterval, getCategoryGroup, getDaysUntilScreening, getDueCategories, getLoincEntry, getMappingDecision, getMappingSheet, getNoLoincDecision, getScreeningInterval, interventionToFHIRMedicationStatement, interventionToFHIRObservation, interventionsToFHIRBundle, isScreeningDue, listMappedSubcategories, loincSpecimenClass, plural, pluralCount, pluralPhrase, pluralPhraseCount, specimenClassOf, specimenMismatch, specimenTypeCoding, validateCNS, validateCPF };