Difference between revisions of "IPS Technical Background 1"

From HL7 IPS
Jump to: navigation, search
(Identifiers for Templates and Value Sets)
(Identifiers for Templates and Value Sets)
Line 38: Line 38:
  
 
==Identifiers for Templates and Value Sets==
 
==Identifiers for Templates and Value Sets==
This specification uses the following OIDs for the artefacts, that are registered at the HL7 OID registry.  
+
This specification uses the following OIDs for the artefacts that are registered at the HL7 OID registry.  
 
*The root OID for templates is 2.16.840.1.113883.10.22
 
*The root OID for templates is 2.16.840.1.113883.10.22
 
**Document Level Templates are sub branch '''.1''', e.g. 2.16.840.1.113883.10.22.1.1 ''International Patient Summary''
 
**Document Level Templates are sub branch '''.1''', e.g. 2.16.840.1.113883.10.22.1.1 ''International Patient Summary''

Revision as of 09:41, 21 July 2017

Technical Background

In Review

What is a CDA

CDA R2 is "… a document markup standard that specifies the structure and semantics of clinical documents for the purpose of exchange” [CDA R2, Section 1.1]. Clinical documents, according to CDA, have the following characteristics:

  • Persistence
  • Stewardship
  • Potential for authentication
  • Context
  • Wholeness
  • Human readability

CDA defines a header for classification and management and a document body that carries the clinical record. While the header metadata are prescriptive and designed for consistency across all instances, the body is highly generic, leaving the designation of semantic requirements to implementation.

Templated CDA

CDA R2 can be constrained by mechanisms defined in the “Refinement and Localization” section of the HL7 Version 3 Interoperability Standards. The mechanism most commonly used to constrain CDA is referred to as “templated CDA”. This specification created a set of artefacts containing modular CDA templates (and associated value sets) for the purpose of the International Patient Summary, and the templates can be reused across any number of CDA document types.

There are different kinds of templates that might be created. Among them, the most common are:

  • CDA Document Level Templates constrain fields in the Clinical Document Architecture (CDA) header, and define containment relationships to CDA sections.
    For example, a History-and-Physical document-level template might require that the patient’s name be present, and that the document contain a Physical Exam section.
  • CDA Header Level Templates constrain fields for parts of the CDA header, like the patient (record target), the author, participations or the service event.
  • CDA Section Level Templates constrain fields in the CDA section, and define containment relationships to CDA entries.
    For example, a Physical-exam section-level template might require that the section/code be fixed to a particular LOINC code, and that the section contain a Systolic Blood Pressure observation.
  • CDA Entry Level Templates constrain the CDA clinical statement model in accordance with real world observations and acts.
    For example, a Systolic-blood-pressure entry-level template defines how the CDA Observation class is constrained (how to populate observation/code, how to populate observation/value, etc.) to represent the notion of a systolic blood pressure.

Open and Closed Templates

Open templates permit anything to be done in the underlying standard that is not explicitly prohibited. This allows templates to be built up over time that extend and go beyond the original use cases for which they were originally designed.

Closed templates only permit what has been defined in the template, and do not permit anything beyond that. There are good reasons to use closed templates, sometimes having to do with local policy. For example, in communicating information from a healthcare provider to an insurance company, some information may need to be omitted to ensure patient privacy laws are followed. Most templates developed for CDA are of the open sort.

Template versioning

Template versioning is needed to enable template designs to evolve over time.

Template versioning enables template designers to control and shape the conformances that make up a template’s design over time tailoring the design to fit the template’s intended purpose.

Each template version is associated with a particular template. The template – as a whole – has a mandatory globally unique, non-semantic, identifier. The identifier serves as the identifier of the original intent of the template and as the identifier of the set of versions that represent the template over time.

Template versions have a mandatory timestamp (date and optional time), called the “effective date”. The date can be seen as the point in time when the template version “came into being”, i.e. was recognized as existent by the governance group. Use of the template prior to this date would be considered an invalid use of the template.

For further information on Templates, Template Versions and related topics refer to the HL7 Templates Standard[1].

Identifiers for Templates and Value Sets

This specification uses the following OIDs for the artefacts that are registered at the HL7 OID registry.

  • The root OID for templates is 2.16.840.1.113883.10.22
    • Document Level Templates are sub branch .1, e.g. 2.16.840.1.113883.10.22.1.1 International Patient Summary
    • Header Level Templates are summarized under 2.16.840.1.113883.10.22.2, e.g. 2.16.840.1.113883.10.22.2.1 IPS CDA recordTarget
    • Section Level Templates are summarized under 2.16.840.1.113883.10.22.3, e.g. 2.16.840.1.113883.10.22.3.1 IPS Medication Summary Section
    • Entry Level templates are summarized under 2.16.840.1.113883.10.22.4, e.g. 2.16.840.1.113883.10.22.4.19 IPS Certainty Observation
    • “other” assistance templates are summarized under 2.16.840.1.113883.10.22.9, e.g. 2.16.840.1.113883.10.22.9.2 IPS CDA Device
  • The root OID for Value Sets is 2.16.840.1.113883.11

The sub branches for templates follow the recommendations of HL7 International and ISO 13582[2]

Terminologies

Some hints

Responsible: Rob Hausam
  • Focus on Value Sets, as they are the main artefacts used for validation
  • General Info about Terminology Binding

How to extend Value Sets

  •  ? Coded with Extensibility / no Extensions ? or other topics ?
  • If needed: Example binding

Note: We must use NI as a nullFlavor instead on UNC (uncoded). Write a note on this.

  1. HL7 Templates Standard: Specification and Use of Reusable Information Constraint Templates, Release 1
  2. ISO/TS 13582:2013 Health informatics -- Sharing of OID registry information