FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageobligation
Resource TypeCodeSystem
IdCodeSystem-obligationOrigCommented.json
FHIR VersionR5
Sourcehttps://build.fhir.org/ig/frankoemig/obligation/CodeSystem-obligationOrigCommented.html
URLhttp://obligation.oemig.de/fhir/CodeSystem/obligationOrigCommented
Version5.1.0-cibuild
Statusactive
Date2026-03-26T16:58:18+00:00
NameObligationOrigCommentedCodes
TitleSupplementing original Obligation Codes (from Grahame, reduced text/property, but commented)
DescriptionThis codesystem is a supplement to the original by providing comments and proposals.
Contentsupplement
Supplementshttp://hl7.org/fhir/CodeSystem/obligation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CodeSystem obligationOrigCommented

Properties

This code system defines the following properties for its concepts

NameCodeURITypeDescription
Parentparenthttp://hl7.org/fhir/concept-properties#parentcode
converseconversecodeIndicates another obligation code with an opposite meaning to this one. A single obligation cannot list two converse codes and an application cannot satisfy both a code and its coverse (though if the obligation strength for both is SHOULD or MAY, an application could conform with both obligations by adhering to one and not the other).
Commentcommenthttp://hl7.org/fhir/concept-properties#commentstringcomment from Conformance WG
equivalentequivalentcodeequivalent code in the proposed codesystem

Concepts

This code system supplement http://obligation.oemig.de/fhir/CodeSystem/obligationOrigCommented defines properties on the following codes:

CodeDisplayDefinitionconverseCommentequivalent
able-to-populate be able to populate
populate-if-known populate if knownsame as populate
populate populatepresence of data has to be determined by minimum cardinality
in-narrative include in narrativeCan be managed by using the text element directly.
exclude-narrative exclude from narrativeCan be managed by using negation.
user-input allow user inputto be taken from UI
explain populate or document irrelevance
persist persistpersist
no-alter not alterNO modification, use negative
no-error not error if present
reject-invalid reject invalid
accept-invalid accept invalidreject-invalid
handle correctly handleprocess
display displaydisplay
process process
print printprint
ignore ignoreCan be managed by negations.
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 be able to populate if known
SHOULD:populate-if-known SHOULD be able to 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
MAY:exclude-narrative MAY exclude from narrative
SHALL:user-input SHALL take from user input
SHOULD:user-input SHOULD take from user input
MAY:user-input MAY take from user input
SHALL:explain SHALL populate or dcoumtn irrelevance
SHOULD:explain SHOULD populate or dcoumtn irrelevance
SHALL:persist SHALL persist
SHOULD:persist SHOULD persist
MAY:persist MAY persist
SHALL:no-alter SHALL not altervia SHALLNOT:modify
SHOULD:no-alter SHOULD not altervia SHOULDNOT:modify
MAY:no-alter MAY not altervia MAYNOT:modify
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 handle correctly
SHOULD:handle SHOULD handle correctly
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)wrong interpretation; intent is 'mustSupport'.
ihe-r2 IHE R2R2 as defined in IHE Appendix ZAppendix Z is FHIR only, so no need to specify; R2 is in principle the same as 'RE'.
std Standard obligationsunclear what 'standard' means

Source1

