@openfn/language-fhir-ndr-et 0.1.0

package/LICENSE.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,179 @@
+# language-fhir-ndr-et <img src='./assets/square.png' width="30" height="30"/>
+
+An OpenFn **_adaptor_** for building integration jobs for use with the FHIR API
+for NDR Ethopia.
+
+## Documentation
+
+This adaptor is largely auto-generated from the spec at
+https://build.fhir.org/ig/jembi/ethiopia-hiv/branches/master/definitions.json.zip.
+See below for more details about that.
+
+We **strongly** recommend not editing generated source files by hand! Better to
+update the spec, mappings, or code generation rules. Otherwise your changes will
+be lost.
+
+View the [docs site](https://docs.openfn.org/adaptors/packages/fhir-ndr-et-docs)
+for full technical documentation.
+
+### Configuration
+
+View the
+[configuration-schema](https://docs.openfn.org/adaptors/packages/fhir-ndr-et-configuration-schema/)
+for required and optional `configuration` properties.
+
+## Building
+
+To generate the adaptor source, run `pnpm build:src`. This will generate the
+builder functions and typings, but not generate all the other adaptor stuff,
+like docs and dist.
+
+Run `pnpm build` to generate source AND build the actual adaptor.
+
+The first time the source build runs, a new "spec" file will be downloaded. To
+force a new download (ie to update the spec) delete `./spec/spec.json`
+
+## How to use
+
+This adaptor provides a bunch of helper functions to create FHIR resources in
+the right structure.
+
+Use `builders.*` (or `b.*` for short) namespace to create resource types, like
+this:
+
+```
+fn(() => {
+  const encounter = builders.encounter('target-facility-encounter', {
+    id,
+    /* add props as needed */
+  });
+})
+```
+
+All supported resource types have a main function on the `builders` object. The
+first argument is the profile id for that resource, the second is JSON data to
+define the resource.
+
+Code assist is available in Lightning for profile ids - just hit ctrl + space to
+bring up the list. It's also available in VSC (see the
+[Wiki article](https://github.com/OpenFn/adaptors/wiki/How-to-get-code-assist-for-adaptors-in-VSC))
+
+The json object is designed to be smart and do stuff like generate references
+automatically, or map typed keys like effective -> effectiveDateTime.
+
+Typescript and documentation should help here although work is needed on this
+stuff. The design is to give it a sensible value and trust it to do the right
+thing.
+
+See Resources.tests.js for some examples of creating the supported resources
+from inputs.
+
+As well as the builders, the adaptor also exports util functions to make it a
+bit easier to create references, codeableconcepts, codings and so on.
+
+So you can do stuff like this:
+
+```js
+fn(() => {
+  const encounter = builders.encounter('target-facility-encounter', {
+    id,
+    subject: util.reference('some-resource-id'),
+    class: util.coding([value, system]),
+  });
+});
+```
+
+## Code Generation
+
+A number of files in `src` are auto-generated (you can tell because they have a
+nice clear comment up at the top).
+
+The build logic is all handled in the `build/` folder.
+
+Here is roughly how the code generation works.
+
+The objective is to read in the snapshot definition of all the fhir resources in
+the destination system, and for each resource type that we're interested in,
+generate a) an easy-to-use builder function and b) a list of typescript
+definitions to match it.
+
+First, we check to see whether `./spec/spec.json` exists if it does not,
+download it!
+
+Then we load this spec.json into memory. It's a large complex file so we break
+it down into a simpler JSON representation which we call a schema.
+
+The schema contains a simple expression of rules that our builder function will
+need to apply. It looks a bit like this:
+
+```json
+{
+  "id": "arv-regimen-medication",
+  "type": "Medication",
+  "url": "http://moh.gov.et/fhir/hiv/StructureDefinition/arv-regimen-medication",
+  "props": {
+    "id": {
+      "type": "string",
+      "isArray": false,
+      "desc": "Logical id of this artifact",
+      "isComposite": false,
+      "defaults": {}
+    }
+    // ...
+  }
+}
+```
+
+This tells us for exaple that an arv-regimen-medication has a property called
+`id`, which is a type string. So our builder function will need to handle that.
+
+We only generate a simple schema for the resource types we're interested in.
+That's controlled by a file called `./build/mappings.ts`. The mappings has two
+jobs:
+
+1. Specific which resource types to generate builder functions for
+2. Provide manual override rules for those builders. This lets us provide
+   special mappings on keys for example, or provide defaults if the schema is
+   missing some information.
+
+So now we've generated simple schema objects for the resource types we're
+interested in.
+
+Next we generate the builder functions. We use a library call `ast-types` to
+help us do this. Mostly we build an AST tree directly - that is, we
+programmatically define the structure of the code using a neat API. And from
+this structure we generate code strings with nice formatting.
+
+This keeps our code generation nice and robust. The API ensures that the
+generated code is syntactically valid, and throws errors if we ask it do do
+something illegal - like nest a statement inside the condition of an
+if-statement. If we were generating strings directly, we'd have to be very
+careful about things like typos and couldn't apply smart transformations to the
+code.
+
+Using the schema information and mapping overrides, we generate code statements
+to take the input data passed as the second argument, and apply it smartly to a
+new FHIR resource, which we finally return. We lean heavily on the util
+functions in `src/utils.js` to simplify this.
+
+Once we've got our code, we have to generate matching TypeScript definitions for
+each builder. This ensures that we get code assist and intellisense on our
+generated functions, making the builders much safer and easier to use.
+
+We use the TypeScript compiler to do this, just like how we use `ast-types` to
+generate the code (although it has to be said that the TypeScript compiler has a
+way less nice API).
+
+Once finished, generated files are written into `src/`, where they can be
+tested.
+
+## Development
+
+Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Follow the
+"Getting Started" guide inside to get set up.
+
+Run tests using `pnpm run test` or `pnpm run test:watch`
+
+Build the project using `pnpm build`.
+
+To build _only_ the docs run `pnpm build docs`.