Obligation Discussion
0.4.1 - Working Draft to present the Concept Ideas and Background Details (FO)
Obligation Discussion
0.4.1 - Working Draft to present the Concept Ideas and Background Details (FO)
Obligation Discussion - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2022-10-10 |
<CodeSystem xmlns="http://hl7.org/fhir">
<id value="dataExpectation"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class="grid"><tr><td><b>Code</b></td><td><b>URI</b></td><td><b>Type</b></td><td><b>Description</b></td></tr><tr><td>parent</td><td>http://hl7.org/fhir/concept-properties#parent</td><td>code</td><td/></tr><tr><td>actor</td><td/><td>code</td><td>associated actor, i.e. to whom it may apply</td></tr></table><p><b>Concepts</b></p><p>This case-sensitive code system <code>http://v2.hl7.org/fhir/CodeSystem/dataExpectation</code> defines the following codes in a Is-A hierarchy:</p><table class="codes"><tr><td><b>Lvl</b></td><td style="white-space:nowrap"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b>Parent</b></td><td><b>actor</b></td></tr><tr><td>1</td><td style="white-space:nowrap">expected<a name="dataExpectation-expected"> </a></td><td>expected</td><td>data fits to expectations/specification</td><td/><td/></tr><tr><td>2</td><td style="white-space:nowrap"> unaltered<a name="dataExpectation-unaltered"> </a></td><td>preserve</td><td>preserve what you get</td><td><a href="#dataExpectation-expected">expected</a></td><td/></tr><tr><td>3</td><td style="white-space:nowrap"> exactly<a name="dataExpectation-exactly"> </a></td><td>exactly</td><td>exactly what is specified, nothing else</td><td><a href="#dataExpectation-unaltered">unaltered</a></td><td/></tr><tr><td>2</td><td style="white-space:nowrap"> modify<a name="dataExpectation-modify"> </a></td><td>modify</td><td>allow for modifications of the data</td><td><a href="#dataExpectation-expected">expected</a></td><td>consumer</td></tr><tr><td>3</td><td style="white-space:nowrap"> assocation<a name="dataExpectation-assocation"> </a></td><td>assocation</td><td>taken by association</td><td><a href="#dataExpectation-modify">modify</a></td><td/></tr><tr><td>3</td><td style="white-space:nowrap"> equivalent<a name="dataExpectation-equivalent"> </a></td><td>equivalent</td><td>in an equivalent way</td><td><a href="#dataExpectation-modify">modify</a></td><td/></tr><tr><td>3</td><td style="white-space:nowrap"> translate<a name="dataExpectation-translate"> </a></td><td>translate</td><td>Data received is preserved by 1:1 mapping/translation to an internal value that is semantically equivalent, that preserves the temporal aspect of the translation.</td><td><a href="#dataExpectation-modify">modify</a></td><td/></tr><tr><td>4</td><td style="white-space:nowrap"> semantically<a name="dataExpectation-semantically"> </a></td><td>translate semantically</td><td>Two concepts are semantically equivalent if they can substitute for each other in the defined use case with no loss of information used to define the concept.</td><td><a href="#dataExpectation-translate">translate</a></td><td/></tr><tr><td>4</td><td style="white-space:nowrap"> clinically<a name="dataExpectation-clinically"> </a></td><td>translate clinically</td><td>Two concepts are clinically equivalent if they can substitute for each other in the defined use case with no impact on clinical interpretation by a trained clinician. This may include further refinements based on the specific domain, e.g., for Lab use case, this would require interpretation that includes the impact of differences in normal ranges.</td><td><a href="#dataExpectation-translate">translate</a></td><td/></tr><tr><td>3</td><td style="white-space:nowrap"> reference<a name="dataExpectation-reference"> </a></td><td>reference</td><td>Use referenced data based on stored pointer; stored data is displayed by linking to the corresponding stored value most often the case for data elements that are STORED EXACT by ASSOCIATION.</td><td><a href="#dataExpectation-modify">modify</a></td><td/></tr><tr><td>3</td><td style="white-space:nowrap"> truncate<a name="dataExpectation-truncate"> </a></td><td>cut off data</td><td>cut off remaining characters from the data thereby shortening the data</td><td><a href="#dataExpectation-modify">modify</a></td><td/></tr><tr><td>3</td><td style="white-space:nowrap"> more-details<a name="dataExpectation-more-details"> </a></td><td>additional details/values</td><td>extends the expected data with more/own information, e.g. appartment if street is specified</td><td><a href="#dataExpectation-modify">modify</a></td><td>creator</td></tr><tr><td>3</td><td style="white-space:nowrap"> more-structure<a name="dataExpectation-more-structure"> </a></td><td>additional substructures</td><td>provides the data with more granular details, e.g. house number for an address line</td><td><a href="#dataExpectation-modify">modify</a></td><td>creator</td></tr><tr><td>3</td><td style="white-space:nowrap"> missing<a name="dataExpectation-missing"> </a></td><td>data is missing/not available</td><td>provide a null-flavor/absent reason</td><td><a href="#dataExpectation-modify">modify</a></td><td>creator</td></tr><tr><td>3</td><td style="white-space:nowrap"> constant<a name="dataExpectation-constant"> </a></td><td>added as a constant</td><td>this value has no valid representation or meaning in the sending application, it is just added because it is required to be there</td><td><a href="#dataExpectation-modify">modify</a></td><td/></tr><tr><td>1</td><td style="white-space:nowrap">unexpected<a name="dataExpectation-unexpected"> </a></td><td>unexpected values</td><td>how to manage unexpected data (as sender or receiver)</td><td/><td/></tr><tr><td>2</td><td style="white-space:nowrap"> replaces<a name="dataExpectation-replaces"> </a></td><td>new/other values</td><td>replaces the expected data by something else</td><td><a href="#dataExpectation-unexpected">unexpected</a></td><td/></tr><tr><td>2</td><td style="white-space:nowrap"> consider<a name="dataExpectation-consider"> </a></td><td>consider unexpected values</td><td>take vare of values that are coming but not described/specified. Allows for warnings</td><td><a href="#dataExpectation-unexpected">unexpected</a></td><td/></tr></table></div>
</text>
<url value="http://v2.hl7.org/fhir/CodeSystem/dataExpectation"/>
<version value="0.1.0"/>
<name value="DataExpectation"/>
<title value="Data Expectation Codes"/>
<status value="active"/>
<experimental value="true"/>
<date value="2022-10-10"/>
<publisher value="FO"/>
<description
value="This is the codesystem describing exptectations for Data Handling.
It has to be discussed whether these codes can become more specialised activities!?"/>
<caseSensitive value="true"/>
<valueSet value="http://v2.hl7.org/fhir/ValueSet/dataExpectation"/>
<hierarchyMeaning value="is-a"/>
<content value="complete"/>
<count value="18"/>
<property>
<code value="parent"/>
<uri value="http://hl7.org/fhir/concept-properties#parent"/>
<type value="code"/>
</property>
<property>
<code value="actor"/>
<description value="associated actor, i.e. to whom it may apply"/>
<type value="code"/>
</property>
<concept>
<code value="expected"/>
<display value="expected"/>
<definition value="data fits to expectations/specification"/>
<concept>
<code value="unaltered"/>
<display value="preserve"/>
<definition value="preserve what you get"/>
<property>
<code value="parent"/>
<valueCode value="expected"/>
</property>
<concept>
<code value="exactly"/>
<display value="exactly"/>
<definition value="exactly what is specified, nothing else"/>
<property>
<code value="parent"/>
<valueCode value="unaltered"/>
</property>
</concept>
</concept>
<concept>
<code value="modify"/>
<display value="modify"/>
<definition value="allow for modifications of the data"/>
<property>
<code value="parent"/>
<valueCode value="expected"/>
</property>
<property>
<code value="actor"/>
<valueCode value="consumer"/>
</property>
<concept>
<code value="assocation"/>
<display value="assocation"/>
<definition value="taken by association"/>
<property>
<code value="parent"/>
<valueCode value="modify"/>
</property>
</concept>
<concept>
<code value="equivalent"/>
<display value="equivalent"/>
<definition value="in an equivalent way"/>
<property>
<code value="parent"/>
<valueCode value="modify"/>
</property>
</concept>
<concept>
<code value="translate"/>
<display value="translate"/>
<definition
value="Data received is preserved by 1:1 mapping/translation to an internal value that is semantically equivalent, that preserves the temporal aspect of the translation."/>
<property>
<code value="parent"/>
<valueCode value="modify"/>
</property>
<concept>
<code value="semantically"/>
<display value="translate semantically"/>
<definition
value="Two concepts are semantically equivalent if they can substitute for each other in the defined use case with no loss of information used to define the concept."/>
<property>
<code value="parent"/>
<valueCode value="translate"/>
</property>
</concept>
<concept>
<code value="clinically"/>
<display value="translate clinically"/>
<definition
value="Two concepts are clinically equivalent if they can substitute for each other in the defined use case with no impact on clinical interpretation by a trained clinician. This may include further refinements based on the specific domain, e.g., for Lab use case, this would require interpretation that includes the impact of differences in normal ranges."/>
<property>
<code value="parent"/>
<valueCode value="translate"/>
</property>
</concept>
</concept>
<concept>
<code value="reference"/>
<display value="reference"/>
<definition
value="Use referenced data based on stored pointer; stored data is displayed by linking to the corresponding stored value most often the case for data elements that are STORED EXACT by ASSOCIATION."/>
<property>
<code value="parent"/>
<valueCode value="modify"/>
</property>
</concept>
<concept>
<code value="truncate"/>
<display value="cut off data"/>
<definition
value="cut off remaining characters from the data thereby shortening the data"/>
<property>
<code value="parent"/>
<valueCode value="modify"/>
</property>
</concept>
<concept>
<code value="more-details"/>
<display value="additional details/values"/>
<definition
value="extends the expected data with more/own information, e.g. appartment if street is specified"/>
<property>
<code value="parent"/>
<valueCode value="modify"/>
</property>
<property>
<code value="actor"/>
<valueCode value="creator"/>
</property>
</concept>
<concept>
<code value="more-structure"/>
<display value="additional substructures"/>
<definition
value="provides the data with more granular details, e.g. house number for an address line"/>
<property>
<code value="parent"/>
<valueCode value="modify"/>
</property>
<property>
<code value="actor"/>
<valueCode value="creator"/>
</property>
</concept>
<concept>
<code value="missing"/>
<display value="data is missing/not available"/>
<definition value="provide a null-flavor/absent reason"/>
<property>
<code value="parent"/>
<valueCode value="modify"/>
</property>
<property>
<code value="actor"/>
<valueCode value="creator"/>
</property>
</concept>
<concept>
<code value="constant"/>
<display value="added as a constant"/>
<definition
value="this value has no valid representation or meaning in the sending application, it is just added because it is required to be there"/>
<property>
<code value="parent"/>
<valueCode value="modify"/>
</property>
</concept>
</concept>
</concept>
<concept>
<code value="unexpected"/>
<display value="unexpected values"/>
<definition
value="how to manage unexpected data (as sender or receiver)"/>
<concept>
<code value="replaces"/>
<display value="new/other values"/>
<definition value="replaces the expected data by something else"/>
<property>
<code value="parent"/>
<valueCode value="unexpected"/>
</property>
</concept>
<concept>
<code value="consider"/>
<display value="consider unexpected values"/>
<definition
value="take vare of values that are coming but not described/specified. Allows for warnings"/>
<property>
<code value="parent"/>
<valueCode value="unexpected"/>
</property>
</concept>
</concept>
</CodeSystem>