Obligation Discussion
0.4.1 - Working Draft to present the Concept Ideas and Background Details (FO)

Obligation Discussion - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

ValueSet: Proposed Obligation Codes VS (complete) (Experimental)

Official URL: http://v2.hl7.org/fhir/ValueSet/obligationProposed Version: 0.1.0
Draft as of 2024-05-08 Computable Name: ObligationProposedCodesVS

This valueset represents the proposed obligation codes.

References

Logical Definition (CLD)

 

Expansion

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

This value set contains 177 concepts.

CodeSystemDisplayDefinition
  Negationhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedNegation

Negate the meaning of the concepts that inherit 'negation'. (Negation is not negated again.)

  MAYNOThttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAYNOT

It is to the developers choice whether an element is probably not supported.

  SHOULDNOThttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD NOT

it is a recommendation NOT to take care of this element (for some reasons)

  SHALLNOThttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL NOT

it is forbidden to handle this element

  SHALLNOT:populate:more-detailshttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL NOT populate more data than is specified

Conformant applications SHALL NOT populatae more data than is specified. The specification is closed.

  SHALLNOT:populate:missinghttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL NOT populate info about missing data, ie. data absent reasons

Conformant applications SHALL NOT populate a reason for missing information.

  v3-mhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedv3: M

mandatory in IHE V3

  SHALLNOT:follow-up:truncatehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL NOT truncate data

Conformant applications SHALL NOT cut off data.

  SHALLNOT:(populate):in-narrativehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL NOT add to narrative

Conformant applications SHALL NOT add this data to the narrative.

  SHALLNOT:processhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL NOT process the data

Conformant applications SHALL NOT process the data in some meaningful way.

  SHALLNOT:modifyhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL NOT modify the data

Conformant applications SHALL NOT modiify the data in any way.

  SHALLNOT:errorhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL NOT return an error to the sender of the data

Conformant applications SHALL NOT reurn an erorr to the sender of the data.

  v3-xhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedv3: X

forbidden in IHE V3

  SHOULDNOT:processhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD NOT process the data

Conformant applications SHOULD NOT process the data in some meaningful way.

  SHOULDNOT:modifyhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD NOT modify the data

Conformant applications SHOULD NOT modiify the data in any way.

  SHOULDNOT:errorhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD NOT return an error to the sender of the data

Conformant applications SHOULD NOT reurn an erorr to the sender of the data.

  v2-xhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedv2: X

forbidden in v2

  v2-bhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedv2: B

backwards use in v2 only

  v2-whttp://v2.hl7.org/fhir/CodeSystem/obligationProposedv2: W

withdrawn use in v2 only

  MAYNOT:processhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY NOT process data

Conformant applications MAY NOT process data, aka of ignoring.

  Verbshttp://v2.hl7.org/fhir/CodeSystem/obligationProposedconformance verbs

Conformance verbs are to be used to define the requirement level that is the foundation to indicate what has to be tested.

  MAYhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY

it is to the developers choice whether an element is supported or not

  SHOULDhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD

It is a recommendation to take care of this element

  SHALLhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL

This verb denotes a testable requirement.

  SHALL:(populate)from-uihttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL populate data taken from ui

Conformant applications SHALL take data from a UI and provide it.

  SHALL:(populate)from-ui:more-detailshttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL populate with data taken from ui perhaps with more details

Conformant applications SHALL take data from a UI and bring it into the instance. It is allowed to provide more details then specified.

  SHALL:sendhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL send the instance

Conformant applications SHALL send the instance.

  SHALL:persisthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL store the data somewhere

Conformant applications SHALL store the data in some way.

  SHALL:persist:exactlyhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL store the data somewhere, but exactly as is sent

Conformant applications SHALL store the data in a way that the originally data from the instance can be reestablished.

  SHALL:printhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL print data

Conformant applications SHALL print the data.

  SHALL:documenthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL document how the data is used

Conformant applications SHALL document the way the data is used in some (meaningful) way.

  SHALL:reject-invalidhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL reject invalid data

Conformant applications SHALL reject invalid data.

  SHALL:accept-invalidhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL accept invalid data

Conformant applications SHALL accept invalid data.

  SHALL:receivehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL be able to receive the data

