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