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

FHIR IG analytics

Packageobligation
Resource TypeCodeSystem
IdCodeSystem-dataExpectation.json
FHIR VersionR5
Sourcehttps://build.fhir.org/ig/frankoemig/obligation/CodeSystem-dataExpectation.html
URLhttp://v2.hl7.org/fhir/CodeSystem/dataExpectation
Version0.1.0
Statusactive
Date2022-10-10
NameDataExpectation
TitleData Expectation Codes
DescriptionThis is the codesystem describing exptectations for Data Handling. It has to be discussed whether these codes can become more specialised activities!?
Contentcomplete

Resources that use this resource

ValueSet
obligation#currentdataExpectationData Expectation ValueSet

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: CodeSystem dataExpectation

Properties

This code system defines the following properties for its concepts

NameCodeURITypeDescription
Parentparenthttp://hl7.org/fhir/concept-properties#parentcode
actoractorcodeassociated actor, i.e. to whom it may apply

Concepts

This case-sensitive code system http://v2.hl7.org/fhir/CodeSystem/dataExpectation defines the following codes in a Is-A hierarchy:

LvlCodeDisplayDefinitionParentactor
1expected expecteddata fits to expectations/specification
2  unaltered preservepreserve what you getexpected
3    exactly exactlyexactly what is specified, nothing elseunaltered
2  modify modifyallow for modifications of the dataexpectedconsumer
3    assocation assocationtaken by associationmodify
3    equivalent equivalentin an equivalent waymodify
3    translate translateData received is preserved by 1:1 mapping/translation to an internal value that is semantically equivalent, that preserves the temporal aspect of the translation.modify
4      semantically translate semanticallyTwo 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.translate
4      clinically translate clinicallyTwo 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.translate
3    reference referenceUse 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.modify
3    truncate cut off datacut off remaining characters from the data thereby shortening the datamodify
3    more-details additional details/valuesextends the expected data with more/own information, e.g. appartment if street is specifiedmodifycreator
3    more-structure additional substructuresprovides the data with more granular details, e.g. house number for an address linemodifycreator
3    missing data is missing/not availableprovide a null-flavor/absent reasonmodifycreator
3    constant added as a constantthis value has no valid representation or meaning in the sending application, it is just added because it is required to be theremodify
1unexpected unexpected valueshow to manage unexpected data (as sender or receiver)
2  replaces new/other valuesreplaces the expected data by something elseunexpected
2  consider consider unexpected valuestake vare of values that are coming but not described/specified. Allows for warningsunexpected

Source1

{
  "resourceType": "CodeSystem",
  "id": "dataExpectation",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://v2.hl7.org/fhir/CodeSystem/dataExpectation",
  "version": "0.1.0",
  "name": "DataExpectation",
  "title": "Data Expectation Codes",
  "status": "active",
  "experimental": true,
  "date": "2022-10-10",
  "description": "This is the codesystem describing exptectations for Data Handling.\nIt has to be discussed whether these codes can become more specialised activities!?",
  "caseSensitive": true,
  "valueSet": "http://v2.hl7.org/fhir/ValueSet/dataExpectation",
  "hierarchyMeaning": "is-a",
  "content": "complete",
  "count": 18,
  "property": [
    {
      "code": "parent",
      "uri": "http://hl7.org/fhir/concept-properties#parent",
      "type": "code"
    },
    {
      "code": "actor",
      "description": "associated actor, i.e. to whom it may apply",
      "type": "code"
    }
  ],
  "concept": [
    {
      "code": "expected",
      "display": "expected",
      "definition": "data fits to expectations/specification",
      "concept": [
        {
          "code": "unaltered",
          "display": "preserve",
          "definition": "preserve what you get",
          "property": [
            {
              "code": "parent",
              "valueCode": "expected"
            }
          ],
          "concept": [
            {
              "code": "exactly",
              "display": "exactly",
              "definition": "exactly what is specified, nothing else",
              "property": [
                {
                  "code": "parent",
                  "valueCode": "unaltered"
                }
              ]
            }
          ]
        },
        {
          "code": "modify",
          "display": "modify",
          "definition": "allow for modifications of the data",
          "property": [
            {
              "code": "parent",
              "valueCode": "expected"
            },
            {
              "code": "actor",
              "valueCode": "consumer"
            }
          ],
          "concept": [
            {
              "code": "assocation",
              "display": "assocation",
              "definition": "taken by association",
              "property": [
                {
                  "code": "parent",
                  "valueCode": "modify"
                }
              ]
            },
            {
              "code": "equivalent",
              "display": "equivalent",
              "definition": "in an equivalent way",
              "property": [
                {
                  "code": "parent",
                  "valueCode": "modify"
                }
              ]
            },
            {
              "code": "translate",
              "display": "translate",
              "definition": "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.",
              "property": [
                {
                  "code": "parent",
                  "valueCode": "modify"
                }
              ],
              "concept": [
                {
                  "code": "semantically",
                  "display": "translate semantically",
                  "definition": "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.",
                  "property": [
                    {
                      "code": "parent",
                      "valueCode": "translate"
                    }
                  ]
                },
                {
                  "code": "clinically",
                  "display": "translate clinically",
                  "definition": "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.",
                  "property": [
                    {
                      "code": "parent",
                      "valueCode": "translate"
                    }
                  ]
                }
              ]
            },
            {
              "code": "reference",
              "display": "reference",
              "definition": "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.",
              "property": [
                {
                  "code": "parent",
                  "valueCode": "modify"
                }
              ]
            },
            {
              "code": "truncate",
              "display": "cut off data",
              "definition": "cut off remaining characters from the data thereby shortening the data",
              "property": [
                {
                  "code": "parent",
                  "valueCode": "modify"
                }
              ]
            },
            {
              "code": "more-details",
              "display": "additional details/values",
              "definition": "extends the expected data with more/own information, e.g. appartment if street is specified",
              "property": [
                {
                  "code": "parent",
                  "valueCode": "modify"
                },
                {
                  "code": "actor",
                  "valueCode": "creator"
                }
              ]
            },
            {
              "code": "more-structure",
              "display": "additional substructures",
              "definition": "provides the data with more granular details, e.g. house number for an address line",
              "property": [
                {
                  "code": "parent",
                  "valueCode": "modify"
                },
                {
                  "code": "actor",
                  "valueCode": "creator"
                }
              ]
            },
            {
              "code": "missing",
              "display": "data is missing/not available",
              "definition": "provide a null-flavor/absent reason",
              "property": [
                {
                  "code": "parent",
                  "valueCode": "modify"
                },
                {
                  "code": "actor",
                  "valueCode": "creator"
                }
              ]
            },
            {
              "code": "constant",
              "display": "added as a constant",
              "definition": "this value has no valid representation or meaning in the sending application, it is just added because it is required to be there",
              "property": [
                {
                  "code": "parent",
                  "valueCode": "modify"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "code": "unexpected",
      "display": "unexpected values",
      "definition": "how to manage unexpected data (as sender or receiver)",
      "concept": [
        {
          "code": "replaces",
          "display": "new/other values",
          "definition": "replaces the expected data by something else",
          "property": [
            {
              "code": "parent",
              "valueCode": "unexpected"
            }
          ]
        },
        {
          "code": "consider",
          "display": "consider unexpected values",
          "definition": "take vare of values that are coming but not described/specified. Allows for warnings",
          "property": [
            {
              "code": "parent",
              "valueCode": "unexpected"
            }
          ]
        }
      ]
    }
  ]
}