Clinical Document Architecture V2.0.1
2.1.0 - CI Build

Clinical Document Architecture V2.0.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: TEL - JSON Profile

JSON representation of the TEL logical model.

Raw json | Download


{
  "resourceType" : "StructureDefinition",
  "id" : "TEL",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>A telephone number (voice or fax), e-mail address, or other locator for a resource (information or service) mediated by telecommunication equipment. The address is specified as a Universal Resource Locator (URL) qualified by time specification and use codes that help in deciding which address to use for a given time and purpose.</p>\n    </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
      "valueUri" : "urn:hl7-org:v3"
    }
  ],
  "url" : "http://hl7.org/fhir/cda/StructureDefinition/TEL",
  "version" : "2.1.0",
  "name" : "TEL",
  "title" : "TEL: TelecommunicationAddress (V3 Data Type)",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-04-15T20:51:17+00:00",
  "publisher" : "Health Level 7",
  "description" : "A telephone number (voice or fax), e-mail address, or other locator for a resource mediated by telecommunication equipment. The address is specified as a Universal Resource Locator (URL) qualified by time specification and use codes that help in deciding which address to use for a given time and purpose.",
  "fhirVersion" : "4.0.1",
  "kind" : "logical",
  "abstract" : false,
  "type" : "TEL",
  "baseDefinition" : "http://hl7.org/fhir/cda/StructureDefinition/ANY",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "TEL",
        "path" : "TEL",
        "definition" : "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
        "min" : 1,
        "max" : "*",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false
      },
      {
        "id" : "TEL.nullFlavor",
        "path" : "TEL.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" : "TEL.value",
        "path" : "TEL.value",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "TEL.value",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "uri"
          }
        ]
      },
      {
        "id" : "TEL.useablePeriod",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
            "valueString" : "SXPR-TS"
          }
        ],
        "path" : "TEL.useablePeriod",
        "representation" : [
          "typeAttr"
        ],
        "label" : "Useable Period",
        "definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "TEL.useablePeriod",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
          },
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS"
          },
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS"
          },
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS"
          }
        ]
      },
      {
        "id" : "TEL.use",
        "path" : "TEL.use",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Use Code",
        "definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "TEL.use",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-AddressUse"
        }
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "TEL",
        "path" : "TEL",
        "min" : 1,
        "max" : "*"
      },
      {
        "id" : "TEL.value",
        "path" : "TEL.value",
        "representation" : [
          "xmlAttr"
        ],
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "uri"
          }
        ]
      },
      {
        "id" : "TEL.useablePeriod",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype",
            "valueString" : "SXPR-TS"
          }
        ],
        "path" : "TEL.useablePeriod",
        "representation" : [
          "typeAttr"
        ],
        "label" : "Useable Period",
        "definition" : "Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"
          },
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS"
          },
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS"
          },
          {
            "code" : "http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS"
          }
        ]
      },
      {
        "id" : "TEL.use",
        "path" : "TEL.use",
        "representation" : [
          "xmlAttr"
        ],
        "label" : "Use Code",
        "definition" : "One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "code"
          }
        ],
        "binding" : {
          "strength" : "required",
          "valueSet" : "http://terminology.hl7.org/ValueSet/v3-AddressUse"
        }
      }
    ]
  }
}