Clinical Document Architecture
2.0.0-sd-202406-matchbox-patch - release

Clinical Document Architecture - Local Development build (v2.0.0-sd-202406-matchbox-patch) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: TN - JSON Profile

Active as of 2024-06-19

JSON representation of the TN logical model.

Raw json | Download


{
  "resourceType" : "StructureDefinition",
  "id" : "TN",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>A restriction of entity name that is effectively a simple string used for a simple name for things and places.</p>\n    </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
      "_valueBoolean" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
            "valueCode" : "not-applicable"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
      "valueUri" : "urn:hl7-org:v3"
    },
    {
      "url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    }
  ],
  "url" : "http://hl7.org/cda/stds/core/StructureDefinition/TN",
  "version" : "2.0.0-sd-202406-matchbox-patch",
  "name" : "TN",
  "title" : "TN: TrivialName (V3 Data Type)",
  "status" : "active",
  "experimental" : false,
  "date" : "2024-06-19T17:47:42+02:00",
  "publisher" : "Health Level 7",
  "contact" : [
    {
      "name" : "HL7 International - Structured Documents",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/structure"
        },
        {
          "system" : "email",
          "value" : "structdog@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "A restriction of entity name that is effectively a simple string used for a simple name for things and places.",
  "fhirVersion" : "5.0.0",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "http://hl7.org/cda/stds/core/StructureDefinition/EN",
  "baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/EN",
  "derivation" : "constraint",
  "snapshot" : {
    "element" : [
      {
        "id" : "EN",
        "path" : "EN",
        "short" : "Base for all types and resources",
        "definition" : "A restriction of entity name that is effectively a simple string used for a simple name for things and places.",
        "min" : 1,
        "max" : "*",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "EN.nullFlavor",
        "path" : "EN.nullFlavor",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Exceptional Value Detail",
        "definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "ANY.nullFlavor",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id" : "EN.use",
        "path" : "EN.use",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Use Code",
        "definition" : "A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "EN.use",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "code",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse"
        }
      },
      {
        "id" : "EN.item",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group",
            "valueBoolean" : true
          }
        ],
        "path" : "EN.item",
        "definition" : "A series of items that constitute the name.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "EN.item",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/StructureDefinition/Base"
          }
        ],
        "constraint" : [
          {
            "key" : "EN-1",
            "severity" : "error",
            "human" : "Can only have only one of the possible item elements in each choice",
            "expression" : "(delimiter | family | given | prefix | suffix | xmlText).count() = 1",
            "source" : "http://hl7.org/cda/stds/core/StructureDefinition/EN"
          }
        ]
      },
      {
        "id" : "EN.item.delimiter",
        "path" : "EN.item.delimiter",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "EN.item.delimiter",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "EN.item.family",
        "path" : "EN.item.family",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "EN.item.family",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "EN.item.given",
        "path" : "EN.item.given",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "EN.item.given",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "EN.item.prefix",
        "path" : "EN.item.prefix",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "EN.item.prefix",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "EN.item.suffix",
        "path" : "EN.item.suffix",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "EN.item.suffix",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "EN.item.xmlText",
        "path" : "EN.item.xmlText",
        "representation" : [
          "xmlText"
        ],
        "short" : "Allows for mixed text content",
        "comment" : "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "EN.item.xmlText",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string",
            "profile" : [
              🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id" : "EN.validTime",
        "path" : "EN.validTime",
        "label" : "Valid Time",
        "definition" : "An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "EN.validTime",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "EN",
        "path" : "EN",
        "definition" : "A restriction of entity name that is effectively a simple string used for a simple name for things and places.",
        "min" : 1,
        "max" : "*"
      },
      {
        "id" : "EN.use",
        "path" : "EN.use",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse"
        }
      },
      {
        "id" : "EN.item.delimiter",
        "path" : "EN.item.delimiter",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "EN.item.family",
        "path" : "EN.item.family",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "EN.item.given",
        "path" : "EN.item.given",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "EN.item.prefix",
        "path" : "EN.item.prefix",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "EN.item.suffix",
        "path" : "EN.item.suffix",
        "min" : 0,
        "max" : "0"
      }
    ]
  }
}