Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

## Logical Model: USRealmPersonNamePNUSFIELDED - JSON Profile

Draft as of 2023-09-29

JSON representation of the USRealmPersonNamePNUSFIELDED logical model.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "USRealmPersonNamePNUSFIELDED",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description &amp; Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-USRealmPersonNamePNUSFIELDED-definitions.html#PN\">PN</a><a name=\"PN\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"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 (81-9371, 81-9372)\">C</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-PN.html\">PN</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">XML Namespace: </span>urn:hl7-org:v3<br/>Elements defined in Ancestors: <a href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-ANY.html\" title=\"If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.\">@nullFlavor</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-EN.html\" title=\"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\">@use</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-EN.html\">delimiter</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-EN.html\">family</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-EN.html\">given</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-EN.html\">prefix</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-EN.html\" title=\"Element EN.family\">suffix</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-EN.html\">other</a>, <a href=\"https://build.fhir.org/ig/HL7/CDA-core-2.0//StructureDefinition-EN.html\" title=\"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.\">validTime</a><br/><span style=\"opacity: 0.5\">Base for all types and resources</span><br/><span style=\"font-weight:bold\">81-9371: </span>The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).<br/><span style=\"font-weight:bold\">81-9372: </span>The string **SHALL NOT** contain name parts (CONF:81-9372).</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
      },
      "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/StructureDefinition/elementdefinition-namespace",
          "valueUri" : "urn:hl7-org:v3"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-no-order",
          "valueBoolean" : true
        }
      ],
      "url" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED",
      "identifier" : [
        {
          "value" : "urn:oid:2.16.840.1.113883.10.20.22.5.1.1"
        }
      ],
      "version" : "2.1",
      "name" : "USRealmPersonNamePNUSFIELDED",
      "title" : "US Realm Person Name (PN.US.FIELDED)",
      "status" : "draft",
      "date" : "2023-09-29T16:20:44+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" : {
        "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" : "ele-1",
                "severity" : "error",
                "human" : "All FHIR elements must have a @value or children",
                "expression" : "hasValue() or (children().count() > id.count())",
                "source" : "http://hl7.org/fhir/StructureDefinition/Element"
              },
              {
                "key" : "pn-no-ls",
                "severity" : "error",
                "human" : "No PN name part may have a qualifier of LS.",
                "expression" : "(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').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).",
                "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).",
                "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://terminology.hl7.org/ValueSet/v3-NullFlavor"
            }
          },
          {
            "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" : "1",
            "base" : {
              "path" : "EN.use",
              "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-EntityNameUse"
            }
          },
          {
            "id" : "PN.delimiter",
            "path" : "PN.delimiter",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "EN.delimiter",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
              }
            ]
          },
          {
            "id" : "PN.family",
            "path" : "PN.family",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "EN.family",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
              }
            ]
          },
          {
            "id" : "PN.given",
            "path" : "PN.given",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "EN.given",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
              }
            ]
          },
          {
            "id" : "PN.prefix",
            "path" : "PN.prefix",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "EN.prefix",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
              }
            ]
          },
          {
            "id" : "PN.suffix",
            "path" : "PN.suffix",
            "definition" : "Element EN.family",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "EN.suffix",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"
              }
            ]
          },
          {
            "id" : "PN.other",
            "path" : "PN.other",
            "representation" : [
              "xmlText"
            ],
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "EN.other",
              "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).",
                "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).",
                "source" : "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"
              }
            ]
          }
        ]
      }
    }