IPS Technical Background 1 - Revision history

Gcangioli: /* Identifiers for Templates and Value Sets */

2018-01-31T23:00:49Z

‎Identifiers for Templates and Value Sets

Gcangioli: /* Value Set Definitions */

2018-01-31T20:26:34Z

‎Value Set Definitions

Gcangioli: /* Value Set Expansions */

2018-01-31T20:21:20Z

‎Value Set Expansions

Gcangioli: /* Value Set Definitions */

2018-01-31T20:20:15Z

‎Value Set Definitions

Gcangioli: /* Value Set Definitions */

2018-01-31T20:16:53Z

‎Value Set Definitions

Gcangioli: /* Value Set Definitions */

2018-01-31T20:15:33Z

‎Value Set Definitions

Gcangioli: /* Value Set Definitions */

2018-01-31T20:14:54Z

‎Value Set Definitions

Admin: /* How to extend Value Sets */

2017-12-13T18:31:51Z

‎How to extend Value Sets

Gcangioli: /* Terminologies */

2017-10-09T15:02:19Z

‎Terminologies

Rhausam: /* How to extend Value Sets */

2017-07-30T21:31:53Z

‎How to extend Value Sets

@@ Line 18: / Line 18: @@
 **“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<ref>ISO/TS 13582:2013 Health informatics -- Sharing of OID registry information</ref>
+The sub branches for templates follow the recommendations of HL7 International and ISO 13582<ref>ISO/TS 13582:2015 Health informatics -- Sharing of OID registry information</ref>
 ==Terminologies==

@@ Line 82: / Line 82: @@
 **An Intensional Definition is a set of rules that can be expanded (ideally computationally) to an exact set of concept representations at a particular point in time.
-Many of the value sets used in the IPS specification are defined intensionally. The source of truth for these value sets and their definitions for IPS is ART-DECOR®<ref>IPS Value Sets is ART-DECOR®  https://art-decor.org/art-decor/decor-valuesets--hl7ips-</ref>.
+Many of the value sets used in the IPS specification are defined intensionally. The source of truth for these value sets and their definitions for IPS is ART-DECOR®<ref>IPS Value Sets in ART-DECOR®  https://art-decor.org/art-decor/decor-valuesets--hl7ips-</ref>.
 {{IncludeImage|IPS_intensionalvs.png|500px|70%}}

@@ Line 90: / Line 90: @@
 To obtain a list of enumerated concepts, Value Sets must be expanded. This means that the Value Set Definition must be converted to a list of concept representations at a point in time. This normally is a list of codes that may be used in populating or validating communicated model instances (but it may alternatively be a list of designations). While this is straightforward for extensional Value Set Definitions, an intensional Value Set Definition must be resolved to a Value Set Expansion by processing the rules contained in the Value Set Definition. Value Set Expansion can be done as early as the point of Value Set definition or as late as run time.  For intensional Value Sets, the set of concepts contained in the expansion will generally change when the definition is changed (a new version of the Value Set Definition), but also may change with the identical version of the definition if the underlying code systems change, and the changes are part of the Value Set Expansion. This can be controlled if the definition statement refers to specific code system versions, thereby prohibiting the expansion from changing when the code system changes with a new version release. See Core Principles and Properties of HL7 Version 3 Models for additional details.<ref name="V3CorePrinciples">Core Principles and Properties of HL7 Version 3 Models http://www.hl7.org/implement/standards/product_brief.cfm?product_id=58</ref>
-In order to implement the IPS specification, the intensionally defined value sets must be expanded (as noted above). ART-DECOR®, in addition to serving as the source of truth for the IPS value sets, is expected to provide capabilities for generating the required value set expansions.  Other terminology servers are also expected to provide this service.
+In order to implement the IPS specification, the intensionally defined value sets must be expanded (as noted above). ART-DECOR® is expected to provide capabilities for generating the required value set expansions.  Other terminology servers are also expected to provide this service.
 ===How to extend Value Sets===
 For elements with a binding to a value set that allows extensibility (Extensible/CWE), it may at times be necessary to extend the value set in order to support implementation needs. Coded With Extensibility (Extensible/CWE) means that the set of codes resulting from processing the Value Set Definition is not necessarily complete for its intended use-case. There may be some concepts that need to be communicated that cannot be represented within the expansion of the specified value set. In these cases, implementers therefore have permission to send local codes or original text within the coded element if an appropriate code cannot be found within the value set and its current expansion. When this does occur, however, there is an expectation that implementers should feed back these "missing concepts" to the maintainers of the Value Sets or referenced Code System(s) to have the necessary concept added, and then to transition to the new "official" code when one is subsequently added to the value set.

@@ Line 80: / Line 80: @@
 **An Extensional Definition is an enumeration of all of the concepts within the Value Set. A Value Set defined by extension is composed of explicitly enumerated sets of concept representations (with the Code System in which they are valid). The simplest case is when the Value Set consists of only one concept.
 *'''Intensional Definition''': Defining an algorithm that, when executed by a machine (or interpreted by a human being), yields an enumeration of all of the concepts within the Value Set, which is called a '''Value Set Expansion'''.
-**An Intensional Definition is a set of rules that can be expanded (ideally computationally) to an exact list of concept representations at a particular point in time.
+**An Intensional Definition is a set of rules that can be expanded (ideally computationally) to an exact set of concept representations at a particular point in time.
 Many of the value sets used in the IPS specification are defined intensionally. The source of truth for these value sets and their definitions for IPS is ART-DECOR®<ref>IPS Value Sets is ART-DECOR®  https://art-decor.org/art-decor/decor-valuesets--hl7ips-</ref>.

