@imranq2/fhirpatientsummary 1.0.4 → 1.0.6

package/dist/index.d.cts

@@ -0,0 +1,718 @@
+type TUri = string;
+
+type TBase64Binary = string;
+
+type TCanonical = string;
+
+type TDate = string;
+
+type TDateTime = string;
+
+type TDecimal = number;
+
+type TId = string;
+
+type TInstant = string | Date;
+
+type TInt = number;
+
+type TMarkdown = string;
+
+type TOid = string;
+
+type TTime = string;
+
+type TUnsignedInt = number;
+
+type TUrl = string;
+
+type TUuid = string;
+
+type TPeriod = {
+    id?: string;
+    extension?: TExtension[];
+    start?: TDateTime;
+    end?: TDateTime;
+};
+
+type TAddress = {
+    id?: string;
+    extension?: TExtension[];
+    use?: string;
+    type?: string;
+    text?: string;
+    line?: string[];
+    city?: string;
+    district?: string;
+    state?: string;
+    postalCode?: string;
+    country?: string;
+    period?: TPeriod;
+};
+
+type TQuantity = {
+    id?: string;
+    extension?: TExtension[];
+    value?: TDecimal;
+    comparator?: string;
+    unit?: string;
+    system?: TUri;
+    code?: string;
+};
+
+type TCoding = {
+    id?: string;
+    extension?: TExtension[];
+    system?: TUri;
+    version?: string;
+    code?: string;
+    display?: string;
+    userSelected?: boolean;
+};
+
+type TCodeableConcept = {
+    id?: string;
+    extension?: TExtension[];
+    coding?: TCoding[];
+    text?: string;
+};
+
+type TIdentifier = {
+    id?: string;
+    extension?: TExtension[];
+    use?: string;
+    type?: TCodeableConcept;
+    system?: TUri;
+    value?: string;
+    period?: TPeriod;
+    assigner?: TReference;
+};
+
+type TReference = {
+    id?: string;
+    extension?: TExtension[];
+    reference?: string;
+    type?: TUri;
+    identifier?: TIdentifier;
+    display?: string;
+    _sourceAssigningAuthority?: string;
+    _uuid?: string;
+    _sourceId?: string;
+};
+
+type TAnnotation = {
+    id?: string;
+    extension?: TExtension[];
+    authorReference?: TReference;
+    authorString?: string;
+    time?: TDateTime;
+    text: TMarkdown;
+};
+
+type TAttachment = {
+    id?: string;
+    extension?: TExtension[];
+    contentType?: string;
+    language?: string;
+    data?: TBase64Binary;
+    url?: TUrl;
+    size?: TUnsignedInt;
+    hash?: TBase64Binary;
+    title?: string;
+    creation?: TDateTime;
+};
+
+type TCodeableReference = {
+    id?: string;
+    extension?: TExtension[];
+    concept?: TCodeableConcept;
+    reference?: TReference;
+};
+
+type TContactPoint = {
+    id?: string;
+    extension?: TExtension[];
+    system?: string;
+    value?: string;
+    use?: string;
+    rank?: TInt;
+    period?: TPeriod;
+};
+
+type THumanName = {
+    id?: string;
+    extension?: TExtension[];
+    use?: string;
+    text?: string;
+    family?: string;
+    given?: string[];
+    prefix?: string[];
+    suffix?: string[];
+    period?: TPeriod;
+};
+
+type TMoney = {
+    id?: string;
+    extension?: TExtension[];
+    value?: TDecimal;
+    currency?: string;
+};
+
+type TRange = {
+    id?: string;
+    extension?: TExtension[];
+    low?: TQuantity;
+    high?: TQuantity;
+};
+
+type TRatio = {
+    id?: string;
+    extension?: TExtension[];
+    numerator?: TQuantity;
+    denominator?: TQuantity;
+};
+
+type TRatioRange = {
+    id?: string;
+    extension?: TExtension[];
+    lowNumerator?: TQuantity;
+    highNumerator?: TQuantity;
+    denominator?: TQuantity;
+};
+
+type TSampledData = {
+    id?: string;
+    extension?: TExtension[];
+    origin: TQuantity;
+    period: TDecimal;
+    factor?: TDecimal;
+    lowerLimit?: TDecimal;
+    upperLimit?: TDecimal;
+    dimensions: TInt;
+    data?: string;
+};
+
+type TSignature = {
+    id?: string;
+    extension?: TExtension[];
+    type: TCoding[];
+    when: TInstant;
+    who: TReference;
+    onBehalfOf?: TReference;
+    targetFormat?: string;
+    sigFormat?: string;
+    data?: TBase64Binary;
+};
+
+type TTimingRepeat = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    boundsDuration?: TQuantity;
+    boundsRange?: TRange;
+    boundsPeriod?: TPeriod;
+    count?: TInt;
+    countMax?: TInt;
+    duration?: TDecimal;
+    durationMax?: TDecimal;
+    durationUnit?: string;
+    frequency?: TInt;
+    frequencyMax?: TInt;
+    period?: TDecimal;
+    periodMax?: TDecimal;
+    periodUnit?: string;
+    dayOfWeek?: string[];
+    timeOfDay?: TTime[];
+    when?: string[];
+    offset?: TUnsignedInt;
+};
+
+type TTiming = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    event?: TDateTime[];
+    repeat?: TTimingRepeat;
+    code?: TCodeableConcept;
+};
+
+type TContactDetail = {
+    id?: string;
+    extension?: TExtension[];
+    name?: string;
+    telecom?: TContactPoint[];
+};
+
+type TContributor = {
+    id?: string;
+    extension?: TExtension[];
+    type: string;
+    name: string;
+    contact?: TContactDetail[];
+};
+
+type TDataRequirementCodeFilter = {
+    id?: string;
+    extension?: TExtension[];
+    path?: string;
+    searchParam?: string;
+    valueSet?: TCanonical;
+    code?: TCoding[];
+};
+
+type TDataRequirementDateFilter = {
+    id?: string;
+    extension?: TExtension[];
+    path?: string;
+    searchParam?: string;
+    valueDateTime?: TDateTime;
+    valuePeriod?: TPeriod;
+    valueDuration?: TQuantity;
+};
+
+type TDataRequirementSort = {
+    id?: string;
+    extension?: TExtension[];
+    path: string;
+    direction: string;
+};
+
+type TDataRequirement = {
+    id?: string;
+    extension?: TExtension[];
+    type: string;
+    profile?: TCanonical[];
+    subjectCodeableConcept?: TCodeableConcept;
+    subjectReference?: TReference;
+    mustSupport?: string[];
+    codeFilter?: TDataRequirementCodeFilter[];
+    dateFilter?: TDataRequirementDateFilter[];
+    limit?: TInt;
+    sort?: TDataRequirementSort[];
+};
+
+type TExpression = {
+    id?: string;
+    extension?: TExtension[];
+    description?: string;
+    name?: TId;
+    language: string;
+    expression?: string;
+    reference?: TUri;
+};
+
+type TParameterDefinition = {
+    id?: string;
+    extension?: TExtension[];
+    name?: string;
+    use: string;
+    min?: TInt;
+    max?: string;
+    documentation?: string;
+    type: string;
+    profile?: TCanonical;
+};
+
+type TRelatedArtifact = {
+    id?: string;
+    extension?: TExtension[];
+    type: string;
+    label?: string;
+    display?: string;
+    citation?: TMarkdown;
+    url?: TUrl;
+    document?: TAttachment;
+    resource?: TCanonical;
+};
+
+type TTriggerDefinition = {
+    id?: string;
+    extension?: TExtension[];
+    type: string;
+    name?: string;
+    timingTiming?: TTiming;
+    timingReference?: TReference;
+    timingDate?: TDate;
+    timingDateTime?: TDateTime;
+    data?: TDataRequirement[];
+    condition?: TExpression;
+};
+
+type TUsageContext = {
+    id?: string;
+    extension?: TExtension[];
+    code: TCoding;
+    valueCodeableConcept?: TCodeableConcept;
+    valueQuantity?: TQuantity;
+    valueRange?: TRange;
+    valueReference?: TReference;
+};
+
+type TDosageDoseAndRate = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    type?: TCodeableConcept;
+    doseRange?: TRange;
+    doseQuantity?: TQuantity;
+    rateRatio?: TRatio;
+    rateRange?: TRange;
+    rateQuantity?: TQuantity;
+};
+
+type TDosage = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    sequence?: TInt;
+    text?: string;
+    additionalInstruction?: TCodeableConcept[];
+    patientInstruction?: string;
+    timing?: TTiming;
+    asNeededBoolean?: boolean;
+    asNeededCodeableConcept?: TCodeableConcept;
+    site?: TCodeableConcept;
+    route?: TCodeableConcept;
+    method?: TCodeableConcept;
+    doseAndRate?: TDosageDoseAndRate[];
+    maxDosePerPeriod?: TRatio;
+    maxDosePerAdministration?: TQuantity;
+    maxDosePerLifetime?: TQuantity;
+};
+
+type TExtension = {
+    id?: string;
+    extension?: TExtension[];
+    url?: TUri;
+    valueBase64Binary?: TBase64Binary;
+    valueBoolean?: boolean;
+    valueCanonical?: TCanonical;
+    valueCode?: string;
+    valueDate?: TDate;
+    valueDateTime?: TDateTime;
+    valueDecimal?: TDecimal;
+    valueId?: TId;
+    valueInstant?: TInstant;
+    valueInteger?: TInt;
+    valueMarkdown?: TMarkdown;
+    valueOid?: TOid;
+    valuePositiveInt?: TInt;
+    valueString?: string;
+    valueTime?: TTime;
+    valueUnsignedInt?: TUnsignedInt;
+    valueUri?: TUri;
+    valueUrl?: TUrl;
+    valueUuid?: TUuid;
+    valueAddress?: TAddress;
+    valueAge?: TQuantity;
+    valueAnnotation?: TAnnotation;
+    valueAttachment?: TAttachment;
+    valueCodeableConcept?: TCodeableConcept;
+    valueCodeableReference?: TCodeableReference;
+    valueCoding?: TCoding;
+    valueContactPoint?: TContactPoint;
+    valueCount?: TQuantity;
+    valueDistance?: TQuantity;
+    valueDuration?: TQuantity;
+    valueHumanName?: THumanName;
+    valueIdentifier?: TIdentifier;
+    valueMoney?: TMoney;
+    valuePeriod?: TPeriod;
+    valueQuantity?: TQuantity;
+    valueRange?: TRange;
+    valueRatio?: TRatio;
+    valueRatioRange?: TRatioRange;
+    valueReference?: TReference;
+    valueSampledData?: TSampledData;
+    valueSignature?: TSignature;
+    valueTiming?: TTiming;
+    valueContactDetail?: TContactDetail;
+    valueContributor?: TContributor;
+    valueDataRequirement?: TDataRequirement;
+    valueExpression?: TExpression;
+    valueParameterDefinition?: TParameterDefinition;
+    valueRelatedArtifact?: TRelatedArtifact;
+    valueTriggerDefinition?: TTriggerDefinition;
+    valueUsageContext?: TUsageContext;
+    valueDosage?: TDosage;
+};
+
+type TMeta = {
+    id?: string;
+    extension?: TExtension[];
+    versionId?: TId;
+    lastUpdated?: TInstant;
+    source?: TUri;
+    profile?: TCanonical[];
+    security?: TCoding[];
+    tag?: TCoding[];
+};
+
+type TXhtml = string;
+
+type TNarrative = {
+    id?: string;
+    extension?: TExtension[];
+    status: string;
+    div: TXhtml;
+};
+
+type TResourceContainer = Record<string, unknown>;
+
+type TPatientContact = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    relationship?: TCodeableConcept[];
+    name?: THumanName;
+    telecom?: TContactPoint[];
+    address?: TAddress;
+    gender?: string;
+    organization?: TReference;
+    period?: TPeriod;
+};
+
+type TPatientCommunication = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    language: TCodeableConcept;
+    preferred?: boolean;
+};
+
+type TPatientLink = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    other: TReference;
+    type: string;
+};
+
+type TPatient = {
+    resourceType?: string;
+    id?: string;
+    meta?: TMeta;
+    implicitRules?: TUri;
+    language?: string;
+    text?: TNarrative;
+    contained?: TResourceContainer[];
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    identifier?: TIdentifier[];
+    active?: boolean;
+    name?: THumanName[];
+    telecom?: TContactPoint[];
+    gender?: string;
+    birthDate?: TDate;
+    deceasedBoolean?: boolean;
+    deceasedDateTime?: TDateTime;
+    address?: TAddress[];
+    maritalStatus?: TCodeableConcept;
+    multipleBirthBoolean?: boolean;
+    multipleBirthInteger?: TInt;
+    photo?: TAttachment[];
+    contact?: TPatientContact[];
+    communication?: TPatientCommunication[];
+    generalPractitioner?: TReference[];
+    managingOrganization?: TReference;
+    link?: TPatientLink[];
+};
+
+type TCompositionSection = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    title?: string;
+    code?: TCodeableConcept;
+    author?: TReference[];
+    focus?: TReference;
+    text?: TNarrative;
+    mode?: string;
+    orderedBy?: TCodeableConcept;
+    entry?: TReference[];
+    emptyReason?: TCodeableConcept;
+    section?: TCompositionSection[];
+};
+
+type TDomainResource = {
+    resourceType?: string;
+    id?: string;
+    meta?: TMeta;
+    implicitRules?: TUri;
+    language?: string;
+    text?: TNarrative;
+    contained?: TResourceContainer[];
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+};
+
+declare enum IPSSections {
+    PATIENT = "Patient",
+    ALLERGIES = "AllergyIntoleranceSection",
+    MEDICATIONS = "MedicationSection",
+    PROBLEMS = "ProblemSection",
+    IMMUNIZATIONS = "ImmunizationSection",
+    VITAL_SIGNS = "VitalSignsSection",
+    MEDICAL_DEVICES = "MedicalDeviceSection",
+    DIAGNOSTIC_REPORTS = "DiagnosticReportSection",
+    PROCEDURES = "ProcedureSection",
+    FAMILY_HISTORY = "FamilyHistorySection",
+    SOCIAL_HISTORY = "SocialHistorySection",
+    PREGNANCY_HISTORY = "PregnancyHistorySection",
+    FUNCTIONAL_STATUS = "FunctionalStatusSection",
+    MEDICAL_HISTORY = "MedicalHistorySection",
+    CARE_PLAN = "CarePlanSection",
+    CLINICAL_IMPRESSION = "ClinicalImpressionSection",
+    ADVANCE_DIRECTIVES = "AdvanceDirectivesSection"
+}
+
+type TBundleLink = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    relation: string;
+    url: TUri;
+};
+
+type TBundleSearch = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    mode?: string;
+    score?: TDecimal;
+};
+
+type TBundleRequest = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    method: string;
+    url: TUri;
+    ifNoneMatch?: string;
+    ifModifiedSince?: TInstant;
+    ifMatch?: string;
+    ifNoneExist?: string;
+};
+
+type TBundleResponse = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    status: string;
+    location?: TUri;
+    etag?: string;
+    lastModified?: TInstant;
+    outcome?: TResourceContainer;
+};
+
+type TBundleEntry = {
+    id?: string;
+    extension?: TExtension[];
+    modifierExtension?: TExtension[];
+    link?: TBundleLink[];
+    fullUrl?: TUri;
+    resource?: TResourceContainer;
+    search?: TBundleSearch;
+    request?: TBundleRequest;
+    response?: TBundleResponse;
+};
+
+type TBundle = {
+    resourceType?: string;
+    id?: string;
+    meta?: TMeta;
+    implicitRules?: TUri;
+    language?: string;
+    identifier?: TIdentifier;
+    type: string;
+    timestamp?: TInstant;
+    total?: TUnsignedInt;
+    link?: TBundleLink[];
+    entry?: TBundleEntry[];
+    signature?: TSignature;
+};
+
+declare class ComprehensiveIPSCompositionBuilder {
+    private patient;
+    private sections;
+    private mandatorySectionsAdded;
+    private resources;
+    /**
+     * sets the patient resource for the IPS Composition.
+     * This is not needed if you are calling read_bundle, but can be used to set the patient resource directly.
+     * @param patient - FHIR Patient resource to set
+     */
+    setPatient(patient: TPatient): this;
+    addSection<T extends TDomainResource>(sectionType: IPSSections, resources: T[], timezone: string | undefined, options?: {
+        isOptional?: boolean;
+        customLoincCode?: string;
+    }): this;
+    /**
+     * Reads a FHIR Bundle and extracts resources for each section defined in IPSSections.
+     * @param bundle - FHIR Bundle containing resources
+     * @param timezone - Optional timezone to use for date formatting (e.g., 'America/New_York', 'Europe/London')
+     */
+    read_bundle(bundle: TBundle, timezone: string | undefined): this;
+    /**
+     * Builds the final Composition sections, ensuring all mandatory sections are present.
+     * @param timezone - Optional timezone to use for date formatting (e.g., 'America/New_York', 'Europe/London')
+     */
+    build(timezone: string | undefined): TCompositionSection[];
+    /**
+     * Builds a complete FHIR Bundle containing the Composition and all resources.
+     * @param authorOrganizationId - ID of the authoring organization (e.g., hospital or clinic)
+     * @param authorOrganizationName - Name of the authoring organization
+     * @param baseUrl - Base URL for the FHIR server (e.g., 'https://example.com/fhir')
+     * @param timezone - Optional timezone to use for date formatting (e.g., 'America/New_York', 'Europe/London')
+     */
+    build_bundle(authorOrganizationId: string, authorOrganizationName: string, baseUrl: string, timezone: string | undefined): TBundle;
+    /**
+     * Creates a narrative for the composition based on the patient and sections.
+     * @param timezone - Optional timezone to use for date formatting (e.g., 'America/New_York', 'Europe/London')
+     * @private
+     */
+    private createCompositionNarrative;
+}
+
+interface Narrative {
+    status: 'generated' | 'extensions' | 'additional' | 'empty';
+    div: string;
+}
+/**
+ * Generates narrative content for FHIR resources using TypeScript templates
+ * Replaces the Nunjucks-based narrative generator
+ */
+declare class NarrativeGenerator {
+    /**
+     * Generates narrative HTML content for a section
+     * @param section - IPS section type
+     * @param resources - Array of domain resources
+     * @param timezone - Optional timezone to use for date formatting (e.g., 'America/New_York', 'Europe/London')
+     * @returns Generated HTML content or undefined if no resources
+     */
+    static generateNarrativeContent<T extends TDomainResource>(section: IPSSections, resources: T[], timezone: string | undefined): string | undefined;
+    /**
+     * Creates a complete FHIR Narrative object
+     * @param content - HTML content
+     * @returns FHIR Narrative object
+     */
+    static createNarrative(content: string): Narrative;
+    /**
+     * Generates a complete FHIR Narrative object for a section
+     * @param section - IPS section type
+     * @param resources - Array of domain resources
+     * @param timezone - Optional timezone to use for date formatting (e.g., 'America/New_York', 'Europe/London')
+     * @returns FHIR Narrative object or undefined if no resources
+     */
+    static generateNarrative<T extends TDomainResource>(section: IPSSections, resources: T[], timezone: string | undefined): Narrative | undefined;
+    /**
+     * Wrap content in XHTML div with FHIR namespace
+     * @param content - HTML content to wrap
+     * @returns XHTML div string
+     */
+    static wrapInXhtml(content: string): string;
+}
+
+declare const myPackage: (taco?: string) => string;
+
+export { ComprehensiveIPSCompositionBuilder, NarrativeGenerator, myPackage };