BioMaxis Implementation Guide
0.0.0-semantic-release - ci-build

BioMaxis Implementation Guide - Local Development build (v0.0.0-semantic-release) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

Inventory Transaction

This operation is used to create a transaction for an inventory item. It records the details of the transaction including the item, lot number, location, and quantity involved.

Inventory Transfer

This operation is used to transfer inventory items from one location to another. It records the details of the transfer including the item, lot number, source location, destination location, and quantity involved.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

BioMaxis Account

A profile for the Account resource used in BioMaxis. This profile includes extensions for balance and calculated instant to adhere to the changes made in the FHIR R5 specification

BioMaxis ActivityDefinition

A profile for the ActivityDefinition resource used in BioMaxis.

BioMaxis ChargeItem

A profile for ChargeItem that includes additional information specific to BioMaxis.

BioMaxis Consent

A Consent profile for BioMaxis HIS that captures patient consent for various purposes such as SMS communications, data sharing, and research participation.

BioMaxis Encounter

A profile for the Encounter resource used in BioMaxis HIS.

BioMaxis Invoice

A profile for the Invoice resource used in BioMaxis. This profile includes an extension for tracking the amount paid towards the invoice.

BioMaxis Location

A profile for the Location resource used in BioMaxis. This profile includes an identifier for bed codes and binds location type to location service types.

BioMaxis Organization

A profile for the Organization resource used in BioMaxis. This profile includes optional extensions for bank account details and documents.

BioMaxis Patient

A Patient profile for BioMaxis HIS.

BioMaxis PaymentNotice

A profile for the PaymentNotice resources used in BioMaxis.

BioMaxis PractitionerRole

A profile for the PractitionerRole resource used in BioMaxis. This is specifically defined in order to add more information to the associated practitioner's availability that includes visit durations and booking windows for enhancing the scheduling workflow.

BioMaxis Questionnaire

A profile of the Questionnaires used in BioMaxis

BioMaxis RelatedPerson

A RelatedPerson profile for BioMaxis HIS that captures information about guardians, parents, spouses, and other related persons for patients.

BioMaxis Request Group

A profile for the RequestGroup resource used in BioMaxis.

BioMaxis ServiceRequest

A profile for the ServiceRequest resource used in BioMaxis.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Account Balance

Extension to represent the calculated account balance(s)

Account Calculated At

Extension to represent the time the balance amount was calculated

Availability Booking Window

This extension specifies the booking window duration (in minutes) displayed to patients when scheduling appointments. It addresses the issue of overwhelming patients with too many time slots to choose from. By dividing the schedule resource into larger booking windows, this extension helps balance patient management efficiency with a positive patient experience.

Availability Visit Duration

This extension specifies the expected visit duration (in minutes) for appointments booked within the associated schedule. It is used to calculate the number of available slots for booking appointments.

Charge Item Category

An extension to represent the category associated with a ChargeItem.

Charge Item Inventory Item

An extension to represent the inventory item associated with a ChargeItem.

Encounter Actor HealthcareService

This extension specifies the healthcare service that the encounter is created under. It is intended to be used as a placeholder implementation of Encounter.participant.actor available in FHIR version R5 onwards.

Encounter Cost Exemption

Records if the encounter was free or subsidized based on eligibility categories such as Ultra Poor, Helpless, Disabled, Senior Citizen, or FCHV.

Encounter Gender-Based Violence

A flag to indicate if the encounter involved treatment for gender-based violence (OCMC - One-Stop Crisis Management Centre).

Encounter Next Visit Date

The scheduled return date for follow-up care.

Encounter Police Case

A boolean flag to indicate if the encounter is a police case (legal requirement).

Encounter Referring Institution

The name or reference of the health facility that referred the patient.

Encounter Visit Type

Indicates whether the encounter is a new visit or a follow-up visit within the fiscal year.

Invoice Amount Paid

Extension to represent the amount paid towards an Invoice

Order Imaging Modality

This extension specifies the modality of the imaging order request this ActivityDefinition defines.

Organization Bank Details

Extension to represent bank account details for an organization, including bank name, branch name, account number, and account holder name.

Organization Document

Extension to represent various documents for an organization, such as business registration, tax/VAT registration, and other supporting documents.

Patient Caste/Ethnicity

This extension captures the caste or ethnicity of a patient based on Nepal HMIS classification.

Patient Disability Card

This extension captures the government-issued disability card type (Red, Blue, Yellow, White) held by a patient in Nepal.

