| Package | hl7.cda.us.ccda |
| Type | StructureDefinition |
| Id | USRealmPatientNamePTNUSFIELDED |
| FHIR Version | R5 |
| Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda/StructureDefinition-USRealmPatientNamePTNUSFIELDED.html |
| URL | http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED |
| Version | 4.0.0 |
| Status | draft |
| Date | 2025-06-26T21:09:45+00:00 |
| Name | USRealmPatientNamePTNUSFIELDED |
| Title | US Realm Patient Name (PTN.US.FIELDED) |
| Realm | us |
| Authority | hl7 |
| Description | 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/). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
| Kind | logical |
| StructureDefinition | |
| USRealmHeader | US Realm Header |
| StructureDefinition | |
| PN | PN: PersonName (V3 Data Type) |
| ValueSet | |
| 2.16.840.1.113883.11.20.9.26 | EntityPersonNamePartQualifier |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition USRealmPatientNamePTNUSFIELDED
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PN | C | 1..* | PN | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item Base for all types and resources Logical Container: ClinicalDocument (CDA Class) Constraints: shall-family, shall-given, shall-max-suffix, 81-7278 |
 @use | 0..1 | cs | If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced | |
| item | ||||
 family | 0..* | ENXP | 𝗨𝗦𝗖𝗗𝗜: Last Name | |
 @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier  (required) | |
| given | 0..* | ENXP | 𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name | |
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| prefix | 0..* | ENXP | ||
| @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| suffix | 0..* | ENXP | 𝗨𝗦𝗖𝗗𝗜: Suffix | |
 @qualifier | 0..1 | cs | Binding: EntityPersonNamePartQualifier (required) | |
