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

FHIR IG analytics

Packagehl7.fhir.uv.xver-r2.r4b
Resource TypeCodeSystem
IdCodeSystem-v3-EntityNameUseR2.json
FHIR VersionR4B
Sourcehttp://hl7.org/fhir/xver-r2.r4b/0.0.1-snapshot-2/CodeSystem-v3-EntityNameUseR2.html
URLhttp://hl7.org/fhir/v3/EntityNameUseR2
Version1.0.2
Statusdraft
Date2025-09-13T15:10:02-04:00
Namev3-EntityNameUseR2
Realmuv
Authorityhl7
Contentcomplete

Resources that use this resource

ValueSet
R2-v3-EntityNameUseR2-for-R4BCross-version VS for R2.v3 Code System EntityNameUseR2 for use in FHIR R4B
R3-v3-EntityNameUseR2-for-R4BCross-version VS for R3.v3 Code System EntityNameUseR2 for use in FHIR R4B
R2-v3-EntityNameUseR2-for-R5Cross-version VS for R2.v3 Code System EntityNameUseR2 for use in FHIR R5
R3-v3-EntityNameUseR2-for-R5Cross-version VS for R3.v3 Code System EntityNameUseR2 for use in FHIR R5

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: CodeSystem v3-EntityNameUseR2

Properties

This code system defines the following properties for its concepts

NameCodeURIType
statusstatushttp://hl7.org/fhir/concept-properties#statuscode
Inactiveinactivehttp://hl7.org/fhir/concept-properties#inactiveboolean
effectiveDateeffectiveDatehttp://hl7.org/fhir/concept-properties#effectiveDatedateTime
deprecationDatedeprecationDatehttp://hl7.org/fhir/concept-properties#deprecationDatedateTime
retirementDateretirementDatehttp://hl7.org/fhir/concept-properties#retirementDatedateTime
Not SelectablenotSelectablehttp://hl7.org/fhir/concept-properties#notSelectableboolean
Parentparenthttp://hl7.org/fhir/concept-properties#parentcode
Childchildhttp://hl7.org/fhir/concept-properties#childcode
partOfpartOfhttp://hl7.org/fhir/concept-properties#partOfcode
synonymsynonymhttp://hl7.org/fhir/concept-properties#synonymcode
commentcommenthttp://hl7.org/fhir/concept-properties#commentstring
itemWeightitemWeighthttp://hl7.org/fhir/concept-properties#itemWeightdecimal

Concepts

This case-sensitive code system http://hl7.org/fhir/v3/EntityNameUseR2 defines the following codes in an undefined hierarchy:

LvlCodeDisplayDefinitionNot Selectable
1Assumed AssumedDescription:A name that a person has assumed or has been assumed to them.true
2  A business nameDescription:A name used in a Professional or Business context . Examples: Continuing to use a maiden name in a professional context, or using a stage performing name (some of these names are also pseudonyms)false
2  ANON AnonymousDescription:Anonymous assigned name (used to protect a persons identity for privacy reasons)false
2  I Indigenous/TribalDescription:e.g. . Chief Red Cloudfalse
2  P Other/Pseudonym/AliasDescription:A non-official name by which the person is sometimes known. (This may also be used to record informal names such as a nickname)false
2  R religiousDescription:A name assumed as part of a religious vocation . e.g. . Sister Mary Francis, Brother Johnfalse
1C customaryDescription:Known as/conventional/the one you normally usefalse
1M maiden nameDescription:A name used prior to marriage.Note that marriage naming customs vary greatly around the world. This name use is for use by applications that collect and store maiden names. Though the concept of maiden name is often gender specific, the use of this term is not gender specific. The use of this term does not imply any particular history for a person's name, nor should the maiden name be determined algorithmicallyfalse
1NameRepresentationUse NameRepresentationUseDescription:Identifies the different representations of a name . The representation may affect how the name is used . (E.g. . use of Ideographic for formal communications.)true
2  ABC alphabeticDescription:Alphabetic transcription of name in latin alphabet (Japanese: romaji)false
2  IDE ideographicDescription:Ideographic representation of name (e.g. Japanese kanji, Chinese characters)false
2  SYL syllabicDescription:Syllabic transcription of name (e.g. Japanese kana, Korean hangul)false
1OLD no longer in useDescription:This name is no longer in use (note: Names may also carry valid time ranges . This code is used to cover the situations where it is known that the name is no longer valid, but no particular time range for its use is known)false
2  DN do not useDescription:This name should no longer be used when interacting with the person (i.e . in addition to no longer being used, the name should not be even mentioned when interacting with the person)Note: applications are not required to compare names labeled "Do Not Use" and other names in order to eliminate name parts that are common between the other name and a name labeled "Do Not Use".false
1OR official registry nameDescription:The formal name as registered in an official (government) registry, but which name might not be commonly used . May correspond to the concept of legal namefalse
1PHON phoneticDescription:The name as understood by the data enterer, i.e. a close approximation of a phonetic spelling of the name, not based on a phonetic algorithm.false
1SRCH searchDescription:A name intended for use in searching or matching. This is used when the name is incomplete and contains enough details for search matching, but not enough for other uses.false
1T temporaryDescription:A temporary name. Note that a name valid time can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations.false

Source1