Patient Educational Level

This extension captures the highest level of education attained by a patient based on Nepal HMIS.

Patient Educational Status

This extension captures the literacy status of a patient (literate/illiterate) based on Nepal HMIS.

Patient Employment Status

This extension captures the current employment status of a patient based on Nepal HMIS.

Payment Method for Payment

The payment method used for the payment.

Questionnaire Grid Gap

This extension specifies the grid gap between child items in questionnaire as a CSS property value

Questionnaire Identifier Group Item

This extension specifies whether the questionnaire item of type group is used for getting identifier element

Questionnaire Item Disabled Display

This extension specifies the display of a questionnaire item when it is disabled. It is created to support item.disabledDisplay in Questionnaire in FHIR R5, which is not supported in FHIR R4.

Questionnaire Item Grid Column

This extension specifies the grid column CSS property used by a questionnaire item placed within a 12-space grid

Questionnaire Item Unit Expression

This extension provides an expression to calculate unit options for quantity inputs. Only applicable to items where type='quantity'.

Questionnaire Item Unit Expression Mapping

This extension provides an expression that may be applied to the results of unit-expression to get the unit codings. Only applicable to items where type='quantity'.

Questionnaire Item Unit Open Choice

This extension specifies whether custom units can be added for quantity type questionnaire items. Only applicable to items where type='quantity'.

Response Mapping

This extension specifies the mapping used during extraction of questionnaire responses generated from the questionnaire in context

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Charge Item Category

A value set to represent the category associated with a ChargeItem.

Extended Organization Type

All codes from the standard organization-type system plus custom supplier types using hierarchical filtering.

Free Service Eligibility Categories

A value set for free service eligibility categories in Nepal based on HMIS.

HMIS AEFI Outcome Value Set

Value set containing AEFI outcome codes, combining general outcomes from HMISOutcome with AEFI-specific outcomes.

HMIS AEFI Reaction Type Value Set

Value set containing AEFI reaction type codes.

HMIS AEFI Severity Value Set

Value set containing AEFI severity classification codes.

HMIS Address Type

A value set for address types in Nepal based on HMIS guidelines.

HMIS Admission Source Value Set

Value set for admission/referral sources used in Nepal HMIS encounters.

HMIS Child Source Type Value Set

Value set containing child source type codes for immunization registers.

HMIS Child Vaccine Type Value Set

Value set containing vaccines for children in Nepal's National Immunization Program.

HMIS Consent Category

A value set for consent categories used in Nepal HMIS.

HMIS Disability Card Type

A value set for government-issued disability card types in Nepal based on severity classification.

HMIS Discharge Disposition Value Set

Value set for discharge disposition/outcome codes used in Nepal HMIS.

HMIS Educational Level

A value set for the highest level of education attained based on Nepal HMIS.

HMIS Educational Status

A value set for educational/literacy status in Nepal based on HMIS.

HMIS Employment Status

A value set for employment status in Nepal based on HMIS.

HMIS Encounter Class

A value set for encounter class/type used in Nepal HMIS.

HMIS Gender

A value set for gender classification in Nepal based on HMIS, including third gender option.

HMIS HIV Test Result

A value set for HIV test results used in Nepal HMIS TB-HIV collaborative activities.

HMIS IMNCI Child Classification Value Set (2-59 Months)

Value set for IMNCI classification codes for sick children aged 2-59 months in Nepal HMIS 2.4.

HMIS IMNCI Counseling Topics Value Set

Value set for counseling topics provided during IMNCI visits in Nepal HMIS.

HMIS IMNCI Follow-up Result Value Set

Value set for IMNCI follow-up visit results used in Nepal HMIS.

HMIS IMNCI Infant Classification Value Set (0-59 Days)

Value set for IMNCI classification codes for young infants (0-59 days) used in Nepal HMIS 2.4.

HMIS IMNCI MUAC Color Value Set

Value set for MUAC color band classification used in IMNCI nutrition assessment.

HMIS IMNCI Malaria Test Result Value Set

Value set for malaria test results (RDT/Microscopy) used in IMNCI protocol in Nepal HMIS 2.4.

HMIS IMNCI Referral Source Value Set

Value set for child health referral sources in Nepal HMIS IMNCI program.

HMIS IMNCI Treatment Outcome Value Set

Value set for IMNCI treatment outcomes used in Nepal HMIS.

HMIS IMNCI Weight Status Value Set

