USRealmPatientNamePTNUSFIELDED
type: StructureDefinition
node role: treeRoot
id:
  v: USRealmPatientNamePTNUSFIELDED
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition USRealmPatientNamePTNUSFIELDED Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> PN <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( shall-family, shall-given, shall-max-suffix, 81-7278 )">C 1..* PN XML Namespace: urn:hl7-org:v3 Base for all types and resources Logical Container: ClinicalDocument (CDA Class) Constraints: shall-family, shall-given, shall-max-suffix, 81-7278 #xD; @use 0..1 cs If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced #xD; item #xD; family 0..* ENXP 헨?헦?헖?헗?헜?: Last Name #xD; @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier (required) #xD; given 0..* ENXP 헨?헦?헖?헗?헜?: First Name / Middle Name #xD; @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier (required) #xD; prefix 0..* ENXP #xD; @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier (required) #xD; suffix 0..* ENXP 헨?헦?헖?헗?헜?: Suffix #xD; @qualifier 0..1 cs Binding: EntityPersonNamePartQualifier (required) #xD; validTime 0..1 IVL_TS 헨?헦?헖?헗?헜?: Previous Name - Available for use to identify the time period when name was/is in use. #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-target
    l: logical-target
  value: Boolean
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/data-absent-reason
        l: data-absent-reason
      value: Code
        v: not-applicable
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    l: xml-namespace
  value: Uri
    v: urn:hl7-org:v3
    l: v3
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
    l: xml-name
  value: String
    v: name
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-container
    l: logical-container
  value: Uri
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
    l: ClinicalDocument
url:
  v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED
  l: USRealmPatientNamePTNUSFIELDED
identifier:
  system:
    v: urn:ietf:rfc:3986
    l: 3986
  value:
    v: urn:oid:2.16.840.1.113883.10.20.22.5.1
version:
  v: 4.0.0
name:
  v: USRealmPatientNamePTNUSFIELDED
title:
  v: US Realm Patient Name (PTN.US.FIELDED)
status:
  v: draft
date:
  v: 2025-11-05T04:26:52+00:00
publisher:
  v: Health Level Seven
