Obligation Discussion
0.5.1 - Working Draft to present the Concept Ideas and Background Details (FO)
Obligation Discussion
0.5.1 - Working Draft to present the Concept Ideas and Background Details (FO)
Obligation Discussion, published by . This guide is not an authorized publication; it is the continuous build for version 0.5.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/frankoemig/obligation/ and changes regularly. See the Directory of published versions
| Official URL: http://v2.hl7.org/fhir/ValueSet/obligationProposedActive | Version: 0.1.0 | |||
| Draft as of 2026-03-26 | 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 version 📦0.1.0 where concept descends from CombinedObligations
Expansion performed internally based on codesystem Proposed Obligation Codes v0.1.0 (CodeSystem)
This value set contains 69 concepts
| System | Code | Display (en) | Definition | JSON | XML |
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY:populate | MAY populate with data | Conformant applications MAY take and provide data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY:populate:missing | MAY populate data element with why orig data is missing | Conformant applications MAY populate the element why the original data is missing. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v3-r | v3: R | required in HL7 V3 | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:populate | SHOULD populate with data | Conformant applications SHOULD take and provide data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY:(populate)into-narrative | MAY populate into-narrative | Conformant applications MAY populate element into narrative text as well. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:(populate)into-narrative | SHOULD populate into-narrative | Conformant applications SHOULD populate element into narrative text as well. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:(populate)into-narrative | SHALL populate into-narrative | Conformant applications SHALL populate element into narrative text as well. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:populate | SHALL populate with data | Conformant applications SHOULD take and provide data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | xDT-M | xDT: M | MUSS in xDT (unbedingtes Mussfeld) | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | xDT-m | xDT: m | muss in xDT (bedingtes Mussfeld) | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | xDT-K | xDT: K | KANN in xDT (unbedingts KANNfeld) | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | xDT-k | xDT: k | kann in xDT (bedingtes Kannfeld) | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | ihe-r2 | IHE: R2 | R2 in IHE v2.x specs | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY:(populate)from-ui | MAY populate with data taken from ui | Conformant applications MAY take data from a UI and provide it. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULDNOT:(populate)into-narrative | SHOULD NOT populate into-narrative | Conformant applications SHOULD NOT populate element into narrative text. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALLNOT:(populate)into-narrative | SHALL NOT populate into-narrative | Conformant applications SHALL NOT populate element into narrative text. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:(populate)from-ui | SHOULD populate with data taken from ui | Conformant applications SHOULD take data from a UI and provide it. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:(populate)from-ui | SHALL populate data taken from ui | Conformant applications SHALL take data from a UI and provide it. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:(populate)from-ui:more-details | 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. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:send | SHOULD send the instance | Conformant applications SHOULD send the instance. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:send | SHALL send the instance | Conformant applications SHALL send the instance. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY:persist | MAY store the data | Conformant applications MAY store the data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:persist | SHOULD store the data | Conformant applications SHOULD store the data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:persist | SHALL store the data somewhere | Conformant applications SHALL store the data in some way. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:persist:exactly | 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. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:(persist)in-database | SHOULD store the data in a database | Conformant applications are asked to store the data in a database. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALLNOT:populate:more-details | SHALL NOT populate more data than is specified | Conformant applications SHALL NOT populatae more data than is specified. The specification is closed. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALLNOT:populate:missing | SHALL NOT populate info about missing data, ie. data absent reasons | Conformant applications SHALL NOT populate a reason for missing information. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v3-m | v3: M | mandatory in HL7 V3 | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY:populate:more-structure | 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. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALLNOT:follow-up:truncate | SHALL NOT truncate data | Conformant applications SHALL NOT cut off data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY:modify | MAY modify the data | Conformant applications MAY, i.e. are allowed to modify the data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY:print | MAY print data | Conformant applications MAY print the data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:print | SHOULD print data | Conformant applications SHOULD print the data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:print | SHALL print data | Conformant applications SHALL print the data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALLNOT:(populate):in-narrative | SHALL NOT add to narrative | Conformant applications SHALL NOT add this data to the narrative. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAY:process | MAY process the data | Conformant applications MAY process the data somehow. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:process | SHOULD process the data | Conformant applications SHOULD process the data in some meaningful way. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:process | SHALL process the data | Conformant applications SHALL process the data in some meaningful way. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULDNOT:process | SHOULD NOT process the data | Conformant applications SHOULD NOT process the data in some meaningful way. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALLNOT:process | SHALL NOT process the data | Conformant applications SHALL NOT process the data in some meaningful way. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:document | SHOULD document how the data is used | Conformant applications SHOULD document the way the data is used in some (meaningful) way. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:document | SHALL document how the data is used | Conformant applications SHALL document the way the data is used in some (meaningful) way. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:display | SHOULD display the data | Conformant applications SHOULD display the data in some meaningful way. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:display | SHALL display the data | Conformant applications SHALL display the data in some meaningful way. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULDNOT:modify | SHOULD NOT modify the data | Conformant applications SHOULD NOT modiify the data in any way. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALLNOT:modify | SHALL NOT modify the data | Conformant applications SHALL NOT modiify the data in any way. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | MAYNOT:process | MAY NOT process data | Conformant applications MAY NOT process data, aka of ignoring. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:reject-invalid | SHOULD reject invalid data | Conformant applications SHOULD reject invalid data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:reject-invalid | SHALL reject invalid data | Conformant applications SHALL reject invalid data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:accept-invalid | SHOULD accept invalid data | Conformant applications SHOULD accept invalid data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:accept-invalid | SHALL accept invalid data | Conformant applications SHALL accept invalid data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULD:receive | SHOULD be able to receive the data | Conformant applications SHOULD be able to receive the data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALL:receive | SHALL be able to receive the data | Conformant applications SHALL be able to receive the data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHOULDNOT:error | SHOULD NOT return an error to the sender of the data | Conformant applications SHOULD NOT reurn an erorr to the sender of the data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | SHALLNOT:error | SHALL NOT return an error to the sender of the data | Conformant applications SHALL NOT reurn an erorr to the sender of the data. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | ForeignStandards | concept codes from other standards | Other standards use specific terms for optionality/usage that should be conceptualized here. | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2 | v2 concept codes | optionality/usage codes from v2 | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2-r | v2: R | required in v2.x | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2-re | v2: RE | required but may be empty in v2.x | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2-x | v2: X | forbidden in v2 | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2-b | v2: B | backwards use in v2 only | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v2-w | v2: W | withdrawn use in v2 only | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v3 | V3 concept codes | optionality/usage codes from V3/CDA | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | v3-x | v3: X | forbidden in HL7 V3 | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | ihe | IHE concept codes | optionality/usage codes from IHE | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | ihe-r | IHE: R | required in IHE v2.x specs | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | ihe-x | IHE: X | X in IHE v2.x specs | ||
http://v2.hl7.org/fhir/CodeSystem/obligationProposed | xDT | 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 |