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 Content-creation-oriented Obligation Codes VS (Experimental)

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

This valueset represents the proposed obligation codes for creating the content.

References

This value set is not used here; it may be used elsewhere (e.g. specifications and/or implementations that use this content)

Logical Definition (CLD)

  • Include these codes as defined in http://v2.hl7.org/fhir/CodeSystem/obligationProposed
    CodeDisplayDefinition
    MAY:populateMAY populate with dataConformant applications MAY take and provide data.
    MAY:populate:missingMAY populate data element with why orig data is missingConformant applications MAY populate the element why the original data is missing.
    MAY:populate:more-structureMAY populate the data in more structured wayConformant applications are allowed to populate the data with more structure. For example, to split an address line into streetname and house number.
    MAY:(populate)from-uiMAY populate with data taken from uiConformant applications MAY take data from a UI and provide it.
    MAY:(populate)into-narrativeMAY populate into-narrativeConformant applications MAY populate element into narrative text as well.
    SHOULD:populateSHOULD populate with dataConformant applications SHOULD take and provide data.
    SHOULD:(populate)from-uiSHOULD populate with data taken from uiConformant applications SHOULD take data from a UI and provide it.
    SHALL:populateSHALL populate with dataConformant applications SHOULD take and provide data.
    SHALL:(populate)from-uiSHALL populate data taken from uiConformant applications SHALL take data from a UI and provide it.
    SHALL:(populate)from-ui:more-detailsSHALL populate with data taken from ui perhaps with more detailsConformant applications SHALL take data from a UI and bring it into the instance. It is allowed to provide more details then specified.
    SHALL:(populate)into-narrativeSHALL populate into-narrativeConformant applications SHALL populate element into narrative text as well.
    SHOULD:(populate)into-narrativeSHOULD populate into-narrativeConformant applications SHOULD populate element into narrative text as well.
    SHOULDNOT:(populate)into-narrativeSHOULD NOT populate into-narrativeConformant applications SHOULD NOT populate element into narrative text.
    SHALLNOT:(populate):in-narrativeSHALL NOT add to narrativeConformant applications SHALL NOT add this data to the narrative.
    SHALLNOT:populate:more-detailsSHALL NOT populate more data than is specifiedConformant applications SHALL NOT populatae more data than is specified. The specification is closed.
    SHALLNOT:populate:missingSHALL NOT populate info about missing data, ie. data absent reasonsConformant applications SHALL NOT populate a reason for missing information.
    SHALLNOT:(populate)into-narrativeSHALL NOT populate into-narrativeConformant applications SHALL NOT populate element into narrative text.

 

Expansion

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

This value set contains 17 concepts.

CodeSystemDisplayDefinition
  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.

  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:(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:(populate)into-narrativehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedMAY populate into-narrative

Conformant applications MAY populate element into narrative text as well.

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

Conformant applications SHOULD take and provide data.

  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.

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

Conformant applications SHOULD take and provide data.

  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:(populate)into-narrativehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL populate into-narrative

Conformant applications SHALL 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.

  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):in-narrativehttp://v2.hl7.org/fhir/CodeSystem/obligationProposedSHALL NOT add to narrative

Conformant applications SHALL NOT add this data to the narrative.

  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.

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

Conformant applications SHALL NOT populate element into narrative text.


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