FHIR IG Statistics: StructureDefinition/DV-CODED-TEXT

Resources that use this resource

Resources that this resource uses

Narrative

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

Generated Narrative: StructureDefinition DV-CODED-TEXT

Name	Flags	Card.	Type	Description & Constraints
DV_CODED_TEXT		0..*	DV_TEXT	Elements defined in Ancestors:value, hyperlink, formatting, mappings, language, encoding A text item whose value must be the rubric from a controlled terminology, the key (i.e. the 'code') of which is the defining_code attribute. In other words: a DV_CODED_TEXT is a combination of a CODE_PHRASE and the rubric of that term in the language in which the data were authored Instances of this logical model are not marked to be the target of a Reference
defining_code		1..1	CODE_PHRASE	Displayable rendition of the item, regardless of its underlying structure
Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "DV-CODED-TEXT",
  "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#_dv_coded_text_class"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-bind"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
      "valueCode": "element-view-as-leaf"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
      "valueCode": "element-view-defns-parent"
    },
    {
      "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/DV-CODED-TEXT",
  "version": "0.1.0",
  "name": "DV_CODED_TEXT",
  "title": "DV_CODED_TEXT",
  "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": "A text item whose value must be the rubric from a controlled terminology, the key (i.e. the 'code') of which is the defining_code attribute. In other words: a DV_CODED_TEXT is a combination of a CODE_PHRASE (effectively a code) and the rubric of that term, from a terminology service, in the language in which the data were authored.",
  "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/DV_CODED_TEXT",
  "baseDefinition": "http://openehr.org/fhir/StructureDefinition/DV-TEXT",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.1.0"
      }
    ],
    "element": [
      {
        "id": "DV_CODED_TEXT",
        "path": "DV_CODED_TEXT",
        "short": "A text item whose value must be the rubric from a controlled terminology, the key (i.e. the 'code') of which is the defining_code attribute. In other words: a DV_CODED_TEXT is a combination of a CODE_PHRASE and the rubric of that term in the language in which the data were authored",
        "definition": "A text item whose value must be the rubric from a controlled terminology, the key (i.e. the 'code') of which is the defining_code attribute. In other words: a DV_CODED_TEXT is a combination of a CODE_PHRASE (effectively a code) and the rubric of that term, from a terminology service, in the language in which the data were authored.\n\nSince DV_CODED_TEXT is a subtype of DV_TEXT, it can be used in place of it, effectively allowing the type DV_TEXT to mean a text item, which may optionally be coded.",
        "comment": "Misuse: If the intention is to represent a term code attached in some way to a fragment of plain text, DV_CODED_TEXT should not be used; instead use a DV_TEXT and a TERM_MAPPING to a CODE_PHRASE.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "DV_CODED_TEXT.value",
        "path": "DV_CODED_TEXT.value",
        "short": "Displayable rendition of the item, regardless of its underlying structure",
        "definition": "Displayable rendition of the item, regardless of its underlying structure. For DV_CODED_TEXT, this is the rubric of the complete term as provided by the terminology service.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "DV_TEXT.value",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_CODED_TEXT.hyperlink",
        "path": "DV_CODED_TEXT.hyperlink",
        "short": "DEPRECATED: this field is deprecated; use markdown",
        "definition": "DEPRECATED: this field is deprecated; use markdown link/text in the value attribute, and 'markdown' as the value of the formatting field.",
        "comment": "Original usage, prior to RM Release 1.0.4: Optional link sitting behind a section of plain text or coded term item.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "DV_TEXT.hyperlink",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-URI"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_CODED_TEXT.formatting",
        "path": "DV_CODED_TEXT.formatting",
        "short": "plain | plain_no_newlines | markdown",
        "definition": "If set, contains one of the following values:\n\n'plain': use for plain text, possibly containing newlines, but otherwise unformatted (same as Void);\n* 'plain_no_newlines': use for text containing no newlines or other formatting;\n* 'markdown': use for markdown formatted text, strongly recommended in the format of the CommonMark specification.\n\nDEPRECATED usage: contains a string of the form ```'name:value; name:value…​'``` , e.g. ```'font-weight : bold; font-family : Arial; font-size : 12pt;'```. Values taken from W3C CSS2 properties lists for background and font",
        "min": 0,
        "max": "1",
        "base": {
          "path": "DV_TEXT.formatting",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_CODED_TEXT.mappings",
        "path": "DV_CODED_TEXT.mappings",
        "short": "Terms from other terminologies most closely matching this term",
        "definition": "Terms from other terminologies most closely matching this term, typically used where the originator (e.g. pathology lab) of information uses a local terminology but also supplies one or more equivalents from well known terminologies (e.g. LOINC).",
        "min": 0,
        "max": "*",
        "base": {
          "path": "DV_TEXT.mappings",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/TERM-MAPPING"
          }
        ],
        "isModifier": false
      },
      {
        "id": "DV_CODED_TEXT.language",
        "path": "DV_CODED_TEXT.language",
        "short": "Optional indicator of the localised language in which the value is written",
        "definition": "Optional indicator of the localised language in which the value is written. Coded from openEHR Code Set languages . Only used when either the text object is in a different language from the enclosing ENTRY, or else the text object is being used outside of an ENTRY or other enclosing structure which indicates the language.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "DV_TEXT.language",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
          }
        ],
        "isModifier": false,
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
        }
      },
      {
        "id": "DV_CODED_TEXT.encoding",
        "path": "DV_CODED_TEXT.encoding",
        "short": "Name of character encoding scheme in which this value is encoded",
        "definition": "Name of character encoding scheme in which this value is encoded. Coded from openEHR Code Set character sets . Unicode is the default assumption in openEHR, with UTF-8 being the assumed encoding. This attribute allows for variations from these assumptions.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "DV_TEXT.encoding",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
          }
        ],
        "isModifier": false,
        "binding": {
          "strength": "required",
          "valueSet": "https://specifications.openehr.org/fhir/valueset-character_sets"
        }
      },
      {
        "id": "DV_CODED_TEXT.defining-code",
        "path": "DV_CODED_TEXT.defining_code",
        "short": "Displayable rendition of the item, regardless of its underlying structure",
        "definition": "Displayable rendition of the item, regardless of its underlying structure. For DV_CODED_TEXT, this is the rubric of the complete term as provided by the terminology service.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "DV_CODED_TEXT.defining_code",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
          }
        ],
        "isModifier": false
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "DV_CODED_TEXT",
        "path": "DV_CODED_TEXT",
        "short": "A text item whose value must be the rubric from a controlled terminology, the key (i.e. the 'code') of which is the defining_code attribute. In other words: a DV_CODED_TEXT is a combination of a CODE_PHRASE and the rubric of that term in the language in which the data were authored",
        "definition": "A text item whose value must be the rubric from a controlled terminology, the key (i.e. the 'code') of which is the defining_code attribute. In other words: a DV_CODED_TEXT is a combination of a CODE_PHRASE (effectively a code) and the rubric of that term, from a terminology service, in the language in which the data were authored.\n\nSince DV_CODED_TEXT is a subtype of DV_TEXT, it can be used in place of it, effectively allowing the type DV_TEXT to mean a text item, which may optionally be coded.",
        "comment": "Misuse: If the intention is to represent a term code attached in some way to a fragment of plain text, DV_CODED_TEXT should not be used; instead use a DV_TEXT and a TERM_MAPPING to a CODE_PHRASE.",
        "min": 0,
        "max": "*",
        "isModifier": false
      },
      {
        "id": "DV_CODED_TEXT.defining-code",
        "path": "DV_CODED_TEXT.defining_code",
        "short": "Displayable rendition of the item, regardless of its underlying structure",
        "definition": "Displayable rendition of the item, regardless of its underlying structure. For DV_CODED_TEXT, this is the rubric of the complete term as provided by the terminology service.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
          }
        ],
        "isModifier": false
      }
    ]
  }
}