🥮 mooncakes.io
    Sign in

    moondicom

    Pure MoonBit toolkit for DICOM Part 10 metadata parsing, validation, anonymization and JSON reporting

    dicom
    medical-imaging
    privacy
    deidentification
    binary-parser
    Download zip
    Version
    0.1.2
    License
    Apache-2.0
    Repository
    Last updated
    last month
    Downloads
    16

    Dependencies

    #MoonDICOM

    MoonDICOM is a pure MoonBit toolkit for reading DICOM Part 10 metadata safely and preparing it for validation, privacy anonymization, and reporting.

    Author: CCllff-jpg 347921583@qq.com

    Repository: https://github.com/CCllff-jpg/MoonDICOM-MoonBit-.git

    #Current status

    The first implementation provides an in-memory core for:

    • DICOM Tag, common tag names, and dictionary VR lookup;
    • Part 10 preamble and DICM marker validation;
    • Explicit VR Little Endian parsing;
    • basic Implicit VR Little Endian parsing;
    • short and long explicit-VR length headers;
    • text, integer, and raw byte values;
    • ordered DataSet lookup, replacement, and removal;
    • byte-offset-aware errors for truncated or malformed input;
    • semantic validation reports with stable issue codes;
    • conservative, policy-driven metadata anonymization with an audit trail.

    ///|
    let dataset = @moondicom.parse(file_bytes)

    ///|
    let patient_name = dataset.get_text(@moondicom.patient_name())

    ///|
    let image_rows = dataset.get_int(@moondicom.rows())

    ///|
    let report = @moondicom.validate(dataset)

    ///|
    let public_copy = @moondicom.anonymize(
      dataset,
      @moondicom.default_anonymization_policy(),
    )

    Validation checks required identity metadata, UID and date syntax, image dimensions, bit depth relationships, pixel representation, and missing pixel data warnings. Anonymization can remove common identifying fields, replace configured text values, remove private groups, and record each change without mutating the source data set.

    #Command line

    The native CLI can inspect and validate a real Part 10 file and export metadata as JSON:

    moon run --target native examples/generate
moon run --target native examples/generate -- examples/sample.dcm
moon run --target native cmd/main -- inspect examples/sample.dcm
moon run --target native cmd/main -- validate examples/sample.dcm
moon run --target native cmd/main -- convert examples/sample.dcm --format json
moon run --target native cmd/main -- anonymize examples/sample.dcm --output anonymized.json

    The anonymize command writes an anonymized metadata JSON report and an audit count. It does not rewrite a binary .dcm file; a DICOM encoder is intentionally not claimed until it can preserve transfer syntax and unsupported data safely.

    This is a metadata parser, not a medical diagnostic system. The current version does not decode compressed pixel formats, interpret all DICOM value representations, parse undefined-length sequences, provide DICOM network services, or guarantee regulatory compliance. Pixel data is retained as raw bytes when it has a defined length.

    Anonymization only changes represented metadata. It does not inspect burned-in text inside pixels, remove every possible identifying attribute, apply date shifting, remap UIDs, or establish legal compliance. It must be followed by domain review and any applicable institutional privacy process.

    #Development

    Run these commands from the module directory:

    moon check
