| Package | hl7.cda.us.ccda |
| Type | StructureDefinition |
| Id | USRealmPersonNamePNUSFIELDED |
| FHIR Version | R5 |
| Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda/StructureDefinition-USRealmPersonNamePNUSFIELDED.html |
| URL | http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED |
| Version | 4.0.0 |
| Status | draft |
| Date | 2025-06-26T21:09:45+00:00 |
| Name | USRealmPersonNamePNUSFIELDED |
| Title | US Realm Person Name (PN.US.FIELDED) |
| Realm | us |
| Authority | hl7 |
| Description | The US Realm Clinical Document Person Name datatype flavor is a set of reusable constraints that can be used for Persons. |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
| Kind | logical |
| StructureDefinition | |
| AdvanceDirectiveObservation | Advance Directive Observation |
| CarePlan | Care Plan |
| CareTeamMemberAct | Care Team Member Act |
| DrugMonitoringAct | Drug Monitoring Act |
| NoteActivity | Note Activity |
| ProcedureActivityProcedure | Procedure Activity Procedure |
| ReferralNote | Referral Note |
| RelatedPersonRelationshipAndNameParticipant | Related Person Relationship and Name Participant |
| USRealmHeader | US Realm Header |
| StructureDefinition | |
| PN | PN: PersonName (V3 Data Type) |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition USRealmPersonNamePNUSFIELDED
| 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: 81-9371, 81-9372 |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "USRealmPersonNamePNUSFIELDED",
"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/USRealmPersonNamePNUSFIELDED",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.10.20.22.5.1.1"
}
],
"version": "4.0.0",
"name": "USRealmPersonNamePNUSFIELDED",
"title": "US Realm Person Name (PN.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 Clinical Document Person Name datatype flavor is a set of reusable constraints that can be used for Persons.",
"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": "81-9371",
"severity": "error",
"human": "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"expression": "conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
},
{
"key": "81-9372",
"severity": "error",
"human": "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"expression": "item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
}
],
"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",
"constraint": [
{
"key": "81-9371",
"severity": "error",
"human": "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).",
"expression": "conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
},
{
"key": "81-9372",
"severity": "error",
"human": "The string **SHALL NOT** contain name parts (CONF:81-9372).",
"expression": "item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
}
]
}
]
}
}