{
  "resourceType": "CodeSystem",
  "id": "obligationOrigCommented",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    }
  ],
  "url": "http://obligation.oemig.de/fhir/CodeSystem/obligationOrigCommented",
  "version": "5.1.0-cibuild",
  "name": "ObligationOrigCommentedCodes",
  "title": "Supplementing original Obligation Codes (from Grahame, reduced text/property, but commented)",
  "status": "active",
  "experimental": true,
  "date": "2026-03-26T16:58:18+00:00",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/conformancewg"
        }
      ]
    }
  ],
  "description": "This codesystem is a supplement to the original by providing comments and proposals.",
  "compositional": true,
  "content": "supplement",
  "supplements": "http://hl7.org/fhir/CodeSystem/obligation",
  "property": [
    {
      "code": "parent",
      "uri": "http://hl7.org/fhir/concept-properties#parent",
      "type": "code"
    },
    {
      "code": "converse",
      "description": "Indicates another obligation code with an opposite meaning to this one.  A single obligation cannot list two converse codes and an application cannot satisfy both a code and its coverse (though if the obligation strength for both is SHOULD or MAY, an application could conform with both obligations by adhering to one and not the other).",
      "type": "code"
    },
    {
      "code": "comment",
      "uri": "http://hl7.org/fhir/concept-properties#comment",
      "description": "comment from Conformance WG",
      "type": "string"
    },
    {
      "code": "equivalent",
      "description": "equivalent code in the proposed codesystem",
      "type": "code"
    }
  ],
  "concept": [
    {
      "code": "able-to-populate",
      "display": "be able to populate"
    },
    {
      "code": "populate-if-known",
      "display": "populate if known",
      "property": [
        {
          "code": "comment",
          "valueString": "same as populate"
        }
      ]
    },
    {
      "code": "populate",
      "display": "populate",
      "property": [
        {
          "code": "comment",
          "valueString": "presence of data has to be determined by minimum cardinality"
        }
      ]
    },
    {
      "code": "in-narrative",
      "display": "include in narrative",
      "property": [
        {
          "code": "comment",
          "valueString": "Can be managed by using the text element directly."
        }
      ]
    },
    {
      "code": "exclude-narrative",
      "display": "exclude from narrative",
      "property": [
        {
          "code": "comment",
          "valueString": "Can be managed by using negation."
        }
      ]
    },
    {
      "code": "user-input",
      "display": "allow user input",
      "property": [
        {
          "code": "comment",
          "valueString": "to be taken from UI"
        }
      ]
    },
    {
      "code": "explain",
      "display": "populate or document irrelevance"
    },
    {
      "code": "persist",
      "display": "persist",
      "property": [
        {
          "code": "equivalent",
          "valueCode": "persist"
        }
      ]
    },
    {
      "code": "no-alter",
      "display": "not alter",
      "property": [
        {
          "code": "comment",
          "valueString": "NO modification, use negative"
        }
      ]
    },
    {
      "code": "no-error",
      "display": "not error if present"
    },
    {
      "code": "reject-invalid",
      "display": "reject invalid"
    },
    {
      "code": "accept-invalid",
      "display": "accept invalid",
      "property": [
        {
          "code": "converse",
          "valueCode": "reject-invalid"
        }
      ]
    },
    {
      "code": "handle",
      "display": "correctly handle",
      "property": [
        {
          "code": "equivalent",
          "valueCode": "process"
        }
      ]
    },
    {
      "code": "display",
      "display": "display",
      "property": [
        {
          "code": "equivalent",
          "valueCode": "display"
        }
      ]
    },
    {
      "code": "process",
      "display": "process"
    },
    {
      "code": "print",
      "display": "print",
      "property": [
        {
          "code": "equivalent",
          "valueCode": "print"
        }
      ]
    },
    {
      "code": "ignore",
      "display": "ignore",
      "property": [
        {
          "code": "comment",
          "valueString": "Can be managed by negations."
        }
      ]
    },
    {
      "code": "SHALL:able-to-populate",
      "display": "SHALL be able to populate"
    },
    {
      "code": "SHOULD:able-to-populate",
      "display": "SHOULD be able to populate"
    },
    {
      "code": "MAY:able-to-populate",
      "display": "MAY be able to populate"
    },
    {
      "code": "SHALL:populate-if-known",
      "display": "SHALL be able to populate if known"
    },
    {
      "code": "SHOULD:populate-if-known",
      "display": "SHOULD be able to populate if known"
    },
    {
      "code": "SHALL:populate",
      "display": "SHALL populate"
    },
    {
      "code": "SHOULD:populate",
      "display": "SHOULD populate"
    },
    {
      "code": "SHALL:in-narrative",
      "display": "SHALL include in narrative"
    },
    {
      "code": "SHOULD:in-narrative",
      "display": "SHOULD include in narrative"
    },
    {
      "code": "MAY:in-narrative",
      "display": "MAY include in narrative"
    },
    {
      "code": "SHALL:exclude-narrative",
      "display": "SHALL exclude from narrative"
    },
    {
      "code": "SHOULD:exclude-narrative",
      "display": "SHOULD exclude from narrative"
    },
    {
      "code": "MAY:exclude-narrative",
      "display": "MAY exclude from narrative"
    },
    {
      "code": "SHALL:user-input",
      "display": "SHALL take from user input"
    },
    {
      "code": "SHOULD:user-input",
      "display": "SHOULD take from user input"
    },
    {
      "code": "MAY:user-input",
      "display": "MAY take from user input"
    },
    {
      "code": "SHALL:explain",
      "display": "SHALL populate or dcoumtn irrelevance"
    },
    {
      "code": "SHOULD:explain",
      "display": "SHOULD populate or dcoumtn irrelevance"
    },
    {
      "code": "SHALL:persist",
      "display": "SHALL persist"
    },
    {
      "code": "SHOULD:persist",
      "display": "SHOULD persist"
    },
    {
      "code": "MAY:persist",
      "display": "MAY persist"
    },
    {
      "code": "SHALL:no-alter",
      "display": "SHALL not alter",
      "property": [
        {
          "code": "comment",
          "valueString": "via SHALLNOT:modify"
        }
      ]
    },
    {
      "code": "SHOULD:no-alter",
      "display": "SHOULD not alter",
      "property": [
        {
          "code": "comment",
          "valueString": "via SHOULDNOT:modify"
        }
      ]
    },
    {
      "code": "MAY:no-alter",
      "display": "MAY not alter",
      "property": [
        {
          "code": "comment",
          "valueString": "via MAYNOT:modify"
        }
      ]
    },
    {
      "code": "SHALL:no-error",
      "display": "SHALL not error if present"
    },
    {
      "code": "SHOULD:no-error",
      "display": "SHOULD not error if present"
    },
    {
      "code": "SHALL:reject-invalid",
      "display": "SHALL reject invalid"
    },
    {
      "code": "SHOULD:reject-invalid",
      "display": "SHOULD reject invalid"
    },
    {
      "code": "SHALL:accept-invalid",
      "display": "SHALL accept invalid"
    },
    {
      "code": "SHOULD:accept-invalid",
      "display": "SHOULD accept invalid"
    },
    {
      "code": "SHALL:handle",
      "display": "SHALL handle correctly"
    },
    {
      "code": "SHOULD:handle",
      "display": "SHOULD handle correctly"
    },
    {
      "code": "SHALL:display",
      "display": "SHALL display"
    },
    {
      "code": "SHOULD:display",
      "display": "SHOULD display"
    },
    {
      "code": "MAY:display",
      "display": "MAY display"
    },
    {
      "code": "SHALL:process",
      "display": "SHALL process"
    },
    {
      "code": "SHOULD:process",
      "display": "SHOULD process"
    },
    {
      "code": "MAY:process",
      "display": "MAY process"
    },
    {
      "code": "SHALL:print",
      "display": "SHALL print"
    },
    {
      "code": "SHOULD:print",
      "display": "SHOULD print"
    },
    {
      "code": "MAY:print",
      "display": "MAY print"
    },
    {
      "code": "SHALL:ignore",
      "display": "SHALL ignore"
    },
    {
      "code": "SHOULD:ignore",
      "display": "SHOULD ignore"
    },
    {
      "code": "MAY:ignore",
      "display": "MAY ignore"
    },
    {
      "code": "v2-re",
      "display": "V2 RE (required but may be empty)",
      "property": [
        {
          "code": "comment",
          "valueString": "wrong interpretation; intent is 'mustSupport'."
        }
      ]
    },
    {
      "code": "ihe-r2",
      "display": "IHE R2",
      "definition": "R2 as defined in IHE Appendix Z",
      "property": [
        {
          "code": "comment",
          "valueString": "Appendix Z is FHIR only, so no need to specify; R2 is in principle the same as 'RE'."
        }
      ]
    },
    {
      "code": "std",
      "display": "Standard obligations",
      "property": [
        {
          "code": "comment",
          "valueString": "unclear what 'standard' means"
        }
      ]
    }
  ]
}