contact:
  name:
    v: HL7 International - Structured Documents
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/structure
description:
  v: The US Realm Patient Name datatype flavor is a set of reusable constraints that can be used for the patient or any other person. It requires a first (given) and last (family) name. If a patient or person has only one name part (e.g., patient with first name only) place the name part in the field required by the organization. Use the appropriate nullFlavor, "Not Applicable" (NA), in the other field. For information on mixed content see the Extensible Markup Language reference (http://www.w3c.org/TR/2008/REC-xml-20081126/).
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: US
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://hl7.org/cda/stds/core/StructureDefinition/PN
  l: PN
base definition:
  v: http://hl7.org/cda/stds/core/StructureDefinition/PN
  l: PN
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 2.0.1-sd
  element:
    id:
      v: PN
    path:
      v: PN
    short:
      v: Base for all types and resources
    definition:
      v: 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:
      v: 1
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: pn-no-ls
      severity:
        v: error
      human:
        v: No PN name part may have a qualifier of LS.
      expression:
        v: (item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()
      source:
        v: http://hl7.org/cda/stds/core/StructureDefinition/PN
        l: PN
    constraint:
      key:
        v: shall-family
      severity:
        v: error
      human:
        v: SHALL contain exactly one [1..1] family (CONF:81-7159).
      expression:
        v: nullFlavor.exists() or item.family.count() = 1
      source:
        v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED
        l: USRealmPatientNamePTNUSFIELDED
    constraint:
      key:
        v: shall-given
      severity:
        v: error
      human:
        v: SHALL contain at least one [1..*] given (CONF:81-7157).
      expression:
        v: nullFlavor.exists() or item.given.exists()
      source:
        v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED
        l: USRealmPatientNamePTNUSFIELDED
    constraint:
      key:
        v: shall-max-suffix
      severity:
        v: error
      human:
        v: There may be at most one suffix
      expression:
        v: (item.suffix.empty() or item.suffix.count() = 1)
      source:
        v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED
        l: USRealmPatientNamePTNUSFIELDED
    constraint:
      key:
        v: 81-7278
      severity:
        v: error
      human:
        v: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
      expression:
        v: item.xmlText.empty()
      source:
        v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED
        l: USRealmPatientNamePTNUSFIELDED
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: PN.nullFlavor
    path:
      v: PN.nullFlavor
    representation:
      v: xmlAttr
    label:
      v: Exceptional Value Detail

v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

v: 0

v: 1

path:
  v: ANY.nullFlavor
min:
  v: 0
max:
  v: 1

code:
  v: code
  l: code
profile:
  v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
  l: cs-simple

strength:
  v: required
value set:
  v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
  l: CDANullFlavor

id:
  v: PN.use
path:
  v: PN.use
representation:
  v: xmlAttr
label:
  v: Use Code
short:
  v: If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
definition:
  v: 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
comment:
  v: MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EN.use
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
    l: CDAEntityNameUse

id:
  v: PN.item
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group
    l: xml-choice-group
  value: Boolean
    v: true
path:
  v: PN.item
definition:
  v: A series of items that constitute the name.
min:
  v: 1
max:
  v: *
base:
  path:
    v: EN.item
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/fhir/StructureDefinition/Base
    l: Base
constraint:
  key:
    v: EN-1
  severity:
    v: error
  human:
    v: Can only have only one of the possible item elements in each choice
  expression:
    v: (delimiter | family | given | prefix | suffix | xmlText).count() = 1
  source:
    v: http://hl7.org/cda/stds/core/StructureDefinition/EN
    l: EN

id:
  v: PN.item.delimiter
path:
  v: PN.item.delimiter
min:
  v: 0
max:
  v: *
base:
  path:
    v: EN.item.delimiter
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP
    l: ENXP

id:
  v: PN.item.family
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: PN.item.family
short:
  v: 𝗨𝗦𝗖𝗗𝗜: Last Name
min:
  v: 0
max:
  v: *
base:
  path:
    v: EN.item.family
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP
    l: ENXP

id:
  v: PN.item.family.nullFlavor
path:
  v: PN.item.family.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: PN.item.family.representation
path:
  v: PN.item.family.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: PN.item.family.mediaType
path:
  v: PN.item.family.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: PN.item.family.language
path:
  v: PN.item.family.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: PN.item.family.xmlText
path:
  v: PN.item.family.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: PN.item.family.partType
path:
  v: PN.item.family.partType
representation:
  v: xmlAttr
label:
  v: Name Part Type Code
definition:
  v: Indicates whether the name part is a given name, family name, prefix, suffix, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ENXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    l: v3-EntityNamePartType

id:
  v: PN.item.family.qualifier
path:
  v: PN.item.family.qualifier
representation:
  v: xmlAttr
label:
  v: Qualifier Code
definition:
  v: qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
comment:
  v: This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ENXP.qualifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26

id:
  v: PN.item.given
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: PN.item.given
short:
  v: 𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name
comment:
  v: SHALL contain at least one [1..*] given (CONF:81-7157).
min:
  v: 0
max:
  v: *
base:
  path:
    v: EN.item.given
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP
    l: ENXP

id:
  v: PN.item.given.nullFlavor
path:
  v: PN.item.given.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: PN.item.given.representation
path:
  v: PN.item.given.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: PN.item.given.mediaType
path:
  v: PN.item.given.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: PN.item.given.language
path:
  v: PN.item.given.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: PN.item.given.xmlText
path:
  v: PN.item.given.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: PN.item.given.partType
path:
  v: PN.item.given.partType
representation:
  v: xmlAttr
label:
  v: Name Part Type Code
definition:
  v: Indicates whether the name part is a given name, family name, prefix, suffix, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ENXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    l: v3-EntityNamePartType

id:
  v: PN.item.given.qualifier
path:
  v: PN.item.given.qualifier
representation:
  v: xmlAttr
label:
  v: Qualifier Code
definition:
  v: qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
comment:
  v: Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ENXP.qualifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26

id:
  v: PN.item.prefix
path:
  v: PN.item.prefix
comment:
  v: MAY contain zero or more [0..*] prefix (CONF:81-7155).
min:
  v: 0
max:
  v: *
base:
  path:
    v: EN.item.prefix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP
    l: ENXP

id:
  v: PN.item.prefix.nullFlavor
path:
  v: PN.item.prefix.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: PN.item.prefix.representation
path:
  v: PN.item.prefix.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: PN.item.prefix.mediaType
path:
  v: PN.item.prefix.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: PN.item.prefix.language
path:
  v: PN.item.prefix.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: PN.item.prefix.xmlText
path:
  v: PN.item.prefix.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: PN.item.prefix.partType
path:
  v: PN.item.prefix.partType
representation:
  v: xmlAttr
label:
  v: Name Part Type Code
definition:
  v: Indicates whether the name part is a given name, family name, prefix, suffix, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ENXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    l: v3-EntityNamePartType

id:
  v: PN.item.prefix.qualifier
path:
  v: PN.item.prefix.qualifier
representation:
  v: xmlAttr
label:
  v: Qualifier Code
definition:
  v: qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
comment:
  v: The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ENXP.qualifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26

id:
  v: PN.item.suffix
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: PN.item.suffix
short:
  v: 𝗨𝗦𝗖𝗗𝗜: Suffix
comment:
  v: MAY contain zero or one [0..1] suffix (CONF:81-7161).
min:
  v: 0
max:
  v: *
base:
  path:
    v: EN.item.suffix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP
    l: ENXP

id:
  v: PN.item.suffix.nullFlavor
path:
  v: PN.item.suffix.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    l: CDANullFlavor

id:
  v: PN.item.suffix.representation
path:
  v: PN.item.suffix.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: TXT

id:
  v: PN.item.suffix.mediaType
path:
  v: PN.item.suffix.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
fixed: Code
  v: text/plain

id:
  v: PN.item.suffix.language
path:
  v: PN.item.suffix.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple

id:
  v: PN.item.suffix.xmlText
path:
  v: PN.item.suffix.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: PN.item.suffix.partType
path:
  v: PN.item.suffix.partType
representation:
  v: xmlAttr
label:
  v: Name Part Type Code
definition:
  v: Indicates whether the name part is a given name, family name, prefix, suffix, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ENXP.partType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-EntityNamePartType
    l: v3-EntityNamePartType

id:
  v: PN.item.suffix.qualifier
path:
  v: PN.item.suffix.qualifier
representation:
  v: xmlAttr
label:
  v: Qualifier Code
definition:
  v: qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
comment:
  v: The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ENXP.qualifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: code
    l: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    l: cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
    l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26

id:
  v: PN.item.xmlText
path:
  v: PN.item.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EN.item.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    l: st-simple

id:
  v: PN.validTime
extension:
  url:
    v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
    l: uscdi-requirement
  value: Boolean
    v: true
path:
  v: PN.validTime
label:
  v: Valid Time
short:
  v: 𝗨𝗦𝗖𝗗𝗜: Previous Name - Available for use to identify the time period when name was/is in use.
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: EN.validTime
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
    l: IVL-TS

element:
  id:
    v: PN
  path:
    v: PN
  constraint:
    key:
      v: shall-family
    severity:
      v: error
    human:
      v: SHALL contain exactly one [1..1] family (CONF:81-7159).
    expression:
      v: nullFlavor.exists() or item.family.count() = 1
    source:
      v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED
      l: USRealmPatientNamePTNUSFIELDED
  constraint:
    key:
      v: shall-given
    severity:
      v: error
    human:
      v: SHALL contain at least one [1..*] given (CONF:81-7157).
    expression:
      v: nullFlavor.exists() or item.given.exists()
    source:
      v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED
      l: USRealmPatientNamePTNUSFIELDED
  constraint:
    key:
      v: shall-max-suffix
    severity:
      v: error
    human:
      v: There may be at most one suffix
    expression:
      v: (item.suffix.empty() or item.suffix.count() = 1)
    source:
      v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED
      l: USRealmPatientNamePTNUSFIELDED
  constraint:
    key:
      v: 81-7278
    severity:
      v: error
    human:
      v: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
    expression:
      v: item.xmlText.empty()
    source:
      v: http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED
      l: USRealmPatientNamePTNUSFIELDED
element:
  id:
    v: PN.use
  path:
    v: PN.use
  short:
    v: If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
  comment:
    v: MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154).
  max:
    v: 1
element:
  id:
    v: PN.item.family
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  path:
    v: PN.item.family
  short:
    v: 𝗨𝗦𝗖𝗗𝗜: Last Name
element:
  id:
    v: PN.item.family.qualifier
  path:
    v: PN.item.family.qualifier
  comment:
    v: This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160).
  max:
    v: 1
  binding:
    strength:
      v: required
    value set:
      v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
      l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
