npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@amida-tech/blue-button-model

v1.10.5

Published

Blue Button Model Validation

Downloads

546

Readme

Blue Button Model

Blue Button Model Definition and Validation

NPM

Build Status Coverage Status

This library defines a JSON Blue Button health data model. All parsers in blue-button library generate data that follow this model. The schema can be found here or programmatically here. The implementation uses z-schema.

Quick up and running guide

Prerequisites

  • Node.js (v14.19+) and NPM
  • Grunt.js
# Install dependencies
npm i

# Install grunt
npm i -g grunt

# Test
grunt

Usage

var fs = require('fs');
var bb = require('@amida-tech/blue-button');
var bbm = require('@amida-tech/blue-button-model');

var xmlString = fs.readFileSync('CCD_1.xml', 'utf-8');
var record = bb.parseString(xmlString);

var valid = bbm.validator.validateDocumentModel(record);
if (!valid) {
  var error = bbm.validator.getLastError();
    console.log(error);
}

API

validator.validateDocumentModel(document)

Primary method to validate Blue Button JSON documents.

Arguments

  • document - JSON health data document.
  • returns - true or false.

validator.validate(obj, schemaName)

Validates individual components in Blue Button documents such as sections and entries.

Arguments

  • obj - Component in the JSON health data document.
  • schemaName - Type of obj. You can use id property of any schema avaiable in the list.
  • returns - true or false.

validator.getLastError()

If validation fails this method returns the details of the errors. The error object is actually an array of errors and directly provided by the underlying library z-schema.

schemas.list(expandCommon)

Provides the list of schemas that are used in the model. The list includes section schemas, entry schemas and common component schemas. Full document schema is also available with id document_model.

Arguments

  • expandCommon - If this is falsy, common component (such as address, time, etc.) schemas are provided in an array.
  • returns - List of schemas.

schemas.map(expandCommon)

Similar to list but provides a map of schema ids (name) to schemas. If expandCommon is falsy, the array of common component schemas are provided with common_models key.

License

Licensed under Apache 2.0.