MGRID HDL and HDM 3.1.3 Documentation

MGRID Healthcare Datatype Library

MGRID Healthcare Data Model

Welcome to the MGRID Healthcare Datatype Library (HDL) and Healthcare Data Model (HDM) Documentation. The Healthcare Datatypes are part of the HL7v3 standard, and have been adopted by the ISO standards organization to form the ISO 21090 Healthcare Datatypes standard. MGRID HDL is a PostgreSQL extension module that implements the Healthcare Datatypes as a set of user defined types (UDT) and user defined functions (UDF). MGRID HDM is a collection of Healthcare Data Models that implement the normative HL7v3 Reference Information Models and their associated vocabulary.

• 1. Introduction
  • 1.1. Legal Notice
• 2. Administrators Guide
  • 2.1. Installing the software
    • 2.1.1. Requirements
    • 2.1.2. Adding the PostgreSQL repository
    • 2.1.3. Adding the MGRID repository
    • 2.1.4. Installing the packages
    • 2.1.5. Dockerfile install repositories and packages
  • 2.2. Creating a database
    • 2.2.1. Create a database on PostgreSQL (≥ 9.4)
    • 2.2.2. Loading MGRID extensions in a database
    • 2.2.3. Loading additional useful extensions
    • 2.2.4. Dockerfile create RIM database
  • 2.3. Backup and Restore
    • 2.3.1. SQL dump and restore
  • 2.4. Upgrade
    • 2.4.1. Minor HDL updates
    • 2.4.2. Major HDL updates
• 3. User Guide
  • 3.1. General Information
    • 3.1.1. Complex and Simple types
    • 3.1.2. Schemas (namespaces)
    • 3.1.3. Type hierarchy
    • 3.1.4. NullFlavor Handling
    • 3.1.5. BL returning functions vs operators
    • 3.1.6. Using indexes
  • 3.2. Working with code systems
    • 3.2.1. Installing a codesystem
    • 3.2.2. Exploring a codesystem
    • 3.2.3. Working with coded values
  • 3.3. Importing xml messages
    • 3.3.1. Create a message parser
    • 3.3.2. Using a message parser to populate a RIM database
  • 3.4. Database configuration options with HDL and HDM
    • 3.4.1. HDL only
    • 3.4.2. HDL with vocabulary
    • 3.4.3. HDM with RIM, table-per-RIM class
    • 3.4.4. HDM with locally customized RIM, table-per-RIM class
    • 3.4.5. HDL with JSONB ‘document store’
    • 3.4.6. HDM NoSQL dual head setup
    • 3.4.7. HDM with OMOP CDM
  • 3.5. Querying RIM databases
    • 3.5.1. Safe querying a RIM database
• 4. Frequently Asked Questions and Troubleshooting
  • 4.1. Frequently Asked Questions
    • 4.1.1. How do I load a HL7v3 XML file in the database
    • 4.1.2. How do I create a RIM database?
    • 4.1.3. How do I view which healthcare modules and vocabularies are loaded?
    • 4.1.4. Which Normative Edition should I use?
    • 4.1.5. Where are the Normative Editions before 2009?
    • 4.1.6. Does MGRID HDM conform to <x>?
  • 4.2. Troubleshooting
    • 4.2.1. ERROR: required extension “name” is not installed
    • 4.2.2. ERROR: type “<name>” does not exist
    • 4.2.3. ERROR: unacceptable schema name “hdl”
    • 4.2.4. ERROR: could not find oid <some oid>
    • 4.2.5. ERROR: could not find contextbinding for conceptdomain <name> (internal id <nr>)
    • 4.2.6. WARNING: code <code> not found in valueset(s) bound (no exceptions) to conceptdomain <name>
    • 4.2.7. WARNING: unknown code <code> for codeSystem <oid> (<name>)
    • 4.2.8. ERROR: unknown input syntax for uuid: “b5c6a04b-2bf4-d194-8336-63abf83190eb1”
    • 4.2.9. ERROR: could not parse month
    • 4.2.10. AttributeError: nsmap
    • 4.2.11. Error: Package: mgridhdl3_94-3.0 Requires: postgresql94-server
• 5. Reference
  • 5.1. HDM RIM implementation
    • 5.1.1. Classes and attributes
    • 5.1.2. Class hierarchy
    • 5.1.3. Class connections
    • 5.1.4. Complex and simple types in the HDM
  • 5.2. Complex Types
    • 5.2.1. Installation
    • 5.2.2. Operators on complex types
    • 5.2.3. Operators on complex types
    • 5.2.4. Complex Data Value Instantiation
    • 5.2.5. Complex Data Value Accessing
    • 5.2.6. List of Complex Types R1
    • 5.2.7. List of Complex Types R2
    • 5.2.8. Casts from Complex Types to simple types
  • 5.3. Simple Types
    • 5.3.1. Simple Healthcare Datatypes
    • 5.3.2. DataValue (‘any’)
    • 5.3.3. Boolean (‘bl’)
    • 5.3.4. Boolean (NonNull) ‘bn’
    • 5.3.5. Interaction between bl, bn and boolean
    • 5.3.6. Coded Value (cv)
    • 5.3.7. Instance Identifier (ii)
    • 5.3.8. Ratio (rto)
    • 5.3.9. Physical Quantity (pq)
    • 5.3.10. Point in Time (ts)
    • 5.3.11. Interval of Point in Time (ivl_ts)
    • 5.3.12. Interval of Physical Quantity (ivl_pq)
    • 5.3.13. Continuous set of Point in Time (qset_ts)
  • 5.4. Context conduction
    • 5.4.1. Conduction Indicator Based
    • 5.4.2. Vocabulary Based
• 6. Index support
• 7. Unified Codes for Units of Measure
• 8. Release History
  • 8.1. Release 3.1.3 (2016-06-30)
  • 8.2. Release 3.1.2 (2016-02-16)
  • 8.3. Release 3.1.1 (2016-02-09)
  • 8.4. Release 3.1.0 (2016-02-02)
  • 8.5. Release 3.0.5 (2015-12-28)
  • 8.6. Release 3.0.4 (2015-11-04)
  • 8.7. Release 3.0.3 (2015-10-15)
  • 8.8. Release 3.0.2 (2015-09-21)
  • 8.9. Release 3.0.1 (2015-03-24)
  • 8.10. Release 3.0.0 (2015-03-10)
  • 8.11. Release 2.0.14 (2015-12-28)
  • 8.12. Release 2.0.13 (2015-09-12)
  • 8.13. Release 2.0.12 (2015-04-15)
  • 8.14. Release 2.0.11 (2015-02-26)
  • 8.15. Release 2.0.10 (2014-11-17)
  • 8.16. Release 2.0.9 (2014-10-03)
  • 8.17. Release 2.0.8 (2014-08-19)
  • 8.18. Release 2.0.7 (2014-08-02)
  • 8.19. Release 2.0.6 (2014-06-17)
  • 8.20. Release 2.0.5 (2014-05-28)
  • 8.21. Release 2.0.4 (2014-05-14)
  • 8.22. Release 2.0.3 (2014-04-23)
  • 8.23. Release 2.0.2 (2014-03-13)
  • 8.24. Release 2.0.1 (2014-01-03)
  • 8.25. Release 2.0.0 (2013-11-06)

Legal Notice

The name MGRID is a registered trademark of MGRID B.V. See section Legal Notice for more information.