Xt-EHR Metadata Standards
0.1.0 - ci-build

Xt-EHR Metadata Standards, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Xt-EHR/xt-ehr-metadata/tree/main and changes regularly. See the Directory of published versions

Metadata framework - requirements and specifications

The Metadata foundation

The metadata foundation is depicted in the following diagram:
Metadata is a way to define data points - and the framework provides this definition in a structured way.
The aspects of metadata that have been deemed valuable for the project are structured in metadata objects (which is the standard approach from metadata standards and data management practices).

The diagram below shows the current components of the metadata framework. These components are combined in a way to support a good description of the data elements and structures in the project specifications, and conrtibute to interoperable and reusable specifications:

• A data structure (as a functional representation, or as a technical specification) contains elements (logical or physical, respectively).

  • A data model is a technology-agnostic logical representation of a data structure or set of data elements. This can be done at project level, national level, etc.
  • A profile is the realisation of the model in a specific technology (e.g. CDA, FHIR).
  • Each data element has certain attributes – name, definition (in context), data type, cardinality, value domain, and possibly some mappings to concepts.
  • When value sets are defined (typically in physical implementations) they are associated with the element.
  • Value sets contain concepts from a code system.
  • A concept is an abstract representation of a term
  • Concepts are captured in a code system
  • Code system is a systematized collection of concepts – each equipped with a code, textual designation, and potentially relationships with other concepts (hierarchy, properties, etc).
Common definitionsLogical data structuresTerminologiesTechnical SpecificationsGlossarytitle 1..1notes 1..1date 1..1scope 1..1status 1..1owner 1..1concept 1..*Conceptdesignation 1..*definition 1..1status 1..1code 1..1codeSystem 1..1source 0..1Data Modelidentifier 1..*status 1..1title 1..1owner 1..1element 1..*Elementname 1..1definition 1..1type 1..1valueDomain 0..*comment 0..1cardinality 0..1mapping 0..*targetConcept 1..1relationship 0..1Value Setidentifier 1..*owner 1..1status 1..1title 1..1description 1..1definition 1..*rule 0..*concept 0..*Code Systemidentifier 1..*owner 1..1status 1..1title 1..1description 1..1concept 1..*Profileidentifier 1..*status 1..1title 1..1description 1..1element 1..*            representscontainsmapped to