Ignixa.Validation 0.0.151

Ignixa.Validation

FHIR validation system with four validation depth levels.

Architecture

Four Validation Depth Levels (ADR-2527):

Quick Start

Basic Validation (Recommended)

using Ignixa.Validation.Schema;
using Ignixa.Specification.Generated;
using Ignixa.Serialization;

// 1. Get FHIR schema for your version (R4, R4B, R5, or STU3)
var fhirSchema = new R4CoreSchemaProvider();

// 2. Get the type definition for the resource you want to validate
var patientType = fhirSchema.GetTypeDefinition("Patient");

// 3. Build validation schema (automatically creates all checks from StructureDefinition)
var builder = new StructureDefinitionSchemaBuilder();
var validationSchema = builder.BuildSchema(patientType!, fhirSchema);

// 4. Parse and validate your FHIR resource
var json = "{\"resourceType\":\"Patient\",\"id\":\"123\"}";
var sourceNode = JsonSourceNodeFactory.Parse(json).ToSourceNode();
var element = sourceNode.ToElement(fhirSchema);

// 5. Choose validation depth
var settings = new ValidationSettings { Depth = ValidationDepth.Spec };
var state = new ValidationState();
var result = validationSchema.Validate(element, settings, state);

if (!result.IsValid)
{
    var operationOutcome = result.ToOperationOutcome();
    // Return operationOutcome to client
}

Validating Different Resource Types

using Ignixa.Validation.Schema;
using Ignixa.Specification.Generated;
using Ignixa.Serialization;

var fhirSchema = new R4CoreSchemaProvider();
var builder = new StructureDefinitionSchemaBuilder();

// Validate Observation
var observationType = fhirSchema.GetTypeDefinition("Observation");
var observationSchema = builder.BuildSchema(observationType!, fhirSchema);

var observationJson = "{\"resourceType\":\"Observation\",\"status\":\"final\",\"code\":{}}";
var sourceNode = JsonSourceNodeFactory.Parse(observationJson).ToSourceNode();
var result = observationSchema.Validate(sourceNode.ToElement(fhirSchema));

Validation Depth Guide

Minimal

Fastest validation for high-throughput scenarios:

var settings = new ValidationSettings { Depth = ValidationDepth.Minimal };

Compatibility

For migrating from Microsoft FHIR Server (Firely SDK validation):

var settings = new ValidationSettings { Depth = ValidationDepth.Compatibility };

• Accepts relative URIs in Coding.system (e.g., "internal-tags")
• Same checks as Spec, but more lenient for migration scenarios
• Use when running Microsoft FHIR Server E2E test suite

Spec

Standard FHIR specification compliance:

var settings = new ValidationSettings { Depth = ValidationDepth.Spec };

• Enforces absolute URIs in Coding.system
• Required terminology bindings
• Recommended for production API operations

Full

Complete FHIR profile validation:

var settings = new ValidationSettings { Depth = ValidationDepth.Full };

• All Spec checks plus FHIRPath invariants
• Extensible terminology bindings
• Use for compliance testing and profile conformance

What Gets Validated

When you use StructureDefinitionSchemaBuilder, it automatically extracts and creates validation checks from FHIR StructureDefinition metadata. Here's what gets checked:

Tier 1 (Fast) - Universal Checks

These checks run for every CREATE/UPDATE operation:

Tier 2 (Spec) - Schema-Driven Checks

Additional checks extracted from StructureDefinition metadata:

Tier 3 (Profile) - Slicing, advanced terminology

Advanced validation for custom profiles:

License

MIT License - see LICENSE file in repository root