Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CodeSystem/identifier-use (XML)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Definition for Code SystemIdentifierUse

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="identifier-use"/> 
  <meta> 
    <lastUpdated value="2022-09-07T10:58:29.429+10:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This code system 
        <code> http://hl7.org/fhir/identifier-use</code>  defines the following codes:
      </p> 
      <table class="codes">
        <tr> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">usual
            <a name="identifier-use-usual"> </a> 
          </td> 
          <td> Usual</td> 
          <td> The identifier recommended for display and use in real-world interactions which should
             be used when such identifier is different from the &quot;official&quot; identifier.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">official
            <a name="identifier-use-official"> </a> 
          </td> 
          <td> Official</td> 
          <td> The identifier considered to be most trusted for the identification of this item. Sometimes
             also known as &quot;primary&quot; and &quot;main&quot;. The determination of &quot;official&quot;
             is subjective and implementation guides often provide additional guidelines for use.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">temp
            <a name="identifier-use-temp"> </a> 
          </td> 
          <td> Temp</td> 
          <td> A temporary identifier.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">secondary
            <a name="identifier-use-secondary"> </a> 
          </td> 
          <td> Secondary</td> 
          <td> An identifier that was assigned in secondary use - it serves to identify the object in
             a relative context, but cannot be consistently assigned to the same object again in a
             different context.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">old
            <a name="identifier-use-old"> </a> 
          </td> 
          <td> Old</td> 
          <td> The identifier id no longer considered valid, but may be relevant for search purposes.
              E.g. Changes to identifier schemes, account merges, etc.</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
    <valueCode value="4.0.0"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/> 
  </extension> 
  <url value="http://hl7.org/fhir/identifier-use"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.1.58"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="IdentifierUse"/> 
  <title value="IdentifierUse"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2022-09-07T10:58:29+10:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="Identifies the purpose for this identifier, if known ."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/identifier-use"/> 
  <content value="complete"/> 
  <concept> 
    <code value="usual"/> 
    <display value="Usual"/> 
    <definition value="The identifier recommended for display and use in real-world interactions which should
     be used when such identifier is different from the &quot;official&quot; identifier."/> 
  </concept> 
  <concept> 
    <code value="official"/> 
    <display value="Official"/> 
    <definition value="The identifier considered to be most trusted for the identification of this item. Sometimes
     also known as &quot;primary&quot; and &quot;main&quot;. The determination of &quot;official&quot;
     is subjective and implementation guides often provide additional guidelines for use."/> 
  </concept> 
  <concept> 
    <code value="temp"/> 
    <display value="Temp"/> 
    <definition value="A temporary identifier."/> 
  </concept> 
  <concept> 
    <code value="secondary"/> 
    <display value="Secondary"/> 
    <definition value="An identifier that was assigned in secondary use - it serves to identify the object in
     a relative context, but cannot be consistently assigned to the same object again in a
     different context."/> 
  </concept> 
  <concept> 
    <code value="old"/> 
    <display value="Old"/> 
    <definition value="The identifier id no longer considered valid, but may be relevant for search purposes.
      E.g. Changes to identifier schemes, account merges, etc."/> 
  </concept> 
</CodeSystem> 

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.