Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft

This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: TN - JSON Profile

Active as of 2023-01-16

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-draft1",
  "name" : "TN",
  "title" : "TN: TrivialName (V3 Data Type)",
  "status" : "active",
  "experimental" : false,
  "date" : "2023-01-16T16:39:50+11:00",
  "publisher" : "Health Level 7",
  "contact" : [
    {
      "name" : "HL7 International - Cross-Group Projects",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cgp"
        },
        {
          "system" : "email",
          "value" : "cgp@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-snapshot3",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "EN",
  "baseDefinition" : "http://hl7.org/fhir/cda/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" : "*"
        },
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "hasValue() or (children().count() > id.count())",
            "source" : "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "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"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
        }
      },
      {
        "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" : "1",
        "base" : {
          "path" : "EN.use",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-EntityNameUse"
        }
      },
      {
        "id" : "EN.delimiter",
        "path" : "EN.delimiter",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "EN.delimiter",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "EN.family",
        "path" : "EN.family",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "EN.family",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "EN.given",
        "path" : "EN.given",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "EN.given",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "EN.prefix",
        "path" : "EN.prefix",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "EN.prefix",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "EN.suffix",
        "path" : "EN.suffix",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "EN.suffix",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id" : "EN.other",
        "path" : "EN.other",
        "representation" : [
          "xmlText"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "EN.other",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "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/fhir/cda/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://terminology.hl7.org/ValueSet/v3-EntityNameUse"
        }
      },
      {
        "id" : "EN.delimiter",
        "path" : "EN.delimiter",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "EN.family",
        "path" : "EN.family",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "EN.given",
        "path" : "EN.given",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "EN.prefix",
        "path" : "EN.prefix",
        "min" : 0,
        "max" : "0"
      },
      {
        "id" : "EN.suffix",
        "path" : "EN.suffix",
        "min" : 0,
        "max" : "0"
      }
    ]
  }
}