Conformant applications SHALL be able to receive the data.

  v2-rhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedv2: R

required in v2.x

  v2-rehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedv2: RE

required but may be empty in v2.x

  v3-rhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedv3: R

required in IHE V3

  xDT-Mhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedxDT: M

MUSS in xDT (unbedingtes Mussfeld)

  xDT-mhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedxDT: m

muss in xDT (bedingtes Mussfeld)

  xDT-Khttp://v2.hl7.org/fhir/CodeSystem/obligationProposedxDT: K

KANN in xDT (unbedingts KANNfeld)

  xDT-khttp://v2.hl7.org/fhir/CodeSystem/obligationProposedxDT: k

kann in xDT (bedingtes Kannfeld)

  SHOULD:(populate)from-uihttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD populate with data taken from ui

Conformant applications SHOULD take data from a UI and provide it.

  SHOULD:(persist)in-databasehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD store the data in a database

Conformant applications are asked to store the data in a database.

  SHOULD:printhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD print data

Conformant applications SHOULD print the data.

  SHOULD:documenthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD document how the data is used

Conformant applications SHOULD document the way the data is used in some (meaningful) way.

  SHOULD:displayhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD display the data

Conformant applications SHOULD display the data in some meaningful way.

  SHALL:displayhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL display the data

Conformant applications SHALL display the data in some meaningful way.

  SHOULD:reject-invalidhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD reject invalid data

Conformant applications SHOULD reject invalid data.

  SHOULD:accept-invalidhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD accept invalid data

Conformant applications SHOULD accept invalid data.

  SHOULD:receivehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD be able to receive the data

Conformant applications SHOULD be able to receive the data.

  MAY:populatehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY populate with data

Conformant applications MAY take and provide data.

  MAY:populate:missinghttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY populate data element with why orig data is missing

Conformant applications MAY populate the element why the original data is missing.

  SHOULD:populatehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD populate with data

Conformant applications SHOULD take and provide data.

  MAY:(populate)into-narrativehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY populate into-narrative

Conformant applications MAY populate element into narrative text as well.

  SHOULD:(populate)into-narrativehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD populate into-narrative

Conformant applications SHOULD populate element into narrative text as well.

  SHALL:(populate)into-narrativehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL populate into-narrative

Conformant applications SHALL populate element into narrative text as well.

  SHALL:populatehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL populate with data

Conformant applications SHOULD take and provide data.

  ihe-r2http://v2.hl7.org/fhir/CodeSystem/obligationProposedIHE: R2

R2 in IHE v2.x specs

  MAY:(populate)from-uihttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY populate with data taken from ui

Conformant applications MAY take data from a UI and provide it.

  MAY:persisthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY store the data

Conformant applications MAY store the data.

  MAY:populate:more-structurehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY populate the data in more structured way

Conformant applications are allowed to populate the data with more structure. For example, to split an address line into streetname and house number.

  MAY:modifyhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY modify the data

Conformant applications MAY, i.e. are allowed to modify the data.

  MAY:printhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY print data

Conformant applications MAY print the data.

  MAY:processhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY process the data

Conformant applications MAY process the data somehow.

  SHOULD:processhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD process the data

Conformant applications SHOULD process the data in some meaningful way.

  SHALL:processhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL process the data

Conformant applications SHALL process the data in some meaningful way.

  FunctionalTypehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedFunctional Type of Requirement

Functional Type of Requirement

  functionalhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedfunctional

functional requirement

  internalhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedinternal functional

function that operates on the internal data management

  returnhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedreturn functional

functional requirement on direct returns

  responsehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedresponse function

functional requirement to prepare responses

  forwardhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedforwarding function

functional requirement to forward data

  datahttp://v2.hl7.org/fhir/CodeSystem/obligationProposeddata

data requirement

  Testablehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedType of Testing

Type of Testing

  testablehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedtestable

requirement is testable

  testableByMachinehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedmachine testable

requirement is testable by a machine

  testableByHumanhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedhuman testable

requirement is testable by a human (inspection)

  withChecklisthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedchecklist

requirement is testable by using a checklist

  notTestablehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedtestable

requirement is not testable

  ActorTypehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedType of Actor

An actor can operate in two ways: with the content itself, or as a manager of the instance.

  transporthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedtransport

