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 - TTL Profile

Draft as of 2023-09-29

TTL representation of the USRealmPersonNamePNUSFIELDED logical model.

Raw ttl | Download

    @prefix fhir: <http://hl7.org/fhir/> .
    @prefix owl: <http://www.w3.org/2002/07/owl#> .
    @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
    @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

    # - resource -------------------------------------------------------------------

     a fhir:StructureDefinition ;
      fhir:nodeRole fhir:treeRoot ;
      fhir:id [ fhir:v "USRealmPersonNamePNUSFIELDED"] ; #
      fhir:text [
    fhir:status [ fhir:v "extensions" ] ;
    fhir: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>"
      ] ; #
      fhir:extension ( [
    fhir:url [ fhir:v "http://hl7.org/fhir/tools/StructureDefinition/logical-target"^^xsd:anyURI ] ;
    fhir:value [
    a fhir:boolean ;
          ( fhir:extension [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/data-absent-reason"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "not-applicable" ]       ] )     ]
      ] [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "urn:hl7-org:v3"^^xsd:anyURI ]
      ] [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-no-order"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "true"^^xsd:boolean ]
      ] ) ; #
      fhir:url [ fhir:v "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"^^xsd:anyURI] ; #
      fhir:identifier ( [
    fhir:value [ fhir:v "urn:oid:2.16.840.1.113883.10.20.22.5.1.1" ]
      ] ) ; #
      fhir:version [ fhir:v "2.1"] ; #
      fhir:name [ fhir:v "USRealmPersonNamePNUSFIELDED"] ; #
      fhir:title [ fhir:v "US Realm Person Name (PN.US.FIELDED)"] ; #
      fhir:status [ fhir:v "draft"] ; #
      fhir:date [ fhir:v "2023-09-29T16:20:44+00:00"^^xsd:dateTime] ; #
      fhir:publisher [ fhir:v "Health Level Seven"] ; #
      fhir:contact ( [
    fhir:name [ fhir:v "HL7 International - Structured Documents" ] ;
        ( fhir:telecom [
    fhir:system [ fhir:v "url" ] ;
    fhir:value [ fhir:v "http://www.hl7.org/Special/committees/structure" ]     ] )
      ] ) ; #
      fhir:description [ fhir:v "The US Realm Clinical Document Person Name datatype flavor is a set of reusable constraints that can be used for Persons."] ; #
      fhir:jurisdiction ( [
        ( fhir:coding [
    fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
    fhir:code [ fhir:v "US" ]     ] )
      ] ) ; #
      fhir:fhirVersion [ fhir:v "5.0.0"] ; #
      fhir:mapping ( [
    fhir:identity [ fhir:v "rim" ] ;
    fhir:uri [ fhir:v "http://hl7.org/v3"^^xsd:anyURI ] ;
    fhir:name [ fhir:v "RIM Mapping" ]
      ] ) ; #
      fhir:kind [ fhir:v "logical"] ; #
      fhir:abstract [ fhir:v "false"^^xsd:boolean] ; #
      fhir:type [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/PN"^^xsd:anyURI] ; #
      fhir:baseDefinition [
    fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/PN"^^xsd:anyURI ;
    fhir:link <http://hl7.org/cda/stds/core/StructureDefinition/PN>
      ] ; #
      fhir:derivation [ fhir:v "constraint"] ; #
      fhir:snapshot [
        ( fhir:element [
    fhir:id [ fhir:v "PN" ] ;
    fhir:path [ fhir:v "PN" ] ;
    fhir:short [ fhir:v "Base for all types and resources" ] ;
    fhir:definition [ fhir: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)." ] ;
    fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ] ;
    fhir:base [
    fhir:path [ fhir:v "Base" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ]       ] ;
          ( fhir:constraint [
    fhir:key [ fhir:v "ele-1" ] ;
    fhir:severity [ fhir:v "error" ] ;
    fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ;
    fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ;
    fhir:source [
    fhir:v "http://hl7.org/fhir/StructureDefinition/Element"^^xsd:anyURI ;
    fhir:link <http://hl7.org/fhir/StructureDefinition/Element>         ]       ] [
    fhir:key [ fhir:v "pn-no-ls" ] ;
    fhir:severity [ fhir:v "error" ] ;
    fhir:human [ fhir:v "No PN name part may have a qualifier of LS." ] ;
    fhir:expression [ fhir:v "(delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()" ] ;
    fhir:source [
    fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/PN"^^xsd:anyURI ;
    fhir:link <http://hl7.org/cda/stds/core/StructureDefinition/PN>         ]       ] [
    fhir:key [ fhir:v "81-9371" ] ;
    fhir:severity [ fhir:v "error" ] ;
    fhir:human [ fhir:v "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371)." ] ;
    fhir:source [
    fhir:v "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"^^xsd:anyURI ;
    fhir:link <http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED>         ]       ] [
    fhir:key [ fhir:v "81-9372" ] ;
    fhir:severity [ fhir:v "error" ] ;
    fhir:human [ fhir:v "The string **SHALL NOT** contain name parts (CONF:81-9372)." ] ;
    fhir:source [
    fhir:v "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"^^xsd:anyURI ;
    fhir:link <http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED>         ]       ] ) ;
    fhir:isModifier [ fhir:v "false"^^xsd:boolean ] ;
          ( fhir:mapping [
    fhir:identity [ fhir:v "rim" ] ;
    fhir:map [ fhir:v "n/a" ]       ] )     ] [
    fhir:id [ fhir:v "PN.nullFlavor" ] ;
    fhir:path [ fhir:v "PN.nullFlavor" ] ;
          ( fhir:representation [ fhir:v "xmlAttr" ] ) ;
    fhir:label [ fhir:v "Exceptional Value Detail" ] ;
    fhir:definition [ fhir:v "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing." ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:base [
    fhir:path [ fhir:v "ANY.nullFlavor" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "1" ]       ] ;
          ( fhir:type [
    fhir:code [ fhir:v "code"^^xsd:anyURI ] ;
            ( fhir:profile [
    fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"^^xsd:anyURI ;
    fhir:link <http://hl7.org/cda/stds/core/StructureDefinition/cs-simple>         ] )       ] ) ;
    fhir:binding [
    fhir:strength [ fhir:v "required" ] ;
    fhir:valueSet [
    fhir:v "http://terminology.hl7.org/ValueSet/v3-NullFlavor"^^xsd:anyURI ;
    fhir:link <http://terminology.hl7.org/ValueSet/v3-NullFlavor>         ]       ]     ] [
    fhir:id [ fhir:v "PN.use" ] ;
    fhir:path [ fhir:v "PN.use" ] ;
          ( fhir:representation [ fhir:v "xmlAttr" ] ) ;
    fhir:label [ fhir:v "Use Code" ] ;
    fhir:definition [ fhir: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" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:base [
    fhir:path [ fhir:v "EN.use" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "1" ]       ] ;
          ( fhir:type [
    fhir:code [ fhir:v "code"^^xsd:anyURI ] ;
            ( fhir:profile [
    fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"^^xsd:anyURI ;
    fhir:link <http://hl7.org/cda/stds/core/StructureDefinition/cs-simple>         ] )       ] ) ;
    fhir:binding [
    fhir:strength [ fhir:v "required" ] ;
    fhir:valueSet [
    fhir:v "http://terminology.hl7.org/ValueSet/v3-EntityNameUse"^^xsd:anyURI ;
    fhir:link <http://terminology.hl7.org/ValueSet/v3-EntityNameUse>         ]       ]     ] [
    fhir:id [ fhir:v "PN.delimiter" ] ;
    fhir:path [ fhir:v "PN.delimiter" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ] ;
    fhir:base [
    fhir:path [ fhir:v "EN.delimiter" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ]       ] ;
          ( fhir:type [
    fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"^^xsd:anyURI ]       ] )     ] [
    fhir:id [ fhir:v "PN.family" ] ;
    fhir:path [ fhir:v "PN.family" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ] ;
    fhir:base [
    fhir:path [ fhir:v "EN.family" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ]       ] ;
          ( fhir:type [
    fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"^^xsd:anyURI ]       ] )     ] [
    fhir:id [ fhir:v "PN.given" ] ;
    fhir:path [ fhir:v "PN.given" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ] ;
    fhir:base [
    fhir:path [ fhir:v "EN.given" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ]       ] ;
          ( fhir:type [
    fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"^^xsd:anyURI ]       ] )     ] [
    fhir:id [ fhir:v "PN.prefix" ] ;
    fhir:path [ fhir:v "PN.prefix" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ] ;
    fhir:base [
    fhir:path [ fhir:v "EN.prefix" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ]       ] ;
          ( fhir:type [
    fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"^^xsd:anyURI ]       ] )     ] [
    fhir:id [ fhir:v "PN.suffix" ] ;
    fhir:path [ fhir:v "PN.suffix" ] ;
    fhir:definition [ fhir:v "Element EN.family" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ] ;
    fhir:base [
    fhir:path [ fhir:v "EN.suffix" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "*" ]       ] ;
          ( fhir:type [
    fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/ENXP"^^xsd:anyURI ]       ] )     ] [
    fhir:id [ fhir:v "PN.other" ] ;
    fhir:path [ fhir:v "PN.other" ] ;
          ( fhir:representation [ fhir:v "xmlText" ] ) ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:base [
    fhir:path [ fhir:v "EN.other" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "1" ]       ] ;
          ( fhir:type [
    fhir:code [ fhir:v "string"^^xsd:anyURI ] ;
            ( fhir:profile [
    fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"^^xsd:anyURI ;
    fhir:link <http://hl7.org/cda/stds/core/StructureDefinition/st-simple>         ] )       ] )     ] [
    fhir:id [ fhir:v "PN.validTime" ] ;
    fhir:path [ fhir:v "PN.validTime" ] ;
    fhir:label [ fhir:v "Valid Time" ] ;
    fhir:definition [ fhir: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." ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:base [
    fhir:path [ fhir:v "EN.validTime" ] ;
    fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ;
    fhir:max [ fhir:v "1" ]       ] ;
          ( fhir:type [
    fhir:code [ fhir:v "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"^^xsd:anyURI ]       ] )     ] )
      ] ; #
      fhir:differential [
        ( fhir:element [
    fhir:id [ fhir:v "PN" ] ;
    fhir:path [ fhir:v "PN" ] ;
          ( fhir:constraint [
    fhir:key [ fhir:v "81-9371" ] ;
    fhir:severity [ fhir:v "error" ] ;
    fhir:human [ fhir:v "The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371)." ] ;
    fhir:source [
    fhir:v "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"^^xsd:anyURI ;
    fhir:link <http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED>         ]       ] [
    fhir:key [ fhir:v "81-9372" ] ;
    fhir:severity [ fhir:v "error" ] ;
    fhir:human [ fhir:v "The string **SHALL NOT** contain name parts (CONF:81-9372)." ] ;
    fhir:source [
    fhir:v "http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED"^^xsd:anyURI ;
    fhir:link <http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED>         ]       ] )     ] )
      ] . #