| validTime | 0..1 | IVL_TS | 𝗨𝗦𝗖𝗗𝗜: Previous Name - Available for use to identify the time period when name was/is in use. | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "USRealmPatientNamePTNUSFIELDED",
"text": {
"status": "extensions",
"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/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.10.20.22.5.1"
}
],
"version": "4.0.0",
"name": "USRealmPatientNamePTNUSFIELDED",
"title": "US Realm Patient Name (PTN.US.FIELDED)",
"status": "draft",
"date": "2025-06-26T21:09:45+00:00",
"publisher": "Health Level Seven",
"contact": [
{
"name": "HL7 International - Structured Documents",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description": "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.\n\nFor information on mixed content see the Extensible Markup Language reference (http://www.w3c.org/TR/2008/REC-xml-20081126/).",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"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/PN",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "2.0.1-sd"
}
],
"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()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/PN"
},
{
"key": "shall-family",
"severity": "error",
"human": "SHALL contain exactly one [1..1] family (CONF:81-7159).",
"expression": "nullFlavor.exists() or item.family.count() = 1",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key": "shall-given",
"severity": "error",
"human": "SHALL contain at least one [1..*] given (CONF:81-7157).",
"expression": "nullFlavor.exists() or item.given.exists()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key": "shall-max-suffix",
"severity": "error",
"human": "There may be at most one suffix",
"expression": "(item.suffix.empty() or item.suffix.count() = 1)",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key": "81-7278",
"severity": "error",
"human": "**SHALL NOT** have mixed content except for white space (CONF:81-7278).",
"expression": "item.xmlText.empty()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
}
],
"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",
"short": "If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced",
"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",
"comment": "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": 0,
"max": "1",
"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",
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
}
],
"path": "PN.item.family",
"short": "𝗨𝗦𝗖𝗗𝗜: Last Name",
"min": 0,
"max": "*",
"base": {
"path": "EN.item.family",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "PN.item.family.nullFlavor",
"path": "PN.item.family.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.item.family.representation",
"path": "PN.item.family.representation",
"representation": [
"xmlAttr"
],
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"min": 0,
"max": "1",
"base": {
"path": "ST.representation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "TXT"
},
{
"id": "PN.item.family.mediaType",
"path": "PN.item.family.mediaType",
"representation": [
"xmlAttr"
],
"label": "Media Type",
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min": 0,
"max": "1",
"base": {
"path": "ST.mediaType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "text/plain"
},
{
"id": "PN.item.family.language",
"path": "PN.item.family.language",
"representation": [
"xmlAttr"
],
"label": "Language",
"definition": "For character based information the language property specifies the human language of the text.",
"min": 0,
"max": "1",
"base": {
"path": "ST.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id": "PN.item.family.xmlText",
"path": "PN.item.family.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": "ST.xmlText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "PN.item.family.partType",
"path": "PN.item.family.partType",
"representation": [
"xmlAttr"
],
"label": "Name Part Type Code",
"definition": "Indicates whether the name part is a given name, family name, prefix, suffix, etc.",
"min": 0,
"max": "1",
"base": {
"path": "ENXP.partType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityNamePartType"
}
},
{
"id": "PN.item.family.qualifier",
"path": "PN.item.family.qualifier",
"representation": [
"xmlAttr"
],
"label": "Qualifier Code",
"definition": "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": "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": 0,
"max": "1",
"base": {
"path": "ENXP.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"
}
},
{
"id": "PN.item.given",
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
}
],
"path": "PN.item.given",
"short": "𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name",
"comment": "SHALL contain at least one [1..*] given (CONF:81-7157).",
"min": 0,
"max": "*",
"base": {
"path": "EN.item.given",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "PN.item.given.nullFlavor",
"path": "PN.item.given.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.item.given.representation",
"path": "PN.item.given.representation",
"representation": [
"xmlAttr"
],
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"min": 0,
"max": "1",
"base": {
"path": "ST.representation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "TXT"
},
{
"id": "PN.item.given.mediaType",
"path": "PN.item.given.mediaType",
"representation": [
"xmlAttr"
],
"label": "Media Type",
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min": 0,
"max": "1",
"base": {
"path": "ST.mediaType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "text/plain"
},
{
"id": "PN.item.given.language",
"path": "PN.item.given.language",
"representation": [
"xmlAttr"
],
"label": "Language",
"definition": "For character based information the language property specifies the human language of the text.",
"min": 0,
"max": "1",
"base": {
"path": "ST.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id": "PN.item.given.xmlText",
"path": "PN.item.given.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": "ST.xmlText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "PN.item.given.partType",
"path": "PN.item.given.partType",
"representation": [
"xmlAttr"
],
"label": "Name Part Type Code",
"definition": "Indicates whether the name part is a given name, family name, prefix, suffix, etc.",
"min": 0,
"max": "1",
"base": {
"path": "ENXP.partType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityNamePartType"
}
},
{
"id": "PN.item.given.qualifier",
"path": "PN.item.given.qualifier",
"representation": [
"xmlAttr"
],
"label": "Qualifier Code",
"definition": "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": "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": 0,
"max": "1",
"base": {
"path": "ENXP.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"
}
},
{
"id": "PN.item.prefix",
"path": "PN.item.prefix",
"comment": "MAY contain zero or more [0..*] prefix (CONF:81-7155).",
"min": 0,
"max": "*",
"base": {
"path": "EN.item.prefix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "PN.item.prefix.nullFlavor",
"path": "PN.item.prefix.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.item.prefix.representation",
"path": "PN.item.prefix.representation",
"representation": [
"xmlAttr"
],
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"min": 0,
"max": "1",
"base": {
"path": "ST.representation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "TXT"
},
{
"id": "PN.item.prefix.mediaType",
"path": "PN.item.prefix.mediaType",
"representation": [
"xmlAttr"
],
"label": "Media Type",
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min": 0,
"max": "1",
"base": {
"path": "ST.mediaType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "text/plain"
},
{
"id": "PN.item.prefix.language",
"path": "PN.item.prefix.language",
"representation": [
"xmlAttr"
],
"label": "Language",
"definition": "For character based information the language property specifies the human language of the text.",
"min": 0,
"max": "1",
"base": {
"path": "ST.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id": "PN.item.prefix.xmlText",
"path": "PN.item.prefix.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": "ST.xmlText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "PN.item.prefix.partType",
"path": "PN.item.prefix.partType",
"representation": [
"xmlAttr"
],
"label": "Name Part Type Code",
"definition": "Indicates whether the name part is a given name, family name, prefix, suffix, etc.",
"min": 0,
"max": "1",
"base": {
"path": "ENXP.partType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityNamePartType"
}
},
{
"id": "PN.item.prefix.qualifier",
"path": "PN.item.prefix.qualifier",
"representation": [
"xmlAttr"
],
"label": "Qualifier Code",
"definition": "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": "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": 0,
"max": "1",
"base": {
"path": "ENXP.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"
}
},
{
"id": "PN.item.suffix",
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
}
],
"path": "PN.item.suffix",
"short": "𝗨𝗦𝗖𝗗𝗜: Suffix",
"comment": "MAY contain zero or one [0..1] suffix (CONF:81-7161).",
"min": 0,
"max": "*",
"base": {
"path": "EN.item.suffix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
}
]
},
{
"id": "PN.item.suffix.nullFlavor",
"path": "PN.item.suffix.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.item.suffix.representation",
"path": "PN.item.suffix.representation",
"representation": [
"xmlAttr"
],
"definition": "Specifies the representation of the binary data that is the content of the binary data value",
"min": 0,
"max": "1",
"base": {
"path": "ST.representation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "TXT"
},
{
"id": "PN.item.suffix.mediaType",
"path": "PN.item.suffix.mediaType",
"representation": [
"xmlAttr"
],
"label": "Media Type",
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min": 0,
"max": "1",
"base": {
"path": "ST.mediaType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "text/plain"
},
{
"id": "PN.item.suffix.language",
"path": "PN.item.suffix.language",
"representation": [
"xmlAttr"
],
"label": "Language",
"definition": "For character based information the language property specifies the human language of the text.",
"min": 0,
"max": "1",
"base": {
"path": "ST.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id": "PN.item.suffix.xmlText",
"path": "PN.item.suffix.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": "ST.xmlText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "PN.item.suffix.partType",
"path": "PN.item.suffix.partType",
"representation": [
"xmlAttr"
],
"label": "Name Part Type Code",
"definition": "Indicates whether the name part is a given name, family name, prefix, suffix, etc.",
"min": 0,
"max": "1",
"base": {
"path": "ENXP.partType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityNamePartType"
}
},
{
"id": "PN.item.suffix.qualifier",
"path": "PN.item.suffix.qualifier",
"representation": [
"xmlAttr"
],
"label": "Qualifier Code",
"definition": "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": "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": 0,
"max": "1",
"base": {
"path": "ENXP.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"
}
},
{
"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",
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
}
],
"path": "PN.validTime",
"label": "Valid Time",
"short": "𝗨𝗦𝗖𝗗𝗜: Previous Name - Available for use to identify the time period when name was/is in use.",
"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",
"constraint": [
{
"key": "shall-family",
"severity": "error",
"human": "SHALL contain exactly one [1..1] family (CONF:81-7159).",
"expression": "nullFlavor.exists() or item.family.count() = 1",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key": "shall-given",
"severity": "error",
"human": "SHALL contain at least one [1..*] given (CONF:81-7157).",
"expression": "nullFlavor.exists() or item.given.exists()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key": "shall-max-suffix",
"severity": "error",
"human": "There may be at most one suffix",
"expression": "(item.suffix.empty() or item.suffix.count() = 1)",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
},
{
"key": "81-7278",
"severity": "error",
"human": "**SHALL NOT** have mixed content except for white space (CONF:81-7278).",
"expression": "item.xmlText.empty()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"
}
]
},
{
"id": "PN.use",
"path": "PN.use",
"short": "If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced",
"comment": "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": "1"
},
{
"id": "PN.item.family",
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
}
],
"path": "PN.item.family",
"short": "𝗨𝗦𝗖𝗗𝗜: Last Name"
},
{
"id": "PN.item.family.qualifier",
"path": "PN.item.family.qualifier",
"comment": "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": "1",
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"
}
},
{
"id": "PN.item.given",
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
}
],
"path": "PN.item.given",
"short": "𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name",
"comment": "SHALL contain at least one [1..*] given (CONF:81-7157)."
},
{
"id": "PN.item.given.qualifier",
"path": "PN.item.given.qualifier",
"comment": "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": "1",
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"
}
},
{
"id": "PN.item.prefix",
"path": "PN.item.prefix",
"comment": "MAY contain zero or more [0..*] prefix (CONF:81-7155)."
},
{
"id": "PN.item.prefix.qualifier",
"path": "PN.item.prefix.qualifier",
"comment": "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": "1",
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"
}
},
{
"id": "PN.item.suffix",
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
}
],
"path": "PN.item.suffix",
"short": "𝗨𝗦𝗖𝗗𝗜: Suffix",
"comment": "MAY contain zero or one [0..1] suffix (CONF:81-7161)."
},
{
"id": "PN.item.suffix.qualifier",
"path": "PN.item.suffix.qualifier",
"comment": "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": "1",
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"
}
},
{
"id": "PN.validTime",
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
}
],
"path": "PN.validTime",
"short": "𝗨𝗦𝗖𝗗𝗜: Previous Name - Available for use to identify the time period when name was/is in use."
}
]
}
}