FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.terminology.r3
Resource TypeCodeSystem
IdCodeSystem-v3-URLScheme.json
FHIR VersionR3

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CodeSystem v3-URLScheme

Language: en

Properties

This code system defines the following properties for its concepts

NameCodeURITypeDescription
Statusstatushttp://hl7.org/fhir/concept-properties#statuscodeDesignation of a concept's state. Normally is not populated unless the state is retired..

Concepts

This case-sensitive code system http://terminology.hl7.org/CodeSystem/v3-URLScheme defines the following codes in a Is-A hierarchy:

CodeDisplayDefinitionStatus
cid Content ID

Description: cid: is the most common mechanism used in webservices. A cid: reference points from the SOAP body to other content in the mime package in which the SOAP envelope is wrapped

active
file File

Host-specific local file names [RCF 1738]. Note that the file scheme works only for local files. There is little use for exchanging local file names between systems, since the receiving system likely will not be able to access the file.

active
ftp FTP

The File Transfer Protocol (FTP) [RFC 1738].

active
hl7-att HL7 Attachment

Description: A reference to an HL7 attachment by it's identifier, which takes the form hl7-att:[II.literal], such as hl7-att:2.1.16.3.9.12345.2.39.3:ABC123

active
http HTTP

Hypertext Transfer Protocol [RFC 2068].

http://www.ietf.org/rfc/rfc2068.txt

active
mailto Mailto

Electronic mail address [RFC 2368]

http://www.ietf.org/rfc/rfc2368.txt

active
mllp MLLP

Description: Mimimal Lower Layer Protocol. See Transport Specification: MLLP, Release 2 (HL7 V3 Transport specification).

active
nfs NFS

Network File System protocol [RFC 2224]. Some sites use NFS servers to share data files.

http://www.ietf.org/rfc/rfc2224.txt

active
tel Telephone

A voice telephone number [http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt].

active
telnet Telnet

Reference to interactive sessions [RFC 1738]. Some sites, (e.g., laboratories) have TTY based remote query sessions that can be accessed through telnet.

http://www.ietf.org/rfc/rfc1738.txt

active
fax Fax

A telephone number served by a fax device [http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt].

retired
modem Modem

A telephone number served by a modem device [http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt].

retired
x-text-fax Fax

Description: A telephone number served by a fax device [http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt]

retired
x-text-tel Text Telephone

Description: A text telephone - a telephone which is designed for use by the hearing-impaired

Notes:

  • x-text-fax is required to replace fax, since this has been deprecated by W3C.
  • hl7-att is associated with a series of rules that must be followed. These rules are documented in Datatypes R2
  • This domain is external and extensible, so documenting this simply clarifies consistent usage for these use cases.
retired

Source1

{
  "resourceType": "CodeSystem",
  "id": "v3-URLScheme",
  "language": "en",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://terminology.hl7.org/CodeSystem/v3-URLScheme",
  "identifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:oid:2.16.840.1.113883.5.143"
  },
  "version": "4.0.0",
  "name": "URLScheme",
  "title": "Universal Resource Locator Scheme",
  "status": "active",
  "experimental": false,
  "date": "2019-03-20",
  "publisher": "Health Level Seven International",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org"
        },
        {
          "system": "email",
          "value": "hq@HL7.org"
        }
      ]
    }
  ],
  "description": "A Universal Resource Locator (URL) is a type of telecommunications address specified as Internet standard RFC 1738 \\[http://www.isi.edu/in-notes/rfc1738.txt\\]. The URL specifies the protocol and the contact point defined by that protocol for the resource.",
  "copyright": "This material derives from the HL7 Terminology THO. THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html",
  "caseSensitive": true,
  "hierarchyMeaning": "is-a",
  "content": "complete",
  "property": [
    {
      "code": "status",
      "uri": "http://hl7.org/fhir/concept-properties#status",
      "description": "Designation of a concept's state.  Normally is not populated unless the state is retired..",
      "type": "code"
    }
  ],
  "concept": [
    {
      "code": "cid",
      "display": "Content ID",
      "definition": "**Description:** cid: is the most common mechanism used in webservices. A cid: reference points from the SOAP body to other content in the mime package in which the SOAP envelope is wrapped",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "code": "file",
      "display": "File",
      "definition": "Host-specific local file names \\[RCF 1738\\]. Note that the file scheme works only for local files. There is little use for exchanging local file names between systems, since the receiving system likely will not be able to access the file.",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "code": "ftp",
      "display": "FTP",
      "definition": "The File Transfer Protocol (FTP) \\[RFC 1738\\].",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "code": "hl7-att",
      "display": "HL7 Attachment",
      "definition": "**Description:** A reference to an HL7 attachment by it's identifier, which takes the form hl7-att:\\[II.literal\\], such as hl7-att:2.1.16.3.9.12345.2.39.3:ABC123",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "code": "http",
      "display": "HTTP",
      "definition": "Hypertext Transfer Protocol \\[RFC 2068\\].\r\n\r\nhttp://www.ietf.org/rfc/rfc2068.txt",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "code": "mailto",
      "display": "Mailto",
      "definition": "Electronic mail address \\[RFC 2368\\]\r\n\r\nhttp://www.ietf.org/rfc/rfc2368.txt",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "code": "mllp",
      "display": "MLLP",
      "definition": "**Description:** Mimimal Lower Layer Protocol. See Transport Specification: MLLP, Release 2 (HL7 V3 Transport specification).",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "code": "nfs",
      "display": "NFS",
      "definition": "Network File System protocol \\[RFC 2224\\]. Some sites use NFS servers to share data files.\r\n\r\nhttp://www.ietf.org/rfc/rfc2224.txt",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "code": "tel",
      "display": "Telephone",
      "definition": "A voice telephone number \\[http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt\\].",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "code": "telnet",
      "display": "Telnet",
      "definition": "Reference to interactive sessions \\[RFC 1738\\]. Some sites, (e.g., laboratories) have TTY based remote query sessions that can be accessed through telnet.\r\n\r\nhttp://www.ietf.org/rfc/rfc1738.txt",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "code": "fax",
      "display": "Fax",
      "definition": "A telephone number served by a fax device \\[http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt\\].",
      "property": [
        {
          "code": "status",
          "valueCode": "retired"
        }
      ]
    },
    {
      "code": "modem",
      "display": "Modem",
      "definition": "A telephone number served by a modem device \\[http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt\\].",
      "property": [
        {
          "code": "status",
          "valueCode": "retired"
        }
      ]
    },
    {
      "code": "x-text-fax",
      "display": "Fax",
      "definition": "**Description:** A telephone number served by a fax device \\[http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt\\]",
      "property": [
        {
          "code": "status",
          "valueCode": "retired"
        }
      ]
    },
    {
      "code": "x-text-tel",
      "display": "Text Telephone",
      "definition": "**Description:** A text telephone - a telephone which is designed for use by the hearing-impaired\r\n\r\n**Notes:**\r\n\r\n *  x-text-fax is required to replace fax, since this has been deprecated by W3C.\r\n *  hl7-att is associated with a series of rules that must be followed. These rules are documented in Datatypes R2\r\n *  This domain is external and extensible, so documenting this simply clarifies consistent usage for these use cases.",
      "property": [
        {
          "code": "status",
          "valueCode": "retired"
        }
      ]
    }
  ]
}