Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions

Hl7nl\extension-nl-core-humanname.json

Raw JSON (canonical form)

nl-core-humanname

{
  "resourceType": "StructureDefinition",
  "id": "nl-core-humanname",
  "meta": {
    "lastUpdated": "2015-09-22T20:02:49.724+10:00"
  },
  "url": "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname",
  "name": "nl-core-humanname",
  "status": "draft",
  "contact": [
    {
      "name": "HL7 Netherlands"
    }
  ],
  "date": "2015-09-22T20:02:49+10:00",
  "description": "Base StructureDefinition for HumanName Type with additions for Dutch realm names. Dutch names break down the family into maximum of 4 parts that are important to know separately in some use cases.",
  "requirements": "Need to be able to record names, along with notes about their use.",
  "fhirVersion": "1.0.1",
  "mapping": [
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    },
    {
      "identity": "servd",
      "uri": "http://www.omg.org/spec/ServD/1.0/",
      "name": "ServD"
    }
  ],
  "kind": "datatype",
  "constrainedType": "HumanName",
  "abstract": false,
  "base": "http://hl7.org/fhir/StructureDefinition/HumanName",
  "snapshot": {
    "element": [
      {
        "path": "HumanName",
        "short": "Name of a human - parts and usage",
        "definition": "A human's name with the ability to identify parts and usage.",
        "comments": "Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.\r\n\r\nA Dutch HumanName is a proper FHIR HumanName. Systems that do not understand any of the extensions, will be able to render and work with a Dutch name. Dutch names make certain name parts seaprately communicable. These parts are required for use in true Dutch systems when dealing with Dutch names, but may not have value for international systems when information gets sent abroad.\r\n\r\nTo have true compatibility an implementer SHOULD use the core HumanName parts as intended. To have names work for Dutch context, the implementer SHOULD in addition use the extension elements.\r\n\r\nThe extension elements cover birth name (NL: eigennaam) and partner name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around.\r\n\r\nFor this reason, the the extension do not have explicit names like \"prefix spouse\", because a person may not have a spouse, or may not have assumed their names. Each extension supports a qualifier to mark what it is.\r\n\r\nExample: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas\r\nfamily = \"Jongeneel-de Haas\"\r\ngiven = \"Irma\"\r\nfamily-name-part1 = \"Jongeneel\" (qualifier=BR)\r\nfamily-name-part2-prefix = \"de \" (qualifier=VV)\r\nfamily-name-part2-prefix = \"Haas\" (qualifier=SP)",
        "min": 0,
        "max": "*",
        "base": {
          "path": "HumanName",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "HumanName"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "XPN"
          },
          {
            "identity": "rim",
            "map": "EN (actually, PN)"
          },
          {
            "identity": "servd",
            "map": "ProviderName"
          }
        ]
      },
      {
        "path": "HumanName.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "HumanName.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "HumanName.extension",
        "slicing": {
          "discriminator": [
            "url"
          ],
          "rules": "openAtEnd"
        },
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "*",
        "base": {
          "path": "HumanName.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ]
      },
      {
        "path": "HumanName.extension",
        "name": "family-name-part1-prefix",
        "short": "family-name-part-prefix",
        "definition": "Optional Extensions Element - found in all resources.",
        "comments": "Officially recognized family name prefixes  may be found in BRP/GBA Table 36 \"Voorvoegsels\"",
        "alias": [
          "voorvoegsel"
        ],
        "min": 0,
        "max": "1",
        "base": {
          "path": "HumanName.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname-prefix"
            ]
          }
        ]
      },
      {
        "path": "HumanName.extension",
        "name": "family-name-part1",
        "short": "family-name-part",
        "definition": "Optional Extensions Element - found in all resources.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "HumanName.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname"
            ]
          }
        ]
      },
      {
        "path": "HumanName.extension",
        "name": "family-name-part2-prefix",
        "short": "family-name-part2-prefix",
        "definition": "Optional Extensions Element - found in all resources.",
        "comments": "Officially recognized family name prefixes  may be found in BRP/GBA Table 36 \"Voorvoegsels\"",
        "min": 0,
        "max": "1",
        "base": {
          "path": "HumanName.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname-prefix"
            ]
          }
        ]
      },
      {
        "path": "HumanName.extension",
        "name": "family-name-part2",
        "short": "family-name-part2",
        "definition": "Optional Extensions Element - found in all resources.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "HumanName.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname"
            ]
          }
        ]
      },
      {
        "path": "HumanName.use",
        "short": "usual | official | temp | nickname | anonymous | old | maiden",
        "definition": "Identifies the purpose for this name.",
        "comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
        "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "HumanName.use",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isSummary": true,
        "binding": {
          "strength": "required",
          "description": "The use of a human name",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/name-use"
          }
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "XPN.7, but often indicated by which field contains the name"
          },
          {
            "identity": "rim",
            "map": "unique(./use)"
          },
          {
            "identity": "servd",
            "map": "./NamePurpose"
          }
        ]
      },
      {
        "path": "HumanName.text",
        "short": "Text representation of the full name",
        "definition": "A full text representation of the name.",
        "comments": "Can provide both a text representation and structured parts.",
        "requirements": "A renderable, unencoded form.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "HumanName.text",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "implied by XPN.11"
          },
          {
            "identity": "rim",
            "map": "./formatted"
          }
        ]
      },
      {
        "path": "HumanName.family",
        "short": "Family name (often called 'Surname')",
        "definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.",
        "comments": "For family name, hyphenated names such as \"Smith-Jones\" are a single name, but names with spaces such as \"Smith Jones\" are broken into multiple parts.",
        "alias": [
          "surname"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "HumanName.family",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "XPN.1"
          },
          {
            "identity": "rim",
            "map": "./part[partType = FAM]"
          },
          {
            "identity": "servd",
            "map": "./FamilyName"
          }
        ]
      },
      {
        "path": "HumanName.given",
        "short": "Given names (not always 'first'). Includes middle names",
        "definition": "Given name.",
        "comments": "If only initials are recorded, they may be used in place of the full name.  Not called \"first name\" since given names do not always come first.",
        "alias": [
          "first name",
          "middle name"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "HumanName.given",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "XPN.2 + XPN.3"
          },
          {
            "identity": "rim",
            "map": "./part[partType = GIV]"
          },
          {
            "identity": "servd",
            "map": "./GivenNames"
          }
        ]
      },
      {
        "path": "HumanName.prefix",
        "short": "Parts that come before the name",
        "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "HumanName.prefix",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "XPN.5"
          },
          {
            "identity": "rim",
            "map": "./part[partType = PFX]"
          },
          {
            "identity": "servd",
            "map": "./TitleCode"
          }
        ]
      },
      {
        "path": "HumanName.suffix",
        "short": "Parts that come after the name",
        "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "HumanName.suffix",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "XPN/4"
          },
          {
            "identity": "rim",
            "map": "./part[partType = SFX]"
          }
        ]
      },
      {
        "path": "HumanName.period",
        "short": "Time period when name was/is in use",
        "definition": "Indicates the period of time when this name was valid for the named person.",
        "requirements": "Allows names to be placed in historical context.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "HumanName.period",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Period"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "XPN.13 + XPN.14"
          },
          {
            "identity": "rim",
            "map": "./usablePeriod[type=\"IVL<TS>\"]"
          },
          {
            "identity": "servd",
            "map": "./StartDate and ./EndDate"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "HumanName",
        "short": "Name of a human - parts and usage",
        "definition": "A human's name with the ability to identify parts and usage.",
        "comments": "Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.\r\n\r\nA Dutch HumanName is a proper FHIR HumanName. Systems that do not understand any of the extensions, will be able to render and work with a Dutch name. Dutch names make certain name parts seaprately communicable. These parts are required for use in true Dutch systems when dealing with Dutch names, but may not have value for international systems when information gets sent abroad.\r\n\r\nTo have true compatibility an implementer SHOULD use the core HumanName parts as intended. To have names work for Dutch context, the implementer SHOULD in addition use the extension elements.\r\n\r\nThe extension elements cover birth name (NL: eigennaam) and partner name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around.\r\n\r\nFor this reason, the the extension do not have explicit names like \"prefix spouse\", because a person may not have a spouse, or may not have assumed their names. Each extension supports a qualifier to mark what it is.\r\n\r\nExample: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas\r\nfamily = \"Jongeneel-de Haas\"\r\ngiven = \"Irma\"\r\nfamily-name-part1 = \"Jongeneel\" (qualifier=BR)\r\nfamily-name-part2-prefix = \"de \" (qualifier=VV)\r\nfamily-name-part2-prefix = \"Haas\" (qualifier=SP)",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "HumanName"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "XPN"
          },
          {
            "identity": "rim",
            "map": "EN (actually, PN)"
          },
          {
            "identity": "servd",
            "map": "ProviderName"
          }
        ]
      },
      {
        "path": "HumanName.extension",
        "slicing": {
          "discriminator": [
            "url"
          ],
          "rules": "openAtEnd"
        }
      },
      {
        "path": "HumanName.extension",
        "name": "family-name-part1-prefix",
        "short": "family-name-part-prefix",
        "definition": "Optional Extensions Element - found in all resources.",
        "comments": "Officially recognized family name prefixes  may be found in BRP/GBA Table 36 \"Voorvoegsels\"",
        "alias": [
          "voorvoegsel"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname-prefix"
            ]
          }
        ]
      },
      {
        "path": "HumanName.extension",
        "name": "family-name-part1",
        "short": "family-name-part",
        "definition": "Optional Extensions Element - found in all resources.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname"
            ]
          }
        ]
      },
      {
        "path": "HumanName.extension",
        "name": "family-name-part2-prefix",
        "short": "family-name-part2-prefix",
        "definition": "Optional Extensions Element - found in all resources.",
        "comments": "Officially recognized family name prefixes  may be found in BRP/GBA Table 36 \"Voorvoegsels\"",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname-prefix"
            ]
          }
        ]
      },
      {
        "path": "HumanName.extension",
        "name": "family-name-part2",
        "short": "family-name-part2",
        "definition": "Optional Extensions Element - found in all resources.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname"
            ]
          }
        ]
      }
    ]
  }
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.