Glossary
The words Atlas uses on screen, in alphabetical order. Key ideas in plain words explains the central ones (template, context, model, mapping, slot) together, with a picture.
A–C
- API client
A machine login for your tenant, made on API access with Generate Client. Your systems use its client id and secret to get a token and call the engine. See Access and permissions and Connect your system to the API.
- AQL path
The openEHR path of a node as an AQL query would write it (
/content[…]/data[at0001]/…). One of the resolved paths the inspector shows with a copy button. See Write FHIR and openEHR paths.- Archetype
A reusable openEHR building block (
openEHR-EHR-OBSERVATION.blood_pressure.v2). A template is assembled from archetypes; in Atlas each archetype you map gets a model.- Auto save
The checkbox under the mapping editor. On: edits are saved to the engine shortly after you stop typing, and the examples re-run. Off: a Save button appears and the example panes go stale until you save (Ctrl+S). It is on at every visit. See Edit mappings in the Workspace.
- Blame
Who changed each mapping last, and when, from the version history. Shown as a column in the outline and a line in the inspector when versioning is available. See History, blame and restoring.
- Checkpoint
Names the changes made since the last checkpoint with a message: it becomes the commit that carries them to the Git remote (pushed right away with Push to
now , or through a review). See History, blame and restoring.- Code view
The model as raw YAML, with schema completion (the Raw YAML editor button above the editor). The other view is the visual editor (Visual mapping editor). Both edit the same model.
- Composition
One openEHR record built from a template. The openEHR example pane shows one as flat JSON;
$compositionin a path starts from its root.- ConceptMap
A FHIR resource that translates codes from one code system to another. Mappings use one for
localterminology; you manage them on Terminology. See Manage ConceptMaps.- Condition
“Map only when…”: a FHIR condition or openEHR condition under Only when limits a mapping to the elements or cases that match. It has a Where (target root), a field, an operator and criteria. See Map only when… (conditions) and Paths and conditions cheat sheet.
- Context mapper
The file that ties a template to its models: which template, which archetype mapping starts from, and which models take part. One per template (plus sub-contexts). You edit it from the Workspace overview. See Key ideas in plain words.
- Core model
A model that maps an archetype on its own, as opposed to an extension model that changes it.
- Coverage
How much of a template (Template view) or of a FHIR profile (Profile view) your mappings reach, with what is still unmapped and what is required. See Find what isn’t mapped yet.
D–L
- Deep link
A URL that opens Atlas on a given template, model, mapping, ConceptMap, Versioning tab or insight. See Links you can share.
- Dismiss
Hides an info problem for this template, in this browser only. See Fix problems.
- Engine
The openFHIR engine that stores the mappings and runs the conversions. Atlas is its editor.
- Engine state
Everything the engine holds for your tenant: templates, context and model mappers, ConceptMaps. Also the name of the Atlas page that lists them. See Engine state.
- Example panes
The openEHR pane (left) and the FHIR pane (right) of the Workspace. One is the source; Atlas converts it with the current mappings and shows the result in the other. See See your mapping in action.
- Extension (FHIR)
An extra element a FHIR profile adds, identified by its url. Atlas marks extension suggestions
extand adds them in the Profile view with + Ext. See Add a FHIR extension.- Extension model
A model that
extendsa core model instead of mapping from scratch. Each of its mappings says how it changes the core:add(a new mapping),overwrite(replaces the core mapping of the same name) orappend(adds its Followed by children under the core mapping named in Append to). See Fixed values, codes and manual pairs.- FHIR package
An implementation guide (IG) package (
.tgz) with FHIR profiles, extensions and value sets, loaded per tenant on FHIR packages. See Use FHIR profiles and IG packages.- Flat path
The openEHR path in the engine’s flat format (segments joined by
/, attributes after|), as in the keys of the openEHR example pane. One of the resolved paths. See Write FHIR and openEHR paths.- Followed by
Child mappings that continue from their parent’s FHIR element and openEHR node, with relative paths. Shown indented under their parent in the outline.
- Helper tree
The engine’s own walk of a template’s mappings, with every path resolved. Atlas reads it for highlights, resolved paths, coverage and problems; it reflects the last save.
- Insight
A record the engine keeps of one conversion: direction, status, the payloads, and which mappings applied. See Understand a conversion (Insights).
- Leaf attribute
A part of an openEHR data value that isn’t a template node, such as a quantity’s magnitude or a coded text’s code. Every spelling of it (
value/magnitude,magnitude,|magnitude) works in every field; see Paths and conditions cheat sheet.- Live problems
Problems Atlas recomputes in the browser from your unsaved edits, marked “unsaved” in the dock. The others are “from last save”. See Fix problems.
- Lock as source
The lock on an example pane: that pane stays the source of every conversion and is never overwritten. See See your mapping in action.
M–R
- Manual
Fixed path/value pairs a mapping writes on one side, relative to the mapping (for example a fixed LOINC code). See Fixed values, codes and manual pairs.
- Mapping
One rule of a model: a FHIR path and an openEHR path that correspond, with optional conditions, terminology, manual values and children.
- Mapping code
The name of a programmed mapping, custom logic built into the engine that the mapping runs (for example
generateNarrative, which writes a FHIR narrative). Add it with + Property (group Advanced). See Programmed Mappings.- Merge / Mirror
The two ways to upload into the engine. Merge adds and updates what the upload contains; Mirror also deletes what it doesn’t contain. See Bring your material in.
- Model (model mapper)
The FHIR Connect file that maps one archetype to one FHIR resource or data type: its metadata, the FHIR side (
spec) and its mappings. Created with the Create a model wizard. See Start mapping a template.- Must support (MS)
A profile’s flag that a system has to be able to handle an element. Shown as the
MSbadge in suggestions and counted in profile coverage.- Not linked
A model of the template that no slot leads to, so conversions never reach it. Fixed with Slot it in…. See Connect models: slots, links, references.
- Not modelled
Archetypes of the template that no model maps yet, listed separately in the Template view.
- OPT (operational template)
The openEHR template file (
.opt) the engine maps against. “Template” in Atlas.- Outline
The list of a model’s mappings in the Workspace, with the editing sheet below it.
- Problem
Something Atlas or the engine found wrong or suspicious in the mappings, with a severity (error, warning, info) and a source. Listed in the Problems dock; every code is in Problems.
- Profile
A FHIR StructureDefinition that narrows a resource (required elements, slices, bindings). A model’s profile drives suggestions, checks, coverage and validation. See Use FHIR profiles and IG packages.
- Reference
A mapping that continues in another FHIR resource the engine creates and points to (
referencewithresourceType), with$referenceas its openEHR path.- Release
A tagged version of a template’s mappings in the Git remote, made with the release wizard. See Release a template.
- Remote
The Git repository the engine pushes the version history to. Set up on Git remote. See Connect a Git repository.
- Resolved paths
Where a mapping really lands once its parents are taken into account: the engine path, the flat path and the AQL path. “unsaved” marks an estimate made from your edits.
- Review
A pull request on the Git remote with your changes, when the workflow is Review — changes go through pull requests. See Submit for review.
- RM attributes
Attributes every openEHR record has from the reference model (time, language, subject …). Counted in coverage only with Show and count RM attributes (time, language, subject …).
S–Z
- Scope
A permission in a sign-in token (
fc.r,versioning.w…). The engine checks scopes on every call. See Access and permissions.- Slice
A named, restricted part of a repeating FHIR element in a profile (
slice: <name>in suggestions). Picking one writes the condition that selects it.- Slot
The place in a template where another archetype sits. A mapping with Slot archetype hands that part over to the model of that archetype. See Connect models: slots, links, references.
- Source
The example pane a conversion starts from (openEHR → FHIR or FHIR → openEHR). Click a read-only pane to make it the source.
- Start archetype
The archetype of the template where the context starts mapping. Chosen when you start mapping a template.
- Sub-context
A context mapper with
scope: sub, entered through a mapping’sslotContextinstead of by template id. See FHIR Connect.- Template
An openEHR operational template (OPT), the shape of one kind of record. Everything in Atlas is organised per template.
- Tenant
Your organisation’s isolated space on the engine. Everything you see belongs to your tenant.
- Terminology
How a mapping translates codes:
inline(pairs written in the mapping),local(a ConceptMap), or, at model level, alsononeandexternal. Also the Atlas page that manages ConceptMaps. See Translate codes.- Unidirectional
A mapping that runs in one direction only:
openehr->fhirorfhir->openehr. Without it a mapping runs both ways.- Validation
Checking the FHIR example against base FHIR and the loaded profiles. It runs in Atlas, not in the engine. See Validate against FHIR profiles.
- Versioning
The engine’s history of every change to the mappings, pushed to a Git remote: history, blame, reviews, releases, compare. See Ship: versions, reviews, releases.
- Workspace
The full-screen editor: the template’s models, the mapping editor, both example panes and the Problems dock. See Workspace.