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 |
{
"resourceType" : "CodeSystem",
"id" : "dataExpectation",
"text" : {
"status" : "generated",
"div" : "<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\">\u00a0\u00a0unaltered<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\">\u00a0\u00a0\u00a0\u00a0exactly<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\">\u00a0\u00a0modify<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\">\u00a0\u00a0\u00a0\u00a0assocation<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\">\u00a0\u00a0\u00a0\u00a0equivalent<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\">\u00a0\u00a0\u00a0\u00a0translate<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\">\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0semantically<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\">\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0clinically<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\">\u00a0\u00a0\u00a0\u00a0reference<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\">\u00a0\u00a0\u00a0\u00a0truncate<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\">\u00a0\u00a0\u00a0\u00a0more-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\">\u00a0\u00a0\u00a0\u00a0more-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\">\u00a0\u00a0\u00a0\u00a0missing<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\">\u00a0\u00a0\u00a0\u00a0constant<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\">\u00a0\u00a0replaces<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\">\u00a0\u00a0consider<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>"
},
"url" : "http://v2.hl7.org/fhir/CodeSystem/dataExpectation",
"version" : "0.1.0",
"name" : "DataExpectation",
"title" : "Data Expectation Codes",
"status" : "active",
"experimental" : true,
"date" : "2022-10-10",
"publisher" : "FO",
"description" : "This is the codesystem describing exptectations for Data Handling.\nIt has to be discussed whether these codes can become more specialised activities!?",
"caseSensitive" : true,
"valueSet" : "http://v2.hl7.org/fhir/ValueSet/dataExpectation",
"hierarchyMeaning" : "is-a",
"content" : "complete",
"count" : 18,
"property" : [
{
"code" : "parent",
"uri" : "http://hl7.org/fhir/concept-properties#parent",
"type" : "code"
},
{
"code" : "actor",
"description" : "associated actor, i.e. to whom it may apply",
"type" : "code"
}
],
"concept" : [
{
"code" : "expected",
"display" : "expected",
"definition" : "data fits to expectations/specification",
"concept" : [
{
"code" : "unaltered",
"display" : "preserve",
"definition" : "preserve what you get",
"property" : [
{
"code" : "parent",
"valueCode" : "expected"
}
],
"concept" : [
{
"code" : "exactly",
"display" : "exactly",
"definition" : "exactly what is specified, nothing else",
"property" : [
{
"code" : "parent",
"valueCode" : "unaltered"
}
]
}
]
},
{
"code" : "modify",
"display" : "modify",
"definition" : "allow for modifications of the data",
"property" : [
{
"code" : "parent",
"valueCode" : "expected"
},
{
"code" : "actor",
"valueCode" : "consumer"
}
],
"concept" : [
{
"code" : "assocation",
"display" : "assocation",
"definition" : "taken by association",
"property" : [
{
"code" : "parent",
"valueCode" : "modify"
}
]
},
{
"code" : "equivalent",
"display" : "equivalent",
"definition" : "in an equivalent way",
"property" : [
{
"code" : "parent",
"valueCode" : "modify"
}
]
},
{
"code" : "translate",
"display" : "translate",
"definition" : "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" : "parent",
"valueCode" : "modify"
}
],
"concept" : [
{
"code" : "semantically",
"display" : "translate semantically",
"definition" : "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" : "parent",
"valueCode" : "translate"
}
]
},
{
"code" : "clinically",
"display" : "translate clinically",
"definition" : "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" : "parent",
"valueCode" : "translate"
}
]
}
]
},
{
"code" : "reference",
"display" : "reference",
"definition" : "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" : "parent",
"valueCode" : "modify"
}
]
},
{
"code" : "truncate",
"display" : "cut off data",
"definition" : "cut off remaining characters from the data thereby shortening the data",
"property" : [
{
"code" : "parent",
"valueCode" : "modify"
}
]
},
{
"code" : "more-details",
"display" : "additional details/values",
"definition" : "extends the expected data with more/own information, e.g. appartment if street is specified",
"property" : [
{
"code" : "parent",
"valueCode" : "modify"
},
{
"code" : "actor",
"valueCode" : "creator"
}
]
},
{
"code" : "more-structure",
"display" : "additional substructures",
"definition" : "provides the data with more granular details, e.g. house number for an address line",
"property" : [
{
"code" : "parent",
"valueCode" : "modify"
},
{
"code" : "actor",
"valueCode" : "creator"
}
]
},
{
"code" : "missing",
"display" : "data is missing/not available",
"definition" : "provide a null-flavor/absent reason",
"property" : [
{
"code" : "parent",
"valueCode" : "modify"
},
{
"code" : "actor",
"valueCode" : "creator"
}
]
},
{
"code" : "constant",
"display" : "added as a constant",
"definition" : "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" : "parent",
"valueCode" : "modify"
}
]
}
]
}
]
},
{
"code" : "unexpected",
"display" : "unexpected values",
"definition" : "how to manage unexpected data (as sender or receiver)",
"concept" : [
{
"code" : "replaces",
"display" : "new/other values",
"definition" : "replaces the expected data by something else",
"property" : [
{
"code" : "parent",
"valueCode" : "unexpected"
}
]
},
{
"code" : "consider",
"display" : "consider unexpected values",
"definition" : "take vare of values that are coming but not described/specified. Allows for warnings",
"property" : [
{
"code" : "parent",
"valueCode" : "unexpected"
}
]
}
]
}
]
}