Profiling with zen-lang
Validate your resources with zen-lang schemas
Aidbox supports an alternative yet very powerful profile validation mechanism powered by Zen language. You can just define a set (or multiple sets) of validation profiles in EDN format and let your Aidbox server know its location. Zen-lang allows Aidbox to validate resources against schemas. It can validate individual properties as well as large profiles in a composable way
- 1.Add environment variables to the docker-compose.yaml
Env name | Sample value | Description |
|---|---|---|
AIDBOX_ZEN_PATHS | url:zip:<url to zen project> | |
AIDBOX_ZEN_PATHS | path:zip:<file system path> | |
AIDBOX_ZEN_ENTRYPOINT | hl7-fhir-us-davinci-pdex-plan-net | Main zen namespace of an IG |
2. Start Aidbox with the docker-compose
StructureDefinitions and inlined terminologies are created during startup.
Resource examples and External (not-present) terminologies are not loaded in the storage by default
3. Validate resources
Use FHIR $validate operation or a CRUD request with profile URL specified in
.meta.profile or in .profile query URL parameter.For validation (e.g. in FHIR CRUD API) Aidbox uses zen schemas tagged with
zen.fhir/base-schema or zen.fhir/profile-schema.Schemas with these tags must have
:zen.fhir/type and :zen.fhir/profileUri keys specified.Schemas tagged with
zen.fhir/base-schema are used to validate every resource of their type. When loaded into Aidbox such schema will be used instead of default json schema validationSchemas tagged with
zen.fhir/profile-schema are used to validate resources that mention their :zen.fhir/profileUri in the meta.profile attributeAidbox team created an open-source tool to generate Zen FHIR packages from FHIR packages
It is distributed as a jar file available here
Zen FHIR Packages require
AIDBOX_CORRECT_AIDBOX_FORMAT environment variable to be declaredYou can enable Zen FHIR packages that contain FHIR profiles of the following implementation guides:
- FHIR R4
hl7-fhir-us-core- US Corehl7-fhir-us-davinci-pdex- Payer Data Exchange (PDex)hl7-fhir-us-davinci-pdex-plan-net- PDEX Payer Networkhl7-fhir-us-davinci-hrex- The Da Vinci Payer Health Record exchange (HRex)hl7-fhir-us-davinci-drug-formulary- DaVinci Payer Data Exchange US Drug Formularyhl7-fhir-us-carin-bb- CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)hl7-fhir-us-mcode- mCODE™ (short for Minimal Common Oncology Data Elements)
- FHIR STU 3
nictiz-fhir-nl-stu3-zib2017- Nictiz NL, including MedMij and HL7 NL
Zen FHIR packages are distributed as npm packages or as zen-lang standalone Aidbox projects
Existing Zen FHIR packages are available as:
AIDBOX_CORRECT_AIDBOX_FORMAT=true
AIDBOX_ZEN_PATHS="url:zip:https://github.com/zen-lang/fhir/releases/latest/download/hl7-fhir-us-core.zip
,url:zip:https://github.com/zen-lang/fhir/releases/latest/download/hl7-fhir-us-carin-bb.zip
,url:zip:https://github.com/zen-lang/fhir/releases/latest/download/hl7-fhir-us-davinci-pdex.zip
,url:zip:https://github.com/zen-lang/fhir/releases/latest/download/hl7-fhir-us-davinci-drug-formulary.zip
,url:zip:https://github.com/zen-lang/fhir/releases/latest/download/hl7-fhir-us-davinci-pdex-plan-net.zip"
AIDBOX_ZEN_LOAD="{ns project
import #{hl7-fhir-us-core
hl7-fhir-us-carin-bb
hl7-fhir-us-davinci-pdex
hl7-fhir-us-davinci-drug-formulary
hl7-fhir-us-davinci-pdex-plan-net}}"
AIDBOX_ZEN_ENTRYPOINT=project
You can use existing Zen FHIR packages as a foundation for your custom Zen FHIR package. Check out Profiling with Zen-lang guide.