Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CodeSystem/identifier-use (JSON)

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

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

Definition for Code SystemIdentifierUse

{
  "resourceType" : "CodeSystem",
  "id" : "identifier-use",
  "meta" : {
    "lastUpdated" : "2023-03-26T15:21:02.749+11:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<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>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "normative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
    "valueCode" : "4.0.0"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 5
  }],
  "url" : "http://hl7.org/fhir/identifier-use",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.58"
  }],
  "version" : "5.0.0",
  "name" : "IdentifierUse",
  "title" : "IdentifierUse",
  "status" : "active",
  "experimental" : false,
  "date" : "2023-03-26T15:21:02+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "Identifies the purpose for this identifier, if known .",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use",
  "content" : "complete",
  "concept" : [{
    "code" : "usual",
    "display" : "Usual",
    "definition" : "The identifier recommended for display and use in real-world interactions which should be used when such identifier is different from the \"official\" identifier."
  },
  {
    "code" : "official",
    "display" : "Official",
    "definition" : "The identifier considered to be most trusted for the identification of this item. Sometimes also known as \"primary\" and \"main\". The determination of \"official\" is subjective and implementation guides often provide additional guidelines for use."
  },
  {
    "code" : "temp",
    "display" : "Temp",
    "definition" : "A temporary identifier."
  },
  {
    "code" : "secondary",
    "display" : "Secondary",
    "definition" : "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."
  },
  {
    "code" : "old",
    "display" : "Old",
    "definition" : "The identifier id no longer considered valid, but may be relevant for search purposes.  E.g. Changes to identifier schemes, account merges, etc."
  }]
}

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.