Skip to content

Commit

Permalink
interface and README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@au2
au2 committed Oct 19, 2014
1 parent 1d3f25f commit 732b185
Show file tree
Hide file tree
Showing 6 changed files with 62 additions and 102 deletions.
76 changes: 42 additions & 34 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,49 +25,53 @@ var record = bb.parseString(xmlString);
// ...

// get back xml as text
var updatedXmlString = bbg(record);
var updatedXmlString = bbg.generateCCD(record);

```

## Implementation

blue-button-generate uses javascript template objects for implementation. As an example Reaction Observation object is shown
blue-button-generate uses javascript template objects for implementation. Each template in CCDA is represented with an object. As an example Reaction Observation object is shown
``` javascript
var reactionObservation = exports.reactionObservation = {
"$": {
key: "observation",
attributes: {
"classCode": "OBS",
"moodCode": "EVN"
},
"templateId": common.templateId("2.16.840.1.113883.10.20.22.4.9"),
"id": fieldLevel.id,
"code": common.nullFlavor,
"text": fieldLevel.text,
"statusCode": common.completed,
"effectiveTime": fieldLevel.effectiveTime,
"value": {
"$": {
"xsi:type": "CD",
"@": attrLevel.code
},
'#': 'reaction',
'+': condition.eitherKeyExists('code', 'name'),
'*': true
},
"entryRelationship": {
"$": {
"typeCode": "SUBJ",
"inversionInd": "true"
},
"observation": severityObservation,
"+": condition.keyExists('severity')
}
content: [
fieldLevel.templateId("2.16.840.1.113883.10.20.22.4.9"),
fieldLevel.id,
fieldLevel.nullFlavor("code"),
fieldLevel.text(leafLevel.sameReference("reaction")),
fieldLevel.statusCodeCompleted,
fieldLevel.effectiveTime, {
key: "value",
attributes: [
leafLevel.typeCD,
leafLevel.code
],
dataKey: 'reaction',
existsWhen: condition.codeOrDisplayname,
required: true
}, {
key: "entryRelationship",
attributes: {
"typeCode": "SUBJ",
"inversionInd": "true"
},
content: severityObservation,
existsWhen: condition.keyExists('severity')
}
]
};
```
this template is internally used with a call

This template is internally used with a call
``` javascript
js2xml.fillUsingTemplate(xmlDoc, input, 'observation', reactionObservation)
js2xml.update(xmlDoc, input, context, reactionObservation);
```
where `xmlDoc` is the parent xml document (Allergy Intolerance Observation) and `input` is the immediate parent of [bluebutton.js](https://github.com/blue-button/bluebutton.js) object that describes Reaction Observation
where `xmlDoc` is the parent xml document (Allergy Intolerance Observation) and `input` is the immediate parent of [bluebutton.js](https://github.com/blue-button/bluebutton.js) object that describes Reaction Observation. `context` is internally used for indices in text references.

### Motivation

Expand All @@ -82,8 +86,12 @@ This approach is an alternative to direct programming or text based templates su

### Template Structure

Each alpha-numeric key in the template corresponds a statement in the CCDA specification. `$` key is used to specify attributes and `*` key is used to indicate an element is required. Values for `$` and `*` also directly come from the specification. `@` and other keys that start with `@` are used as place holder keys. Values for `@` are functions that provide both the keys and the values of the attributes. An additional key `_` is used to represent text value of an xml node.

`#` and `+` keys relates the templates to [blue-button](https://github.com/amida-tech/blue-button) data model. Value for the key `#` identifies the key in the data model that is associated with the node. For example [blue-button](https://github.com/amida-tech/blue-button) data model uses `reaction` for values of Reaction Observations. `+` is used to specify a function that checks if the node should exists or not. For example in `reactionObservation` the Severity Observation `entryRelationship` is only created if `reaction` has a `severity` key. Required nodes that should not exist based on `+` are created with a `nullFlavor`.

Each value in the template can either be an other template object or a function.
The following are the properties of the templates
* `key`: This is the name for the xml element.
* `attributes`: This describes the attributes of the element. `attributes` can be an object of with `key` and `value` pairs for each attribute or it can be an array of such objects. Each attribute object or can be a function with `input` argument that returns attributes.
* `text`: This is a function with `input` attribute that returns text value of the element.
* `content`: This is an array of other templates that describe the children of the element. For a single child an object can be used.
* `dataKey`: This is the property of `input` that serves as the date for the template.
* `required`: This identifies if template is required or not. If template is required and there is not value in the `input` a `nullFlavor` node is created.
* `dataTransform`: This is a function to transform the input.
* `existWhen`: This is a boolean function with `input` argument to describe it the elements should exists or not.
14 changes: 7 additions & 7 deletions index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ var createContext = (function () {
};
})();

