Blueprint Schema Reference

How to define structural validation rules, value set bindings, and business rules for your HIE

What is a Blueprint?

The definition of what good data looks like for a message type

A Blueprint is a named set of validation rules applied to every incoming message of a given type and format. When a message is scored, the platform evaluates all active blueprints that match the message's type and format, and each rule result contributes to one of the five quality dimension scores.

Blueprints are managed in the Blueprints page. Engineers and admins can create, edit, enable, and disable blueprints without restarting the platform — changes take effect on the next scored message.

Blueprint Schema Fields

Top-level fields in the Blueprint JSON structure

namestringrequiredUnique blueprint name within your HIE

message_typestringrequiredHL7 V2 type (ADT, ORU, ORM…) or FHIR resource (Patient, Observation…)

formatstringrequired"HL7V2", "FHIR_R4", or "IHE"

enabledbooleanWhether the blueprint is active. Defaults to true.

rulesRule[]Array of rule objects evaluated in order

value_setsValueSetBinding[]Field → vocabulary bindings

Rule Types

Each rule object has a type that determines which quality dimension it affects

required_fieldCompleteness

Asserts that a specific field path is present and non-empty in the message. Failures reduce the Completeness dimension score.

{
  "type": "required_field",
  "field": "PID.5",
  "message": "Patient name (PID-5) is required"
}

value_setConformance

Validates that a coded field's value is a member of a bound vocabulary (LOINC, SNOMED CT, ICD-10, RxNorm, HL7 Tables). Failures reduce the Conformance dimension score.

{
  "type": "value_set",
  "field": "OBR.4",
  "vocabulary": "LOINC",
  "message": "Order code (OBR-4) must be a valid LOINC code"
}

business_ruleAccuracy

Evaluates a custom HIE-specific rule expression — NPI format validation, insurance segment presence, reference range completeness, etc. Uses a simple expression DSL evaluated at scoring time.

{
  "type": "business_rule",
  "rule_id": "npi_format",
  "field": "ROL.4",
  "message": "Provider NPI (ROL-4) must be a 10-digit number"
}

cross_fieldConsistency

Compares two field values within the same message for logical consistency — e.g., discharge date must be after admission date. Failures reduce the Consistency dimension score.

{
  "type": "cross_field",
  "field_a": "PV1.44",
  "field_b": "PV1.45",
  "operator": "before",
  "message": "Admission date (PV1-44) must be before discharge date (PV1-45)"
}

Value Set Bindings

Bind specific field paths to standard vocabularies

Value set bindings in the top-level value_sets array supplement rule-based validation by mapping a field path to a vocabulary without needing a full rule object. The platform will check the field value against the loaded vocabulary entries.

{
  "value_sets": [
    {
      "field": "OBX.3",
      "vocabulary": "LOINC",
      "message": "Result code (OBX-3) must be a valid LOINC code"
    },
    {
      "field": "DG1.3",
      "vocabulary": "ICD10CM",
      "message": "Diagnosis code (DG1-3) must be a valid ICD-10-CM code"
    }
  ]
}

Supported vocabularies: LOINC, SNOMED_CT, ICD10CM, RXNORM, HL7_TABLES, FHIR_CODESYSTEMS. Vocabulary entries are managed in the Terminology page.

Ready to create your first Blueprint?

Open the live Blueprint editor to build, test, and enable rules for your HIE.

Open Blueprints