http://hl7.org/fhir/CodeSystem/obligation|5.2.0

name
ObligationCodes
package
hl7.fhir.uv.extensions.r5@5.2.0
content
complete
status
active
date
2025-02-10 10:45:45.0

Obligation Codes

Codes that describe application obligations for handling FHIR content. There are five kinds of codes in this code system:\n * Categorizer codes: ResourceProducerObligations, ResourcesExchangerObligations, and ResourceConsumerObligations which are used to construct value sets and indicate the contexts in which the obligations apply. Note that many applications will be producers, consumers, and potentially exchangers simultaneously, so there is no need to limit obligations to only one category. These are abstract and cannot be declared as obligations.\n * Qualifier codes: SHALL/SHOULD/MAY which convey the 'strength' of an obligation. These are also abstract and cannot be declared as obligations.\n * Generic codes - these describe abstract functional obligation behaviors applications may implement, but do not specify a specific strength. They may be organized in a hierarchy where one generic code specializes another. These are also abstract cannot be declared as obligations.\n * Leaf obligation codes - these are specific qualified obligations that can be declared by a data element and represent leaf-level obligations. They always inherit from a qualification concept and usually inherit from a functional code concept. These codes *can* be declared as obligations.\n * Composite codes - these specialise Leaf obligation codes, inheriting the expectations of multiple concrete obligations. They represent common or externally defined combinations of obligations for ease of reference. These codes can also be declared as obligations.

