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-EntityNameUse.json
FHIR VersionR4B
Sourcehttp://hl7.org/fhir/xver-r2.r4b/0.0.1-snapshot-2/CodeSystem-v3-EntityNameUse.html
URLhttp://hl7.org/fhir/v3/EntityNameUse
Version1.0.2
Statusdraft
Date2025-09-13T15:10:02-04:00
Namev3-EntityNameUse
Realmuv
Authorityhl7
Contentcomplete

Resources that use this resource

ValueSet
R2-v3-EntityNameUse-for-R4BCross-version VS for R2.v3 Code System EntityNameUse for use in FHIR R4B
R3-name-v3-representation-for-R4BCross-version VS for R3.NameRepresentationUse for use in FHIR R4B
R3-v3-EntityNameUse-for-R4BCross-version VS for R3.v3 Code System EntityNameUse for use in FHIR R4B
R2-v3-EntityNameUse-for-R5Cross-version VS for R2.v3 Code System EntityNameUse for use in FHIR R5
R3-name-v3-representation-for-R4Cross-version VS for R3.NameRepresentationUse for use in FHIR R4
R3-name-v3-representation-for-R5Cross-version VS for R3.NameRepresentationUse for use in FHIR R5
R3-v3-EntityNameUse-for-R5Cross-version VS for R3.v3 Code System EntityNameUse 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-EntityNameUse

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/EntityNameUse defines the following codes in an undefined hierarchy:

LvlCodeDisplayDefinitionNot Selectable
1_NameRepresentationUse NameRepresentationUseIdentifies 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 AlphabeticAlphabetic transcription of name (Japanese: romaji)false
2  IDE IdeographicIdeographic representation of name (e.g. Japanese kanji, Chinese characters)false
2  SYL SyllabicSyllabic transcription of name (e.g. Japanese kana, Korean hangul)false
1ASGN assignedA name assigned to a person. Reasons some organizations assign alternate names may include not knowing the person's name, or to maintain anonymity. Some, but not necessarily all, of the name types that people call "alias" may fit into this category.false
1C LicenseAs recorded on a license, record, certificate, etc. (only if different from legal name)false
1I Indigenous/Tribale.g. Chief Red Cloudfalse
1L LegalKnown as/conventional/the one you usefalse
2  OR official registryDefinition:The formal name as registered in an official (government) registry, but which name might not be commonly used. Particularly used in countries with a law system based on Napoleonic law.false
1P pseudonymA self asserted name that the person is using or has used.false
2  A Artist/StageIncludes writer's pseudonym, stage name, etc.false
1R Religiouse.g. Sister Mary Francis, Brother Johnfalse
1SRCH searchA name intended for use in searching or matching.false
2  PHON phoneticA name spelled phonetically. There are a variety of phonetic spelling algorithms. This code value does not distinguish between these.Discussion:false
2  SNDX SoundexA name spelled according to the SoundEx algorithm.false

Source1

{
  "resourceType": "CodeSystem",
  "id": "v3-EntityNameUse",
  "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.45"
    },
    {
      "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/EntityNameUse",
  "version": "1.0.2",
  "name": "v3-EntityNameUse",
  "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": "_NameRepresentationUse",
      "display": "NameRepresentationUse",
      "definition": "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": "Alphabetic transcription of name (Japanese: romaji)",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "IDE",
          "display": "Ideographic",
          "definition": "Ideographic representation of name (e.g. Japanese kanji, Chinese characters)",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "SYL",
          "display": "Syllabic",
          "definition": "Syllabic transcription of name (e.g. Japanese kana, Korean hangul)",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        }
      ]
    },
    {
      "code": "ASGN",
      "display": "assigned",
      "definition": "A name assigned to a person. Reasons some organizations assign alternate names may include not knowing the person's name, or to maintain anonymity. Some, but not necessarily all, of the name types that people call \"alias\" may fit into this category.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "C",
      "display": "License",
      "definition": "As recorded on a license, record, certificate, etc. (only if different from legal name)",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "I",
      "display": "Indigenous/Tribal",
      "definition": "e.g. Chief Red Cloud",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "L",
      "display": "Legal",
      "definition": "Known as/conventional/the one you use",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ],
      "concept": [
        {
          "code": "OR",
          "display": "official registry",
          "definition": "Definition:The formal name as registered in an official (government) registry, but which name might not be commonly used. Particularly used in countries with a law system based on Napoleonic law.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        }
      ]
    },
    {
      "code": "P",
      "display": "pseudonym",
      "definition": "A self asserted name that the person is using or has used.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ],
      "concept": [
        {
          "code": "A",
          "display": "Artist/Stage",
          "definition": "Includes writer's pseudonym, stage name, etc.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        }
      ]
    },
    {
      "code": "R",
      "display": "Religious",
      "definition": "e.g. Sister Mary Francis, Brother John",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "SRCH",
      "display": "search",
      "definition": "A name intended for use in searching or matching.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ],
      "concept": [
        {
          "code": "PHON",
          "display": "phonetic",
          "definition": "A name spelled phonetically.                          There are a variety of phonetic spelling algorithms. This code value does not distinguish between these.Discussion:",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "SNDX",
          "display": "Soundex",
          "definition": "A name spelled according to the SoundEx algorithm.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        }
      ]
    }
  ]
}