Value set for weight-for-age status classification in IMNCI protocol used in Nepal HMIS 2.4.

HMIS Immunization Campaign Type Value Set

Value set containing immunization campaign type codes.

HMIS Immunization Session Status Value Set

Value set containing immunization session status codes.

HMIS Immunization Status Value Set

Value set containing child immunization status codes.

HMIS Leprosy MDT Regimen ValueSet

ValueSet for Multi-Drug Therapy regimens for leprosy treatment.

HMIS Leprosy Mode of Detection ValueSet

ValueSet for how leprosy cases were detected.

HMIS Leprosy Monthly Dose Status ValueSet

ValueSet for recording monthly MDT dose status in leprosy treatment.

HMIS Leprosy Nerve Finding ValueSet

ValueSet for nerve examination findings in leprosy patients.

HMIS Leprosy Physical Support Type ValueSet

ValueSet for physical support and assistive devices for leprosy patients.

HMIS Leprosy Reaction Type ValueSet

ValueSet for types of lepra reactions during treatment.

HMIS Leprosy Registration Category ValueSet

ValueSet for leprosy patient registration categories, combining general categories from HMISPatientRegistrationCategory with leprosy-specific categories.

HMIS Leprosy Skin Smear Result ValueSet

ValueSet for skin smear examination results with Bacteriological Index.

HMIS Leprosy Social Rehabilitation Type ValueSet

ValueSet for social rehabilitation support types for leprosy patients.

HMIS Leprosy Treatment Outcome ValueSet

ValueSet for leprosy treatment outcomes, combining general outcomes from HMISOutcome with leprosy-specific outcomes.

HMIS Leprosy Type ValueSet

ValueSet for leprosy classification as Paucibacillary (PB) or Multibacillary (MB).

HMIS Leprosy WHO Disability Grade ValueSet

ValueSet for WHO disability grading system in leprosy patients.

HMIS Maternal Vaccine Type Value Set

Value set containing vaccines for pregnant women in Nepal's National Immunization Program.

HMIS Patient Identifier Types

A value set for patient identifier types used in Nepal HMIS.

HMIS Relationship Type

A value set for relationship types used in Nepal HMIS, combining standard HL7 codes with HMIS-specific codes for guardians.

HMIS Smoking Status (ABC)

A value set for smoking status used in Nepal HMIS TB program based on the ABC approach.

HMIS TB Chest X-Ray Result

A value set for chest X-ray results in Nepal HMIS TB program.

HMIS TB Follow-up Month

A value set for standard TB follow-up months in Nepal HMIS (months 0, 2, 3, 5, 6, and 8 for extended treatment).

HMIS TB LPA Result

A value set for Line Probe Assay (LPA) test results in Nepal HMIS TB program.

HMIS TB Referral Source Value Set

Value set for TB patient referral sources in Nepal HMIS.

HMIS TB Site

A value set for tuberculosis anatomical site classification in Nepal HMIS.

HMIS TB Sputum Smear Result

A value set for sputum smear microscopy results used in Nepal HMIS TB program.

HMIS TB Treatment Outcome Value Set

Value set for TB treatment outcomes based on WHO definitions used in Nepal HMIS.

HMIS TB Treatment Phase

A value set for TB treatment phases in Nepal HMIS.

HMIS TB Treatment Type

A value set for TB treatment types based on patient history in Nepal HMIS.

HMIS TB Xpert MTB/RIF Result

A value set for Xpert MTB/RIF test results in Nepal HMIS TB program.

HMIS Vaccine Type Value Set

Value set containing all vaccines in Nepal's National Immunization Program.

HMIS Vial Wastage Reason Value Set

Value set containing reasons for vaccine vial wastage.

HMIS Visit Type

A value set for visit types in Nepal HMIS indicating whether the encounter is a new visit or a follow-up within the fiscal year.

Inventory Disposal Reason

A value set to represent reasons for inventory disposal.

Inventory Operation Method

A value set to represent methods for inventory operations in healthcare settings, including disposal, transfer, and other inventory-related activities.

Inventory Operation Reason

A comprehensive value set to represent reasons for all inventory operations including transfers, disposals, and other inventory-related activities.

Inventory Transfer Reason

A value set to represent reasons for inventory transfers between locations or facilities.

Location Service Type

A value set to represent the type of service provided at a location.

Nepal Caste/Ethnicity Groups

A value set for caste/ethnicity groups in Nepal based on HMIS.

