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/obligationContentCreationProposed | Version: 0.1.0 | |||
| Draft as of 2026-03-26 | Computable Name: ObligationProposedContentCreationCodesVS | |||
This valueset represents the proposed obligation codes for creating the content.
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| Code | Display | Definition |
| MAY:populate | MAY populate with data | Conformant applications MAY take and provide data. |
| 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. |
| 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. |
| MAY:(populate)from-ui | MAY populate with data taken from ui | Conformant applications MAY take data from a UI and provide it. |
| MAY:(populate)into-narrative | MAY populate into-narrative | Conformant applications MAY populate element into narrative text as well. |
| SHOULD:populate | SHOULD populate with data | Conformant applications SHOULD take and provide data. |
| SHOULD:(populate)from-ui | SHOULD populate with data taken from ui | Conformant applications SHOULD take data from a UI and provide it. |
| SHALL:populate | SHALL populate with data | Conformant applications SHOULD take and provide data. |
| SHALL:(populate)from-ui | SHALL populate data taken from ui | Conformant applications SHALL take data from a UI and provide it. |
| 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. |
| SHALL:(populate)into-narrative | SHALL populate into-narrative | Conformant applications SHALL populate element into narrative text as well. |
| SHOULD:(populate)into-narrative | SHOULD populate into-narrative | Conformant applications SHOULD populate element into narrative text as well. |
| SHOULDNOT:(populate)into-narrative | SHOULD NOT populate into-narrative | Conformant applications SHOULD NOT populate element into narrative text. |
| SHALLNOT:(populate):in-narrative | SHALL NOT add to narrative | Conformant applications SHALL NOT add this data to the narrative. |
| 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. |
| SHALLNOT:populate:missing | SHALL NOT populate info about missing data, ie. data absent reasons | Conformant applications SHALL NOT populate a reason for missing information. |
| SHALLNOT:(populate)into-narrative | SHALL NOT populate into-narrative | Conformant applications SHALL NOT populate element into narrative text. |
Expansion performed internally based on codesystem Proposed Obligation Codes v0.1.0 (CodeSystem)
This value set contains 17 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 | 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 | 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 | 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 | SHOULD populate with data | Conformant applications SHOULD take and provide data. | ||
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 | SHALL populate with data | Conformant applications SHOULD take and provide data. | ||
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 | 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 | 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 | 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):in-narrative | SHALL NOT add to narrative | Conformant applications SHALL NOT add this data to the narrative. | ||
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 | SHALLNOT:(populate)into-narrative | SHALL NOT populate into-narrative | Conformant applications SHALL NOT populate element into narrative text. |
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 |