Clinical Document Architecture V2.1
2.1.0 - CI Build

Clinical Document Architecture V2.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: TN - JSON Profile

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/StructureDefinition/elementdefinition-namespace",
      "valueUri" : "urn:hl7-org:v3"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-no-order",
      "valueBoolean" : true
    }
  ],
  "url" : "http://hl7.org/fhir/cda/StructureDefinition/TN",
  "version" : "2.1.0",
  "name" : "TN",
  "title" : "TN: TrivialName (V3 Data Type)",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-07-14T20:15:37+00:00",
  "publisher" : "Health Level 7",
  "description" : "A restriction of entity name that is effectively a simple string used for a simple name for things and places.",
  "fhirVersion" : "4.0.1",
  "kind" : "logical",
  "abstract" : false,
  "type" : "TN",
  "baseDefinition" : "http://hl7.org/fhir/cda/StructureDefinition/EN",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "TN",
        "path" : "TN",
        "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
      },
      {
        "id" : "TN.nullFlavor",
        "path" : "TN.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"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
        }
      },
      {
        "id" : "TN.use",
        "path" : "TN.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" : "1",
        "base" : {
          "path" : "EN.use",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityNameUse"
        }
      },
      {
        "id" : "TN.delimiter",
        "path" : "TN.delimiter",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "EN.delimiter",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "TN.family",
        "path" : "TN.family",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "EN.family",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "TN.given",
        "path" : "TN.given",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "EN.given",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "TN.prefix",
        "path" : "TN.prefix",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "EN.prefix",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "TN.suffix",
        "path" : "TN.suffix",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "EN.suffix",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "TN.other",
        "path" : "TN.other",
        "representation" : [
          "xmlText"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "EN.other",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "TN.validTime",
        "path" : "TN.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/fhir/cda/StructureDefinition/IVL-TS"
          }
        ]
      },
      {
        "id" : "TN.delimiter",
        "path" : "TN.delimiter",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "TN.delimiter",
          "min" : 0,
          "max" : "0"
        }
      },
      {
        "id" : "TN.family",
        "path" : "TN.family",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "TN.family",
          "min" : 0,
          "max" : "0"
        }
      },
      {
        "id" : "TN.given",
        "path" : "TN.given",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "TN.given",
          "min" : 0,
          "max" : "0"
        }
      },
      {
        "id" : "TN.prefix",
        "path" : "TN.prefix",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "TN.prefix",
          "min" : 0,
          "max" : "0"
        }
      },
      {
        "id" : "TN.suffix",
        "path" : "TN.suffix",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "TN.suffix",
          "min" : 0,
          "max" : "0"
        }
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "TN",
        "path" : "TN",
        "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" : "TN.delimiter",
        "path" : "TN.delimiter",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "TN.family",
        "path" : "TN.family",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "TN.given",
        "path" : "TN.given",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "TN.prefix",
        "path" : "TN.prefix",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "TN.suffix",
        "path" : "TN.suffix",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "TN.use",
        "path" : "TN.use",
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityNameUse"
        }
      }
    ]
  }
}