@@ Line 78: / Line 78: @@
 Two approaches can be used to define the contents of a Value Set:
 *'''Extensional Definition''': Explicitly enumerating each of the Value Set concepts.
-**An Extensional Definition is an enumeration of all of the concepts within the Value Set. Value Sets defined by extension are composed of explicitly enumerated sets of concept representations (with the Code System in which they are valid). The simplest case is when the Value Set consists of only one concept.
+**An Extensional Definition is an enumeration of all of the concepts within the Value Set. A Value Set defined by extension is composed of explicitly enumerated sets of concept representations (with the Code System in which they are valid). The simplest case is when the Value Set consists of only one concept.
 *'''Intensional Definition''': Defining an algorithm that, when executed by a machine (or interpreted by a human being), yields an enumeration of all of the concepts within the Value Set, which is called a '''Value Set Expansion'''.
 **An Intensional Definition is a set of rules that can be expanded (ideally computationally) to an exact list of concept representations at a particular point in time.

← Older revision		Revision as of 18:31, 13 December 2017
Line 93:		Line 93:

	===How to extend Value Sets===		===How to extend Value Sets===
−	For elements with a binding to a value set that allows extensibility (CWE), it may at times be necessary to extend the value set in order to support implementation needs. Coded With Extensibility (CWE) means that the set of codes resulting from processing the Value Set Definition is not necessarily complete for its intended use-case. There may be some concepts that need to be communicated that cannot be represented within the expansion of the specified value set. In these cases, implementers therefore have permission to send local codes or original text within the coded element if an appropriate code cannot be found within the value set and its current expansion. When this does occur, however, there is an expectation that implementers should feed back these "missing concepts" to the maintainers of the Value Sets or referenced Code System(s) to have the necessary concept added, and then to transition to the new "official" code when one is subsequently added to the value set.	+	For elements with a binding to a value set that allows extensibility (Extensible/CWE), it may at times be necessary to extend the value set in order to support implementation needs. Coded With Extensibility (Extensible/CWE) means that the set of codes resulting from processing the Value Set Definition is not necessarily complete for its intended use-case. There may be some concepts that need to be communicated that cannot be represented within the expansion of the specified value set. In these cases, implementers therefore have permission to send local codes or original text within the coded element if an appropriate code cannot be found within the value set and its current expansion. When this does occur, however, there is an expectation that implementers should feed back these "missing concepts" to the maintainers of the Value Sets or referenced Code System(s) to have the necessary concept added, and then to transition to the new "official" code when one is subsequently added to the value set.

@@ Line 23: / Line 23: @@
 ''Note: Much of the description provided in this section is copied and adapted from the §4.2.8 Vocabulary Conformance section of the C-CDA DSTU R2.1 Implementation Guide Volume 1.<ref name="ccda21"></ref>''
-The templates in this document use terms from several code systems. These vocabularies are defined in various supporting specifications and may be maintained by other bodies, as is the case for the LOINC® and SNOMED CT® vocabularies.  The primary terminologies identified for this specification are listed [[IPS_implementationguide_1#How_to_use_terminologies_(preferred_binding)|here]].
+The templates in this document use terms from several code systems. These vocabularies are defined in various supporting specifications and may be maintained by other bodies, as is the case for the LOINC® and SNOMED CT® vocabularies.  The primary terminologies identified for this specification are listed [[IPS_implementationguide_1#How_to_use_terminologies_(preferred_binding)|in section 4.1]].
 Note that value set identifiers (e.g., ValueSet 2.16.840.1.113883.1.11.78 ''Observation Interpretation'' (DYNAMIC)) used in the binding definitions of template conformance statements do not appear in the XML instance of a CDA document. The definition of the template must be referenced to determine or validate the vocabulary conformance requirements of the template.

← Older revision		Revision as of 21:31, 30 July 2017
Line 93:		Line 93:

	===How to extend Value Sets===		===How to extend Value Sets===
−	~~{{NoteBox\|~~
−	* ? Coded with Extensibility / no Extensions ? or other topics ?
−	* If needed: Example binding
−	*We must use NI as a nullFlavor instead on UNC (uncoded). Write a note on this. - added to the note in 4.3 Uncoded information, which should be sufficient
−	}}
	For elements with a binding to a value set that allows extensibility (CWE), it may at times be necessary to extend the value set in order to support implementation needs. Coded With Extensibility (CWE) means that the set of codes resulting from processing the Value Set Definition is not necessarily complete for its intended use-case. There may be some concepts that need to be communicated that cannot be represented within the expansion of the specified value set. In these cases, implementers therefore have permission to send local codes or original text within the coded element if an appropriate code cannot be found within the value set and its current expansion. When this does occur, however, there is an expectation that implementers should feed back these "missing concepts" to the maintainers of the Value Sets or referenced Code System(s) to have the necessary concept added, and then to transition to the new "official" code when one is subsequently added to the value set.		For elements with a binding to a value set that allows extensibility (CWE), it may at times be necessary to extend the value set in order to support implementation needs. Coded With Extensibility (CWE) means that the set of codes resulting from processing the Value Set Definition is not necessarily complete for its intended use-case. There may be some concepts that need to be communicated that cannot be represented within the expansion of the specified value set. In these cases, implementers therefore have permission to send local codes or original text within the coded element if an appropriate code cannot be found within the value set and its current expansion. When this does occur, however, there is an expectation that implementers should feed back these "missing concepts" to the maintainers of the Value Sets or referenced Code System(s) to have the necessary concept added, and then to transition to the new "official" code when one is subsequently added to the value set.