handle the transport of data once the instance is available/accessible

  senderhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedsender

sender (transmitter) of data

  sendhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedsend

convey instance with values to somewhere

  receiverhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedreceiver

receiver of data

  ConsumerObligationshttp://v2.hl7.org/fhir/CodeSystem/obligationProposedResource Consumer Obligations

Obligation for Consumer

  receivehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedreceive

receive data form somewhere

  processhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedprocess

handle data from instances as needed for general message consumption, store permitted.

  follow-uphttp://v2.hl7.org/fhir/CodeSystem/obligationProposedfollow-up activity

what to do internally

  displayhttp://v2.hl7.org/fhir/CodeSystem/obligationProposeddisplay/present (UI)

present the data on a display

  persisthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedpersist

persist/store the data somewhere

  archivehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedarchive

persist/store the archive which ensures longlasting access

  in-databasehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedpersist in a database

persist in a database

  in-filehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedstore in a file

store in a file

  printhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedprint

print the data (somewhere)

  evalhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedevaluate

consider the data in order to interpret other correctly

  integratehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedintegrate into data

to UPDATE existing data by merging other data with the existing data in a controlled manner

  respondhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedactivity as response

what to respond

  warninghttp://v2.hl7.org/fhir/CodeSystem/obligationProposedreturn warnings

return possible warnings

  errorhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedreturn error

return possible errors

  reject-invalidhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedreject invalid data

reject if data is invalid

  accept-invalidhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedaccept invalid data

accept if data is invalid

  routerhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedrouter

router of data: shall be receiver and sender!

  from-inputhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedfrom input stream

As a router, take data from input stream.

  ExchangerObligationshttp://v2.hl7.org/fhir/CodeSystem/obligationProposedResource Exchanger Obligations

needs clarification ...

  routehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedroute forward

as a router forward to the next recipient

  contenthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedcontent mngmt

manage the data itself

  creatorhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedcreator

creator of data

  populatehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedpopulate

populate with values from somewhere

  from-uihttp://v2.hl7.org/fhir/CodeSystem/obligationProposedfrom UI

Take the data from UI, so that the user has the ability to enter it.

  from-storehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedfrom persistence layer

Take data from storage/persistence layer.

  generatehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedgenerate this data

This data can be generated.

  from-otherhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedgenerate from other values

This data can be generated from other data.

  sequencehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedgenerate a sequence number
  as-constanthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedconstant

added as constant to the data, no special treatment done internally

  into-narrativehttp://v2.hl7.org/fhir/CodeSystem/obligationProposednarrative

added to the narrative, no special treatment done internally

  DataObligationhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedObligations on Data

Data Obligations

  expectedhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedexpected

data fits to expectations/specification

  unalteredhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedpreserve

preserve what you get

  exactlyhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedexactly

exactly what is specified, nothing else

  modifyhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedmodify

allow for modifications of the data

  assocationhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedassocation

taken by association

  equivalenthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedequivalent

in an equivalent way

  translatehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedtranslate

Data received is preserved by 1:1 mapping/translation to an internal value that is semantically equivalent, that preserves the temporal aspect of the translation.

  semanticallyhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedtranslate semantically

Two concepts are semantically equivalent if they can substitute for each other in the defined use case with no loss of information used to define the concept.

  clinicallyhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedtranslate clinically

Two concepts are clinically equivalent if they can substitute for each other in the defined use case with no impact on clinical interpretation by a trained clinician. This may include further refinements based on the specific domain, e.g., for Lab use case, this would require interpretation that includes the impact of differences in normal ranges.

  referencehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedreference

Use referenced data based on stored pointer; stored data is displayed by linking to the corresponding stored value most often the case for data elements that are STORED EXACT by ASSOCIATION.

  truncatehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedcut off data

cut off remaining characters from the data thereby shortening the data

  more-detailshttp://v2.hl7.org/fhir/CodeSystem/obligationProposedadditional details/values

extends the expected data with more/own information, e.g. appartment if street is specified

  more-structurehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedadditional substructures

provides the data with more granular details, e.g. house number for an address line

  missinghttp://v2.hl7.org/fhir/CodeSystem/obligationProposeddata is missing/not available

provide a null-flavor/absent reason

  constanthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedadded as a constant