{
  "resourceType": "CodeSystem",
  "id": "v3-EntityNameUseR2",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/valueset-oid",
      "valueUri": "urn:oid:2.16.840.1.113883.5.1120"
    },
    {
      "extension": [
        {
          "url": "packageId",
          "valueId": "hl7.fhir.uv.xver-r2.r4b"
        },
        {
          "url": "version",
          "valueString": "0.0.1-snapshot-2"
        }
      ],
      "url": "http://hl7.org/fhir/StructureDefinition/package-source"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/1.0/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/1.0/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/v3/EntityNameUseR2",
  "version": "1.0.2",
  "name": "v3-EntityNameUseR2",
  "status": "draft",
  "date": "2025-09-13T15:10:02-04:00",
  "publisher": "FHIR Infrastructure",
  "contact": [
    {
      "name": "FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "caseSensitive": true,
  "content": "complete",
  "property": [
    {
      "code": "status",
      "uri": "http://hl7.org/fhir/concept-properties#status",
      "type": "code"
    },
    {
      "code": "inactive",
      "uri": "http://hl7.org/fhir/concept-properties#inactive",
      "type": "boolean"
    },
    {
      "code": "effectiveDate",
      "uri": "http://hl7.org/fhir/concept-properties#effectiveDate",
      "type": "dateTime"
    },
    {
      "code": "deprecationDate",
      "uri": "http://hl7.org/fhir/concept-properties#deprecationDate",
      "type": "dateTime"
    },
    {
      "code": "retirementDate",
      "uri": "http://hl7.org/fhir/concept-properties#retirementDate",
      "type": "dateTime"
    },
    {
      "code": "notSelectable",
      "uri": "http://hl7.org/fhir/concept-properties#notSelectable",
      "type": "boolean"
    },
    {
      "code": "parent",
      "uri": "http://hl7.org/fhir/concept-properties#parent",
      "type": "code"
    },
    {
      "code": "child",
      "uri": "http://hl7.org/fhir/concept-properties#child",
      "type": "code"
    },
    {
      "code": "partOf",
      "uri": "http://hl7.org/fhir/concept-properties#partOf",
      "type": "code"
    },
    {
      "code": "synonym",
      "uri": "http://hl7.org/fhir/concept-properties#synonym",
      "type": "code"
    },
    {
      "code": "comment",
      "uri": "http://hl7.org/fhir/concept-properties#comment",
      "type": "string"
    },
    {
      "code": "itemWeight",
      "uri": "http://hl7.org/fhir/concept-properties#itemWeight",
      "type": "decimal"
    }
  ],
  "concept": [
    {
      "code": "Assumed",
      "display": "Assumed",
      "definition": "Description:A name that a person has assumed or has been assumed to them.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": true
        }
      ],
      "concept": [
        {
          "code": "A",
          "display": "business name",
          "definition": "Description:A name used in a Professional or Business context .  Examples: Continuing to use a maiden name in a professional context, or using a stage performing name (some of these names are also pseudonyms)",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "ANON",
          "display": "Anonymous",
          "definition": "Description:Anonymous assigned name (used to protect a persons identity for privacy reasons)",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "I",
          "display": "Indigenous/Tribal",
          "definition": "Description:e.g. .  Chief Red Cloud",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "P",
          "display": "Other/Pseudonym/Alias",
          "definition": "Description:A non-official name by which the person is sometimes known.  (This may also be used to record informal names such as a nickname)",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "R",
          "display": "religious",
          "definition": "Description:A name assumed as part of a religious vocation .  e.g. .  Sister Mary Francis, Brother John",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        }
      ]
    },
    {
      "code": "C",
      "display": "customary",
      "definition": "Description:Known as/conventional/the one you normally use",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "M",
      "display": "maiden name",
      "definition": "Description:A name used prior to marriage.Note that marriage naming customs vary greatly around the world.  This name use is for use by applications that collect and store maiden names.  Though the concept of maiden name is often gender specific, the use of this term is not gender specific.  The use of this term does not imply any particular history for a person's name, nor should the maiden name be determined algorithmically",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "NameRepresentationUse",
      "display": "NameRepresentationUse",
      "definition": "Description:Identifies the different representations of a name .  The representation may affect how the name is used .  (E.g. .  use of Ideographic for formal communications.)",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": true
        }
      ],
      "concept": [
        {
          "code": "ABC",
          "display": "alphabetic",
          "definition": "Description:Alphabetic transcription of name in latin alphabet (Japanese: romaji)",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "IDE",
          "display": "ideographic",
          "definition": "Description:Ideographic representation of name (e.g. Japanese kanji, Chinese characters)",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "SYL",
          "display": "syllabic",
          "definition": "Description:Syllabic transcription of name (e.g. Japanese kana, Korean hangul)",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        }
      ]
    },
    {
      "code": "OLD",
      "display": "no longer in use",
      "definition": "Description:This name is no longer in use (note: Names may also carry valid time ranges .  This code is used to cover the situations where it is known that the name is no longer valid, but no particular time range for its use is known)",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ],
      "concept": [
        {
          "code": "DN",
          "display": "do not use",
          "definition": "Description:This name should no longer be used when interacting with the person (i.e .  in addition to no longer being used, the name should not be even mentioned when interacting with the person)Note: applications are not required to compare names labeled \"Do Not Use\" and other names in order to eliminate name parts that are common between the other name and a name labeled \"Do Not Use\".",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        }
      ]
    },
    {
      "code": "OR",
      "display": "official registry name",
      "definition": "Description:The formal name as registered in an official (government) registry, but which name might not be commonly used .  May correspond to the concept of legal name",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "PHON",
      "display": "phonetic",
      "definition": "Description:The name as understood by the data enterer, i.e. a close approximation of a phonetic spelling of the name, not based on a phonetic algorithm.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "SRCH",
      "display": "search",
      "definition": "Description:A name intended for use in searching or matching.  This is used when the name is incomplete and contains enough details for search matching, but not enough for other uses.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "T",
      "display": "temporary",
      "definition": "Description:A temporary name.  Note that a name valid time can provide more detailed information.  This may also be used for temporary names assigned at birth or in emergency situations.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    }
  ]
}