FHIR Cross-Version Extensions package for FHIR R4B from FHIR R5
0.0.1-snapshot-2 - informative International flag

FHIR Cross-Version Extensions package for FHIR R4B from FHIR R5 - Version 0.0.1-snapshot-2. See the Directory of published versions

ValueSet: Cross-version VS for R5.URLScheme for use in FHIR R4B

Official URL: http://hl7.org/fhir/5.0/ValueSet/R5-v3-URLScheme-for-R4B Version: 0.0.1-snapshot-2
Standards status: Informative Maturity Level: 0 Computable Name: R5_v3_URLScheme_for_R4B

This cross-version ValueSet represents concepts from http://terminology.hl7.org/ValueSet/v3-URLScheme 2.0.0 for use in FHIR R4B. Concepts not present here have direct equivalent mappings crossing all versions from R5 to R4B.

References

This value set is not used here; it may be used elsewhere (e.g. specifications and/or implementations that use this content)

Logical Definition (CLD)

  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-URLScheme version 2.1.0
    CodeDisplayDefinition
    cidContent 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
    fileFileHost-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.
    ftpFTPThe File Transfer Protocol (FTP) \[RFC 1738\].
    hl7-attHL7 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
    httpHTTPHypertext Transfer Protocol \[RFC 2068\].

    http://www.ietf.org/rfc/rfc2068.txt
    mailtoMailtoElectronic mail address \[RFC 2368\]

    http://www.ietf.org/rfc/rfc2368.txt
    mllpMLLP**Description:** Mimimal Lower Layer Protocol. See Transport Specification: MLLP, Release 2 (HL7 V3 Transport specification).
    nfsNFSNetwork File System protocol \[RFC 2224\]. Some sites use NFS servers to share data files.

    http://www.ietf.org/rfc/rfc2224.txt
    telTelephoneA voice telephone number \[http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt\].
    telnetTelnetReference 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
    faxFaxA telephone number served by a fax device \[http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt\].
    modemModemA telephone number served by a modem device \[http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt\].
    x-text-faxFax**Description:** A telephone number served by a fax device \[http://www.ietf.org/rfc/rfc3966.txt and http://www.ietf.org/rfc/rfc2806.txt\]
    x-text-telText 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.

 

Expansion

This value set expansion contains 14 concepts.

CodeSystemDisplayDefinition
  cidhttp://terminology.hl7.org/CodeSystem/v3-URLSchemeContent 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

  filehttp://terminology.hl7.org/CodeSystem/v3-URLSchemeFile

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.

  ftphttp://terminology.hl7.org/CodeSystem/v3-URLSchemeFTP

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

  hl7-atthttp://terminology.hl7.org/CodeSystem/v3-URLSchemeHL7 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

  httphttp://terminology.hl7.org/CodeSystem/v3-URLSchemeHTTP

Hypertext Transfer Protocol [RFC 2068].

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

  mailtohttp://terminology.hl7.org/CodeSystem/v3-URLSchemeMailto

Electronic mail address [RFC 2368]

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

  mllphttp://terminology.hl7.org/CodeSystem/v3-URLSchemeMLLP

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

  nfshttp://terminology.hl7.org/CodeSystem/v3-URLSchemeNFS

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

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

  telhttp://terminology.hl7.org/CodeSystem/v3-URLSchemeTelephone

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

  telnethttp://terminology.hl7.org/CodeSystem/v3-URLSchemeTelnet

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

  faxhttp://terminology.hl7.org/CodeSystem/v3-URLSchemeFax

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

  modemhttp://terminology.hl7.org/CodeSystem/v3-URLSchemeModem

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

  x-text-faxhttp://terminology.hl7.org/CodeSystem/v3-URLSchemeFax

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

  x-text-telhttp://terminology.hl7.org/CodeSystem/v3-URLSchemeText 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.

Explanation of the columns that may appear on this page:

Level A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies
System The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance)
Display The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code