this value has no valid representation or meaning in the sending application, it is just added because it is required to be there

  unexpectedhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedunexpected values

how to manage unexpected data (as sender or receiver)

  replaceshttp://v2.hl7.org/fhir/CodeSystem/obligationProposednew/other values

replaces the expected data by something else

  considerhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedconsider unexpected values

take vare of values that are coming but not described/specified. Allows for warnings

  consumerhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedconsumer

Consumer of data

  Actorhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedActor of Communication

Actor, i.e. indirect direction of communication

  bothhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedsender and/or receiver

both: sender+receiver resp. creator+consumer

  Devicehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedDevice for Activity

Device to be used for the activity

  screenhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedscreen

screen/display

  wideScreenhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedwide screen

wide screen/display

  radScreenhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedradiologic screen

screen/display capable of showing radiologic results

  printerhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedprinter

printer

  laserPrinterhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedlaser printer

laser printer

  matrixPrinterhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedmatrix printer

matrix printer

  portableStoragehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedportable storage device

portable storage device

  usbStickhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedusb stick

USB Stick

  tapeDrivehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedtape drive

tape drive

  Mediahttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMedia

different media to be used with specialised devices

  paperhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedpaper

paper

  stickhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedstick

stick

  dischttp://v2.hl7.org/fhir/CodeSystem/obligationProposeddisc

disc

  tapehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedtape

tape

  ElementLevelhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedLevel of Application

On which level to apply this obligation: root, node, or leaf

  roothttp://v2.hl7.org/fhir/CodeSystem/obligationProposedon root node

apply obligation on root node only

  nodehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedon any node

apply on any node that is not root or leaf

  leafhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedon leaf node

apply on leaf node only

  allhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedon all levels

application on all levels possible

  notRoothttp://v2.hl7.org/fhir/CodeSystem/obligationProposedall but root

apply on non-root nodes only

  notLeafhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedall but leaf

apply on non-leaf nodes

  Activityhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedActivity

Activities, aka of general obligation

  FunctionalObligationshttp://v2.hl7.org/fhir/CodeSystem/obligationProposedFunctional Obligations

Functional Obligation describing processsing functionalities

  ProducerObligationshttp://v2.hl7.org/fhir/CodeSystem/obligationProposedResource Producer Obligations
  OtherObligationshttp://v2.hl7.org/fhir/CodeSystem/obligationProposedResource Other Obligations

Other obligations beyond what has been described above.

  explainhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedexplain

provide an explanation in a capability statement how this element is handled

  documenthttp://v2.hl7.org/fhir/CodeSystem/obligationProposeddocument

document the use of this element in a separate document

  CombinedObligationshttp://v2.hl7.org/fhir/CodeSystem/obligationProposedcombined obligations

The children can be used to encode obligations for data elements. Terms in parenthesis are shown for readability. This list is not complete, and only provides some reasonable samples.

  SHOULDNOT:(populate)into-narrativehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD NOT populate into-narrative

Conformant applications SHOULD NOT populate element into narrative text.

  SHALLNOT:(populate)into-narrativehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL NOT populate into-narrative

Conformant applications SHALL NOT populate element into narrative text.

  SHOULD:sendhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD send the instance

Conformant applications SHOULD send the instance.

  SHOULD:persisthttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHOULD store the data

Conformant applications SHOULD store the data.

  ForeignStandardshttp://v2.hl7.org/fhir/CodeSystem/obligationProposedconcept codes from other standards

Other standards use specific terms for optionality/usage that should be conceptualized here.

  v2http://v2.hl7.org/fhir/CodeSystem/obligationProposedv2 concept codes

optionality/usage codes from v2

  v3http://v2.hl7.org/fhir/CodeSystem/obligationProposedV3 concept codes

optionality/usage codes from V3/CDA

  ihehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedIHE concept codes

optionality/usage codes from IHE

  ihe-rhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedIHE: R

required in IHE v2.x specs

  ihe-xhttp://v2.hl7.org/fhir/CodeSystem/obligationProposedIHE: X

XX in IHE v2.x specs

  xDThttp://v2.hl7.org/fhir/CodeSystem/obligationProposedGerman xDT standards

The German xDT standard family has a very specific set of codes and is just presented here for completeness and demonstration purposes


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