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
| Official URL: http://v2.hl7.org/fhir/ValueSet/obligationProposedActive | Version: 0.1.0 | |||
| Draft as of 2024-05-08 | Computable Name: ObligationProposedActiveCodesVS | |||
This valueset represents the proposed obligation codes that are available for use (active resp. not abstract).
References
This value set is not used here; it may be used elsewhere (e.g. specifications and/or implementations that use this content)
http://v2.hl7.org/fhir/CodeSystem/obligationProposed where concept descends from CombinedObligations
Expansion based on codesystem Proposed Obligation Codes v0.1.0 (CodeSystem)
This value set contains 69 concepts.
| Code | System | Display | Definition |
| MAY:populate | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY populate with data | Conformant applications MAY take and provide data. |
| MAY:populate:missing | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY populate data element with why orig data is missing | Conformant applications MAY populate the element why the original data is missing. |
| v3-r | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v3: R | required in IHE V3 |
| SHOULD:populate | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD populate with data | Conformant applications SHOULD take and provide data. |
| MAY:(populate)into-narrative | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY populate into-narrative | Conformant applications MAY populate element into narrative text as well. |
| SHOULD:(populate)into-narrative | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD populate into-narrative | Conformant applications SHOULD populate element into narrative text as well. |
| SHALL:(populate)into-narrative | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL populate into-narrative | Conformant applications SHALL populate element into narrative text as well. |
| SHALL:populate | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL populate with data | Conformant applications SHOULD take and provide data. |
| xDT-M | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | xDT: M | MUSS in xDT (unbedingtes Mussfeld) |
| xDT-m | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | xDT: m | muss in xDT (bedingtes Mussfeld) |
| xDT-K | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | xDT: K | KANN in xDT (unbedingts KANNfeld) |
| xDT-k | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | xDT: k | kann in xDT (bedingtes Kannfeld) |
| ihe-r2 | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | IHE: R2 | R2 in IHE v2.x specs |
| MAY:(populate)from-ui | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY populate with data taken from ui | Conformant applications MAY take data from a UI and provide it. |
| SHOULDNOT:(populate)into-narrative | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD NOT populate into-narrative | Conformant applications SHOULD NOT populate element into narrative text. |
| SHALLNOT:(populate)into-narrative | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL NOT populate into-narrative | Conformant applications SHALL NOT populate element into narrative text. |
| SHOULD:(populate)from-ui | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD populate with data taken from ui | Conformant applications SHOULD take data from a UI and provide it. |
| SHALL:(populate)from-ui | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL populate data taken from ui | Conformant applications SHALL take data from a UI and provide it. |
| SHALL:(populate)from-ui:more-details | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL populate with data taken from ui perhaps with more details | Conformant applications SHALL take data from a UI and bring it into the instance. It is allowed to provide more details then specified. |
| SHOULD:send | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD send the instance | Conformant applications SHOULD send the instance. |
| SHALL:send | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL send the instance | Conformant applications SHALL send the instance. |
| MAY:persist | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY store the data | Conformant applications MAY store the data. |
| SHOULD:persist | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD store the data | Conformant applications SHOULD store the data. |
| SHALL:persist | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL store the data somewhere | Conformant applications SHALL store the data in some way. |
| SHALL:persist:exactly | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL store the data somewhere, but exactly as is sent | Conformant applications SHALL store the data in a way that the originally data from the instance can be reestablished. |
| SHOULD:(persist)in-database | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD store the data in a database | Conformant applications are asked to store the data in a database. |
| SHALLNOT:populate:more-details | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL NOT populate more data than is specified | Conformant applications SHALL NOT populatae more data than is specified. The specification is closed. |
| SHALLNOT:populate:missing | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL NOT populate info about missing data, ie. data absent reasons | Conformant applications SHALL NOT populate a reason for missing information. |
| v3-m | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v3: M | mandatory in IHE V3 |
| MAY:populate:more-structure | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY populate the data in more structured way | Conformant applications are allowed to populate the data with more structure. For example, to split an address line into streetname and house number. |
| SHALLNOT:follow-up:truncate | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL NOT truncate data | Conformant applications SHALL NOT cut off data. |
| MAY:modify | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY modify the data | Conformant applications MAY, i.e. are allowed to modify the data. |
| MAY:print | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY print data | Conformant applications MAY print the data. |
| SHOULD:print | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD print data | Conformant applications SHOULD print the data. |
| SHALL:print | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL print data | Conformant applications SHALL print the data. |
| SHALLNOT:(populate):in-narrative | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL NOT add to narrative | Conformant applications SHALL NOT add this data to the narrative. |
| MAY:process | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY process the data | Conformant applications MAY process the data somehow. |
| SHOULD:process | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD process the data | Conformant applications SHOULD process the data in some meaningful way. |
| SHALL:process | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL process the data | Conformant applications SHALL process the data in some meaningful way. |
| SHOULDNOT:process | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD NOT process the data | Conformant applications SHOULD NOT process the data in some meaningful way. |
| SHALLNOT:process | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL NOT process the data | Conformant applications SHALL NOT process the data in some meaningful way. |
| SHOULD:document | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD document how the data is used | Conformant applications SHOULD document the way the data is used in some (meaningful) way. |
| SHALL:document | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL document how the data is used | Conformant applications SHALL document the way the data is used in some (meaningful) way. |
| SHOULD:display | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD display the data | Conformant applications SHOULD display the data in some meaningful way. |
| SHALL:display | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL display the data | Conformant applications SHALL display the data in some meaningful way. |
| SHOULDNOT:modify | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD NOT modify the data | Conformant applications SHOULD NOT modiify the data in any way. |
| SHALLNOT:modify | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL NOT modify the data | Conformant applications SHALL NOT modiify the data in any way. |
| MAYNOT:process | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY NOT process data | Conformant applications MAY NOT process data, aka of ignoring. |
| SHOULD:reject-invalid | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD reject invalid data | Conformant applications SHOULD reject invalid data. |
| SHALL:reject-invalid | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL reject invalid data | Conformant applications SHALL reject invalid data. |
| SHOULD:accept-invalid | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD accept invalid data | Conformant applications SHOULD accept invalid data. |
| SHALL:accept-invalid | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL accept invalid data | Conformant applications SHALL accept invalid data. |
| SHOULD:receive | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD be able to receive the data | Conformant applications SHOULD be able to receive the data. |
| SHALL:receive | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL be able to receive the data | Conformant applications SHALL be able to receive the data. |
| SHOULDNOT:error | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD NOT return an error to the sender of the data | Conformant applications SHOULD NOT reurn an erorr to the sender of the data. |
| SHALLNOT:error | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL NOT return an error to the sender of the data | Conformant applications SHALL NOT reurn an erorr to the sender of the data. |
| ForeignStandards | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | concept codes from other standards | Other standards use specific terms for optionality/usage that should be conceptualized here. |
| v2 | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2 concept codes | optionality/usage codes from v2 |
| v2-r | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2: R | required in v2.x |
| v2-re | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2: RE | required but may be empty in v2.x |
| v2-x | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2: X | forbidden in v2 |
| v2-b | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2: B | backwards use in v2 only |
| v2-w | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2: W | withdrawn use in v2 only |
| v3 | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | V3 concept codes | optionality/usage codes from V3/CDA |
| v3-x | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v3: X | forbidden in IHE V3 |
| ihe | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | IHE concept codes | optionality/usage codes from IHE |
| ihe-r | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | IHE: R | required in IHE v2.x specs |
| ihe-x | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | IHE: X | XX in IHE v2.x specs |
| xDT | http://v2.hl7.org/fhir/CodeSystem/obligationProposed | German xDT standards | The German xDT standard family has a very specific set of codes and is just presented here for completeness and demonstration purposes |
Explanation of the columns that may appear on this page:
| Level | A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies |
| System | The source of the definition of the code (when the value set draws in codes defined elsewhere) |
| Code | The code (used as the code in the resource instance) |
| Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application |
| Definition | An explanation of the meaning of the concept |
| Comments | Additional notes about how to use the code |