var generate = function (input) {
var data = input.data ? input.data : input;
data.identifiers = input.meta && input.meta.identifiers;

var generate = exports.generate = function (template, input) {
var context = createContext();

return js2xml.create(documentLevel.ccd, data, context);
return js2xml.create(documentLevel.ccd, input, context);
};

module.exports = generate;
exports.generateCCD = function (input) {
var data = input.data ? input.data : input;
data.identifiers = input.meta && input.meta.identifiers;
return generate(documentLevel.ccd, data);
};
48 changes: 0 additions & 48 deletions lib/README.md
View file

This file was deleted.

20 changes: 10 additions & 10 deletions test/sample_runs/test-generator-ccda.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ describe('parse generate parse generate', function () {
expect(err.valid).to.be.true;

// generate ccda
var xml = bbg(result).toString();
var xml = bbg.generateCCD(result);
// write ccda
fs.writeFileSync(path.join(generatedDir, "CCD_1_generated.xml"), xml);

Expand All @@ -49,7 +49,7 @@ describe('parse generate parse generate', function () {
fs.writeFileSync(path.join(generatedDir, "CCD_1_generated_2.json"), JSON.stringify(result2, null, 4));

// re-generate
var xml2 = bbg(result2).toString();
var xml2 = bbg.generateCCD(result2);
fs.writeFileSync(path.join(generatedDir, "CCD_1_generated_2.xml"), xml2);

delete result.errors;
Expand All @@ -71,7 +71,7 @@ describe('parse generate parse generate', function () {
var val = bb.validator.validateDocumentModel(result);

// generate ccda
var xml = bbg(result).toString();
var xml = bbg.generateCCD(result);
// write ccda
fs.writeFileSync(path.join(generatedDir, "Vitera_CCDA_SMART_Sample_generated.xml"), xml);

Expand All @@ -81,7 +81,7 @@ describe('parse generate parse generate', function () {
fs.writeFileSync(path.join(generatedDir, "Vitera_CCDA_SMART_Sample_generated_2.json"), JSON.stringify(result2, null, 4));

// re-generate
var xml2 = bbg(result2).toString();
var xml2 = bbg.generateCCD(result2);
fs.writeFileSync(path.join(generatedDir, "Vitera_CCDA_SMART_Sample_generated_2.xml"), xml2);

delete result.errors;
Expand All @@ -104,7 +104,7 @@ describe('parse generate parse generate', function () {
var val = bb.validator.validateDocumentModel(result);

// generate ccda
var xml = bbg(result).toString();
var xml = bbg.generateCCD(result);
// write ccda
fs.writeFileSync(path.join(generatedDir, "VA_CCD_Sample_File_Version_12_5_1_generated.xml"), xml);

Expand All @@ -116,7 +116,7 @@ describe('parse generate parse generate', function () {
fs.writeFileSync(path.join(generatedDir, "VA_CCD_Sample_File_Version_12_5_1_generated_2.json"), JSON.stringify(result2, null, 4));

// re-generate
var xml2 = bbg(result2).toString();
var xml2 = bbg.generateCCD(result2);
fs.writeFileSync(path.join(generatedDir, "VA_CCD_Sample_File_Version_12_5_1_generated_2.xml"), xml2);

delete result.errors;
Expand Down Expand Up @@ -144,7 +144,7 @@ describe('parse generate parse generate', function () {
var val = bb.validator.validateDocumentModel(result);

// generate ccda
var xml = bbg(result).toString();
var xml = bbg.generateCCD(result);
// write ccda
fs.writeFileSync(path.join(generatedDir, "SampleCCDDocument_generated.xml"), xml);

Expand All @@ -156,7 +156,7 @@ describe('parse generate parse generate', function () {
fs.writeFileSync(path.join(generatedDir, "SampleCCDDocument_generated_2.json"), JSON.stringify(result2, null, 4));

// re-generate
var xml2 = bbg(result2).toString();
var xml2 = bbg.generateCCD(result2);
fs.writeFileSync(path.join(generatedDir, "SampleCCDDocument_generated_2.xml"), xml2);

delete result.errors;
Expand All @@ -182,7 +182,7 @@ describe('parse generate parse generate', function () {
var val = bb.validator.validateDocumentModel(result);

// generate ccda
var xml = bbg(result).toString();
var xml = bbg.generateCCD(result);
// write ccda
fs.writeFileSync(path.join(generatedDir, "cms_sample_generated.xml"), xml);

Expand All @@ -192,7 +192,7 @@ describe('parse generate parse generate', function () {
fs.writeFileSync(path.join(generatedDir, "cms_sample_generated_2.json"), JSON.stringify(result2, null, 4));

// re-generate
var xml2 = bbg(result2).toString();
var xml2 = bbg.generateCCD(result2);
fs.writeFileSync(path.join(generatedDir, "cms_sample_generated_2.xml"), xml2);

delete result.errors;
Expand Down
4 changes: 2 additions & 2 deletions test/sample_runs/test-generator-ccda_new.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ describe('try skewed sample data from app.', function () {
// generate ccda

//console.log(result.demographics);
var xml = bbg(result).toString();
var xml = bbg.generateCCD(result);

// write ccda
fs.writeFileSync(path.join(generatedDir, "CCD_1_generated_new.xml"), xml);
Expand All @@ -44,7 +44,7 @@ describe('try skewed sample data from app.', function () {
fs.writeFileSync(path.join(generatedDir, "CCD_1_generated_2_new.json"), JSON.stringify(result2, null, 4));

// re-generate
var xml2 = bbg(result2).toString();
var xml2 = bbg.generateCCD(result2);
fs.writeFileSync(path.join(generatedDir, "CCD_1_generated_2_new.xml"), xml2);

delete result.errors;
Expand Down
2 changes: 1 addition & 1 deletion test/sample_runs/test-xml-vs-generatedxml.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ describe('xml vs parse generate xml ', function () {
}

// generate ccda
var xmlGeneratedRaw = bbg(result).toString();
var xmlGeneratedRaw = bbg.generateCCD(result);

var mods = bbGeneratorMods;
if (addlGeneratorMods) {
Expand Down

0 comments on commit 732b185

Please sign in to comment.