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 2024-05-08 |
{
"resourceType" : "CodeSystem",
"id" : "obligationAlone",
"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>what type of actor</td></tr><tr><td>comment</td><td>http://hl7.org/fhir/concept-properties#comment</td><td>string</td><td>comments/remarks</td></tr></table><p><b>Concepts</b></p><p>This case-sensitive code system <code>http://v2.hl7.org/fhir/CodeSystem/obligationAlone</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><td><b>Comment</b></td></tr><tr><td>1</td><td style=\"white-space:nowrap\">send<a name=\"obligationAlone-send\"> </a></td><td>send</td><td>populate with values from somewhere</td><td/><td>creator</td><td>prohibited elements can be expressed by 'SHALL NOT send'.</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0from-ui<a name=\"obligationAlone-from-ui\"> </a></td><td>from UI</td><td>Take the data from UI, so that the user has the ability to enter it.</td><td><a href=\"#obligationAlone-send\">send</a></td><td/><td/></tr><tr><td>3</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0from-textfield<a name=\"obligationAlone-from-textfield\"> </a></td><td>from textfield in UI</td><td>Take the data from a test input field</td><td><a href=\"#obligationAlone-from-ui\">from-ui</a></td><td/><td>too explicit/dedicated, concerns application details</td></tr><tr><td>3</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0from-widget<a name=\"obligationAlone-from-widget\"> </a></td><td>from widget in UI</td><td>Take the data from a specific widget</td><td><a href=\"#obligationAlone-from-ui\">from-ui</a></td><td/><td>too explicit/dedicated, concerns application details</td></tr><tr><td>3</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0from-combobox<a name=\"obligationAlone-from-combobox\"> </a></td><td>from combobox in UI</td><td>Take the data from a combobox</td><td><a href=\"#obligationAlone-from-ui\">from-ui</a></td><td/><td>too explicit/dedicated, concerns application details</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0from-store<a name=\"obligationAlone-from-store\"> </a></td><td>from persistence layer</td><td>Take data from storage/persistence layer.</td><td><a href=\"#obligationAlone-send\">send</a></td><td/><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0from-input<a name=\"obligationAlone-from-input\"> </a></td><td>from input stream</td><td>As a router, take data from input stream.</td><td><a href=\"#obligationAlone-send\">send</a></td><td>router</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0as-constant<a name=\"obligationAlone-as-constant\"> </a></td><td>constant</td><td>added as constant to the data, no special treatment done internally</td><td><a href=\"#obligationAlone-send\">send</a></td><td/><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">process<a name=\"obligationAlone-process\"> </a></td><td>process/receive</td><td>Data received is processed as needed for general message consumption, store permitted.</td><td/><td>consumer</td><td>elements that are to be ignored can be expressed by 'SHALL NOT process'.</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0follow-up<a name=\"obligationAlone-follow-up\"> </a></td><td>follow-up activity</td><td>what to do internally</td><td/><td/><td/></tr><tr><td>3</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0display<a name=\"obligationAlone-display\"> </a></td><td>display/present (UI)</td><td>present the data on a display</td><td><a href=\"#obligationAlone-follow-up\">follow-up</a></td><td/><td/></tr><tr><td>3</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0store<a name=\"obligationAlone-store\"> </a></td><td>store</td><td>store/persist the data somewhere</td><td><a href=\"#obligationAlone-follow-up\">follow-up</a></td><td>router</td><td/></tr><tr><td>4</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0archive<a name=\"obligationAlone-archive\"> </a></td><td>archive</td><td>store/persist the archive which ensures longlasting access</td><td/><td/><td/></tr><tr><td>4</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0in-database<a name=\"obligationAlone-in-database\"> </a></td><td>store in a database</td><td>store in a database</td><td/><td/><td>too explicit/dedicated, concerns application details</td></tr><tr><td>4</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0in-file<a name=\"obligationAlone-in-file\"> </a></td><td>store in a file</td><td>store in a file</td><td/><td/><td>too explicit/dedicated, concerns application details</td></tr><tr><td>3</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0print<a name=\"obligationAlone-print\"> </a></td><td>print</td><td>print the data (somewhere)</td><td><a href=\"#obligationAlone-follow-up\">follow-up</a></td><td/><td/></tr><tr><td>3</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0eval<a name=\"obligationAlone-eval\"> </a></td><td>evaluate</td><td>consider the data in order to interpret other correctly</td><td><a href=\"#obligationAlone-follow-up\">follow-up</a></td><td/><td/></tr><tr><td>3</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0integrate<a name=\"obligationAlone-integrate\"> </a></td><td>integrate into data</td><td>to UPDATE existing data by merging other data with the existing data in a controlled manner</td><td><a href=\"#obligationAlone-follow-up\">follow-up</a></td><td/><td/></tr><tr><td>3</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0forward<a name=\"obligationAlone-forward\"> </a></td><td>forward</td><td>as a router forward to the next recipient</td><td><a href=\"#obligationAlone-follow-up\">follow-up</a></td><td>router</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0respond<a name=\"obligationAlone-respond\"> </a></td><td>activity as response</td><td>what to respond</td><td/><td/><td/></tr><tr><td>3</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0warning<a name=\"obligationAlone-warning\"> </a></td><td>return warnings</td><td>return possible warnings</td><td><a href=\"#obligationAlone-respond\">respond</a></td><td/><td/></tr><tr><td>4</td><td style=\"white-space:nowrap\">\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0error<a name=\"obligationAlone-error\"> </a></td><td>return error</td><td>return possible errors</td><td><a href=\"#obligationAlone-warning\">warning</a></td><td/><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">other<a name=\"obligationAlone-other\"> </a></td><td>other obligations</td><td>other obligations beyond</td><td/><td/><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0explain<a name=\"obligationAlone-explain\"> </a></td><td>explain</td><td>provide an explanation in a capability statement how this element is handled</td><td><a href=\"#obligationAlone-other\">other</a></td><td/><td/></tr></table></div>"
},
"url" : "http://v2.hl7.org/fhir/CodeSystem/obligationAlone",
"version" : "0.1.0",
"name" : "ObligationAloneCodes",
"title" : "Obligation Alone Codes",
"status" : "active",
"experimental" : true,
"date" : "2024-05-08T17:58:37+02:00",
"description" : "This is the Obligation CodeSystem (alone) as part of the triplet.",
"caseSensitive" : true,
"valueSet" : "http://v2.hl7.org/fhir/ValueSet/obligationAlone",
"hierarchyMeaning" : "is-a",
"content" : "complete",
"count" : 24,
"property" : [
{
"code" : "parent",
"uri" : "http://hl7.org/fhir/concept-properties#parent",
"type" : "code"
},
{
"code" : "actor",
"description" : "what type of actor",
"type" : "code"
},
{
"code" : "comment",
"uri" : "http://hl7.org/fhir/concept-properties#comment",
"description" : "comments/remarks",
"type" : "string"
}
],
"concept" : [
{
"code" : "send",
"display" : "send",
"definition" : "populate with values from somewhere",
"property" : [
{
"code" : "actor",
"valueCode" : "creator"
},
{
"code" : "comment",
"valueString" : "prohibited elements can be expressed by 'SHALL NOT send'."
}
],
"concept" : [
{
"code" : "from-ui",
"display" : "from UI",
"definition" : "Take the data from UI, so that the user has the ability to enter it.",
"property" : [
{
"code" : "parent",
"valueCode" : "send"
}
],
"concept" : [
{
"code" : "from-textfield",
"display" : "from textfield in UI",
"definition" : "Take the data from a test input field",
"property" : [
{
"code" : "parent",
"valueCode" : "from-ui"
},
{
"code" : "comment",
"valueString" : "too explicit/dedicated, concerns application details"
}
]
},
{
"code" : "from-widget",
"display" : "from widget in UI",
"definition" : "Take the data from a specific widget",
"property" : [
{
"code" : "parent",
"valueCode" : "from-ui"
},
{
"code" : "comment",
"valueString" : "too explicit/dedicated, concerns application details"
}
]
},
{
"code" : "from-combobox",
"display" : "from combobox in UI",
"definition" : "Take the data from a combobox",
"property" : [
{
"code" : "parent",
"valueCode" : "from-ui"
},
{
"code" : "comment",
"valueString" : "too explicit/dedicated, concerns application details"
}
]
}
]
},
{
"code" : "from-store",
"display" : "from persistence layer",
"definition" : "Take data from storage/persistence layer.",
"property" : [
{
"code" : "parent",
"valueCode" : "send"
}
]
},
{
"code" : "from-input",
"display" : "from input stream",
"definition" : "As a router, take data from input stream.",
"property" : [
{
"code" : "parent",
"valueCode" : "send"
},
{
"code" : "actor",
"valueCode" : "router"
}
]
},
{
"code" : "as-constant",
"display" : "constant",
"definition" : "added as constant to the data, no special treatment done internally",
"property" : [
{
"code" : "parent",
"valueCode" : "send"
}
]
}
]
},
{
"code" : "process",
"display" : "process/receive",
"definition" : "Data received is processed as needed for general message consumption, store permitted.",
"property" : [
{
"code" : "actor",
"valueCode" : "consumer"
},
{
"code" : "comment",
"valueString" : "elements that are to be ignored can be expressed by 'SHALL NOT process'."
}
],
"concept" : [
{
"code" : "follow-up",
"display" : "follow-up activity",
"definition" : "what to do internally",
"concept" : [
{
"code" : "display",
"display" : "display/present (UI)",
"definition" : "present the data on a display",
"property" : [
{
"code" : "parent",
"valueCode" : "follow-up"
}
]
},
{
"code" : "store",
"display" : "store",
"definition" : "store/persist the data somewhere",
"property" : [
{
"code" : "actor",
"valueCode" : "router"
},
{
"code" : "parent",
"valueCode" : "follow-up"
}
],
"concept" : [
{
"code" : "archive",
"display" : "archive",
"definition" : "store/persist the archive which ensures longlasting access"
},
{
"code" : "in-database",
"display" : "store in a database",
"definition" : "store in a database",
"property" : [
{
"code" : "comment",
"valueString" : "too explicit/dedicated, concerns application details"
}
]
},
{
"code" : "in-file",
"display" : "store in a file",
"definition" : "store in a file",
"property" : [
{
"code" : "comment",
"valueString" : "too explicit/dedicated, concerns application details"
}
]
}
]
},
{
"code" : "print",
"display" : "print",
"definition" : "print the data (somewhere)",
"property" : [
{
"code" : "parent",
"valueCode" : "follow-up"
}
]
},
{
"code" : "eval",
"display" : "evaluate",
"definition" : "consider the data in order to interpret other correctly",
"property" : [
{
"code" : "parent",
"valueCode" : "follow-up"
}
]
},
{
"code" : "integrate",
"display" : "integrate into data",
"definition" : "to UPDATE existing data by merging other data with the existing data in a controlled manner",
"property" : [
{
"code" : "parent",
"valueCode" : "follow-up"
}
]
},
{
"code" : "forward",
"display" : "forward",
"definition" : "as a router forward to the next recipient",
"property" : [
{
"code" : "parent",
"valueCode" : "follow-up"
},
{
"code" : "actor",
"valueCode" : "router"
}
]
}
]
},
{
"code" : "respond",
"display" : "activity as response",
"definition" : "what to respond",
"concept" : [
{
"code" : "warning",
"display" : "return warnings",
"definition" : "return possible warnings",
"property" : [
{
"code" : "parent",
"valueCode" : "respond"
}
],
"concept" : [
{
"code" : "error",
"display" : "return error",
"definition" : "return possible errors",
"property" : [
{
"code" : "parent",
"valueCode" : "warning"
}
]
}
]
}
]
}
]
},
{
"code" : "other",
"display" : "other obligations",
"definition" : "other obligations beyond",
"concept" : [
{
"code" : "explain",
"display" : "explain",
"definition" : "provide an explanation in a capability statement how this element is handled",
"property" : [
{
"code" : "parent",
"valueCode" : "other"
}
]
}
]
}
]
}