Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CodeSystem/name-use (JSON)

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

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

Definition for Code SystemNameUse

{
  "resourceType" : "CodeSystem",
  "id" : "name-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/name-use</code> defines the following codes:</p><table class=\"codes\"><tr><td><b>Lvl</b></td><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td>1</td><td style=\"white-space:nowrap\">usual<a name=\"name-use-usual\"> </a></td><td>Usual</td><td>Known as/conventional/the one you normally use.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">official<a name=\"name-use-official\"> </a></td><td>Official</td><td>The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called &quot;legal name&quot;.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">temp<a name=\"name-use-temp\"> </a></td><td>Temp</td><td>A temporary name. Name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">nickname<a name=\"name-use-nickname\"> </a></td><td>Nickname</td><td>A name that is used to address the person in an informal manner, but is not part of their formal or usual name.</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">anonymous<a name=\"name-use-anonymous\"> </a></td><td>Anonymous</td><td>Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">old<a name=\"name-use-old\"> </a></td><td>Old</td><td>This name is no longer in use (or was never correct, but retained for records).</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0maiden<a name=\"name-use-maiden\"> </a></td><td>Name changed for Marriage</td><td>A name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a marriage. Marriage naming customs vary greatly around the world, and are constantly changing. This term is not gender specific. The use of this term does not imply any particular history for a person's name.</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/name-use",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.66"
  }],
  "version" : "5.0.0",
  "name" : "NameUse",
  "title" : "NameUse",
  "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" : "The use of a human name.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/name-use",
  "content" : "complete",
  "concept" : [{
    "code" : "usual",
    "display" : "Usual",
    "definition" : "Known as/conventional/the one you normally use."
  },
  {
    "code" : "official",
    "display" : "Official",
    "definition" : "The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called \"legal name\"."
  },
  {
    "code" : "temp",
    "display" : "Temp",
    "definition" : "A temporary name. Name.period can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations."
  },
  {
    "code" : "nickname",
    "display" : "Nickname",
    "definition" : "A name that is used to address the person in an informal manner, but is not part of their formal or usual name."
  },
  {
    "code" : "anonymous",
    "display" : "Anonymous",
    "definition" : "Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons)."
  },
  {
    "code" : "old",
    "display" : "Old",
    "definition" : "This name is no longer in use (or was never correct, but retained for records).",
    "concept" : [{
      "code" : "maiden",
      "display" : "Name changed for Marriage",
      "definition" : "A name used prior to changing name because of marriage. This name use is for use by applications that collect and store names that were used prior to a marriage. Marriage naming customs vary greatly around the world, and are constantly changing. This term is not gender specific. The use of this term does not imply any particular history for a person's name."
    }]
  }]
}

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.