FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/PN

Packageau.digitalhealth.cda.schema
TypeStructureDefinition
IdPN
FHIR VersionR5
Sourcehttp://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-PN.html
URLhttp://hl7.org/cda/stds/core/StructureDefinition/PN
Version1.0.0
Statusactive
Date2025-07-21T22:05:27+00:00
NamePN
TitlePN: PersonName (V3 Data Type)
Realmau
Authoritynational
DescriptionA name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
Kindlogical

Resources that use this resource

StructureDefinition
PatientPatient (CDA Class)
PersonPerson (CDA Class)
PlayingEntityPlayingEntity (CDA Class)
SubjectPersonSubjectPerson (CDA Class)
au-ObservationADHA Observation (CDA Class)
AdvanceDirectiveObservationAdvance Directive Observation
CarePlanCare Plan
CareTeamMemberActCare Team Member Act
DrugMonitoringActDrug Monitoring Act
NoteActivityNote Activity
ProcedureActivityProcedureProcedure Activity Procedure
ReferralNoteReferral Note
RelatedPersonRelationshipAndNameParticipantRelated Person Relationship and Name Participant
USRealmHeaderUS Realm Header
USRealmPatientNamePTNUSFIELDEDUS Realm Patient Name (PTN.US.FIELDED)
USRealmPersonNamePNUSFIELDEDUS Realm Person Name (PN.US.FIELDED)
2.16.840.1.113883.10.22.4.37--20200508162154IPS Advance Directive Observation

Resources that this resource uses

StructureDefinition
ENEN: EntityName (V3 Data Type)

Narrative

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

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).


Source

{
  "resourceType": "StructureDefinition",
  "id": "PN",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
      "_valueBoolean": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
            "valueCode": "not-applicable"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
      "valueUri": "urn:hl7-org:v3"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
      "valueString": "name"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
      "valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
    }
  ],
  "url": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
  "version": "1.0.0",
  "name": "PN",
  "title": "PN: PersonName (V3 Data Type)",
  "status": "active",
  "experimental": false,
  "date": "2025-07-21T22:05:27+00:00",
  "publisher": "HL7",
  "description": "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.org/cda/stds/core/StructureDefinition/PN",
  "baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/EN",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "1.0.0"
      }
    ],
    "element": [
      {
        "id": "PN",
        "path": "PN",
        "short": "Base for all types and resources",
        "definition": "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
        "min": 1,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "pn-no-ls",
            "severity": "error",
            "human": "No PN name part may have a qualifier of LS.",
            "expression": "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "PN.nullFlavor",
        "path": "PN.nullFlavor",
        "representation": [
          "xmlAttr"
        ],
        "label": "Exceptional Value Detail",
        "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ANY.nullFlavor",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
        }
      },
      {
        "id": "PN.use",
        "path": "PN.use",
        "representation": [
          "xmlAttr"
        ],
        "label": "Use Code",
        "definition": "A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EN.use",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "code",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
            ]
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse"
        }
      },
      {
        "id": "PN.item",
        "extension": [
          {
            "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group",
            "valueBoolean": true
          }
        ],
        "path": "PN.item",
        "definition": "A series of items that constitute the name.",
        "min": 1,
        "max": "*",
        "base": {
          "path": "EN.item",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/fhir/StructureDefinition/Base"
          }
        ],
        "constraint": [
          {
            "key": "EN-1",
            "severity": "error",
            "human": "Can only have only one of the possible item elements in each choice",
            "expression": "(delimiter | family | given | prefix | suffix | xmlText).count() = 1",
            "source": "http://hl7.org/cda/stds/core/StructureDefinition/EN"
          }
        ]
      },
      {
        "id": "PN.item.delimiter",
        "path": "PN.item.delimiter",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EN.item.delimiter",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id": "PN.item.family",
        "path": "PN.item.family",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EN.item.family",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id": "PN.item.given",
        "path": "PN.item.given",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EN.item.given",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id": "PN.item.prefix",
        "path": "PN.item.prefix",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EN.item.prefix",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id": "PN.item.suffix",
        "path": "PN.item.suffix",
        "min": 0,
        "max": "*",
        "base": {
          "path": "EN.item.suffix",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
          }
        ]
      },
      {
        "id": "PN.item.xmlText",
        "path": "PN.item.xmlText",
        "representation": [
          "xmlText"
        ],
        "short": "Allows for mixed text content",
        "comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EN.item.xmlText",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string",
            "profile": [
              "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
            ]
          }
        ]
      },
      {
        "id": "PN.validTime",
        "path": "PN.validTime",
        "label": "Valid Time",
        "definition": "An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EN.validTime",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "PN",
        "path": "PN",
        "definition": "A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are \"Jim Bob Walton, Jr.\", \"Adam Everyman\", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, \"Jim\", \"Bob\", \"Walton\", and \"Jr.\". PN differs from EN because the qualifier type cannot include LS (Legal Status).",
        "constraint": [
          {
            "key": "pn-no-ls",
            "severity": "error",
            "human": "No PN name part may have a qualifier of LS.",
            "expression": "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()"
          }
        ]
      },
      {
        "id": "PN.item",
        "path": "PN.item",
        "min": 1,
        "max": "*"
      }
    ]
  }
}