http://hl7.org/fhir/CodeSystem/obligation|5.2.0
ObligationCodes
hl7.fhir.uv.extensions.r5@5.2.0
complete
active
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.
| code | display | definition | hierarchy |
|---|---|---|---|
| SHALL | SHALL | The functional requirement is mandatory. Applications that do not implement this functional behavior... | |
| SHOULD | SHOULD | The functional requirement is a recommendation. Applications are strongly encouraged to implement t... | |
| MAY | MAY | The functional requirement is an option worthy of consideration but there is no expectation or recom... | |
| ResourceProducerObligations | ResourceProducerObligations | Resource producers are applications that assembles resources in the first place. Resource producers ... | |
| ResourceExchangerObligations | ResourceExchangerObligations | Exchangers do not produce or consume resources; they only pass the resource on. They may store the r... | |
| ResourceConsumerObligations | ResourceConsumerObligations | Resource Consumers are applications that consume resources and do something with them, either displa... | |
| able-to-populate | be able to populate | Conformant applications producing resources SHALL/SHOULD/MAY be able to correctly populate this elem... | |
| populate-if-known | populate if known | Conformant applications producing resources SHALL/SHOULD correctly populate this element if they kno... | |
| populate | populate | Conformant applications producing resources SHALL/SHOULD include this element if a value is known an... | |
| in-narrative | include in narrative | Conformant applications SHALL/SHOULD/MAY ensure that this data element is represented in any human r... | |
| exclude-narrative | exclude from narrative | Conformant applications SHALL/SHOULD ensure that this data element is NOT represented in any human r... | |
| user-input | allow user input | Conformant applications SHALL/SHOULD/MAY ensure that users can enter a value for this element during... | |
| explain | populate or document irrelevance | Documentation applicable to Conformant applications SHALL/SHOULD explain how this element is handled... | |
| persist | persist | Conformant applications SHALL/SHOULD/MAY ensure that the value for this element is stored in a persi... | |
| no-alter | not alter | Conformant applications SHALL/SHOULD ensure that this element does not change between receiving and ... | |
| no-error | not error if present | Conformant applications SHALL/SHOULD accept resources containing any valid value for the element wit... | |
| reject-invalid | reject invalid | Conformant applications SHALL/SHOULD check that values for this element meet all data constraints as... | |
| accept-invalid | accept invalid | Conformant applications SHALL/SHOULD accept data that does not meet all data constraints asserted wi... | |
| handle | correctly handle | Conformant applications SHALL/SHOULD handle the meaning of this element correctly.\nNotes: this rule... | |
| display | display | Conformant applications SHALL/SHOULD/MAY display the value of this element when presenting the data ... | |
| process | process | Conformant applications SHALL/SHOULD/MAY consider the value of this element when processing the reso... | |
Conformant applications SHALL/SHOULD/MAY print the value of this element somewhere.\nNotes: The form... | |||
| ignore | ignore | Conformant applications SHALL/SHOULD/MAY not make any use of the value of this element if received.... | |
| SHALL:able-to-populate | SHALL be able to populate | Conformant applications producing resources SHALL be able to correctly populate this element.\nNotes... | |
| SHOULD:able-to-populate | SHOULD be able to populate | Conformant applications producing resources SHOULD be able to correctly populate this element.\nNote... | |
| MAY:able-to-populate | MAY be able to populate | Conformant applications producing resources MAY be able to correctly populate this element.\nNotes: ... | |
| SHALL:populate-if-known | SHALL populate if known | Conformant applications producing resources SHALL correctly populate this element if they know a val... | |
| SHOULD:populate-if-known | SHOULD populate if known | Conformant applications producing resources SHOULD correctly populate this element if they know a va... | |
| SHALL:populate | SHALL populate | Conformant applications producing resources SHALL include this element if a value is known and allow... | |
| SHOULD:populate | SHOULD populate | Conformant applications producing resources SHOULD include this element if a value is known and allo... | |
| SHALL:in-narrative | SHALL include in narrative | Conformant applications SHALL ensure that this data element is represented in any human readable rep... | |
| SHOULD:in-narrative | SHOULD include in narrative | Conformant applications SHOULD ensure that this data element is represented in any human readable re... | |
| MAY:in-narrative | MAY include in narrative | Conformant applications MAY ensure that this data element is represented in any human readable repre... | |
| SHALL:exclude-narrative | SHALL exclude from narrative | Conformant applications SHALL ensure that this data element is NOT represented in any human readable... | |
| SHOULD:exclude-narrative | SHOULD exclude from narrative | Conformant applications SHOULD ensure that this data element is NOT represented in any human readabl... | |
| SHALL:user-input | SHALL allow user input | Conformant applications SHALL ensure that users can enter a value for this element during data input... | |
| SHOULD:user-input | SHOULD allow user input | Conformant applications SHOULD ensure that users can enter a value for this element during data inpu... | |
| MAY:user-input | MAY allow user input | Conformant applications MAY ensure that users can enter a value for this element during data input/c... | |
| SHALL:explain | SHALL populate or document irrelevance | Documentation applicable to Conformant applications SHALL explain how this element is handled.\nNote... | |
| SHOULD:explain | SHOULD populate or document irrelevance | Documentation applicable to Conformant applications SHOULD explain how this element is handled.\nNot... | |
| SHALL:persist | SHALL persist | Conformant applications SHALL ensure that the value for this element is stored in a persistent data ... | |
| SHOULD:persist | SHOULD persist | Conformant applications SHOULD ensure that the value for this element is stored in a persistent data... | |
| MAY:persist | MAY persist | Conformant applications MAY ensure that the value for this element is stored in a persistent data st... | |
| SHALL:no-alter | SHALL not alter | Conformant applications SHALL ensure that this element does not change between receiving and transfe... | |
| SHOULD:no-alter | SHOULD not alter | Conformant applications SHOULD ensure that this element does not change between receiving and transf... | |
| MAY:alter | MAY alter | Conformant applications MAY choose to alter this element value.\nNotes: this is really a null-statem... | |
| SHALL:no-error | SHALL not error if present | Conformant applications SHALL accept resources containing any valid value for the element without er... | |
| SHOULD:no-error | SHOULD not error if present | Conformant applications SHOULD accept resources containing any valid value for the element without e... | |
| SHALL:reject-invalid | SHALL reject invalid | Conformant applications SHALL check that values for this element meet all data constraints asserted ... | |
| SHOULD:reject-invalid | SHOULD reject invalid | Conformant applications SHOULD check that values for this element meet all data constraints asserted... | |
| SHALL:accept-invalid | SHALL accept invalid | Conformant applications SHALL accept data that does not meet all data constraints asserted within th... | |
| SHOULD:accept-invalid | SHOULD accept invalid | Conformant applications SHOULD accept data that does not meet all data constraints asserted within t... | |
| SHALL:handle | SHALL correctly handle | Conformant applications SHALL handle the meaning of this element correctly.\nNotes: this rule is vag... | |
| SHOULD:handle | SHOULD correctly handle | Conformant applications SHOULD handle the meaning of this element correctly.\nNotes: this rule is va... | |
| SHALL:display | SHALL display | Conformant applications SHALL display the value of this element when presenting the data from the re... | |
| SHOULD:display | SHOULD display | Conformant applications SHOULD display the value of this element when presenting the data from the r... | |
| MAY:display | MAY display | Conformant applications MAY display the value of this element when presenting the data from the reso... | |
| SHALL:process | SHALL process | Conformant applications SHALL consider the value of this element when processing the resource as spe... | |
| SHOULD:process | SHOULD process | Conformant applications SHOULD consider the value of this element when processing the resource as sp... | |
| MAY:process | MAY process | Conformant applications MAY consider the value of this element when processing the resource as speci... | |
| SHALL:print | SHALL print | Conformant applications SHALL print the value of this element somewhere.\nNotes: The form of the pri... | |
| SHOULD:print | SHOULD print | Conformant applications SHOULD print the value of this element somewhere.\nNotes: The form of the pr... | |
| MAY:print | MAY print | Conformant applications MAY print the value of this element somewhere.\nNotes: The form of the print... | |
| SHALL:ignore | SHALL ignore | Conformant applications SHALL not make any use of the value of this element if received.... | |
| SHOULD:ignore | SHOULD ignore | Conformant applications SHOULD not make any use of the value of this element if received.... | |
| MAY:ignore | MAY ignore | Conformant applications MAY not make any use of the value of this element if received. This is a nu... | |
| v2-re | V2 RE (required but may be empty) | RE as defined in chapter 2 of the v2 specification... | |
| ihe-r2 | IHE R2 | R2 as defined in IHE Appendix Z... | |
| std | Standard obligations | The standard recommended set of obligations for IGs to use unless they know they want something diff... |