moon check --target all
moon test
moon fmt
moon info

    Tests construct small synthetic DICOM byte sequences in memory; no real patient data is included.

    ParseError

    source
    pub(all) suberror ParseError {
      InvalidMagic(offset~ : Int)
      Truncated(offset~ : Int, needed~ : Int, remaining~ : Int)
      InvalidVr(offset~ : Int, code~ : String)
      InvalidLength(offset~ : Int, length~ : Int)
      Unsupported(offset~ : Int, message~ : String)
    }

    A parse failure with the byte offset where it was detected.

    AnonymizationAction

    source
    pub(all) enum AnonymizationAction {
      Removed
      Replaced
    } derive(Eq, 
    Debug    )

    One change made during anonymization.

    AnonymizationAudit

    source
    pub(all) struct AnonymizationAudit {
      tag : Tag
      action : AnonymizationAction
    } derive(Eq, 
    Debug    )

    An audit record for one anonymized tag.

    AnonymizationAudit::action

    source

    Return the action recorded for this audit entry.

    AnonymizationAudit::tag

    source

    Return the tag changed by this audit entry.

    AnonymizationPolicy

    source
    pub(all) struct AnonymizationPolicy {
      remove : Array[Tag]
      replacements : Array[(Tag, String)]
      remove_private : Bool
    } derive(Eq, 
    Debug    )

    A conservative metadata anonymization policy.

    AnonymizationPolicy::with_private_removal

    source
    fn AnonymizationPolicy::with_private_removal(self : AnonymizationPolicy) -> AnonymizationPolicy

    Return a policy with private-tag removal enabled.

    AnonymizationPolicy::with_remove

    source

    Return a policy that removes the given tag.

    AnonymizationPolicy::with_replacement

    source
    fn AnonymizationPolicy::with_replacement(self : AnonymizationPolicy, tag : Tag, value : String) -> AnonymizationPolicy

    Return a policy that replaces a text value for the given tag.

    AnonymizationResult

    source
    pub(all) struct AnonymizationResult {
      dataset : DataSet
      audit : Array[AnonymizationAudit]
    } derive(Eq, 
    Debug    )

    The result of applying an anonymization policy.

    AnonymizationResult::audit

    source

    Return the audit entries in source order.

    AnonymizationResult::dataset

    source

    Return the anonymized data set.

    ByteReader

    source
    pub struct ByteReader {
      bytes : Bytes
      position : Int
    }

    A bounded little-endian reader for DICOM byte streams.

    ByteReader::position

    source
    fn ByteReader::position(self : ByteReader) -> Int

    Return the current byte offset.

    ByteReader::remaining

    source
    fn ByteReader::remaining(self : ByteReader) -> Int

    Return the number of unread bytes.

    DataElement

    source
    pub(all) struct DataElement {
      tag : Tag
      vr : ValueRepresentation
      value : Value
    } derive(Eq, 
    Debug    )

    One DICOM data element.

    DataSet

    source
    pub(all) struct DataSet {
      elements : Array[DataElement]
    } derive(Eq, 
    Debug    )

    The ordered elements in a DICOM data set.

    DataSet::elements

    source
    fn DataSet::elements(self : DataSet) -> Array[DataElement]

    Return all elements in file order.

    DataSet::get

    source
    fn DataSet::get(self : DataSet, tag : Tag) -> DataElement?

    Find an element by tag.

    DataSet::get_bytes

    source
    fn DataSet::get_bytes(self : DataSet, tag : Tag) -> Bytes?

    Return raw bytes when the element contains bytes.

    DataSet::get_int

    source
    fn DataSet::get_int(self : DataSet, tag : Tag) -> Int?

    Return an integer value when the element contains an integer.

    DataSet::get_text

    source
    fn DataSet::get_text(self : DataSet, tag : Tag) -> String?

    Return a text value when the element contains text.

    DataSet::length

    source
    fn DataSet::length(self : DataSet) -> Int

    Return the number of elements.

    DataSet::remove

    source
    fn DataSet::remove(self : DataSet, tag : Tag) -> Bool

    Remove an element by tag.

    DataSet::set

    source
    fn DataSet::set(self : DataSet, element : DataElement) -> Unit

    Add or replace an element while preserving its position when replacing.

    Tag

    source
    pub(all) struct Tag {
      group : Int
      element : Int
    } derive(Eq, 
    Debug    )

    Core DICOM tag identifier.

    Tag::is_private

    source
    fn Tag::is_private(self : Tag) -> Bool

    True when the tag is a private creator or private data element.

    Tag::to_string

    source
    fn Tag::to_string(self : Tag) -> String

    Render a tag using DICOM notation, for example (0010,0010).

    ValidationIssue

    source
    pub(all) struct ValidationIssue {
      severity : ValidationSeverity
      code : String
      tag : Tag?
      message : String
    } derive(Eq, 
    Debug    )

    One structural or semantic validation finding.

    ValidationIssue::code

    source
    fn ValidationIssue::code(self : ValidationIssue) -> String

    Return the stable machine-readable issue code.

    ValidationIssue::message

    source
    fn ValidationIssue::message(self : ValidationIssue) -> String

    Return the human-readable issue message.

    ValidationIssue::severity

    source

    Return the severity of an issue.

    ValidationIssue::tag

    source
    fn ValidationIssue::tag(self : ValidationIssue) -> Tag?

    Return the related tag, when one exists.

    ValidationReport

    source
    pub(all) struct ValidationReport {
      issues : Array[ValidationIssue]
    } derive(Eq, 
    Debug    )

    The complete validation result for a data set.

    ValidationReport::error_count

    source
    fn ValidationReport::error_count(self : ValidationReport) -> Int

    Return the number of errors.

    ValidationReport::issues

    source

    Return all findings in insertion order.

    ValidationReport::warning_count

    source
    fn ValidationReport::warning_count(self : ValidationReport) -> Int

    Return the number of warnings.

    ValidationSeverity

    source
    pub(all) enum ValidationSeverity {
      Error
      Warning
    } derive(Eq, 
    Debug    )

    Severity of a validation issue.

    Value

    source
    pub(all) enum Value {
      Text(String)
      Integer(Int)
      Bytes(Bytes)
    } derive(Eq, 
    Debug    )

    A decoded DICOM element value.

    ValueRepresentation

    source
    pub(all) enum ValueRepresentation {
      AE
      AS
      AT
      CS
      DA
      DS
      DT
      FD
      FL
      IS
      LO
      LT
      OB
      OD
      OF
      OL
      OV
      OW
      PN
      SH
      SL
      SQ
      SS
      ST
      SV
      TM
      UC
      UI
      UL
      UN
      UR
      US
      UT
      UV
    } derive(Eq, 
    Debug    )

    DICOM Value Representation.

    ValueRepresentation::is_text

    source
    fn ValueRepresentation::is_text(self : ValueRepresentation) -> Bool

    Whether this VR is represented as text in the public value model.

    ValueRepresentation::to_string

    source
    fn ValueRepresentation::to_string(self : ValueRepresentation) -> String

    Render a VR as its DICOM two-byte code.

    ValueRepresentation::uses_long_header

    source
    fn ValueRepresentation::uses_long_header(self : ValueRepresentation) -> Bool

    Whether a VR uses the explicit VR long-length header form.

    accession_number

    source
    fn accession_number() -> Tag

    anonymization_policy

    source
    fn anonymization_policy() -> AnonymizationPolicy

    Create an empty policy.

    anonymize

    source
    fn anonymize(dataset : DataSet, policy : AnonymizationPolicy) -> AnonymizationResult

    Apply a policy without modifying the source data set.

    bits_allocated

    source
    fn bits_allocated() -> Tag

    bits_stored

    source
    fn bits_stored() -> Tag

    byte_reader

    source
    fn byte_reader(bytes : Bytes) -> ByteReader

    Create a reader positioned at the first byte.

    columns

    source
    fn columns() -> Tag

    data_element

    source
    fn data_element(tag : Tag, vr : ValueRepresentation, value : Value) -> DataElement

    Construct a data element.

    data_set

    source
    fn data_set() -> DataSet

    Create an empty data set.

    dataset_to_json

    source
    fn dataset_to_json(dataset : DataSet) -> Json

    Convert a data set to DICOMweb-style JSON.

    default_anonymization_policy

    source
    fn default_anonymization_policy() -> AnonymizationPolicy

    Return a conservative policy for common identifying metadata.

    dictionary_vr

    source
    fn dictionary_vr(tag : Tag) -> String

    Expected VR for common tags. Unknown implicit-VR tags use UN.

    file_meta_group_length

    source
    fn file_meta_group_length() -> Tag

    Commonly used DICOM tags.

    file_meta_information_version

    source
    fn file_meta_information_version() -> Tag

    high_bit

    source
    fn high_bit() -> Tag

    implementation_class_uid

    source
    fn implementation_class_uid() -> Tag

    implementation_version_name

    source
    fn implementation_version_name() -> Tag

    institution_name

    source
    fn institution_name() -> Tag

    media_storage_sop_class_uid

    source
    fn media_storage_sop_class_uid() -> Tag

    media_storage_sop_instance_uid

    source
    fn media_storage_sop_instance_uid() -> Tag

    modality

    source
    fn modality() -> Tag

    parse

    source
    fn parse(bytes : Bytes) -> DataSet raise ParseError

    Parse a DICOM Part 10 byte sequence into its data set.

    patient_birth_date

    source
    fn patient_birth_date() -> Tag

    patient_id

    source
    fn patient_id() -> Tag

    patient_name

    source
    fn patient_name() -> Tag

    patient_sex

    source
    fn patient_sex() -> Tag

    pixel_data

    source
    fn pixel_data() -> Tag

    pixel_representation

    source
    fn pixel_representation() -> Tag

    pixel_spacing

    source
    fn pixel_spacing() -> Tag

    referring_physician_name

    source
    fn referring_physician_name() -> Tag

    rows

    source
    fn rows() -> Tag

    samples_per_pixel

    source
    fn samples_per_pixel() -> Tag

    series_description

    source
    fn series_description() -> Tag

    series_instance_uid

    source
    fn series_instance_uid() -> Tag

    sop_class_uid

    source
    fn sop_class_uid() -> Tag

    sop_instance_uid

    source
    fn sop_instance_uid() -> Tag

    specific_character_set

    source
    fn specific_character_set() -> Tag

    study_date

    source
    fn study_date() -> Tag

    study_description

    source
    fn study_description() -> Tag

    study_instance_uid

    source
    fn study_instance_uid() -> Tag

    study_time

    source
    fn study_time() -> Tag

    tag

    source
    fn tag(group : Int, element : Int) -> Tag

    Construct a DICOM tag from group and element numbers.

    tag_name

    source
    fn tag_name(tag : Tag) -> String

    Human-readable name for a common tag.

    transfer_syntax_uid

    source
    fn transfer_syntax_uid() -> Tag

    validate

    source
    fn validate(dataset : DataSet) -> ValidationReport

    Validate a DICOM data set without modifying it.

    value_representation

    source
    fn value_representation(code : String, offset~ : Int) -> ValueRepresentation raise ParseError

    Parse a two-byte VR code.

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io