IF Commons GitHub

mod

Written to: 7 requirements: 7 proved, 0 partly, 0 failing, 0 with no test recorded. 0001-integrations-fhir-plugin FR-001, 0001-integrations-fhir-plugin FR-002, 0001-integrations-fhir-plugin FR-003, 0001-integrations-fhir-plugin FR-004, 0001-integrations-fhir-plugin FR-005, 0001-integrations-fhir-plugin FR-006 and 1 more

The FHIR plugin of Integrations (commons integrations-fhir 0001-integrations-fhir-plugin): R4 and US Core as registry entries with their licence as data, a codec for FHIR JSON and for NDJSON to and from the abstract typed tree, a loader that reads StructureDefinitions, CodeSystems and ValueSets the user supplies into schemas, profiles and terminologies (it embeds none of them), and the acknowledgement port of OperationOutcome.

A JSON object is one transaction whose id is its resourceType; a property is a segment (a primitive: one element with an empty id, typed number, boolean or null where the JSON is, a text otherwise, and the type is no part of a path) or a loop (an object); an array is a run of siblings of one id. Whether one sibling is an array is not in the JSON, so a codec is made with the set of repeating paths that the StructureDefinitions give (repeatingPaths), and writes an array for those and for any id that occurs twice.

Source: commons/integrations-fhir/src/mod.ts

11 of 13 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

FHIR_JSONconst
const FHIR_JSON: StandardUrn

FHIR JSON, the syntax.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

FHIR_NDJSONconst
const FHIR_NDJSON: StandardUrn

FHIR NDJSON (one resource a line), the syntax of bulk data.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

FHIR_R4const
const FHIR_R4: StandardUrn

FHIR R4 (4.0.1), the resources.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

US_COREconst
const US_CORE: StandardUrn

US Core, the implementation guide.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

STANDARDSconst
const STANDARDS: readonly Standard[]

The standards the plugin registers.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

EMBEDDEDconst
const EMBEDDED: readonly EmbeddedContent[]

The files of standards content the package embeds: none.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

jsonCodecfunction
function jsonCodec(more?: ReadonlySet<string>): Codec

The codec of FHIR JSON: one resource a text. repeating is the set of paths that are arrays even where one occurs (repeatingPaths).

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

ndjsonCodecfunction
function ndjsonCodec(repeating?: ReadonlySet<string>): Codec

The codec of NDJSON: one resource a line, each a transaction.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

repeatingPathsfunction
function repeatingPaths(schemas: readonly Schema[]): ReadonlySet<string>

The paths that are arrays in the schemas: those whose cardinality allows more than one. For jsonCodec.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

loaderconstno test imports it
const loader: Loader

The loader of FHIR definitions the user supplies: StructureDefinition, CodeSystem and ValueSet JSON.

acksconstno test imports it
const acks: AckPort

The acknowledgement port of FHIR: an OperationOutcome made from a status, and read back into findings that hold codes and paths only.

fhirPluginfunction
function fhirPlugin(repeating?: ReadonlySet<string>): StandardsPlugin

The plugin of FHIR JSON.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

fhirNdjsonPluginfunction
function fhirNdjsonPlugin(repeating?: ReadonlySet<string>): StandardsPlugin

The plugin of FHIR NDJSON.

Imported by 6 tests of the run (6 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.