{ "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).", "_filename": "StructureDefinition-PN.json", "package_name": "hl7.cda.uv.core", "date": "2023-12-16T11:59:27-05:00", "derivation": "specialization", "publisher": "Health Level 7", "fhirVersion": "5.0.0", "name": "PN", "mapping": [ { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" } ], "abstract": false, "type": "http://hl7.org/cda/stds/core/StructureDefinition/PN", "experimental": "false", "resourceType": "StructureDefinition", "title": "PN: PersonName (V3 Data Type)", "package_version": "2.0.0-sd-snapshot1", "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" } ], "snapshot": { "element": [ { "constraint": [ { "key": "pn-no-ls", "human": "No PN name part may have a qualifier of LS.", "severity": "error", "expression": "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()" } ], "path": "PN", "min": 1, "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).", "isModifier": false, "short": "Base for all types and resources", "mapping": [ { "map": "n/a", "identity": "rim" } ], "max": "*", "id": "PN", "base": { "max": "*", "min": 0, "path": "Base" } }, { "path": "PN.nullFlavor", "min": 0, "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "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" }, "representation": [ "xmlAttr" ], "max": "1", "label": "Exceptional Value Detail", "id": "PN.nullFlavor", "base": { "max": "1", "min": 0, "path": "ANY.nullFlavor" } }, { "path": "PN.use", "min": 0, "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", "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" }, "representation": [ "xmlAttr" ], "max": "*", "label": "Use Code", "id": "PN.use", "base": { "max": "*", "min": 0, "path": "EN.use" } }, { "constraint": [ { "key": "EN-1", "human": "Can only have only one of the possible item elements in each choice", "source": "http://hl7.org/cda/stds/core/StructureDefinition/EN", "severity": "error", "expression": "(delimiter | family | given | prefix | suffix | xmlText).count() = 1" } ], "path": "PN.item", "min": 1, "definition": "A series of items that constitute the name.", "type": [ { "code": "http://hl7.org/fhir/StructureDefinition/Base" } ], "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group", "valueBoolean": true } ], "max": "*", "id": "PN.item", "base": { "max": "*", "min": 0, "path": "EN.item" } }, { "id": "PN.item.delimiter", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "EN.item.delimiter" }, "path": "PN.item.delimiter", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP" } ] }, { "id": "PN.item.family", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "EN.item.family" }, "path": "PN.item.family", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP" } ] }, { "id": "PN.item.given", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "EN.item.given" }, "path": "PN.item.given", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP" } ] }, { "id": "PN.item.prefix", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "EN.item.prefix" }, "path": "PN.item.prefix", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP" } ] }, { "id": "PN.item.suffix", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "EN.item.suffix" }, "path": "PN.item.suffix", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ENXP" } ] }, { "path": "PN.item.xmlText", "min": 0, "short": "Allows for mixed text content", "type": [ { "code": "string", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ] } ], "representation": [ "xmlText" ], "max": "1", "id": "PN.item.xmlText", "comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.", "base": { "max": "1", "min": 0, "path": "EN.item.xmlText" } }, { "id": "PN.validTime", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "EN.validTime" }, "path": "PN.validTime", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS" } ], "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." } ] }, "status": "active", "id": "c702f156-43ad-4c52-bb2b-e5ab1e808c15", "kind": "logical", "url": "http://hl7.org/cda/stds/core/StructureDefinition/PN", "version": "2.0.0-sd-snapshot1", "differential": { "element": [ { "id": "PN", "path": "PN", "constraint": [ { "key": "pn-no-ls", "human": "No PN name part may have a qualifier of LS.", "severity": "error", "expression": "(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()" } ], "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)." }, { "id": "PN.item", "max": "*", "min": 1, "path": "PN.item" } ] }, "contact": [ { "name": "HL7 International - Structured Documents", "telecom": [ { "value": "http://www.hl7.org/Special/committees/structure", "system": "url" }, { "value": "structdog@lists.HL7.org", "system": "email" } ] } ], "baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/EN" }