FHIR IG Statistics: StructureDefinition/TERM-MAPPING

Resources that use this resource

Resources that this resource uses

Narrative

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

Generated Narrative: StructureDefinition TERM-MAPPING

Name	Flags	Card.	Type	Description & Constraints
TERM_MAPPING		0..*	Base	Items which are truly boolean data
match	C	1..1	string	> | = | < | ?: The relative match of the target term with respect to the mapped text item Constraints: MatchValid
purpose		0..1	DV_CODED_TEXT	Purpose of the mapping Binding: Term Mapping Purpose (required)
target		1..1	CODE_PHRASE	The target term of the mapping
Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "TERM-MAPPING",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
      "valueUrl": "https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_term_mapping_class"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 3,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "informative",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
          }
        ]
      }
    }
  ],
  "url": "http://openehr.org/fhir/StructureDefinition/TERM-MAPPING",
  "version": "0.1.0",
  "name": "TERM_MAPPING",
  "title": "TERM_MAPPING",
  "status": "active",
  "experimental": false,
  "date": "2023-06-27T18:45:58+10:00",
  "publisher": "openEHR + HL7",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.openehr.org"
        }
      ]
    }
  ],
  "description": "Items which are truly boolean data, such as true/false or yes/no answers. For such data, it is important to devise the meanings (usually questions in subjective data) carefully, so that the only allowed results are in fact true or false.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://openehr.org/fhir/StructureDefinition/TERM_MAPPING",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "TERM_MAPPING",
        "path": "TERM_MAPPING",
        "short": "Items which are truly boolean data",
        "definition": "Items which are truly boolean data, such as true/false or yes/no answers. For such data, it is important to devise the meanings (usually questions in subjective data) carefully, so that the only allowed results are in fact true or false.",
        "comment": "Misuse: The TERM_MAPPING class should not be used as a replacement for naively modelled enumerated types such as male/female etc. Such values should be coded, and in any case the enumeration often has more than two values.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "TERM_MAPPING.match",
        "path": "TERM_MAPPING.match",
        "short": "> | = | < | ?: The relative match of the target term with respect to the mapped text item",
        "definition": "The relative match of the target term with respect to the mapped text item. Result meanings:\n\n* '>': the mapping is to a broader term e.g. orginal text = arbovirus infection , target = viral infection\n* '=': the mapping is to a (supposedly) equivalent to the original item\n* '<': the mapping is to a narrower term. e.g. original text = diabetes , mapping = diabetes mellitus.\n* '?': the kind of mapping is unknown.\n\nThe first three values are taken from the ISO standards 2788 ( Guide to Establishment and development of monolingual thesauri) and 5964 (Guide to Establishment and development of multilingual thesauri).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "TERM_MAPPING.match",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "MatchValid",
            "severity": "error",
            "human": "match must be >, =, < or ?",
            "expression": "$this = '<' or $this = '=' or $this = '>' or $this = '?'"
          }
        ],
        "isModifier": false
      },
      {
        "id": "TERM_MAPPING.purpose",
        "path": "TERM_MAPPING.purpose",
        "short": "Purpose of the mapping",
        "definition": "Purpose of the mapping e.g. 'automated data mining', 'billing', 'interoperability'.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "TERM_MAPPING.purpose",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"
          }
        ],
        "isModifier": false,
        "binding": {
          "strength": "required",
          "valueSet": "https://specifications.openehr.org/fhir/valueset-term_mapping_purpose"
        }
      },
      {
        "id": "TERM_MAPPING.target",
        "path": "TERM_MAPPING.target",
        "short": "The target term of the mapping",
        "definition": "The target term of the mapping.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "TERM_MAPPING.target",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
          }
        ],
        "isModifier": false
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "TERM_MAPPING",
        "path": "TERM_MAPPING",
        "short": "Items which are truly boolean data",
        "definition": "Items which are truly boolean data, such as true/false or yes/no answers. For such data, it is important to devise the meanings (usually questions in subjective data) carefully, so that the only allowed results are in fact true or false.",
        "comment": "Misuse: The TERM_MAPPING class should not be used as a replacement for naively modelled enumerated types such as male/female etc. Such values should be coded, and in any case the enumeration often has more than two values.",
        "min": 0,
        "max": "*",
        "isModifier": false
      },
      {
        "id": "TERM_MAPPING.match",
        "path": "TERM_MAPPING.match",
        "short": "> | = | < | ?: The relative match of the target term with respect to the mapped text item",
        "definition": "The relative match of the target term with respect to the mapped text item. Result meanings:\n\n* '>': the mapping is to a broader term e.g. orginal text = arbovirus infection , target = viral infection\n* '=': the mapping is to a (supposedly) equivalent to the original item\n* '<': the mapping is to a narrower term. e.g. original text = diabetes , mapping = diabetes mellitus.\n* '?': the kind of mapping is unknown.\n\nThe first three values are taken from the ISO standards 2788 ( Guide to Establishment and development of monolingual thesauri) and 5964 (Guide to Establishment and development of multilingual thesauri).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "MatchValid",
            "severity": "error",
            "human": "match must be >, =, < or ?",
            "expression": "$this = '<' or $this = '=' or $this = '>' or $this = '?'"
          }
        ],
        "isModifier": false
      },
      {
        "id": "TERM_MAPPING.purpose",
        "path": "TERM_MAPPING.purpose",
        "short": "Purpose of the mapping",
        "definition": "Purpose of the mapping e.g. 'automated data mining', 'billing', 'interoperability'.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"
          }
        ],
        "isModifier": false,
        "binding": {
          "strength": "required",
          "valueSet": "https://specifications.openehr.org/fhir/valueset-term_mapping_purpose"
        }
      },
      {
        "id": "TERM_MAPPING.target",
        "path": "TERM_MAPPING.target",
        "short": "The target term of the mapping",
        "definition": "The target term of the mapping.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
          }
        ],
        "isModifier": false
      }
    ]
  }
}