codedisplaydefinitionhierarchy
SHALLSHALL
The functional requirement is mandatory. Applications that do not implement this functional behavior...
SHOULDSHOULD
The functional requirement is a recommendation. Applications are strongly encouraged to implement t...
MAYMAY
The functional requirement is an option worthy of consideration but there is no expectation or recom...
ResourceProducerObligationsResourceProducerObligations
Resource producers are applications that assembles resources in the first place. Resource producers ...
ResourceExchangerObligationsResourceExchangerObligations
Exchangers do not produce or consume resources; they only pass the resource on. They may store the r...
ResourceConsumerObligationsResourceConsumerObligations
Resource Consumers are applications that consume resources and do something with them, either displa...
able-to-populatebe able to populate
Conformant applications producing resources SHALL/SHOULD/MAY be able to correctly populate this elem...
populate-if-knownpopulate if known
Conformant applications producing resources SHALL/SHOULD correctly populate this element if they kno...
populatepopulate
Conformant applications producing resources SHALL/SHOULD include this element if a value is known an...
in-narrativeinclude in narrative
Conformant applications SHALL/SHOULD/MAY ensure that this data element is represented in any human r...
exclude-narrativeexclude from narrative
Conformant applications SHALL/SHOULD ensure that this data element is NOT represented in any human r...
user-inputallow user input
Conformant applications SHALL/SHOULD/MAY ensure that users can enter a value for this element during...
explainpopulate or document irrelevance
Documentation applicable to Conformant applications SHALL/SHOULD explain how this element is handled...
persistpersist
Conformant applications SHALL/SHOULD/MAY ensure that the value for this element is stored in a persi...
no-alternot alter
Conformant applications SHALL/SHOULD ensure that this element does not change between receiving and ...
no-errornot error if present
Conformant applications SHALL/SHOULD accept resources containing any valid value for the element wit...
reject-invalidreject invalid
Conformant applications SHALL/SHOULD check that values for this element meet all data constraints as...
accept-invalidaccept invalid
Conformant applications SHALL/SHOULD accept data that does not meet all data constraints asserted wi...
handlecorrectly handle
Conformant applications SHALL/SHOULD handle the meaning of this element correctly.\nNotes: this rule...
displaydisplay
Conformant applications SHALL/SHOULD/MAY display the value of this element when presenting the data ...
processprocess
Conformant applications SHALL/SHOULD/MAY consider the value of this element when processing the reso...
printprint
Conformant applications SHALL/SHOULD/MAY print the value of this element somewhere.\nNotes: The form...
ignoreignore
Conformant applications SHALL/SHOULD/MAY not make any use of the value of this element if received....
SHALL:able-to-populateSHALL be able to populate
Conformant applications producing resources SHALL be able to correctly populate this element.\nNotes...
SHOULD:able-to-populateSHOULD be able to populate
Conformant applications producing resources SHOULD be able to correctly populate this element.\nNote...
MAY:able-to-populateMAY be able to populate
Conformant applications producing resources MAY be able to correctly populate this element.\nNotes: ...
SHALL:populate-if-knownSHALL populate if known
Conformant applications producing resources SHALL correctly populate this element if they know a val...
SHOULD:populate-if-knownSHOULD populate if known
Conformant applications producing resources SHOULD correctly populate this element if they know a va...
SHALL:populateSHALL populate
Conformant applications producing resources SHALL include this element if a value is known and allow...
SHOULD:populateSHOULD populate
Conformant applications producing resources SHOULD include this element if a value is known and allo...
SHALL:in-narrativeSHALL include in narrative
Conformant applications SHALL ensure that this data element is represented in any human readable rep...
SHOULD:in-narrativeSHOULD include in narrative
Conformant applications SHOULD ensure that this data element is represented in any human readable re...
MAY:in-narrativeMAY include in narrative
Conformant applications MAY ensure that this data element is represented in any human readable repre...
SHALL:exclude-narrativeSHALL exclude from narrative
Conformant applications SHALL ensure that this data element is NOT represented in any human readable...
SHOULD:exclude-narrativeSHOULD exclude from narrative
Conformant applications SHOULD ensure that this data element is NOT represented in any human readabl...
SHALL:user-inputSHALL allow user input
Conformant applications SHALL ensure that users can enter a value for this element during data input...
SHOULD:user-inputSHOULD allow user input
Conformant applications SHOULD ensure that users can enter a value for this element during data inpu...
MAY:user-inputMAY allow user input
Conformant applications MAY ensure that users can enter a value for this element during data input/c...
SHALL:explainSHALL populate or document irrelevance
Documentation applicable to Conformant applications SHALL explain how this element is handled.\nNote...
SHOULD:explainSHOULD populate or document irrelevance
Documentation applicable to Conformant applications SHOULD explain how this element is handled.\nNot...
SHALL:persistSHALL persist
Conformant applications SHALL ensure that the value for this element is stored in a persistent data ...
SHOULD:persistSHOULD persist
Conformant applications SHOULD ensure that the value for this element is stored in a persistent data...
MAY:persistMAY persist
Conformant applications MAY ensure that the value for this element is stored in a persistent data st...
SHALL:no-alterSHALL not alter
Conformant applications SHALL ensure that this element does not change between receiving and transfe...
SHOULD:no-alterSHOULD not alter
Conformant applications SHOULD ensure that this element does not change between receiving and transf...
MAY:alterMAY alter
Conformant applications MAY choose to alter this element value.\nNotes: this is really a null-statem...
SHALL:no-errorSHALL not error if present
Conformant applications SHALL accept resources containing any valid value for the element without er...
SHOULD:no-errorSHOULD not error if present
Conformant applications SHOULD accept resources containing any valid value for the element without e...
SHALL:reject-invalidSHALL reject invalid
Conformant applications SHALL check that values for this element meet all data constraints asserted ...
SHOULD:reject-invalidSHOULD reject invalid
Conformant applications SHOULD check that values for this element meet all data constraints asserted...
SHALL:accept-invalidSHALL accept invalid
Conformant applications SHALL accept data that does not meet all data constraints asserted within th...
SHOULD:accept-invalidSHOULD accept invalid
Conformant applications SHOULD accept data that does not meet all data constraints asserted within t...
SHALL:handleSHALL correctly handle
Conformant applications SHALL handle the meaning of this element correctly.\nNotes: this rule is vag...
SHOULD:handleSHOULD correctly handle
Conformant applications SHOULD handle the meaning of this element correctly.\nNotes: this rule is va...
SHALL:displaySHALL display
Conformant applications SHALL display the value of this element when presenting the data from the re...
SHOULD:displaySHOULD display
Conformant applications SHOULD display the value of this element when presenting the data from the r...
MAY:displayMAY display
Conformant applications MAY display the value of this element when presenting the data from the reso...
SHALL:processSHALL process
Conformant applications SHALL consider the value of this element when processing the resource as spe...
SHOULD:processSHOULD process
Conformant applications SHOULD consider the value of this element when processing the resource as sp...
MAY:processMAY process
Conformant applications MAY consider the value of this element when processing the resource as speci...
SHALL:printSHALL print
Conformant applications SHALL print the value of this element somewhere.\nNotes: The form of the pri...
SHOULD:printSHOULD print
Conformant applications SHOULD print the value of this element somewhere.\nNotes: The form of the pr...
MAY:printMAY print
Conformant applications MAY print the value of this element somewhere.\nNotes: The form of the print...
SHALL:ignoreSHALL ignore
Conformant applications SHALL not make any use of the value of this element if received....
SHOULD:ignoreSHOULD ignore
Conformant applications SHOULD not make any use of the value of this element if received....
MAY:ignoreMAY ignore
Conformant applications MAY not make any use of the value of this element if received. This is a nu...
v2-reV2 RE (required but may be empty)
RE as defined in chapter 2 of the v2 specification...
ihe-r2IHE R2
R2 as defined in IHE Appendix Z...
stdStandard obligations
The standard recommended set of obligations for IGs to use unless they know they want something diff...