Nepal District

Value set for districts of Nepal.

Nepal Local Level

Value set for local levels (municipalities and rural municipalities) of Nepal.

Nepal Province

Value set for provinces of Nepal.

Supplier Organization Type

Organization types for suppliers, including all supplier subtypes using hierarchical filtering.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Additional Organization Type

A hierarchical code system for additional organization types including supplier hierarchy.

Free Service Eligibility Categories

Standardized codes for free service eligibility categories in Nepal based on HMIS.

HMIS AEFI Outcome

AEFI-specific outcome codes used in Nepal's National Immunization Program based on HMIS 2.2.

HMIS AEFI Reaction Type

Standardized codes for types of Adverse Events Following Immunization (AEFI) reactions used in Nepal's National Immunization Program based on HMIS 2.2.

HMIS AEFI Severity Classification

Standardized codes for Adverse Events Following Immunization (AEFI) severity classification used in Nepal's National Immunization Program based on HMIS 2.2.

HMIS Address Type

Standardized codes for address types in Nepal based on HMIS guidelines.

HMIS Caste/Ethnicity Groups

Standardized codes for Caste/Ethnicity groups in Nepal based on HMIS.

HMIS Child Immunization Status

Standardized codes for child immunization status used in Nepal's National Immunization Program based on HMIS 2.2.

HMIS Child Source Type

Standardized codes for categorizing children by source in immunization registers based on Nepal HMIS 2.2.

HMIS Consent Category

Standardized codes for consent categories used in Nepal HMIS.

HMIS Disability Card Type

Standardized codes for government-issued disability card types in Nepal based on severity classification.

HMIS Educational Level

Standardized codes for the highest level of education attained based on Nepal HMIS.

HMIS Educational Status

Standardized codes for educational/literacy status in Nepal based on HMIS.

HMIS Employment Status

Standardized codes for employment status in Nepal based on HMIS.

HMIS Encounter Class

Standardized codes for encounter class/type used in Nepal HMIS.

HMIS Gender

Standardized codes for gender classification in Nepal HMIS, including third gender option.

HMIS HIV Test Result

Standardized codes for HIV test results used in Nepal HMIS TB-HIV collaborative activities.

HMIS IMNCI Assessment Codes

Standardized codes for clinical assessment findings in IMNCI protocol used in Nepal HMIS 2.4.

HMIS IMNCI Child Classification (2-59 Months)

Standardized classification codes for sick children aged 2-59 months based on IMNCI protocol used in Nepal HMIS 2.4.

HMIS IMNCI Counseling Topics

Standardized codes for counseling topics provided during IMNCI visits in Nepal HMIS.

HMIS IMNCI Infant Classification (0-59 Days)

Standardized IMNCI classification codes for young infants (0-59 days) used in Nepal HMIS 2.4.

HMIS IMNCI MUAC Color

Standardized codes for MUAC (Mid-Upper Arm Circumference) color band classification used in IMNCI nutrition assessment in Nepal HMIS 2.4.

HMIS IMNCI Malaria Test Result

Standardized codes for malaria test results (RDT/Microscopy) used in IMNCI protocol in Nepal HMIS 2.4.

HMIS IMNCI Weight Status

Standardized codes for weight-for-age status classification in IMNCI protocol used in Nepal HMIS 2.4.

HMIS Immunization Campaign Type

Standardized codes for immunization campaign types used in Nepal's National Immunization Program based on HMIS 2.2.

HMIS Immunization Session Status

Standardized codes for immunization session conduct status used in Nepal's National Immunization Program based on HMIS 2.2.

HMIS Leprosy MDT Regimen

Multi-Drug Therapy (MDT) regimens for leprosy treatment based on WHO guidelines and Nepal HMIS 5.4.

HMIS Leprosy Mode of Detection

Standardized codes for how leprosy cases were detected based on Nepal HMIS 5.4.

HMIS Leprosy Monthly Dose Status

Standardized codes for recording monthly MDT dose status in leprosy treatment based on Nepal HMIS 5.4.

HMIS Leprosy Nerve Finding

Standardized codes for nerve examination findings in leprosy patients based on Nepal HMIS 5.4.

HMIS Leprosy Physical Support Type

Standardized codes for physical support and assistive devices provided to leprosy patients based on Nepal HMIS 5.4.

HMIS Leprosy Reaction Type

Types of lepra reactions that may occur during leprosy treatment based on Nepal HMIS 5.4.

