FHIR HumanName Data Type (R4)

HumanName holds a person's name in a structured form, with a use, family name, given names, prefixes and suffixes. Element table, example JSON and FHIRPath for FHIR R4.

  • FHIR HumanName Data Type (R4) — part of the free FHIR Toolbox library.
  • Runs entirely in your browser: your FHIR data is never uploaded to a server.

Overview

HumanName holds a person's name in a structured form, with a use, family name, given names, prefixes and suffixes. Patient.name and Practitioner.name are arrays of HumanName.

Elements

ElementTypeCardinalityDescription
HumanName.usecode0..1usual | official | temp | nickname | anonymous | old | maiden
HumanName.familystring0..1Family name (often called 'Surname')
HumanName.givenstring0..*Given names (not always 'first'). Includes middle names
HumanName.prefixstring0..*Parts that come before the name
HumanName.suffixstring0..*Parts that come after the name
HumanName.periodPeriod0..1Time period when name was/is in use

Example JSON (R4)

{
  "use": "official",
  "family": "Smith",
  "given": [
    "John",
    "Michael"
  ],
  "prefix": [
    "Mr."
  ]
}

FHIRPath

  • Patient.name.where(use='official').given.first() — First given name of the official name
  • Patient.name.family — All family names

FHIR Toolbox is a free, privacy-first collection of HL7 FHIR utilities by Omindra Labs. Every tool performs zero-server processing — your health data never leaves your device.