Information | CodeSystem.status | Values for status differ: 'draft' vs 'active' |
Warning | CodeSystem.experimental | Values for experimental differ: 'true' vs 'false' |
Name | Value | Comments | |
---|---|---|---|
caseSensitive | true | ||
compositional | true | ||
content | complete | ||
copyright | |||
description | Codes that describe application obligations for handling FHIR content. There are three kinds of codes in this code system: * Qualifier codes: SHALL/SHOULD/MAY * Functional codes - these describe a functional behavior applications may implement, and have the concept property qualify = true, and must be qualified by one of SHALL, SHOULD, or MAY * Composite codes - these specialise AggregateConcepts, and have an concept property 'expression' that defines them in terms of a set of functional codes Functional and Qualifier codes are combined using the syntax ```[modifierCode] ":" [obligationCode]``` e.g. SHALL:will-send The functional codes are grouped into three different high level categories: * ResourceProducerObligations - functions that pertain to applications that produce resources (typically from databases or forms) * ExchangerObligations - functions that pertain to applications that transfer resources between other applications (including FHIR repositories) * ResourceConsumerObligations - functions that pertain to applications that consume the content of resources and do something with them Note that applications typically produce and consume resources, whether client, server or something else again, and many applications transfer resources as well | Codes that describe application obligations for handling FHIR content. There are five kinds of codes in this code system: * 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. * Qualifier codes: SHALL/SHOULD/MAY which convey the 'strength' of an obligation. These are also abstract and cannot be declared as obligations. * 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. * 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. * 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. |
|
experimental | true | false |
|
hierarchyMeaning | is-a | ||
jurisdiction | |||
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | ||
name | ObligationCodes | ||
publisher | HL7 International / FHIR Infrastructure | ||
purpose | |||
status | draft | active |
|
title | Obligation Codes | ||
url | http://hl7.org/fhir/CodeSystem/obligation | ||
versionNeeded |
Code | Display | qualify | combination | qualify | combination | not-selectable | parent | qualifier | converse | security-dependent | Comments | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ModifierCodes | ModifierCodes |
| |||||||||||||||||||
ResourceProducerObligations | ResourceProducerObligations | ||||||||||||||||||||
ExchangerObligations | ExchangerObligations |
| |||||||||||||||||||
ResourceConsumerObligations | ResourceConsumerObligations | ||||||||||||||||||||
AggregateConcepts | AggregateConcepts |
| |||||||||||||||||||
SHALL | SHALL |
| |||||||||||||||||||
SHOULD | SHOULD |
| |||||||||||||||||||
MAY | MAY |
| |||||||||||||||||||
ResourceExchangerObligations | ResourceExchangerObligations |
| |||||||||||||||||||
able-to-populate | be able to populate |
| |||||||||||||||||||
populate-if-known | populate if known |
| |||||||||||||||||||
populate | populate |
| |||||||||||||||||||
in-narrative | include in narrative |
| |||||||||||||||||||
exclude-narrative | exclude from narrative |
| |||||||||||||||||||
user-input | allow user input |
| |||||||||||||||||||
explain | populate or document irrelevance |
| |||||||||||||||||||
persist | persist |
| |||||||||||||||||||
no-alter | not alter |
| |||||||||||||||||||
no-error | not error if present |
| |||||||||||||||||||
reject-invalid | reject invalid |
| |||||||||||||||||||
accept-invalid | accept invalid |
| |||||||||||||||||||
handle | correctly handle |
| |||||||||||||||||||
display | display |
| |||||||||||||||||||
process | process |
| |||||||||||||||||||
| |||||||||||||||||||||
ignore | ignore |
| |||||||||||||||||||
SHALL:able-to-populate | SHALL be able to populate |
| |||||||||||||||||||
SHOULD:able-to-populate | SHOULD be able to populate |
| |||||||||||||||||||
MAY:able-to-populate | MAY be able to populate |
| |||||||||||||||||||
SHALL:populate-if-known | SHALL populate if known |
| |||||||||||||||||||
SHOULD:populate-if-known | SHOULD populate if known |
| |||||||||||||||||||
SHALL:populate | SHALL populate |
| |||||||||||||||||||
SHOULD:populate | SHOULD populate |
| |||||||||||||||||||
SHALL:in-narrative | SHALL include in narrative |
| |||||||||||||||||||
SHOULD:in-narrative | SHOULD include in narrative |
| |||||||||||||||||||
MAY:in-narrative | MAY include in narrative |
| |||||||||||||||||||
SHALL:exclude-narrative | SHALL exclude from narrative |
| |||||||||||||||||||
SHOULD:exclude-narrative | SHOULD exclude from narrative |
| |||||||||||||||||||
SHALL:user-input | SHALL allow user input |
| |||||||||||||||||||
SHOULD:user-input | SHOULD allow user input |
| |||||||||||||||||||
MAY:user-input | MAY allow user input |
| |||||||||||||||||||
SHALL:explain | SHALL populate or document irrelevance |
| |||||||||||||||||||
SHOULD:explain | SHOULD populate or document irrelevance |
| |||||||||||||||||||
SHALL:persist | SHALL persist |
| |||||||||||||||||||
SHOULD:persist | SHOULD persist |
| |||||||||||||||||||
MAY:persist | MAY persist |
| |||||||||||||||||||
SHALL:no-alter | SHALL not alter |
| |||||||||||||||||||
SHOULD:no-alter | SHOULD not alter |
| |||||||||||||||||||
MAY:alter | MAY alter |
| |||||||||||||||||||
SHALL:no-error | SHALL not error if present |
| |||||||||||||||||||
SHOULD:no-error | SHOULD not error if present |
| |||||||||||||||||||
SHALL:reject-invalid | SHALL reject invalid |
| |||||||||||||||||||
SHOULD:reject-invalid | SHOULD reject invalid |
| |||||||||||||||||||
SHALL:accept-invalid | SHALL accept invalid |
| |||||||||||||||||||
SHOULD:accept-invalid | SHOULD accept invalid |
| |||||||||||||||||||
SHALL:handle | SHALL correctly handle |
| |||||||||||||||||||
SHOULD:handle | SHOULD correctly handle |
| |||||||||||||||||||
SHALL:display | SHALL display |
| |||||||||||||||||||
SHOULD:display | SHOULD display |
| |||||||||||||||||||
MAY:display | MAY display |
| |||||||||||||||||||
SHALL:process | SHALL process |
| |||||||||||||||||||
SHOULD:process | SHOULD process |
| |||||||||||||||||||
MAY:process | MAY process |
| |||||||||||||||||||
SHALL:print | SHALL print |
| |||||||||||||||||||
SHOULD:print | SHOULD print |
| |||||||||||||||||||
MAY:print | MAY print |
| |||||||||||||||||||
SHALL:ignore | SHALL ignore |
| |||||||||||||||||||
SHOULD:ignore | SHOULD ignore |
| |||||||||||||||||||
MAY:ignore | MAY ignore |
| |||||||||||||||||||
v2-re | V2 RE (required but may be empty) |
| |||||||||||||||||||
ihe-r2 | IHE R2 |
| |||||||||||||||||||
std | Standard obligations |
|