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

ValueSet: Proposed Content-consumption-oriented Obligation Codes VS (Experimental)

Official URL: http://v2.hl7.org/fhir/ValueSet/obligationContentConsumptionProposed Version: 0.1.0
Draft as of 2026-03-26 Computable Name: ObligationProposedContentConsumptionCodesVS

This valueset represents the proposed obligation codes for consuming 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)

Logical Definition (CLD)

  • Include these codes as defined in http://v2.hl7.org/fhir/CodeSystem/obligationProposed version 📦0.1.0
    CodeDisplayDefinition
    MAY:persistMAY store the dataConformant applications MAY store the data.
    MAY:modifyMAY modify the dataConformant applications MAY, i.e. are allowed to modify the data.
    MAY:printMAY print dataConformant applications MAY print the data.
    SHOULD:(persist)in-databaseSHOULD store the data in a databaseConformant applications are asked to store the data in a database.
    SHOULD:processSHOULD process the dataConformant applications SHOULD process the data in some meaningful way.
    SHOULD:displaySHOULD display the dataConformant applications SHOULD display the data in some meaningful way.
    SHOULD:documentSHOULD document how the data is usedConformant applications SHOULD document the way the data is used in some (meaningful) way.
    SHOULD:printSHOULD print dataConformant applications SHOULD print the data.
    SHALL:documentSHALL document how the data is usedConformant applications SHALL document the way the data is used in some (meaningful) way.
    SHALL:printSHALL print dataConformant applications SHALL print the data.
    SHALL:persistSHALL store the data somewhereConformant applications SHALL store the data in some way.
    SHALL:persist:exactlySHALL store the data somewhere, but exactly as is sentConformant applications SHALL store the data in a way that the originally data from the instance can be reestablished.
    MAYNOT:processMAY NOT process dataConformant applications MAY NOT process data, aka of ignoring.
    SHOULDNOT:processSHOULD NOT process the dataConformant applications SHOULD NOT process the data in some meaningful way.
    SHOULDNOT:modifySHOULD NOT modify the dataConformant applications SHOULD NOT modiify the data in any way.
    SHALLNOT:processSHALL NOT process the dataConformant applications SHALL NOT process the data in some meaningful way.
    SHALLNOT:modifySHALL NOT modify the dataConformant applications SHALL NOT modiify the data in any way.
    SHALLNOT:follow-up:truncateSHALL NOT truncate dataConformant applications SHALL NOT cut off data.

 

Expansion

Expansion performed internally based on codesystem Proposed Obligation Codes v0.1.0 (CodeSystem)

This value set contains 18 concepts

SystemCodeDisplay (en)DefinitionJSONXML
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  MAY:persistMAY store the dataConformant applications MAY store the data.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  MAY:modifyMAY modify the dataConformant applications MAY, i.e. are allowed to modify the data.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  MAY:printMAY print dataConformant applications MAY print the data.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHOULD:(persist)in-databaseSHOULD store the data in a databaseConformant applications are asked to store the data in a database.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHOULD:processSHOULD process the dataConformant applications SHOULD process the data in some meaningful way.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHOULD:displaySHOULD display the dataConformant applications SHOULD display the data in some meaningful way.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHOULD:documentSHOULD document how the data is usedConformant applications SHOULD document the way the data is used in some (meaningful) way.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHOULD:printSHOULD print dataConformant applications SHOULD print the data.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHALL:documentSHALL document how the data is usedConformant applications SHALL document the way the data is used in some (meaningful) way.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHALL:printSHALL print dataConformant applications SHALL print the data.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHALL:persistSHALL store the data somewhereConformant applications SHALL store the data in some way.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHALL:persist:exactlySHALL store the data somewhere, but exactly as is sentConformant 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  MAYNOT:processMAY NOT process dataConformant applications MAY NOT process data, aka of ignoring.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHOULDNOT:processSHOULD NOT process the dataConformant applications SHOULD NOT process the data in some meaningful way.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHOULDNOT:modifySHOULD NOT modify the dataConformant applications SHOULD NOT modiify the data in any way.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHALLNOT:processSHALL NOT process the dataConformant applications SHALL NOT process the data in some meaningful way.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHALLNOT:modifySHALL NOT modify the dataConformant applications SHALL NOT modiify the data in any way.
http://v2.hl7.org/fhir/CodeSystem/obligationProposed  SHALLNOT:follow-up:truncateSHALL NOT truncate dataConformant applications SHALL NOT cut off data.

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