element:
  id:
    v: PN.item.given
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  path:
    v: PN.item.given
  short:
    v: 𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name
  comment:
    v: SHALL contain at least one [1..*] given (CONF:81-7157).
element:
  id:
    v: PN.item.given.qualifier
  path:
    v: PN.item.given.qualifier
  comment:
    v: Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158).
  max:
    v: 1
  binding:
    strength:
      v: required
    value set:
      v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
      l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
element:
  id:
    v: PN.item.prefix
  path:
    v: PN.item.prefix
  comment:
    v: MAY contain zero or more [0..*] prefix (CONF:81-7155).
element:
  id:
    v: PN.item.prefix.qualifier
  path:
    v: PN.item.prefix.qualifier
  comment:
    v: The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156).
  max:
    v: 1
  binding:
    strength:
      v: required
    value set:
      v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
      l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
element:
  id:
    v: PN.item.suffix
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  path:
    v: PN.item.suffix
  short:
    v: 𝗨𝗦𝗖𝗗𝗜: Suffix
  comment:
    v: MAY contain zero or one [0..1] suffix (CONF:81-7161).
element:
  id:
    v: PN.item.suffix.qualifier
  path:
    v: PN.item.suffix.qualifier
  comment:
    v: The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162).
  max:
    v: 1
  binding:
    strength:
      v: required
    value set:
      v: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
      l: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26
element:
  id:
    v: PN.validTime
  extension:
    url:
      v: http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement
      l: uscdi-requirement
    value: Boolean
      v: true
  path:
    v: PN.validTime
  short:
    v: 𝗨𝗦𝗖𝗗𝗜: Previous Name - Available for use to identify the time period when name was/is in use.