STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Ccda/TEL.json

Raw JSON (canonical form)

Logical Model V3 Data type TEL (TelecommunicationAddress)

{
  "resourceType": "StructureDefinition",
  "id": "TEL",
  "extension": [
    {
      "url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace",
      "valueUri": "urn:hl7-org:v3"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/TEL",
  "name": "V3 Data type TEL (TelecommunicationAddress)",
  "display": "V3 Data type TEL (TelecommunicationAddress)",
  "status": "active",
  "experimental": false,
  "publisher": "HL7",
  "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.",
  "kind": "logical",
  "abstract": false,
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ANY",
  "snapshot": {
    "element": [
      {
        "path": "TEL",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ]
      },
      {
        "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",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/v3-NullFlavor"
          }
        }
      },
      {
        "path": "TEL.value",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "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": "IVL_TS"
          },
          {
            "code": "EIVL"
          },
          {
            "code": "PIVL"
          },
          {
            "code": "SXPR_TS"
          }
        ]
      },
      {
        "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",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/v3-AddressUse"
          }
        }
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "TEL",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ]
      },
      {
        "path": "TEL.value",
        "representation": [
          "xmlAttr"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "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": "IVL_TS"
          },
          {
            "code": "EIVL"
          },
          {
            "code": "PIVL"
          },
          {
            "code": "SXPR_TS"
          }
        ]
      },
      {
        "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",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/v3-AddressUse"
          }
        }
      }
    ]
  }
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.