fhir-validator-js's Introduction

Javascript FHIR Validator

A javascript FHIR (www.hl7.org/fhir/) validator for use with json or strings that conform to the FHIR 3 standard.

Usage

Node

var fhir = require('fhir-validator'),
	resource,
	result;

// Your resource to validate (as json or a string)
resource = {
	resourceType: 'Medication',
	invalidProperty: 'This property is invalid for medications'
};

// Run the validation on the resource
result = fhir.validate(resource);

// Use the validation result
if(result.errors.length > 0) {
	throw { errors: result.errors, message: 'The given resource is invalid. There were ' + result.errors.length + ' errors.' };
}

fhir-validator-js's People

Contributors

Stargazers

Watchers

fhir-validator-js's Issues

$ref properties should not be extended

Running fhir-validator outputs quite a lot of warnings like this one:

$ref: all keywords used in schema at path "#/properties/district". It will change in the next major version, see issue #260. Use option { extendRefs: true } to keep current behaviour

The cause is that extra properties in JSON reference objects are supposed to be ignored. I.e. pattern is incorrectly placed here:

{ "district": {"$ref":"#/types/string","pattern":"[^s]+([s]+[^s]+)*"} }

See ajv-validator/ajv#260.

Complex elements support extensions

The FHIR standard states that complex elements can have extensions, here:

Extensions are represented in a JSON array of objects named "extension".

Right now, using a valid extension for complex elements throws this error:

    dataPath: '.address[0]',
    schemaPath: '#/additionalProperties',
    params: { additionalProperty: 'extension' },
    message: 'should NOT have additional properties' } ]

For this sample Patient data:

   "resourceType":"Patient",
   "id":"example",
   "address":[
      {
         "use":"home",
         "type":"both",
         "text":"534 Erewhon St PeasantVille, Rainbow, Vic  3999",
         "line":[
            "534 Erewhon St"
         ],
         "extension":[
            {
               "url":"/StructureDefinition/example-extension-1",
               "valueString":"data to save"
            }
         ]
      }
   ]
}

This is throwing false positives.

Recommend Projects