Chronic Disease Surveillance, published by Clinical Quality Framework. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cqframework/aphl-chronic-ig/ and changes regularly. See the Directory of published versions

Validation

The HL7 FHIR Validator

The HL7 FHIR Validator is a command-line Java tool that checks FHIR resources and bundles for conformance against a given set of Implementation Guides. It can validate individual JSON or XML files against profiles defined in this IG and its dependencies, reporting errors, warnings, and informational messages.

To learn more about the validator and download the latest version, see the official documentation: https://confluence.hl7.org/display/FHIR/Using+the+FHIR+Validator

Dependencies

When validating against this IG, the following packages must be included so the validator can resolve all referenced profiles, value sets, and code systems.

Note: Transitive dependencies of the above packages will be resolved automatically by the validator from the FHIR package registry.

Validating a File

The validator is a Java JAR file that can be run from the command line. The general pattern for validating a FHIR resource against this IG is:

java -jar validator_cli.jar <file-to-validate> \
  -version 4.0.1 \
  -ig hl7.fhir.us.chronic-ds#0.1.0 \
  -profile <profile-url>

Example: Validating a Bundle

The following command validates a file called my-bundle.json against the APHL Chronic Disease Surveillance IG:

java -jar validator_cli.jar my-bundle.json \
  -version 4.0.1 \
  -ig hl7.fhir.us.chronic-ds#0.1.0 \
  -profile http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-measurereport-bundle

Replace <ProfileName> with the specific profile you want to validate against (e.g., a profile defined in this IG). If you want to validate against all applicable profiles declared in the resource's meta.profile, you can omit the -profile flag and the validator will use the profiles asserted in the resource itself.

The validator will automatically download required packages from the FHIR package registry. If you are working in an offline or restricted environment, pre-download the packages and provide them via the -ig flag using local paths.

For a full list of validator options, run:

java -jar validator_cli.jar --help

Known Validation Issues

The following are known validation issues or expected failures that implementers may encounter when validating against this IG. These are documented here to help distinguish known/expected results from genuine conformance problems.

• The measurereport-populationDescription extension (http://hl7.org/fhir/StructureDefinition/measurereport-populationDescription) is reported as being used in invalid locations, including the root MeasureReport element and a MeasureReport.group.stratifier.stratum.population element. Planned fix: Remove these invalid uses from generated MeasureReport instances.

• Validation reports a missing MeasureReport.supplementalData.reference extension (http://hl7.org/fhir/5.0/StructureDefinition/extension-MeasureReport.supplementalDataElement.reference) on MeasureReport.supplementalData elements. Planned fix: Update generated instances to use the correct supplemental data extension.

• MeasureReport validation reports a violation of constraint mrp-2 ("Stratifiers SHALL be either a single criteria or a set of criteria components."). Status: Believed to be an issue with the current DEQM IG profile and expected to be resolved in a future DEQM IG update.