HMIS Leprosy Registration Category

Leprosy-specific patient registration category codes based on Nepal HMIS 5.4.

HMIS Leprosy Skin Smear Result

Standardized codes for leprosy skin smear (slit-skin smear) examination results with Bacteriological Index (BI) based on Nepal HMIS 5.4.

HMIS Leprosy Social Rehabilitation Type

Standardized codes for social rehabilitation support provided to leprosy patients based on Nepal HMIS 5.4.

HMIS Leprosy Treatment Outcome

Leprosy-specific treatment outcome codes based on Nepal HMIS 5.4.

HMIS Leprosy Type

Classification of leprosy as Paucibacillary (PB) or Multibacillary (MB) based on WHO criteria for Nepal HMIS.

HMIS Leprosy WHO Disability Grade

WHO disability grading system for leprosy patients used in Nepal HMIS.

HMIS Outcome

Standardized codes for treatment outcomes, discharge dispositions, and follow-up results used in Nepal HMIS.

HMIS Patient Identifier Types

Standardized codes for patient identifier types used in Nepal HMIS.

HMIS Patient Registration Category

Standardized codes for patient registration categories used across disease programs (TB, Leprosy) in Nepal HMIS. These categories are based on WHO definitions for treatment history classification.

HMIS Referral Source

Standardized codes for referral and admission sources used across all programs in Nepal HMIS.

HMIS Relationship Type

Supplementary codes for relationship types used in Nepal HMIS that are not available in standard FHIR terminology.

HMIS Smoking Status (ABC)

Standardized codes for smoking status used in Nepal HMIS TB program based on the ABC approach (Ask, Brief advice, Cessation support).

HMIS TB Chest X-Ray Result

Standardized codes for chest X-ray results in Nepal HMIS TB program.

HMIS TB Follow-up Month

Standardized codes for TB treatment follow-up months in Nepal HMIS.

HMIS TB LPA Result

Standardized codes for Line Probe Assay (LPA) test results in Nepal HMIS TB program.

HMIS TB Site

Standardized codes for tuberculosis anatomical site classification in Nepal HMIS.

HMIS TB Sputum Smear Result

Standardized codes for sputum smear microscopy results used in Nepal HMIS TB program for diagnosis and follow-up.

HMIS TB Treatment Phase

Standardized codes for TB treatment phases in Nepal HMIS.

HMIS TB Treatment Type

TB-specific treatment type codes based on patient history in Nepal HMIS.

HMIS TB Xpert MTB/RIF Result

Standardized codes for Xpert MTB/RIF test results in Nepal HMIS TB program.

HMIS Type of Service

Standardized codes for types of health services in Nepal based on HMIS.

HMIS Vaccine Type

Standardized codes for vaccines included in Nepal's National Immunization Program based on HMIS 2.2.

HMIS Vial Wastage Reason

Standardized codes for vaccine vial wastage reasons used in Nepal's National Immunization Program based on HMIS 2.2.

HMIS Visit Type

Standardized codes for visit types in Nepal HMIS indicating whether the encounter is a new visit or a follow-up within the fiscal year.

Inventory Operation Method

A code system to represent methods for inventory operations in healthcare settings, including disposal, transfer, and other inventory-related activities.

Inventory Operation Reason

A code system to represent reasons for inventory operations, including transfers, disposals, and other inventory-related activities.

Location Service Type

A code system to represent the type of service provided at a location.

Nepal Administrative Location

Codes for administrative locations in Nepal including provinces, districts, and local levels.

Order Business-Status CodeSystem

Terminologies used to specify business status of Tasks in Biomaxis

Order Categories

A code system to represent the category associated with clinical orders.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

BioMaxis Account - Jane Doe

Patient account with all balance aggregate values and calculated timestamp extensions.

BioMaxis Account - John Doe

Patient account with no balance aggregate value and only one extension for balance.

BioMaxis Invoice - Balanced (Alternative Example)

Another example invoice with balanced status demonstrating full payment with different amounts.

BioMaxis Invoice - Balanced with Full Payment

Example invoice with balanced status demonstrating full payment.

BioMaxis Invoice - Issued with No Payment

Example invoice with issued status and no payment made yet.

BioMaxis Invoice - Issued with Partial Payment

Example invoice with issued status and partial payment made.

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

InventoryItem

An InventoryItem represents a specific item in the inventory, including its stock levels and related information.

InventoryReport

A report that details the transactions of inventory items